Merge pull request #821 from PowerShell/release-2.3

Release 2.3
dsccommunity · Jun 13, 2018 · 586ca8a · 586ca8a
2 parents 5eee020 + 44dd807
commit 586ca8a
Show file tree

Hide file tree

Showing 234 changed files with 2,846 additions and 166 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,34 @@
 # Change log for SharePointDsc
 
+## 2.3
+
+* Changes to SharePointDsc
+  * Added a Branches section to the README.md with Codecov and build badges for
+    both master and dev branch.
+* All Resources
+  * Added information about the Resource Type in each ReadMe.md files.
+* SPFarm
+  * Fixed issue where the resource throws an exception if the farm already
+    exists and the server has been joined using the FQDN (issue 795)
+* SPTimerJobState
+  * Fixed issue where the Set method for timerjobs deployed to multiple web
+    applications failed.
+* SPTrustedIdentityTokenIssuerProviderRealms
+  * Added the resource.
+* SPUserProfileServiceApp
+  * Now supported specifying the host Managed path, and properly sets the host.
+  * Changed error for running with Farm Account into being a warning
+* SPUserProfileSyncConnection
+  * Added support for filtering disabled users
+  * Fixed issue where UseSSL was set to true resulted in an error
+  * Fixed issue where the connection was recreated when the name contained a
+    dot (SP2016)
+
 ## 2.2
 
 * SPAlternateURL
   * If resource specifies Central Admin webapp and Default Zone, the existing
-    AAM will be updated instead of adding a new one
+    AAM will be updated instead of adding a new one.
 * SPContentDatabase
   * Fixed issue where mounting a content database which had to be upgraded
     resulted in a reboot.

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPAccessServiceApp/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPAccessServiceApp/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is responsible for creating Access Services Application instances
 within the local SharePoint farm. The resource will provision and configure the
 Access Services Service Application.

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPAlternateUrl/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPAlternateUrl/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 application. Alternatively a URL can be removed from a zone to ensure that it

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPAntivirusSettings/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPAntivirusSettings/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 scanning tool that is able to integrate with SharePoint. Note that this will

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPAppCatalog/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPAppCatalog/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 have been created using the correct template (APPCATALOG#0).

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPAppDomain/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPAppDomain/readme.md
@@ -1,4 +1,6 @@
 # Description
 
+**Type:** Distributed
+
 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/DSCResources/MSFT_SPAppManagementServiceApp/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPAppManagementServiceApp/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 management service application through the application display name. Currently

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPAppStoreSettings/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPAppStoreSettings/readme.md
@@ -1,4 +1,6 @@
 # Description
 
+**Type:** Distributed
+
 This resource will configure the ability to purchase apps for both SharePoint
 and Office apps.
diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPBCSServiceApp/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPBCSServiceApp/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is used to provision and manage an instance of the Business
 Connectivity Services Service Application. It will identify an instance
 of the BCS app through the application display name. Currently the resource

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPBlobCacheSettings/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPBlobCacheSettings/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Specific
+
 This resource is used to configure the Blob Cache settings for a web
 application.
 

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPCacheAccounts/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPCacheAccounts/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 [Configure object cache user accounts in SharePoint Server 2013](https://technet.microsoft.com/en-us/library/ff758656.aspx)).
diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPConfigWizard/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPConfigWizard/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Utility
+
 This resource is used to perform the upgrade step of installing SharePoint
 updates, like Cumulative Updates, Service Packs and Language Packs. The
 DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPContentDatabase/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPContentDatabase/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is used to add and remove Content Databases to web applications
 and configure these databases.
 

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPDatabaseAAG/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPDatabaseAAG/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource will allow specifying which SQL Server AlwaysOn Availability
 group a resource should be in. This resource does not configure the
 Availability Groups on SQL Server, they must already exist. It simply adds

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPDesignerSettings/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPDesignerSettings/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 allowed to make changes using SharePoint Designer. Note that this will not

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPDiagnosticLoggingSettings/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPDiagnosticLoggingSettings/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPDiagnosticsProvider/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPDiagnosticsProvider/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is responsible for configuring the Diagnostics Provider 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.
diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPDistributedCacheClientSettings/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPDistributedCacheClientSettings/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is responsible for configuring the distributed cache client
 settings. It only accepts Ensure='Present' as a key. The resource can
 configure the following cache components: DistributedLogonTokenCache,

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPDistributedCacheService/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPDistributedCacheService/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Specific
+
 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
 the behavior of SPCreateFarm and SPJoinFarm is to not enroll every server as a

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPExcelServiceApp/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPExcelServiceApp/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is responsible for creating Excel Services Application instances
 within the local SharePoint farm. The resource will provision and configure the
 Excel Services Service Application.

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPFarm/MSFT_SPFarm.psm1 b/Modules/SharePointDsc/DSCResources/MSFT_SPFarm/MSFT_SPFarm.psm1
@@ -83,7 +83,6 @@ function Get-TargetResource
         }
     }
 
