From 2c1a0e47bdd370bbeb8e297a77b0f85b793a549c Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Thu, 8 Nov 2018 10:01:01 +0100 Subject: [PATCH] Update documentation --- .../en-US/about_SPAccessServiceApp.help.txt | 1 + .../en-US/about_SPAccessServices2010.help.txt | 33 ++++++ .../en-US/about_SPAlternateUrl.help.txt | 1 + .../en-US/about_SPAntivirusSettings.help.txt | 11 +- .../en-US/about_SPAppCatalog.help.txt | 1 + .../en-US/about_SPAppDomain.help.txt | 1 + .../about_SPAppManagementServiceApp.help.txt | 1 + .../en-US/about_SPAppStoreSettings.help.txt | 1 + .../en-US/about_SPBCSServiceApp.help.txt | 1 + .../en-US/about_SPBlobCacheSettings.help.txt | 1 + .../en-US/about_SPCacheAccounts.help.txt | 1 + .../en-US/about_SPConfigWizard.help.txt | 18 ++- .../en-US/about_SPContentDatabase.help.txt | 1 + .../en-US/about_SPCreateFarm.help.txt | 47 -------- .../en-US/about_SPDatabaseAAG.help.txt | 1 + .../en-US/about_SPDesignerSettings.help.txt | 9 +- ...about_SPDiagnosticLoggingSettings.help.txt | 13 +- .../about_SPDiagnosticsProvider.help.txt | 1 + ..._SPDistributedCacheClientSettings.help.txt | 1 + .../about_SPDistributedCacheService.help.txt | 1 + .../en-US/about_SPExcelServiceApp.help.txt | 1 + .../SharePointDsc/en-US/about_SPFarm.help.txt | 26 ++-- .../en-US/about_SPFarmAdministrators.help.txt | 16 +-- .../en-US/about_SPFarmPropertyBag.help.txt | 1 + .../en-US/about_SPFarmSolution.help.txt | 9 +- .../en-US/about_SPFeature.help.txt | 1 + .../about_SPHealthAnalyzerRuleState.help.txt | 1 + ...bout_SPInfoPathFormsServiceConfig.help.txt | 10 +- .../en-US/about_SPInstall.help.txt | 30 +++-- .../about_SPInstallLanguagePack.help.txt | 5 +- .../en-US/about_SPInstallPrereqs.help.txt | 27 ++++- .../en-US/about_SPIrmSettings.help.txt | 12 +- .../en-US/about_SPJoinFarm.help.txt | 30 ----- .../en-US/about_SPLogLevel.help.txt | 1 + ...ut_SPMachineTranslationServiceApp.help.txt | 1 + .../en-US/about_SPManagedAccount.help.txt | 1 + ...about_SPManagedMetaDataServiceApp.help.txt | 1 + ...PManagedMetaDataServiceAppDefault.help.txt | 1 + .../en-US/about_SPManagedPath.help.txt | 1 + .../en-US/about_SPMinRoleCompliance.help.txt | 13 +- ...about_SPOfficeOnlineServerBinding.help.txt | 1 + .../about_SPOutgoingEmailSettings.help.txt | 5 +- .../about_SPPasswordChangeSettings.help.txt | 13 +- ...bout_SPPerformancePointServiceApp.help.txt | 1 + ..._SPPowerPointAutomationServiceApp.help.txt | 112 ++++++++++++++++++ .../en-US/about_SPProductUpdate.help.txt | 1 + ...SPProjectServerADResourcePoolSync.help.txt | 1 + ...SPProjectServerAdditionalSettings.help.txt | 1 + ..._SPProjectServerGlobalPermissions.help.txt | 1 + .../en-US/about_SPProjectServerGroup.help.txt | 1 + .../about_SPProjectServerLicense.help.txt | 17 ++- ...out_SPProjectServerPermissionMode.help.txt | 1 + .../about_SPProjectServerServiceApp.help.txt | 3 +- ..._SPProjectServerTimeSheetSettings.help.txt | 1 + ...t_SPProjectServerUserSyncSettings.help.txt | 1 + .../about_SPProjectServerWssSettings.help.txt | 1 + ...about_SPPublishServiceApplication.help.txt | 3 +- .../en-US/about_SPQuotaTemplate.help.txt | 1 + .../en-US/about_SPRemoteFarmTrust.help.txt | 1 + .../about_SPSearchAuthoritativePage.help.txt | 1 + .../about_SPSearchContentSource.help.txt | 13 +- .../en-US/about_SPSearchCrawlMapping.help.txt | 1 + .../en-US/about_SPSearchCrawlRule.help.txt | 1 + .../about_SPSearchCrawlerImpactRule.help.txt | 1 + .../en-US/about_SPSearchFileType.help.txt | 1 + .../about_SPSearchIndexPartition.help.txt | 1 + .../about_SPSearchManagedProperty.help.txt | 1 + .../about_SPSearchMetadataCategory.help.txt | 72 +++++++++++ .../en-US/about_SPSearchResultSource.help.txt | 23 +++- .../en-US/about_SPSearchServiceApp.help.txt | 1 + .../en-US/about_SPSearchTopology.help.txt | 1 + .../about_SPSecureStoreServiceApp.help.txt | 1 + ...bout_SPSecurityTokenServiceConfig.help.txt | 11 +- .../about_SPSelfServiceSiteCreation.help.txt | 83 ++++++++++++- .../en-US/about_SPServiceAppPool.help.txt | 1 + .../about_SPServiceAppProxyGroup.help.txt | 1 + .../en-US/about_SPServiceAppSecurity.help.txt | 75 +++++++++--- .../en-US/about_SPServiceIdentity.help.txt | 1 + .../en-US/about_SPServiceInstance.help.txt | 1 + .../about_SPSessionStateService.help.txt | 1 + .../en-US/about_SPShellAdmins.help.txt | 24 ++-- .../SharePointDsc/en-US/about_SPSite.help.txt | 3 +- .../en-US/about_SPSiteUrl.help.txt | 1 + .../en-US/about_SPStateServiceApp.help.txt | 1 + ..._SPSubscriptionSettingsServiceApp.help.txt | 1 + .../en-US/about_SPTimerJobState.help.txt | 1 + ...bout_SPTrustedIdentityTokenIssuer.help.txt | 1 + ...IdentityTokenIssuerProviderRealms.help.txt | 1 + .../about_SPTrustedRootAuthority.help.txt | 81 +++++++++++++ .../en-US/about_SPUsageApplication.help.txt | 1 + .../about_SPUserProfileProperty.help.txt | 96 +++++++-------- .../en-US/about_SPUserProfileSection.help.txt | 1 + .../about_SPUserProfileServiceApp.help.txt | 1 + ...PUserProfileServiceAppPermissions.help.txt | 1 + ...about_SPUserProfileSyncConnection.help.txt | 1 + .../about_SPUserProfileSyncService.help.txt | 1 + .../en-US/about_SPVisioServiceApp.help.txt | 1 + .../SharePointDsc/en-US/about_SPWeb.help.txt | 1 + .../about_SPWebAppAuthentication.help.txt | 1 + .../about_SPWebAppBlockedFileTypes.help.txt | 13 +- ...ut_SPWebAppClientCallableSettings.help.txt | 15 +-- .../about_SPWebAppGeneralSettings.help.txt | 9 +- ...bout_SPWebAppPeoplePickerSettings.help.txt | 1 + .../en-US/about_SPWebAppPermissions.help.txt | 1 + .../en-US/about_SPWebAppPolicy.help.txt | 1 + .../en-US/about_SPWebAppPropertyBag.help.txt | 11 +- .../en-US/about_SPWebAppProxyGroup.help.txt | 1 + .../about_SPWebAppSiteUseAndDeletion.help.txt | 5 +- .../en-US/about_SPWebAppSuiteBar.help.txt | 9 +- .../about_SPWebAppThrottlingSettings.help.txt | 7 +- .../about_SPWebAppWorkflowSettings.help.txt | 7 +- .../en-US/about_SPWebApplication.help.txt | 5 +- .../about_SPWebApplicationAppDomain.help.txt | 7 +- .../about_SPWebApplicationExtension.help.txt | 1 + .../about_SPWordAutomationServiceApp.help.txt | 1 + .../about_SPWorkManagementServiceApp.help.txt | 5 +- .../en-US/about_SPWorkflowService.help.txt | 1 + 117 files changed, 830 insertions(+), 280 deletions(-) create mode 100644 Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt delete mode 100644 Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt delete mode 100644 Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPPowerPointAutomationServiceApp.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPSearchMetadataCategory.help.txt create mode 100644 Modules/SharePointDsc/en-US/about_SPTrustedRootAuthority.help.txt diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt index 7c47d5fd6..daedfdc63 100644 --- a/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for creating Access Services Application instances within the local SharePoint farm. The resource will provision and configure the diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt new file mode 100644 index 000000000..7306ce274 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt @@ -0,0 +1,33 @@ +.NAME + SPAccessServices2010 + +# Description + + **Type:** Distributed + **Requires CredSSP:** No + + This resource is responsible for creating Access Services 2010 Application + instances within the local SharePoint farm. The resource will provision and + configure the Access Services 2010 Service Application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - String + The name of the service application + +.PARAMETER ApplicationPool + Required - String + The name of the application pool to run the service app in + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Present ensures service app exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run thsi resource as, use PsDscRunAsCredential if using PowerShell 5 + + diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt index adf0e202c..b61e08714 100644 --- a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to define an alternate access mapping URL for a specified web application. These can be assigned to specific zones for each web diff --git a/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt index a311bd156..1a51b0d64 100644 --- a/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to set the global antivirus settings for the local farm. These settings will be used to control the behavior of an external anti-virus @@ -11,8 +12,13 @@ not scan documents for viruses on it's own, an external tool still needs to be installed on the servers that integrates with SharePoint. +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER ScanOnDownload - Key - Boolean + Write - Boolean Should documents be scanned before being downloaded .PARAMETER ScanOnUpload @@ -44,7 +50,7 @@ This example shows how to apply specific anti-virus configuration to the farm - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -56,6 +62,7 @@ node localhost { SPAntivirusSettings AVSettings { + IsSingleInstance = "Yes" ScanOnDownload = $true ScanOnUpload = $true AllowDownloadInfected = $false diff --git a/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt index 1fd2673d8..de083e063 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** Yes This resource will ensure that a specific site collection is marked as the app catalog for the web application that the site is in. The catalog site needs to diff --git a/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt index 522632ebf..6acffc7e5 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will set the value for the app domain settings at the farm level. You can set the domain name and the prefix that is to be used for app URLs. diff --git a/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt index 3782a62e2..6e88b4c7e 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to provision and manage an instance of the App Management Services Service Application. It will identify an instance of the app diff --git a/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt index 1f0c44782..07ae80b41 100644 --- a/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will configure the ability to purchase apps for both SharePoint and Office apps. diff --git a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt index 11a901a7b..c213a52d2 100644 --- a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to provision and manage an instance of the Business Connectivity Services Service Application. It will identify an instance diff --git a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt index 682705314..60c7bfe86 100644 --- a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Specific + **Requires CredSSP:** No This resource is used to configure the Blob Cache settings for a web application. diff --git a/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt index 7545cc4bd..13d3df0a2 100644 --- a/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to set the "super user" and "super reader" cache accounts for the specified web application object (as described in the TechNet article diff --git a/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt b/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt index 8cd498ddc..83197c294 100644 --- a/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Utility + **Requires CredSSP:** No This resource is used to perform the upgrade step of installing SharePoint updates, like Cumulative Updates, Service Packs and Language Packs. The @@ -11,10 +12,15 @@ which the update can be installed. This module has to be used to complete the update installation step, performed by SPProductUpdate. +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER Ensure - Key - string + Write - string Allowed values: Present, Absent - Present to install SharePoint. Absent is currently not supported + Present to run the Configuration Wizard. Absent is currently not supported .PARAMETER DatabaseUpgradeDays Write - String @@ -34,7 +40,7 @@ This example runs the Configuration Wizard as soon as it is applied. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -46,7 +52,7 @@ node localhost { SPConfigWizard RunConfigWizard { - Ensure = "Present" + IsSingleInstance = "Yes" PsDscRunAsCredential = $SetupAccount } } @@ -58,7 +64,7 @@ - Saturday and Sunday night between 3am and 5am. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -70,7 +76,7 @@ node localhost { SPConfigWizard RunConfigWizard { - Ensure = "Present" + IsSingleInstance = "Yes" DatabaseUpgradeDays = "sat", "sun" DatabaseUpgradeTime = "3:00am to 5:00am" PsDscRunAsCredential = $SetupAccount diff --git a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt index ec5888af0..820a6cdd1 100644 --- a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to add and remove Content Databases to web applications and configure these databases. diff --git a/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt deleted file mode 100644 index d7f4e2ea5..000000000 --- a/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt +++ /dev/null @@ -1,47 +0,0 @@ -.NAME - SPCreateFarm - -# Description - - WARNING: This resource has been removed. Please use SPFarm instead. - See http://aka.ms/SPDsc-SPFarm for details. - -.PARAMETER FarmConfigDatabaseName - Key - String - Name of the configuration database - -.PARAMETER DatabaseServer - Key - String - Server that will host the configuration and admin content databases - -.PARAMETER FarmAccount - Required - String - The account to use as the main farm account - -.PARAMETER Passphrase - Required - String - The passphrase to use to allow servers to join this farm - -.PARAMETER AdminContentDatabaseName - Required - String - The name of the admin content database - -.PARAMETER CentralAdministrationPort - Write - uint32 - What port will Central Admin be provisioned to - default is 9999 - -.PARAMETER CentralAdministrationAuth - Write - String - Allowed values: NTLM, Kerberos - The authentication provider of the CentralAdministration web application - -.PARAMETER ServerRole - Write - string - Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache - SharePoint 2016 only - the MinRole role to enroll this server as - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - diff --git a/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt index 5dff457fb..d722e76bd 100644 --- a/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will allow specifying which SQL Server AlwaysOn Availability group a resource should be in. This resource does not configure the diff --git a/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt index b6337b942..76b780aa1 100644 --- a/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to set the SharePoint Designer settings for the local farm or site collections. These settings will be used to control if users are @@ -22,7 +23,7 @@ changing the Site Collection settings results in an Access Denied error. Consider implementing PowerShell v5 and switching to the PsDscRunAsCredential -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The URL of the web application or site collection to configure @@ -65,11 +66,11 @@ .EXAMPLE - This example applies settings to disable SharePoint Designer access to the + This example applies settings to disable SharePoint Designer access to the specified web application. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -81,7 +82,7 @@ node localhost { SPDesignerSettings MainWebAppSPDSettings { - Url = "https://intranet.sharepoint.contoso.com" + WebAppUrl = "https://intranet.sharepoint.contoso.com" SettingsScope = "WebApplication" AllowSharePointDesigner = $false AllowDetachPagesFromDefinition = $false diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt index a7ac89ff3..08fb18203 100644 --- a/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt @@ -4,14 +4,20 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for configuring settings to do with the diagnostic (ULS) logging on servers in the farm. These settings are applied to the diagnostic logging service for the farm and do not need to be applied to each server individually, the settings will be propagated throughout the farm when +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER LogPath - Key - string + Required - string The physical path on each server to store ULS logs .PARAMETER LogSpaceInGB @@ -93,7 +99,7 @@ whatever value has been manually configured outside of DSC. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -105,7 +111,7 @@ node localhost { SPDiagnosticLoggingSettings ApplyDiagnosticLogSettings { - PsDscRunAsCredential = $SetupAccount + IsSingleInstance = "Yes" LogPath = "L:\ULSLogs" LogSpaceInGB = 10 AppAnalyticsAutomaticUploadEnabled = $false @@ -124,6 +130,7 @@ ScriptErrorReportingDelay = 30 ScriptErrorReportingEnabled = $true ScriptErrorReportingRequireAuth = $true + PsDscRunAsCredential = $SetupAccount } } } diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt index 43b0acf98..bfc898057 100644 --- a/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for configuring the Diagnostics Provider within the local SharePoint farm. Using Ensure equals to Absent is not supported. diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt index acf3d850b..d366ef408 100644 --- a/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for configuring the distributed cache client settings. It only accepts Ensure='Present' as a key. The resource can diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt index 5210953af..d2387c7e4 100644 --- a/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Specific + **Requires CredSSP:** No This resource is responsible for provisioning the distributed cache to the service it runs on. This is required in your farm on at least one server (as diff --git a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt index 4a95d56dc..217884c77 100644 --- a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for creating Excel Services Application instances within the local SharePoint farm. The resource will provision and configure the diff --git a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt index c0ce3ae8a..de881fe49 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Specific + **Requires CredSSP:** No This resource is used to create a new SharePoint farm and allow servers to join that farm. It will detect the presence of the configuration database @@ -36,8 +37,13 @@ specified, it defaults to NTLM. If using Kerberos, make sure to have appropriate SPNs setup for Farm account and Central Administration URI. +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER Ensure - Key - string + Write - string Allowed values: Present, Absent Present to create/join the farm. Absent is currently not supported @@ -77,7 +83,7 @@ .PARAMETER ServerRole Write - string Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache - SharePoint 2016 only - the MinRole role to enroll this server as + SharePoint 2016 & 2019 only - the MinRole role to enroll this server as .PARAMETER InstallAccount Write - String @@ -91,7 +97,7 @@ example is provisioned to port 9999 using NTLM authentication. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -111,7 +117,7 @@ node localhost { SPFarm SharePointFarm { - Ensure = "Present" + IsSingleInstance = "Yes" DatabaseServer = "SQL.contoso.local\SQLINSTANCE" FarmConfigDatabaseName = "SP_Config" AdminContentDatabaseName = "SP_AdminContent" @@ -131,7 +137,7 @@ run on, as well as the authentication mode for the site are also specified. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -151,7 +157,7 @@ node localhost { SPFarm SharePointFarm { - Ensure = "Present" + IsSingleInstance = "Yes" DatabaseServer = "SQL.contoso.local\SQLINSTANCE" FarmConfigDatabaseName = "SP_Config" AdminContentDatabaseName = "SP_AdminContent" @@ -166,17 +172,17 @@ } -.EXAMPLE +.EXAMPLE This example shows how a basic SharePoint farm can be created. The database server and names are specified, and the accounts to run the setup as, the farm account and the passphrase are all passed in to the configuration to be applied. By default the central admin site in this example is provisioned to port 9999 using NTLM authentication. In this example we also see - the server role defined as "Application" which tells SharePoint 2016 the role to apply to + the server role defined as "Application" which tells SharePoint 2016/2019 the role to apply to this server as soon as the farm is created. This property is not supported for SharePoint 2013 and so this specific example would fail if used against that verison. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -196,7 +202,7 @@ node localhost { SPFarm SharePointFarm { - Ensure = "Present" + IsSingleInstance = "Yes" DatabaseServer = "SQL.contoso.local\SQLINSTANCE" FarmConfigDatabaseName = "SP_Config" AdminContentDatabaseName = "SP_AdminContent" diff --git a/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt index 4820892b7..a7b8c17f4 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarmAdministrators.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Common + **Requires CredSSP:** No This resource is used to manage the membership of the farm administrators group. There are a number of approaches to how this can be implemented. The @@ -15,9 +16,10 @@ group already that may not be specified here, allowing for some manual management outside of this configuration resource. -.PARAMETER Name +.PARAMETER IsSingleInstance Key - String - A generic name for this resource, its value is not important + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' .PARAMETER Members Write - String @@ -38,10 +40,10 @@ .EXAMPLE This example shows how to set a specific list of members for the farm admins group. - Any members not in this list will be removed. + Any members not in this list will be removed. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -53,7 +55,7 @@ node localhost { SPFarmAdministrators LocalFarmAdmins { - Name = "Farm Administrators" + IsSingleInstance = "Yes" Members = @("CONTOSO\user1", "CONTOSO\user2") PsDscRunAsCredential = $SetupAccount } @@ -68,7 +70,7 @@ in either of these properties are left alone. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -80,7 +82,7 @@ node localhost { SPFarmAdministrators LocalFarmAdmins { - Name = "Farm Administrators" + IsSingleInstance = "Yes" MembersToInclude = @("CONTOSO\user1") MembersToExclude = @("CONTOSO\user2") PsDscRunAsCredential = $SetupAccount diff --git a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt index c2e12c59d..318f1fa0b 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to work with SharePoint Property Bags at the farm level. The account that runs this resource must be a farm administrator. diff --git a/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt b/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt index 6bfc8c997..b0aca92a2 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to make sure that a specific farm solution is either present or absent in a farm. The solution can be deployed to one or more web @@ -23,7 +24,7 @@ Required - string The full path to the WSP file -.PARAMETER WebApplications +.PARAMETER WebAppUrls Write - string A list of the web applications to deploy this to @@ -51,10 +52,10 @@ .EXAMPLE - This example shows how to deploy a WSP to specific web applications. + This example shows how to deploy a WSP to specific web applications. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -70,7 +71,7 @@ LiteralPath = "C:\src\MySolution.wsp" Ensure = "Present" Version = "1.0.0" - WebApplications = @("http://collaboration", "http://mysites") + WebAppUrls = @("http://collaboration", "http://mysites") PsDscRunAsCredential = $SetupAccount } } diff --git a/Modules/SharePointDsc/en-US/about_SPFeature.help.txt b/Modules/SharePointDsc/en-US/about_SPFeature.help.txt index aee7301c4..425e7f266 100644 --- a/Modules/SharePointDsc/en-US/about_SPFeature.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFeature.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to make sure that a specific feature is either enabled or disabled at a given URL/scope. The Ensure property will dictate if the diff --git a/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt b/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt index 9373405b9..a3e5ecb59 100644 --- a/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPHealthAnalyzerRuleState.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to configure Health Analyzer rules for the local farm. The resource is able to enable/disable and configure the specified rule. diff --git a/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt b/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt index a3f29c642..d4319cab8 100644 --- a/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInfoPathFormsServiceConfig.help.txt @@ -4,13 +4,19 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for configuring the InfoPath Forms service within the local SharePoint farm. Using Ensure equals to Absent is not supported. This resource can only apply configuration, not ensure they don't exist. +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER Ensure - Key - string + Write - string Allowed values: Present, Absent Present ensures the settings are applied @@ -88,7 +94,7 @@ node localhost { SPInfoPathFormsServiceConfig InfoPathFormsServiceConfig { - Ensure = "Present" + IsSingleInstance = "Yes" AllowUserFormBrowserEnabling = $true AllowUserFormBrowserRendering = $true MaxDataConnectionTimeout = 20000 diff --git a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt index 64379e38d..6f82e5715 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstall.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstall.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Common + **Requires CredSSP:** No This resource is used to install the SharePoint binaries. The BinaryDir parameter should point to the path that setup.exe is located (not to setup.exe @@ -35,8 +36,13 @@ deployments. However due to constraints in how we set up and install the product, only English ISOs are supported for installing SharePoint. -.PARAMETER BinaryDir +.PARAMETER IsSingleInstance Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + +.PARAMETER BinaryDir + Required - String The directory that contains all of the SharePoint binaries .PARAMETER ProductKey @@ -63,7 +69,7 @@ C:\SPInstall\Setup.exe) - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -75,8 +81,9 @@ node localhost { SPInstall InstallBinaries { - BinaryDir = "C:\SPInstall" - ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" + IsSingleInstance = "Yes" + BinaryDir = "C:\SPInstall" + ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" } } } @@ -84,10 +91,10 @@ .EXAMPLE This module will install SharePoint to the specific locations set for the - InstallPath and DataPath directories. + InstallPath and DataPath directories. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -99,10 +106,11 @@ node localhost { SPInstall InstallBinaries { - BinaryDir = "D:\SharePoint\Binaries" - InstallPath = "D:\SharePoint\Install" - DataPath = "D:\SharePoint\Data" - ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" + IsSingleInstance = "Yes" + BinaryDir = "D:\SharePoint\Binaries" + InstallPath = "D:\SharePoint\Install" + DataPath = "D:\SharePoint\Data" + ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" } } } @@ -112,7 +120,7 @@ This module will install SharePoint Foundation 2013 to the local server - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] diff --git a/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt index 86c7283e9..56e6c53b1 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstallLanguagePack.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to install the SharePoint Language Pack binaries. The BinaryDir parameter should point to the path that setup.exe is located (not to @@ -12,8 +13,8 @@ The BinaryInstallDays and BinaryInstallTime parameters specify a window in which the update can be installed. - With SharePoint 2016, the Language Packs are offered as an EXE package. You have - to extract this package before installing, using the following command: + Starting with SharePoint 2016, the Language Packs are offered as an EXE package. + You have to extract this package before installing, using the following command: .\serverlanguagepack.exe /extract:[Extract Folder] .PARAMETER BinaryDir diff --git a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt index 384b1e13a..d05a000bc 100644 --- a/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Common + **Requires CredSSP:** No This resource is responsible for ensuring the installation of all SharePoint prerequisites. It makes use of the PrerequisiteInstaller.exe file that is part @@ -49,8 +50,15 @@ SharePoint 2016: https://technet.microsoft.com/en-us/library/cc262485(v=office.16).aspx#section5 -.PARAMETER InstallerPath + SharePoint 2019: + +.PARAMETER IsSingleInstance Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + +.PARAMETER InstallerPath + Required - String The full path to prerequisiteinstaller.exe .PARAMETER OnlineMode @@ -125,6 +133,14 @@ Write - String The path to the installer for this prerequisite (SP2016 only) +.PARAMETER DotNet472 + Write - String + The path to the installer for this prerequisite (SP2019 only) + +.PARAMETER MSVCRT141 + Write - String + The path to the installer for this prerequisite (SP2019 only) + .PARAMETER Ensure Write - string Allowed values: Present, Absent @@ -136,7 +152,7 @@ online mode, looking to download all prerequisites from the internet. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -148,6 +164,7 @@ node localhost { SPInstallPrereqs InstallPrerequisites { + IsSingleInstance = "Yes" InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" OnlineMode = $true } @@ -160,7 +177,7 @@ offline mode, running all prerequisite installations from the specified paths. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -172,6 +189,7 @@ node localhost { SPInstallPrereqs InstallPrerequisites { + IsSingleInstance = "Yes" InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" OnlineMode = $false SXSpath = "c:\SPInstall\Windows2012r2-SXS" @@ -192,7 +210,7 @@ .EXAMPLE - This module will install the prerequisites for SharePoint 2016. This resource will run in + This module will install the prerequisites for SharePoint 2016/2019. This resource will run in offline mode, running all prerequisite installations from the specified paths. @@ -208,6 +226,7 @@ node localhost { SPInstallPrereqs InstallPrerequisites { + IsSingleInstance = "Yes" InstallerPath = "C:\SPInstall\Prerequisiteinstaller.exe" OnlineMode = $false SXSpath = "C:\SPInstall\Windows2012r2-SXS" diff --git a/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt index fdd87143b..5440b52f4 100644 --- a/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to manipulate the IRM settings in SharePoint, integrating it with AD RMS @@ -11,8 +12,13 @@ The default value for the Ensure parameter is Present. When not specifying this parameter, IRM is configured. -.PARAMETER Ensure +.PARAMETER IsSingleInstance Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + +.PARAMETER Ensure + Write - String Allowed values: Present, Absent Enable or Disable IRM on this farm @@ -34,7 +40,7 @@ a specific RMS server - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -46,7 +52,7 @@ node localhost { SPIrmSettings RMSSettings { - Ensure = "Present" + IsSingleInstance = "Yes" RMSserver = "https://rms.contoso.com" PsDscRunAsCredential = $SetupAccount } diff --git a/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt deleted file mode 100644 index 2a98ad3e9..000000000 --- a/Modules/SharePointDsc/en-US/about_SPJoinFarm.help.txt +++ /dev/null @@ -1,30 +0,0 @@ -.NAME - SPJoinFarm - -# Description - - WARNING: This resource has been removed. Please use SPFarm instead. - See http://aka.ms/SPDsc-SPFarm for details. - -.PARAMETER FarmConfigDatabaseName - Key - string - The name of the config database to connect to - -.PARAMETER DatabaseServer - Key - string - The server that hosts the config database - -.PARAMETER Passphrase - Required - string - The passphrase that should be used to join the farm - -.PARAMETER ServerRole - Write - string - Allowed values: Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServer, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache - SharePoint 2016 only - the MinRole role to enroll this server as - -.PARAMETER InstallAccount - Write - String - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 - - diff --git a/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt b/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt index 8ecc0003f..d3edae9ef 100644 --- a/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to change the minimum severity of events captured in the trace logs (ULS logs) and the Windows event logs. Settings can be changed diff --git a/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt index 92cc49c62..01d77d580 100644 --- a/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPMachineTranslationServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to provision and manage an instance of the Machine Translation Service Application. It will identify an instance of the MT diff --git a/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt index 38738833a..b646af763 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will ensure a managed account is provisioned in to the SharePoint farm. The Account object specific the credential to store (including username diff --git a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt index 65cb8b84d..7a7cb9ddd 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No Creates a managed metadata service application. The application pool property specifies which application pool it should use, and will reset the application diff --git a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt index 551c38276..db888be2f 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedMetaDataServiceAppDefault.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No Using several managed metadata service instances in a farm requires some configuration, which service application proxy should be used as default diff --git a/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt b/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt index aba74df6b..290bc0a98 100644 --- a/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for creating managed paths associated with a specific web application. The WebAppUrl parameter is used to specify the web diff --git a/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt b/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt index 3f7776d9f..294d794cd 100644 --- a/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPMinRoleCompliance.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Utility + **Requires CredSSP:** No This resource will help manage compliance of MinRole based servers. Each time the resource runs it will investigate which service instances should be running @@ -11,8 +12,13 @@ compliant state it will tell SharePoint to create timer jobs to make the necesssary modifications to make the farm compliant again. +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER State - Key - string + Required - string Allowed values: Compliant, NonCompliant Should the state be set to compliant @@ -25,7 +31,7 @@ This example shows how to ensure the farm is always compliant with MinRole settings - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -35,8 +41,9 @@ Import-DscResource -ModuleName SharePointDsc node localhost { - SPMinRoleCompliance MinRoleCompliance + SPMinRoleCompliance MinRoleCompliance { + IsSingleInstance = "Yes" State = "Compliant" PSDscRunAsCredential = $SetupAccount } diff --git a/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt index 82a1c2487..0cf347584 100644 --- a/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPOfficeOnlineServerBinding.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will create a binding to an Office Online Server (formerly known as Office Web Apps). The DnsName property can be a single server name, or a diff --git a/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt index cd4886d7d..c61283630 100644 --- a/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPOutgoingEmailSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to set the outgoing email settings for either a single web application, or the whole farm. To configure the resource for a specific @@ -34,11 +35,11 @@ .PARAMETER UseTLS Write - boolean - Use TLS when connecting to the SMTP server (SharePoint 2016 only) + Use TLS when connecting to the SMTP server (SharePoint 2016 and 2019 only) .PARAMETER SMTPPort Write - uint32 - The port which is used to connect to the SMTP server (SharePoint 2016 only) + The port which is used to connect to the SMTP server (SharePoint 2016 and 2019 only) .PARAMETER InstallAccount Write - String diff --git a/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt index 344e716c6..534d81e89 100644 --- a/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPasswordChangeSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to control settings that relate to the automatic changing of passwords for managed accounts (where they opt-in to be managed by @@ -11,8 +12,13 @@ administration, or configured in this resource. The settings relate to email notifications of when passwords are reset, as well as behavior when a reset +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER MailAddress - key - string + Required - string The email address to send notifications of password changes to .PARAMETER DaysBeforeExpiry @@ -36,7 +42,7 @@ This example sets the password change settings for managed accounts in the local farm - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -48,7 +54,8 @@ node localhost { SPPasswordChangeSettings ManagedAccountPasswordResetSettings { - MailAddress = "sharepoint`@contoso.com" + IsSingleInstance = "Yes" + MailAddress = "sharepoint@contoso.com" DaysBeforeExpiry = "14" PasswordChangeWaitTimeSeconds = "60" NumberOfRetries = "3" diff --git a/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt index 40a9da043..dce2562ff 100644 --- a/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPerformancePointServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for creating Performance Point Service Application instances within the local SharePoint farm. The resource will provision and diff --git a/Modules/SharePointDsc/en-US/about_SPPowerPointAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPPowerPointAutomationServiceApp.help.txt new file mode 100644 index 000000000..a3531185a --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPPowerPointAutomationServiceApp.help.txt @@ -0,0 +1,112 @@ +.NAME + SPPowerPointAutomationServiceApp + +# Description + + **Type:** Distributed + **Requires CredSSP:** No + + This resource is responsible for creating PowerPoint Automation Service + Application instances within the local SharePoint farm. The resource will + provision and configure the PowerPoint Automation Service Application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the service application is provisioned. + +.PARAMETER Name + Key - String + The name of the service application + +.PARAMETER ProxyName + Write - String + The name of the service application proxy + +.PARAMETER ApplicationPool + Write - String + The name of the application pool to run the service app in + +.PARAMETER CacheExpirationPeriodInSeconds + Write - Uint32 + Specifies the maximum time, in seconds, that items remain in the back-end server cache. The default value is 600 seconds (10 minutes). + +.PARAMETER MaximumConversionsPerWorker + Write - Uint32 + Specifies the maximum number of presentations that a conversion worker process can convert before recycling. The default value is 5. + +.PARAMETER WorkerKeepAliveTimeoutInSeconds + Write - Uint32 + Specifies the maximum time, in seconds, that a conversion worker process can be unresponsive before being terminated. The default value is 120 seconds. + +.PARAMETER WorkerProcessCount + Write - Uint32 + 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. + +.PARAMETER WorkerTimeoutInSeconds + Write - Uint32 + Specifies the maximum time, in seconds, that a conversion worker process is given for any single conversion. The default is 300 seconds (5 minutes). + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Ensure the crawl rule is Present or Absent + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run thsi resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example makes sure the service application exists and has a specific configuration + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPowerPointAutomationServiceApp PowerPointAutomation + { + Name = "PowerPoint Automation Service Application" + ProxyName = "PowerPoint Automation Service Application Proxy" + CacheExpirationPeriodInSeconds = 600 + MaximumConversionsPerWorker = 5 + WorkerKeepAliveTimeoutInSeconds = 120 + WorkerProcessCount = 3 + WorkerTimeoutInSeconds = 300 + ApplicationPool = "SharePoint Web Services" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a word automation service app + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPPowerPointAutomationServiceApp WordAutomation + { + Name = "PowerPoint Automation Service Application" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt index b244788f4..079a04c75 100644 --- a/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Common + **Requires CredSSP:** No This resource is used to perform the update step of installing SharePoint updates, like Cumulative Updates and Service Packs. The SetupFile parameter diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt index 35d5372e4..5cb4d1094 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerADResourcePoolSync.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to control the settings of the Active Directory resource pool sync for Project Server, for a specific PWA instance. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt index fd3114aea..0683e92bf 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerAdditionalSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to manage the "additional settings" for a PWA instance (based on what is in the 'additional settings' page of the web interface). diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt index 0beb81a13..f20c5a217 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerGlobalPermissions.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource allows you to enforce global permissions in a PWA site for a specific project server group or an individual resource. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt index f6a67953d..ab2cae30f 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerGroup.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to configure a group within Project Server. This is only available for use when the site is configured to use Project Server permissions diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt index c22b21e95..9d6b9229e 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerLicense.help.txt @@ -4,12 +4,18 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to enable a Project Server license in to a SharePoint - 2016 farm. + 2016 or 2019 farm. +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER Ensure - Key - string + Write - string Allowed values: Present, Absent Should a Project Server license be enabled or disabled @@ -26,7 +32,7 @@ This example enables Project Server in the current environment -Configuration Example +Configuration Example { param( [Parameter(Mandatory = $true)] @@ -38,7 +44,7 @@ Configuration Example node localhost { SPProjectServerLicense ProjectLicense { - Ensure = "Present" + IsSingleInstance = "Yes" ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" PsDscRunAsCredential = $SetupAccount } @@ -50,7 +56,7 @@ Configuration Example This example disables Project Server in the current environment -Configuration Example +Configuration Example { param( [Parameter(Mandatory = $true)] @@ -62,6 +68,7 @@ Configuration Example node localhost { SPProjectServerLicense ProjectLicense { + IsSingleInstance = "Yes" Ensure = "Absent" PsDscRunAsCredential = $SetupAccount } diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt index e73d6e644..ec9426453 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerPermissionMode.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource allows you to set the permissions mode (either SharePoint or ProjectServer) for a specific project server site. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt index cbc06e397..0e39cf7b2 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerServiceApp.help.txt @@ -4,9 +4,10 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for provisioning and managing the Project Server - service application in SharePoint Server 2016. + service application in SharePoint Server 2016 or 2019. To create a Project Server site the following DSC resources can be used to create the site and enable the feature. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt index a53f30310..77c0bd2be 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerTimeSheetSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No Allows you to configure the default timesheet settings for a specific PWA instance. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt index 3ce3df5c2..a22ad256e 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerUserSyncSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for configuration of the user sync settings between projects and project sites. diff --git a/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt index 575397561..e4f8913c3 100644 --- a/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProjectServerWssSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to control settings that relate to the SharePoint sites that are linked to projects in Project Server. diff --git a/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt index dfa1ad01d..715c2ff59 100644 --- a/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPPublishServiceApplication.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to specify if a specific service application should be published (Ensure = "Present") or not published (Ensure = "Absent") on the @@ -11,7 +12,7 @@ shown in the Central Admin website. You can publish the following service applications in a SharePoint Server - 2013/2016 farm: + 2013/2016/2019 farm: * Business Data Connectivity * Machine Translation diff --git a/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt b/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt index ca4dd1e9f..8adb95d9f 100644 --- a/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPQuotaTemplate.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to configure quota templates in the farm. These settings will be used to make sure a certain quota template exists or not. When it diff --git a/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt b/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt index 2d3079f83..3dbff7ac5 100644 --- a/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPRemoteFarmTrust.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to trust a remote SharePoint farm. This is used when federating search results between two different SharePoint farms. The diff --git a/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt index 9164a96d9..3331d2679 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchAuthoritativePage.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for managing the search authoritative pages in the search service application. You can create new pages, change existing pages and diff --git a/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt index eb5f41447..17581f6c9 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchContentSource.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will deploy and configure a content source in a specified search service application. @@ -21,15 +22,15 @@ .PARAMETER ContentSourceType Required - String - Allowed values: SharePoint, Website, FileShare - The type of content source - currently only SharePoint, Website and File Shares are supported + Allowed values: SharePoint, Website, FileShare, Business + The type of content source - currently only SharePoint, Website, File Shares and Business are supported .PARAMETER Addresses - Required - String + Write - String A list of the addresses this content source includes .PARAMETER CrawlSetting - Required - String + Write - String Allowed values: CrawlEverything, CrawlFirstOnly, Custom Should the crawler index everything, just the first site or page, or a custom depth (applies to websites only) @@ -58,6 +59,10 @@ Write - Uint32 How many server hops should the crawler make (-1 = unlimtied, website sources only) +.PARAMETER LOBSystemSet + Write - String + Line of Business System and System Instance names + .PARAMETER Ensure Write - string Allowed values: Present, Absent diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt index 0ce04c2b1..4029ebce5 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlMapping.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for managing the search crawl mapping in the search service application. You can create new mappings, change existing mappings diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt index b21158382..f01096fb1 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlRule.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for managing the search crawl rules in the search service application. You can create new rules, change existing rules and remove diff --git a/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt index a1765d510..1b6c64173 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchCrawlerImpactRule.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for managing the search crawl impact rules in the search service application. You can create new rules, change existing rules and diff --git a/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt index 6c027f7fb..a987ee9a9 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchFileType.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for managing the search file types in the search service application. You can create new file types, change existing types and diff --git a/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt index 8be8cbeb6..11a4dc11a 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchIndexPartition.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for creating search indexes. It works by creating the index topology components and updating the topology from the server that diff --git a/Modules/SharePointDsc/en-US/about_SPSearchManagedProperty.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchManagedProperty.help.txt index a144dcf8b..bcade07fd 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchManagedProperty.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchManagedProperty.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will deploy and configure a managed property in a specified search service application. diff --git a/Modules/SharePointDsc/en-US/about_SPSearchMetadataCategory.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchMetadataCategory.help.txt new file mode 100644 index 000000000..6db4cd921 --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPSearchMetadataCategory.help.txt @@ -0,0 +1,72 @@ +.NAME + SPSearchMetadataCategory + +# Description + + **Type:** Distributed + **Requires CredSSP:** No + + This resource will deploy and configure a Metadata Category in a specified search + service application. + + The default value for the Ensure parameter is Present. When not specifying this + parameter, the Metadata Category is created. + +.PARAMETER Name + Key - String + The name of the Metadata Category + +.PARAMETER ServiceAppName + Key - String + The name of the search service app that this Metadata Category exists within + +.PARAMETER AutoCreateNewManagedProperties + Write - Boolean + 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 + +.PARAMETER DiscoverNewProperties + Write - Boolean + Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. + +.PARAMETER MapToContents + Write - Boolean + Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. + +.PARAMETER Ensure + Write - string + Allowed values: Present, Absent + Present if the result source should exist, absent if it should not + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example shows how to create a new Search Metadata Category, using the required parameters + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSearchMetadataCategory NewCategory + { + Name = "My New category" + ServiceAppName = "Search Service Application" + AutoCreateNewManagedProperties = $true + DiscoverNewProperties = $true + MapToContents = $true + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt index 2fa561889..0ce15567d 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchResultSource.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to configure search result sources in the SharePoint search service application. Result sources can be configured to be of the @@ -19,10 +20,22 @@ The default value for the Ensure parameter is Present. When not specifying this parameter, the result source is created. + To define a result source as global, use the value 'SSA' as the ScopeName + value. + .PARAMETER Name Key - String The name of the result source +.PARAMETER ScopeName + Key - String + Allowed values: SSA, SPSite, SPWeb + The scope at which the Result Source will be created. Options are SSA, SPSite or SPWeb + +.PARAMETER ScopeUrl + Key - String + The URI of the site where to create the result source. Leave empty to have it created globally + .PARAMETER SearchServiceAppName Required - String The name of the search service application to associate this result source with @@ -40,10 +53,6 @@ Write - String The URI to connect to the remote location -.PARAMETER ScopeUrl - Write - String - The URI of the site where to create the result source. Leave empty to have it created globally - .PARAMETER Ensure Write - string Allowed values: Present, Absent @@ -58,7 +67,7 @@ This example shows how to create a remote sharepoint search result source - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -66,11 +75,13 @@ $SetupAccount ) Import-DscResource -ModuleName SharePointDsc - + node localhost { SPSearchResultSource RemoteSharePointFarm { Name = "External SharePoint results" + ScopeName = "SPSite" + ScopeUrl = "https://SharePoint.contoso.com" SearchServiceAppName = "Search Service Application" Query = "{searchTerms}" ProviderType = "Remote SharePoint Provider" diff --git a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt index 90bc720ee..5f0463e09 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for provisioning the search service application. The current version lets you specify the database name and server, as well as diff --git a/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt index 47784d4f2..93e38a46d 100644 --- a/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSearchTopology.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for provisioning a search topology in to the current farm. It allows the configuration to dictate the search topology roles diff --git a/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt index bf5f94015..f865daa12 100644 --- a/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSecureStoreServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for provisioning and configuring the secure store service application. The parameters passed in (except those related to database diff --git a/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt b/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt index 0812616ea..c25220d64 100644 --- a/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSecurityTokenServiceConfig.help.txt @@ -4,13 +4,19 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for configuring the Security Token Service within the local SharePoint farm. Using Ensure equals to Absent is not supported. This resource can only apply configuration, not ensure they don't exist. +.PARAMETER IsSingleInstance + Key - String + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' + .PARAMETER Name - Key - string + Required - string The name of the security token service .PARAMETER NameIdentifier @@ -43,7 +49,7 @@ This example configures the Security Token Service - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -55,6 +61,7 @@ node localhost { SPSecurityTokenServiceConfig SecurityTokenService { + IsSingleInstance = "Yes" Name = "SPSecurityTokenService" NameIdentifier = "00000003-0000-0ff1-ce00-000000000000@9f11c5ea-2df9-4950-8dcf-da8cd7aa4eff" UseSessionCookies = $false diff --git a/Modules/SharePointDsc/en-US/about_SPSelfServiceSiteCreation.help.txt b/Modules/SharePointDsc/en-US/about_SPSelfServiceSiteCreation.help.txt index 4044d0d72..d59b69c11 100644 --- a/Modules/SharePointDsc/en-US/about_SPSelfServiceSiteCreation.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSelfServiceSiteCreation.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to configure self-service site creation on a web application. @@ -26,7 +27,7 @@ SharePoint Online. This requires that [hybrid self-service site creation](https://docs.microsoft.com/en-us/sharepoint/hybrid/hybrid-self-service-site-creation) is configured using the Hybrid Picker. -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The url of the web application @@ -72,3 +73,83 @@ POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 +.EXAMPLE + This example shows how to configure self-service site creation for a web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSelfServiceSiteCreation SSC + { + WebAppUrl = "http://example.contoso.local" + Enabled = $true + OnlineEnabled = $false + QuotaTemplate = "SSCQoutaTemplate" + ShowStartASiteMenuItem = $true + CreateIndividualSite = $true + PolicyOption = "CanHavePolicy" + RequireSecondaryContact = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to configure self-service site creation with a custom form for a web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSelfServiceSiteCreation SSC + { + WebAppUrl = "http://example.contoso.local" + Enabled = $true + ShowStartASiteMenuItem = $true + CustomFormUrl = "http://ssc.contoso.com.local/ssc" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example shows how to disable self-service site creation for a web application + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPSelfServiceSiteCreation SSC + { + WebAppUrl = "http://example.contoso.local" + Enabled = $false + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt index 7a61d86f7..313972269 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppPool.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used for provisioning an application pool that can be used for service applications. The account used for the service account must already be diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt index 998180edb..8f2391453 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppProxyGroup.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to manage SharePoint Service Application Proxy Groups. The "Ensure" parameter controls whether or not the Proxy Group should exist. A diff --git a/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt index df557c5cc..991887cff 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceAppSecurity.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to manage the sharing security settings of a specific service application. There are a number of approaches to how this can be @@ -22,6 +23,47 @@ In order to specify Local Farm you can use the token "\{LocalFarm\}" as the username. The token is case sensitive. + ## Permission overview + + Available permissions for Administrators are Full Control except for these + service applications: + + Secure Store Service Application: + + - Full Control + - Create Target Application + - Delete Target Application + - Manage Target Application + - All Target Applications + + User Profile Service Application: + + - Full Control + - Manage Profiles + - Manage Audiences + - Manage Permissions + - Retrieve People Data for Search Crawlers + - Manage Social Data + + Search Service Application: + + - Full Control + - Read (Diagnostics Pages Only) + + Permissions for Sharing Permissions are Full Control except for these + service applications: + + Managed Metadata Service Application: + + - Read Access to Term Store + - Read and Restricted Write Access to Term Store + - Full Access to Term Store + + NOTE: + Multiple permissions can be specified for each principal. Full Control + will include all other permissions. It is not required to specify all + available permissions if Full Control is specified. + .PARAMETER ServiceAppName Key - String The name of the service application you wish to apply security settings to @@ -49,12 +91,13 @@ .EXAMPLE - This example shows how full control permission can be given to the farm - account and service app pool account to the user profile service app's + This example shows how full control permission can be given to the farm + account and service app pool account to the user profile service app's sharing permission. + It also shows granting access to specific areas to a user. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -66,12 +109,16 @@ node localhost { $membersToInclude = @() $membersToInclude += MSFT_SPServiceAppSecurityEntry { - Username = "CONTOSO\SharePointFarmAccount" - AccessLevel = "Full Control" + Username = "CONTOSO\SharePointFarmAccount" + AccessLevels = @("Full Control") + } + $membersToInclude += MSFT_SPServiceAppSecurityEntry { + Username = "CONTOSO\SharePointServiceApps" + AccessLevels = @("Full Control") } $membersToInclude += MSFT_SPServiceAppSecurityEntry { - Username = "CONTOSO\SharePointServiceApps" - AccessLevel = "Full Control" + Username = "CONTOSO\User1" + AccessLevels = @("Manage Profiles", "Manage Social Data") } SPServiceAppSecurity UserProfileServiceSecurity { @@ -79,19 +126,19 @@ SecurityType = "SharingPermissions" MembersToInclude = $membersToInclude MembersToExclude = @("CONTOSO\BadAccount1", "CONTOSO\BadAccount2") - PsDscRunAsCredential = $SetupAccount + PsDscRunAsCredential = $SetupAccount } } } .EXAMPLE - This example shows how to use the local farm token to grant - full control permission to the local farm to the + This example shows how to use the local farm token to grant + full control permission to the local farm to the user profile service app's sharing permission. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -103,15 +150,15 @@ node localhost { $members = @() $members += MSFT_SPServiceAppSecurityEntry { - Username = "{LocalFarm}" - AccessLevel = "Full Control" + Username = "{LocalFarm}" + AccessLevels = @("Full Control") } SPServiceAppSecurity UserProfileServiceSecurity { ServiceAppName = "User Profile Service Application" SecurityType = "SharingPermissions" Members = $members - PsDscRunAsCredential = $SetupAccount + PsDscRunAsCredential = $SetupAccount } } } diff --git a/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt index 05a0d9e23..079c2d27c 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceIdentity.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to specify a managed account to be used to run a service instance. You can also specify LocalService, LocalSystem or NetworkService as ManagedAccount. diff --git a/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt index 6296109a1..68330cf6d 100644 --- a/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPServiceInstance.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Specific + **Requires CredSSP:** No This resource is used to specify if a specific service should be running (Ensure = "Present") or not running (Ensure = "Absent") on the current server. diff --git a/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt b/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt index 873001830..bd2261a38 100644 --- a/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSessionStateService.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will provision a state service app to the local farm. Specify the name of the database server and database name to provision the app with, diff --git a/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt index d35cb799c..bda7639b0 100644 --- a/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPShellAdmins.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to manage the users with Shell Admin permissions. There are a number of approaches to how this can be implemented. The "Members" @@ -42,9 +43,10 @@ cannot add it to the Shell Admins (common for AllContentDatabases parameter) and the resource will throw an error. Workaround: Change database owner in SQL -.PARAMETER Name +.PARAMETER IsSingleInstance Key - String - Name for the config, used for administration purposes + Allowed values: Yes + Specifies the resource is a single instance, the value must be 'Yes' .PARAMETER Members Write - String @@ -80,7 +82,7 @@ all content databases in the local farm. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -92,9 +94,9 @@ node localhost { SPShellAdmins ShellAdmins { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - AllDatabases = $true + IsSingleInstance = "Yes" + Members = "CONTOSO\user1", "CONTOSO\user2" + AllDatabases = $true } } } @@ -105,7 +107,7 @@ all content databases in the local farm. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -117,9 +119,9 @@ node localhost { SPShellAdmins ShellAdmins { - Name = "Shell Admins" - Members = "CONTOSO\user1", "CONTOSO\user2" - Databases = @( + IsSingleInstance = "Yes" + Members = "CONTOSO\user1", "CONTOSO\user2" + Databases = @( @(MSFT_SPDatabasePermissions { Name = "SharePoint_Content_1" Members = "CONTOSO\user2", "CONTOSO\user3" @@ -152,7 +154,7 @@ node localhost { SPShellAdmins ShellAdmins { - Name = "Shell Admins" + IsSingleInstance = "Yes" Members = "CONTOSO\user1", "CONTOSO\user2" AllDatabases = $true ExcludeDatabases = "WSS_Content_Portal" diff --git a/Modules/SharePointDsc/en-US/about_SPSite.help.txt b/Modules/SharePointDsc/en-US/about_SPSite.help.txt index 25972ab8c..8fd06e444 100644 --- a/Modules/SharePointDsc/en-US/about_SPSite.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSite.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will provision a site collection to the current farm, based on the settings that are passed through. These settings map to the New-SPSite @@ -89,7 +90,7 @@ .PARAMETER AdministrationSiteType Write - string Allowed values: TenantAdministration, None - The administration site type + Specifies the type of the site collection: Regular site or tenant administration site .PARAMETER InstallAccount Write - String diff --git a/Modules/SharePointDsc/en-US/about_SPSiteUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPSiteUrl.help.txt index 6975b2f84..476a3c355 100644 --- a/Modules/SharePointDsc/en-US/about_SPSiteUrl.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSiteUrl.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will configure the site url for a host named site collection. There are four available zones to configure: Intranet, Internet, Extranet diff --git a/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt index 3f86c150a..b9c70d895 100644 --- a/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPStateServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource provisions an instance of the state service in to the local farm. The database specific parameters are only used during initial provisioning of diff --git a/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt index 48fa80533..9a9dcd244 100644 --- a/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPSubscriptionSettingsServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to provision and manage an instance of the App Management Services Service Application. It will identify an instance of the subscription diff --git a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt index 95c14b49f..126b5fc78 100644 --- a/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to configure a timer job and make sure it is in a specific state. The resource can be used to enable or disabled the job and diff --git a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt index fc2ad394c..9ffd968f2 100644 --- a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuer.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to create or remove SPTrustedIdentityTokenIssuer in a SharePoint farm. diff --git a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt index 837832af7..2b2005933 100644 --- a/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPTrustedIdentityTokenIssuerProviderRealms.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to add or remove provider realms to SPTrustedIdentityTokenIssuer in a SharePoint farm. The "ProviderRealms" diff --git a/Modules/SharePointDsc/en-US/about_SPTrustedRootAuthority.help.txt b/Modules/SharePointDsc/en-US/about_SPTrustedRootAuthority.help.txt new file mode 100644 index 000000000..bb21df75f --- /dev/null +++ b/Modules/SharePointDsc/en-US/about_SPTrustedRootAuthority.help.txt @@ -0,0 +1,81 @@ +.NAME + SPTrustedRootAuthority + +# Description + + **Type:** Distributed + **Requires CredSSP:** No + + This resource is used to create or remove SPTrustedRootAuthority in a + SharePoint farm. It imports the certificate into SharePoint in order for + high trust apps or consuming service applications from other farms will + work. + +.PARAMETER Name + Key - String + Specifies the name of the trusted root authority to create. + +.PARAMETER CertificateThumbprint + Required - String + Specifies the X.509 certificate of the trusted root authority, as a certificate thumbprint. + +.PARAMETER Ensure + Write - String + Allowed values: Present, Absent + Present ensures the trusted root authority exists, absent ensures it is removed + +.PARAMETER InstallAccount + Write - String + POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 + + +.EXAMPLE + This example deploys a SP Trusted Root Authority to the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTrustedRootAuthority SampleRootAuthority + { + Name = "Contoso" + CertificateThumbprint = "770515261D1AB169057E246E0EE6431D557C3AFB" + Ensure = "Present" + PsDscRunAsCredential = $SetupAccount + } + } + } + + +.EXAMPLE + This example removes a SP Trusted Root Authority from the local farm. + + + Configuration Example + { + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + SPTrustedRootAuthority SampleRootAuthority + { + Name = "Contoso" + CertificateThumbprint = "770515261D1AB169057E246E0EE6431D557C3AFB" + Ensure = "Absent" + PsDscRunAsCredential = $SetupAccount + } + } + } + + diff --git a/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt index 3a935104f..8654c0986 100644 --- a/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUsageApplication.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource provisions an instance of the usage and health monitoring service application. The database settings are only used for initial provisioning, but diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt index b15ea0204..77226fd26 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileProperty.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will create a property in a user profile service application. It creates, update or delete a property using the parameters that are passed in to @@ -16,8 +17,6 @@ Length is only relevant if Field type is "String". - This Resource doesn't currently support removing existing user profile - The default value for the Ensure parameter is Present. When not specifying this parameter, the user profile property is created. @@ -57,17 +56,9 @@ Allowed values: Public, Contacts, Organization, Manager, Private The privacy setting for the property -.PARAMETER MappingConnectionName - Write - string - The name of the UPS connect to map this property to - -.PARAMETER MappingPropertyName +.PARAMETER PropertyMappings Write - string - The name of the property from the UPS connection to map to - -.PARAMETER MappingDirection - Write - string - The direction of the mapping, either Import or Export + The details about the property mapping .PARAMETER Length Write - uint32 @@ -118,7 +109,7 @@ The name of the term set to allow values to be selected from .PARAMETER InstallAccount - Write - String + Write - string POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 @@ -127,44 +118,49 @@ app - Configuration Example - { - param( - [Parameter(Mandatory = $true)] - [PSCredential] - $SetupAccount - ) - Import-DscResource -ModuleName SharePointDsc - - node localhost { - SPUserProfileProperty WorkEmailProperty - { - Name = "WorkEmail2" - Ensure = "Present" - UserProfileService = "User Profile Service Application" - DisplayName = "Work Email" - Type = "Email" - Description = "" #implementation isn't using it yet - PolicySetting = "Mandatory" - PrivacySetting = "Public" - MappingConnectionName = "contoso.com" - MappingPropertyName = "mail" - MappingDirection = "Import" - Length = 10 - DisplayOrder =25 - IsEventLog =$false - IsVisibleOnEditor=$true - IsVisibleOnViewer = $true - IsUserEditable = $true - IsAlias = $false - IsSearchable = $false - TermStore = "" - TermGroup = "" - TermSet = "" - UserOverridePrivacy = $false - PsDscRunAsCredential = $SetupAccount - } +Configuration Example +{ + param( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + Import-DscResource -ModuleName SharePointDsc + + node localhost { + + SPUserProfileProperty WorkEmailProperty + { + Name = "WorkEmail2" + Ensure = "Present" + UserProfileService = "User Profile Service Application" + DisplayName = "Work Email" + Type = "Email" + Description = "" #implementation isn't using it yet + PolicySetting = "Mandatory" + PrivacySetting = "Public" + PropertyMappings = @( + MSFT_SPUserProfilePropertyMapping { + ConnectionName = "contoso.com" + PropertyName = "mail" + Direction = "Import" + } + ) + Length = 10 + DisplayOrder = 25 + IsEventLog = $false + IsVisibleOnEditor = $true + IsVisibleOnViewer = $true + IsUserEditable = $true + IsAlias = $false + IsSearchable = $false + TermStore = "" + TermGroup = "" + TermSet = "" + UserOverridePrivacy = $false + PsDscRunAsCredential = $SetupAccount } } +} diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt index f298036a2..11a9f7ea0 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSection.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will create a section in a user profile service application. It creates, update or delete a section using the parameters that are passed in to diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt index 2ab8ccba5..eaaa0d399 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** Yes This resource will provision an instance of the user profile service to the farm. It creates the required databases using the parameters that are passed diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt index 89470cea2..2b250c58e 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileServiceAppPermissions.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will apply permissions to a user profile service application. These can control access to create my sites, use social features, and use diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt index b37f0f99a..9303edc25 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncConnection.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will ensure a specifc user profile sync connection is in place and that it is configured accordingly to its definition diff --git a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt index 8975104ec..42ae55316 100644 --- a/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Specific + **Requires CredSSP:** Yes This resource is responsible for ensuring that the user profile sync service has been provisioned (Ensure = "Present") or is not running (Ensure = diff --git a/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt index e5819b715..5a7cf1b9c 100644 --- a/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPVisioServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for creating Visio Graphics Service Application instances within the local SharePoint farm. The resource will provision and diff --git a/Modules/SharePointDsc/en-US/about_SPWeb.help.txt b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt index fe4b41121..56dfc25df 100644 --- a/Modules/SharePointDsc/en-US/about_SPWeb.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWeb.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will provision a SPWeb based on the settings that are passed through. These settings map to the New-SPWeb cmdlet and accept the same values diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt index 95c0c65f8..2ee0cff66 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for configuring the authentication on a web application within the local SharePoint farm. The resource is able to diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt index 6c00a2e51..9c1e71b49 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppBlockedFileTypes.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for controlling the blocked file type setting on a specific web application. It has two modes of operation, the first is to use @@ -17,7 +18,7 @@ properties will only make changes to the file types in their list and will leave the full list as it is otherwise, whereas the blocked property resets -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The URL of the web application to set blocked file types for @@ -39,12 +40,12 @@ .EXAMPLE - This example shows how to ensure that specific file types are always blocked while + This example shows how to ensure that specific file types are always blocked while others will always be allowed. Any file types not mentioned in this config will be able to be managed manually. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -56,7 +57,7 @@ node localhost { SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes { - Url = "http://exmaple.contoso.local" + WebAppUrl = "http://exmaple.contoso.local" EnsureBlocked = @("exe", "dll", "msi") EnsureAllowed = @("pdf", "docx", "xlsx") PsDscRunAsCredential = $SetupAccount @@ -70,7 +71,7 @@ specifically matches this list. - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -82,7 +83,7 @@ node localhost { SPWebAppBlockedFileTypes PrimaryWebAppBlockedFileTypes { - Url = "http://exmaple.contoso.local" + WebAppUrl = "http://exmaple.contoso.local" Blocked = @("exe", "dll", "msi") PsDscRunAsCredential = $SetupAccount } diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppClientCallableSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppClientCallableSettings.help.txt index 14b999c8a..c218791b1 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppClientCallableSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppClientCallableSettings.help.txt @@ -4,12 +4,13 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource sets the client callable settings for the web application. It can set the proxy libraries and specific properties for the client - callable settings. - The resource can for example be used to increase the timeout for client - code, and to enable the tenant administration functionality. + callable settings. The resource can for example be used to increase the + timeout for client code, and to enable the tenant administration + functionality. Tenant administration functionality enables client code to work with the namespace Microsoft.Online.SharePoint.Client.Tenant from the @@ -37,7 +38,7 @@ Microsoft.Online.SharePoint.Dedicated.TenantAdmin.ServerStub , Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c - **SharePoint 2016**: + **SharePoint 2016/2019**: Microsoft.Online.SharePoint.Dedicated.TenantAdmin.ServerStub , Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c @@ -47,7 +48,7 @@ An IIS reset needs to be performed on all servers in the farm after modifying the registered proxy libraries. -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The URL of the web application to set blocked file types for @@ -120,7 +121,7 @@ node localhost { SPWebAppClientCallableSettings DefaultClientCallableSettings { - Url = "http://example.contoso.local" + WebAppUrl = "http://example.contoso.local" MaxResourcesPerRequest = 16 MaxObjectPaths = 256 ExecutionTimeout = 90 @@ -158,7 +159,7 @@ SPWebAppClientCallableSettings TenantAdministration { - Url = "http://example.contoso.local" + WebAppUrl = "http://example.contoso.local" ProxyLibraries = $proxyLibraries PsDscRunAsCredential = $SetupAccount } diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt index e19a2bcb8..8825ced80 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppGeneralSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for setting web application settings that are found under the "general settings" screen in central admin. The web @@ -11,7 +12,7 @@ settings can be applied. Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The URL of the web app to set the general settings for @@ -102,11 +103,11 @@ .EXAMPLE - This example shows how to apply some of the available general settings to the + This example shows how to apply some of the available general settings to the specified web app - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -118,7 +119,7 @@ node localhost { SPWebAppGeneralSettings PrimaryWebAppGeneralSettings { - Url = "http://exmaple.contoso.local" + WebAppUrl = "http://exmaple.contoso.local" TimeZone = 76 Alerts = $true RSS = $false diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt index 556fb2333..b8f01206b 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPeoplePickerSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to configure the People Picker settings for a web application. diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt index ec399bd14..eeecb1ecb 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPermissions.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for managing the user permissions for a web application. You can either specify to set all permissions or specify diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt index 0a6ce43e1..93ac24f56 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPolicy.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to set the User Policies for web applications. The usernames can be either specified in Classic or Claims format, both will be diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppPropertyBag.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppPropertyBag.help.txt index 0a91519b8..9c1975845 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppPropertyBag.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppPropertyBag.help.txt @@ -4,13 +4,14 @@ # Description **Type:** Distributed + **Requires CredSSP:** No - This resource is used to work with SharePoint Property Bags - at the web application level. - The account that runs this resource must be a farm administrator. + This resource is used to work with SharePoint Property Bags at the web + application level. The account that runs this resource must be a farm + administrator. - The default value for the Ensure parameter is Present. When not specifying this - parameter, the property bag is configured. + The default value for the Ensure parameter is Present. When not specifying + this parameter, the property bag is configured. .PARAMETER WebAppUrl Key - string diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt index 726b24e8f..62800c8bb 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppProxyGroup.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to associate a web application to a service application proxy group. Use the proxy group name "Default" to associate the web diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt index a8cbe3e18..2bebd9a97 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppSiteUseAndDeletion.help.txt @@ -4,13 +4,14 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for controlling the Site Use and Deletion settings on a specific web application. You can enable or disable the Site Use and Deletion feature, specify the amount of days after which the alerts are being send, if sites have to be deleted automatically and if so after how many -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The URL of the web application @@ -51,7 +52,7 @@ node localhost { SPWebAppSiteUseAndDeletion ConfigureSiteUseAndDeletion { - Url = "http://example.contoso.local" + WebAppUrl = "http://example.contoso.local" SendUnusedSiteCollectionNotifications = $true UnusedSiteNotificationPeriod = 90 AutomaticallyDeleteUnusedSiteCollections = $true diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt index 5f7e74cb9..1f1da82f0 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppSuiteBar.help.txt @@ -4,14 +4,15 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to set the Suite Bar branding for web applications. It supports both the SharePoint 2013 and SharePoint - 2016 ways of branding the suite bar. + 2016/2019 ways of branding the suite bar. Requirements: - For SharePoint 2013, only the SuiteBarBrandingElementHtml - should be specified, whereas for SharePoint 2016, all properties + For SharePoint 2013, only the SuiteBarBrandingElementHtml should + be specified, whereas for SharePoint 2016/2019, all properties are supported. Note that SuiteBarBrandingElementHtml has no effect unless using a SharePoint 2013 master page. @@ -46,7 +47,7 @@ .EXAMPLE This example sets the branding for the suite bar of a given - Web Application in SharePoint 2016. + Web Application in SharePoint 2016/2019. Configuration Example diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt index 6b21ce165..8e62dc284 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppThrottlingSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for setting web application settings that are found under the "resource throttling" screen in central admin. The web @@ -13,7 +14,7 @@ is the setting used to control the window where threshold do not apply throughout the day. You can specify the start time of this window as well as -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The URL of the web application @@ -70,7 +71,7 @@ This example shows how to apply throttling settings to a specific web app - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -82,7 +83,7 @@ node localhost { SPWebAppThrottlingSettings PrimaryWebAppThrottlingSettings { - Url = "http://exmaple.contoso.local" + WebAppUrl = "http://exmaple.contoso.local" ListViewThreshold = 5000 AllowObjectModelOverride = $false HappyHourEnabled = $true diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt index fe71b8148..656211252 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppWorkflowSettings.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for setting web application settings that are found under the "workflow settings" screen in central admin. The web @@ -11,7 +12,7 @@ settings can be applied. Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint). -.PARAMETER Url +.PARAMETER WebAppUrl Key - string The URL of the web application @@ -36,7 +37,7 @@ This example shows how to apply workflow settings to the specific web application - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -48,7 +49,7 @@ node localhost { SPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings { - Url = "Shttp://exmaple.contoso.local" + WebAppUrl = "Shttp://exmaple.contoso.local" ExternalWorkflowParticipantsEnabled = $false EmailToNoPermissionWorkflowParticipantsEnable = $false PsDscRunAsCredential = $SetupAccount diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt index 4962bccfd..c1cd03a9f 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplication.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for creating a web application within the local SharePoint farm. The resource will provision the web application with all of @@ -33,7 +34,7 @@ Required - string The name of the managed account to run the app pool with -.PARAMETER Url +.PARAMETER WebAppUrl Required - string The URL of the web application @@ -97,7 +98,7 @@ AllowAnonymous = $false DatabaseName = "SP_Content_01" DatabaseServer = "SQL.contoso.local\SQLINSTANCE" - Url = "http://example.contoso.local" + WebAppUrl = "http://example.contoso.local" Port = 80 Ensure = "Present" PsDscRunAsCredential = $SetupAccount diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt index 351b54ed1..e27025010 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplicationAppDomain.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource will configure the App Domain at a specific zone for the given Web Application. The configuration is done per zone on the specified web @@ -11,7 +12,7 @@ of a web application. The app prefix should still be set using the SPAppDomain resource before this is applied to customise a specific zone. -.PARAMETER WebApplication +.PARAMETER WebAppUrl Key - string The URL of the web application to set the app domain for @@ -41,7 +42,7 @@ This example shows how to set the app domain for a specified web application - Configuration Example + Configuration Example { param( [Parameter(Mandatory = $true)] @@ -54,7 +55,7 @@ SPWebApplicationAppDomain Domain { AppDomain = "contosointranetapps.com" - WebApplication ="http://portal.contoso.com"; + WebAppUrl ="http://portal.contoso.com"; Zone = "Default"; Port = 80; SSL = $false; diff --git a/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt index 3911fc15d..609149451 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebApplicationExtension.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is responsible for extending an existing web application into a new zone. The resource will provision the web application extension with all of diff --git a/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt index e902221ee..d8aab140f 100644 --- a/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWordAutomationServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No The resource is able to provision, unprovision and configure the Word Automation Service Application. All settings that you can configure on the diff --git a/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt index ec7b9d855..b8050ab56 100644 --- a/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWorkManagementServiceApp.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to provision and manage an instance of the Work Management Services Service Application. It will identify an instance of the @@ -22,8 +23,8 @@ parameter, the service application is provisioned. NOTE: - You cannot use this resource with SharePoint 2016, since the Work - Management functionality has been removed in SharePoint 2016. + You cannot use this resource with SharePoint 2016/2019, since the Work + Management functionality has been removed in SharePoint 2016/2019. More information: https://technet.microsoft.com/en-us/library/mt346112(v=office.16).aspx diff --git a/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt b/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt index 1b64effe7..62304ade7 100644 --- a/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWorkflowService.help.txt @@ -4,6 +4,7 @@ # Description **Type:** Distributed + **Requires CredSSP:** No This resource is used to register the SharePoint Server against a Workflow Manager Instance.