This DSC module is used to deploy and configure SharePoint Server 2013 and 2016, and convers a wide range of areas including web apps, service apps and farm configuration.

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name SharePointDSC -RequiredVersion

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deloy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More


Microsoft Corporation


(c) 2015-2016 Microsoft Corporation. All rights reserved.



DesiredStateConfiguration DSC DSCResourceKit DSCResource


Invoke-SPDSCCommand Get-SPDSCInstalledProductVersion Get-SPDSCContentService Rename-SPDSCParamValue Add-SPDSCUserToLocalAdmin Remove-SPDSCUserToLocalAdmin Test-SPDSCObjectHasProperty Test-SPDSCRunAsCredential Test-SPDSCUserIsLocalAdmin Test-SPDSCSpecificParameters Set-SPDSCObjectPropertyIfValueExists Get-SPDSCUserProfileSubTypeManager


Add-SPDSCUserToLocalAdmin Get-SPDSCAssemblyVersion Get-SPDSCServiceContext Get-SPDSCContentService Get-SPDSCUserProfileSubTypeManager Get-SPDSCInstalledProductVersion Invoke-SPDSCCommand Rename-SPDSCParamValue Remove-SPDSCUserToLocalAdmin Test-SPDSCObjectHasProperty Test-SPDSCRunAsCredential Test-SPDSCSpecificParameters Test-SPDSCUserIsLocalAdmin Set-SPDSCObjectPropertyIfValueExists Remove-WebAppPolicy


SPAccessServiceApp SPAlternateUrl SPAntivirusSettings SPAppCatalog SPAppDomain SPAppManagementServiceApp SPBCSServiceApp SPCacheAccounts SPContentDatabase SPCreateFarm SPDatabaseAAG SPDesignerSettings SPDiagnosticLoggingSettings SPDistributedCacheService SPExcelServiceApp SPFarmAdministrators SPFarmSolution SPFeature SPHealthAnalyzerRuleState SPInstall SPInstallPrereqs SPIrmSettings SPJoinFarm SPManagedAccount SPManagedMetaDataServiceApp SPManagedPath SPOutgoingEmailSettings SPPasswordChangeSettings SPPerformancePointServiceApp SPQuotaTemplate SPSearchContentSource SPSearchCrawlRule SPSearchIndexPartition SPSearchServiceApp SPSearchTopology SPSecureStoreServiceApp SPServiceAppPool SPServiceAppSecurity SPServiceInstance SPSessionStateService SPShellAdmins SPSite SPStateServiceApp SPSubscriptionSettingsServiceApp SPTimerJobState SPUsageApplication SPUserProfileProperty SPUserProfileSection SPUserProfileServiceApp SPUserProfileSyncConnection SPUserProfileSyncService SPVisioServiceApp SPWeb SPWebAppBlockedFileTypes SPWebAppGeneralSettings SPWebApplication SPWebApplicationAppDomain SPWebAppPolicy SPWebAppSiteUseAndDeletion SPWebAppThrottlingSettings SPWebAppWorkflowSettings SPWordAutomationServiceApp SPWorkManagementServiceApp


This module has no dependencies.

Release Notes

* Renamed module from xSharePoint to SharePointDsc
* Fixed bug in managed account schedule get method
* Fixed incorrect output of server name in xSPOutgoingEmailSettings
* Added ensure properties to multiple resources to standardise schemas
* Added xSPSearchContentSource, xSPContentDatabase, xSPServiceAppSecurity, xSPAccessServiceApp, xSPExcelServiceApp, xSPPerformancePointServiceApp, xSPIrmSettings resources
* Fixed a bug in xSPInstallPrereqs that would cause an updated version of AD rights management to fail the test method for SharePoint 2013
* Fixed bug in xSPFarmAdministrators where testing for users was case sensitive
* Fixed a bug with reboot detection in xSPInstallPrereqs
* Added SearchCenterUrl property to xSPSearchServiceApp
* Fixed a bug in xSPAlternateUrl to account for a default zone URL being changed
* Added content type hub URL option to xSPManagedMetadataServiceApp for when it provisions a service app
* Updated xSPWebAppPolicy to allow addition and removal of accounts, including the Cache Accounts, to the web application policy.
* Fixed bug with claims accounts not being added to web app policy in xSPCacheAccounts
* Added option to not apply cache accounts policy to the web app in xSPCacheAccounts
* Farm Passphrase now uses a PSCredential object, in order to pass the value as a securestring on xSPCreateFarm and xSPJoinFarm
* xSPCreateFarm supports specifying Kerberos authentication for the Central Admin site with the CentralAdministrationAuth property
* Fixed nuget package format for development feed from AppVeyor
* Fixed bug with get output of xSPUSageApplication
* Added SXSpath parameter to xSPInstallPrereqs for installing Windows features in offline environments
* Added additional parameters to xSPWebAppGeneralSettings for use in hardened environments
* Added timestamps to verbose logging for resources that pause for responses from SharePoint
* Added options to customise the installation directories used when installing SharePoint with xSPInstall
* Aligned testing to common DSC resource test module
* Fixed bug in the xSPWebApplication which prevented a web application from being created in an existing application pool
* Updated xSPInstallPrereqs to align with SharePoint 2016 RTM changes
* Added support for cloud search index to xSPSearchServiceApp
* Fixed bug in xSPWebAppGeneralSettings that prevented setting a security validation timeout value

Version History

Version Downloads Last updated
4.3.0 22 9/30/2020
4.3.0-previe... 0 9/30/2020
4.3.0-previe... 0 9/25/2020
4.3.0-previe... 0 9/25/2020
4.2.1-previe... 4 7/30/2020
4.2.1-previe... 1 7/29/2020
4.2.0 13,514 6/14/2020
4.2.0-previe... 1 6/13/2020
4.1.0 1,413 6/10/2020
4.1.0-previe... 1 6/9/2020
4.1.0-previe... 5 6/2/2020
4.1.0-previe... 8 5/11/2020
4.0.1-previe... 4 5/5/2020
4.0.0 6,742 4/28/2020
4.0.0-previe... 7 4/28/2020
4.0.0-previe... 7 4/28/2020
4.0.0-previe... 10 3/31/2020
4.0.0-previe... 3 3/27/2020
3.9.0-previe... 5 3/19/2020
3.8.0 11,654 2/27/2020
3.8.0-previe... 5 2/25/2020
3.8.0-previe... 7 2/18/2020
3.8.0-previe... 3 2/18/2020
3.8.0-previe... 11 1/24/2020
3.8.0-previe... 3 1/17/2020
3.8.0-previe... 5 1/16/2020 22,981 10/30/2019 15,576 8/12/2019 9,408 6/26/2019 9,211 5/15/2019 16,379 4/3/2019 34,076 2/20/2019 4,163 11/29/2018 1,456 11/12/2018 2,729 10/25/2018 10,036 9/5/2018 10,160 7/25/2018 3,576 6/13/2018 8,034 3/22/2018 2,987 2/8/2018 2,472 12/20/2017 11,829 10/5/2017 7,257 7/12/2017 1,270 5/31/2017 12,656 3/8/2017 1,456 12/14/2016 669 11/2/2016 854 9/21/2016 476 8/10/2016 577 6/29/2016 (current version) 273 6/7/2016
Show less