-
     if (($PSBoundParameters.ContainsKey("ServerRole") -eq $true) `
         -and $installedVersion.FileMajorPart -ne 16)
     {
@@ -186,11 +185,22 @@ function Get-TargetResource
             $installedVersion = Get-SPDSCInstalledProductVersion
             if($installedVersion.FileMajorPart -eq 16)
             {
-                $server = Get-SPServer -Identity $env:COMPUTERNAME
+                $server = Get-SPServer -Identity $env:COMPUTERNAME -ErrorAction SilentlyContinue
                 if($null -ne $server -and $null -ne $server.Role)
                 {
                     $returnValue.Add("ServerRole", $server.Role)
                 }
+                else
+                {
+                    $domain = (Get-CimInstance -ClassName Win32_ComputerSystem).Domain
+                    $currentServer = "$($env:COMPUTERNAME).$domain"
+
+                    $server = Get-SPServer -Identity $currentServer -ErrorAction SilentlyContinue
+                    if($null -ne $server -and $null -ne $server.Role)
+                    {
+                        $returnValue.Add("ServerRole", $server.Role)
+                    }
+                }
             }
             return $returnValue
         }

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPFarm/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPFarm/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Specific
+
 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
 on the SQL server as a first step, and if it does not exist then the farm

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPFarmAdministrators/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPFarmAdministrators/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Common
+
 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
 "members" property will set a specific list of members for the group, making

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPFarmPropertyBag/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPFarmPropertyBag/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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/DSCResources/MSFT_SPFarmSolution/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPFarmSolution/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 application passing an array of URL's to the WebApplications property. If the

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPFeature/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPFeature/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 feature should be on or off. The name property is the name of the feature

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPHealthAnalyzerRuleState/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPHealthAnalyzerRuleState/Readme.md
@@ -1,4 +1,6 @@
 # Description
 
+**Type:** Distributed
+
 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/DSCResources/MSFT_SPInfoPathFormsServiceConfig/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPInfoPathFormsServiceConfig/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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.
diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPInstall/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPInstall/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Common
+
 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
 itself). The ProductKey parameter is used to inject in to the configuration

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPInstallLanguagePack/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPInstallLanguagePack/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 setup.exe itself).

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPInstallPrereqs/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPInstallPrereqs/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Common
+
 This resource is responsible for ensuring the installation of all SharePoint
 prerequisites. It makes use of the PrerequisiteInstaller.exe file that is part
 of the SharePoint binaries, and will install the required Windows features as

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPIrmSettings/Readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPIrmSettings/Readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is used to manipulate the IRM settings in SharePoint, integrating
 it with AD RMS
 

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPLogLevel/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPLogLevel/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 globally for all areas and categories (using the '*' character as the

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPMachineTranslationServiceApp/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPMachineTranslationServiceApp/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is used to provision and manage an instance of the Machine
 Translation Service Application. It will identify an instance of the MT
 app through the application display name. Currently the resource will

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPManagedAccount/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPManagedAccount/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource will ensure a managed account is provisioned in to the SharePoint
 farm. The Account object specific the credential to store (including username
 and password) to set as the managed account. The settings for

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPManagedMetadataServiceApp/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPManagedMetadataServiceApp/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 Creates a managed metadata service application. The application pool property
 specifies which application pool it should use, and will reset the application
 back to this pool if it is changed after its initial provisioning. The

diff --git a/...es/SharePointDsc/DSCResources/MSFT_SPManagedMetadataServiceAppDefault/readme.md b/...es/SharePointDsc/DSCResources/MSFT_SPManagedMetadataServiceAppDefault/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 Using several managed metadata service instances in a farm requires some
 configuration, which service application proxy should be used as default
 for keywords or site collection specific term sets.

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPManagedPath/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPManagedPath/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is responsible for creating managed paths associated with a
 specific web application. The WebAppUrl parameter is used to specify the web
 application to create the path against, and the RelativeUrl parameter lets you

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPMinRoleCompliance/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPMinRoleCompliance/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Utility
+
 This resource will help manage compliance of MinRole based servers. Each time
 the resource runs it will investigate which service instances should be running
 based on the role of servers anywhere in the farm, and if they are not in a

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPOfficeOnlineServerBinding/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPOfficeOnlineServerBinding/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 FQDN of a load balanced end point that will direct traffic to a farm.

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPOutgoingEmailSettings/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPOutgoingEmailSettings/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 web app, use the URL of the web application for the WebAppUrl property, to

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPPasswordChangeSettings/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPPasswordChangeSettings/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 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
 SharePoint). These settings can be manually controlled through central

diff --git a/Modules/SharePointDsc/DSCResources/MSFT_SPPerformancePointServiceApp/readme.md b/Modules/SharePointDsc/DSCResources/MSFT_SPPerformancePointServiceApp/readme.md
@@ -1,5 +1,7 @@
 # Description
 
+**Type:** Distributed
+
 This resource is responsible for creating Performance Point Service Application
 instances within the local SharePoint farm. The resource will provision and
 configure the Performance Point Service Application.