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

Minimum PowerShell version


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 4.0.0

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


DSC Community


Copyright the DSC Community contributors. 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-SPDscParameterState Test-SPDscIsADUser Test-SPDscRunningAsFarmAccount Set-SPDscObjectPropertyIfValuePresent Get-SPDscUserProfileSubTypeManager Get-SPDscOSVersion Get-SPDscRegistryKey Resolve-SPDscSecurityIdentifier Get-SPDscFarmProductsInfo Get-SPDscFarmVersionInfo Convert-SPDscADGroupIDToName Convert-SPDscADGroupNameToID


SPAccessServiceApp SPAccessServices2010 SPAlternateUrl SPAntivirusSettings SPAppCatalog SPAppDomain SPAppManagementServiceApp SPAppStoreSettings SPAuthenticationRealm SPBCSServiceApp SPBlobCacheSettings SPCacheAccounts SPConfigWizard SPContentDatabase SPDatabaseAAG SPDesignerSettings SPDiagnosticLoggingSettings SPDiagnosticsProvider SPDistributedCacheClientSettings SPDistributedCacheService SPExcelServiceApp SPFarm SPFarmAdministrators SPFarmPropertyBag SPFarmSolution SPFeature SPHealthAnalyzerRuleState SPIncomingEmailSettings SPInfoPathFormsServiceConfig SPInstall SPInstallLanguagePack SPInstallPrereqs SPIrmSettings SPLogLevel SPMachineTranslationServiceApp SPManagedAccount SPManagedMetadataServiceApp SPManagedMetadataServiceAppDefault SPManagedPath SPMinRoleCompliance SPOfficeOnlineServerBinding SPOutgoingEmailSettings SPPasswordChangeSettings SPPerformancePointServiceApp SPPowerPointAutomationServiceApp SPProductUpdate SPProjectServerAdditionalSettings SPProjectServerADResourcePoolSync SPProjectServerGlobalPermissions SPProjectServerGroup SPProjectServerLicense SPProjectServerPermissionMode SPProjectServerServiceApp SPProjectServerTimeSheetSettings SPProjectServerUserSyncSettings SPProjectServerWssSettings SPPublishServiceApplication SPQuotaTemplate SPRemoteFarmTrust SPSearchAuthoritativePage SPSearchContentSource SPSearchCrawlerImpactRule SPSearchCrawlMapping SPSearchCrawlRule SPSearchFileType SPSearchIndexPartition SPSearchManagedProperty SPSearchMetadataCategory SPSearchResultSource SPSearchServiceApp SPSearchServiceSettings SPSearchTopology SPSecureStoreServiceApp SPSecurityTokenServiceConfig SPSelfServiceSiteCreation SPServiceAppPool SPServiceAppProxyGroup SPServiceAppSecurity SPServiceIdentity SPServiceInstance SPSessionStateService SPShellAdmins SPSite SPSitePropertyBag SPSiteUrl SPStateServiceApp SPSubscriptionSettingsServiceApp SPTimerJobState SPTrustedIdentityTokenIssuer SPTrustedIdentityTokenIssuerProviderRealms SPTrustedRootAuthority SPTrustedSecurityTokenIssuer SPUsageApplication SPUserProfileProperty SPUserProfileSection SPUserProfileServiceApp SPUserProfileServiceAppPermissions SPUserProfileSyncConnection SPUserProfileSyncService SPVisioServiceApp SPWeb SPWebAppAuthentication SPWebAppBlockedFileTypes SPWebAppClientCallableSettings SPWebAppGeneralSettings SPWebApplication SPWebApplicationAppDomain SPWebApplicationExtension SPWebAppPeoplePickerSettings SPWebAppPermissions SPWebAppPolicy SPWebAppPropertyBag SPWebAppProxyGroup SPWebAppSiteUseAndDeletion SPWebAppSuiteBar SPWebAppThrottlingSettings SPWebAppWorkflowSettings SPWordAutomationServiceApp SPWorkflowService SPWorkManagementServiceApp


This module has no dependencies.

Release Notes

## [4.0.0] - 2020-04-28

### Added

- SharePointDsc
 - Added verbose logging of the test results in the Test method
 - Added function to create SharePointDsc event log and add log entries
 - Added the logging of all test results to the new SharePointDsc event log
 - Added support in several resources for creating/connecting to farm
   and service applications using a (single) SQL-based credential
   instead of the default Windows credentials. Needed when e.g. using
   Azure SQL Managed Instance as SharePoint's database server.
   UseSQLAuthentication and DatabaseCredentials parameters will need
   to be considered.

### Changed

The following changes will break v3.x and earlier configurations that use these

- SPManagedMetaDataServiceAppDefault
 - Updated resource to allow the configuration of default per service application
   proxy groups instead of per farm
- SPSearchContentSource
 - Discontinued CrawlEverything, CrawlFirstOnly and null as allowable CrawlSetting
   values for a SharePoint based content source, requiring CrawlVirtualServers or
- SPTrustedRootAuthority
 - It's now possible to specify both CertificateFilePath and CertificateThumbprint
   so that the certificate thumbprint can be verified before importing.
- SPTrustedSecurityTokenIssuer
 - It's now possible to specify both SigningCertificateFilePath and
   SigningCertificateThumbprint so that the certificate thumbprint can be verified
   before importing.
- SPUserProfileServiceApp
 - Changed the MySiteHostLocation parameter to a required parameter
- SPWebAppAuthentication
 - Updated resource to add support for Basic Authentication

### Fixed

- SPFarmSolution
 - Corrected bug running Solution Job wait for an Absent solution.
 - Corrected bug trying to remove an already Absent solution.
- SPSearchAuthoritativePage
 - Corrected bug when checking for an existing Demoted Action
- SPWebAppAuthentication
 - Updated to support passing of null/empty collections for zones not utilized.

### Removed

The following changes will break v3.x and earlier configurations that use these

- SPSearchServiceApp
 - Removed the WindowsServiceAccount parameter that was depricated in v3.1
- SPUserProfileSyncService
 - Removed the FarmAccount parameter that was depricated in v2.2

Version History

Version Downloads Last updated
4.2.0 2,759 6/14/2020
4.2.0-previe... 1 6/13/2020
4.1.0 1,407 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 (current version) 6,734 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,638 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,945 10/30/2019 15,385 8/12/2019 9,399 6/26/2019 9,026 5/15/2019 16,372 4/3/2019 34,071 2/20/2019 4,157 11/29/2018 1,448 11/12/2018 2,725 10/25/2018 10,030 9/5/2018 10,156 7/25/2018 3,571 6/13/2018 8,033 3/22/2018 2,983 2/8/2018 2,369 12/20/2017 11,827 10/5/2017 7,252 7/12/2017 1,266 5/31/2017 12,655 3/8/2017 1,455 12/14/2016 668 11/2/2016 853 9/21/2016 475 8/10/2016 576 6/29/2016 272 6/7/2016
Show less