This DSC module is used to deploy and configure SharePoint Server 2013 and 2016, 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

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-2018 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-SPDscParameterState Test-SPDSCIsADUser Test-SPDSCRunningAsFarmAccount Set-SPDscObjectPropertyIfValuePresent Get-SPDSCUserProfileSubTypeManager Get-SPDscOSVersion Get-SPDSCRegistryKey Resolve-SPDscSecurityIdentifier Get-SPDscFarmProductsInfo Get-SPDscFarmVersionInfo Convert-SPDscADGroupIDToName Convert-SPDscADGroupNameToID


Add-SPDSCUserToLocalAdmin Clear-SPDscKerberosToken Convert-SPDscADGroupIDToName Convert-SPDscADGroupNameToID Get-SPDscOSVersion Get-SPDSCAssemblyVersion Get-SPDscFarmAccount Get-SPDscFarmAccountName Get-SPDscFarmVersionInfo Get-SPDscFarmProductsInfo Get-SPDscRegProductsInfo Get-SPDSCRegistryKey Get-SPDSCServiceContext Get-SPDSCContentService Get-SPDSCUserProfileSubTypeManager Get-SPDSCInstalledProductVersion Invoke-SPDSCCommand Rename-SPDSCParamValue Remove-SPDSCUserToLocalAdmin Resolve-SPDscSecurityIdentifier Test-SPDSCObjectHasProperty Test-SPDSCRunAsCredential Test-SPDSCRunningAsFarmAccount Test-SPDscParameterState Test-SPDSCUserIsLocalAdmin Test-SPDSCIsADUser Set-SPDscObjectPropertyIfValuePresent Remove-SPDSCGenericObject Format-OfficePatchGUID ConvertTo-TwoDigitFlipString ConvertTo-ReverseString


SPAccessServiceApp SPAccessServices2010 SPAlternateUrl SPAntivirusSettings SPAppCatalog SPAppDomain SPAppManagementServiceApp SPAppStoreSettings SPBCSServiceApp SPBlobCacheSettings SPCacheAccounts SPConfigWizard SPContentDatabase SPCreateFarm SPDatabaseAAG SPDesignerSettings SPDiagnosticLoggingSettings SPDiagnosticsProvider SPDistributedCacheClientSettings SPDistributedCacheService SPExcelServiceApp SPFarm SPFarmAdministrators SPFarmPropertyBag SPFarmSolution SPFeature SPHealthAnalyzerRuleState SPInfoPathFormsServiceConfig SPInstall SPInstallLanguagePack SPInstallPrereqs SPIrmSettings SPJoinFarm 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 SPSearchResultSource SPSearchServiceApp SPSearchTopology SPSecureStoreServiceApp SPSecurityTokenServiceConfig SPSelfServiceSiteCreation SPServiceAppPool SPServiceAppProxyGroup SPServiceAppSecurity SPServiceIdentity SPServiceInstance SPSessionStateService SPShellAdmins SPSite SPSiteUrl SPStateServiceApp SPSubscriptionSettingsServiceApp SPTimerJobState SPTrustedIdentityTokenIssuer SPTrustedIdentityTokenIssuerProviderRealms SPTrustedRootAuthority 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

     * SPFarm
       * Fixed issue where Central Admin service was not starting for non-english farms
     * SPManagedMetadataServiceApp
       * Added additional content type settings (ContentTypePushdownEnabled &
       * Fixed issue where Get method would throw an error when the proxy did not exist.
       * Fixed an issue where the resource checks if the proxy exists and if not, it is
     * SPSearchContentSource
       * Fixed issue with numerical Content Sources name
       * Fixed issue where the code throws an error when the content source cannot be
         successfully created
     * SPSearchManagedProperty
       * Added a new resource to support Search Managed Properties
       * Fix for multiple aliases
     * SPSearchResultSource
       * Added a new ScopeUrl parameter to allow for local source creation
     * SPSearchTopology
       * Updated to remove some incorrect information
       * Fixed logic to handle the FirstPartitionDirectory in Get-TargetResource
     * SPSelfServiceSiteCreation
       * New resource to manage self-service site creation
     * SPServiceAppSecurity
       * Added local farm token.
       * Fixed issues that prevented the resource to work as expected in many situations.
     * SPSite
       * Added the possibility for creating the default site groups
       * Added the possibility to set AdministrationSiteType
       * Fixed test method that in some cases always would return false
       * Fixed a typo in the values to check for AdministrationSiteType
       * Fixed an access denied issue when creating default site groups
         when the run as account does not have proper permissions for the site
     * SPTrustedIdentityTokenIssuer
       * Added parameter UseWReplyParameter
     * SPUserProfileServiceApp
       * Fixed issue which was introduced in v2.5 where the service application proxy
         was not created.
       * Updated resource to grant the InstallAccount permissions to a newly created service
         application to prevent issues in the Get method.
     * SPUserProfileSyncConnection
       * Fixed issue where empty IncludedOUs and ExcludedOUs would throw an error
     * SPWebAppClientCallableSettings
       * New resource to manage web application client callable settings including
         proxy libraries.
     * SPWebAppPropertyBag
       * New resource to manage web application property bag
     * SPWebAppSuiteBar
       * Fixed incorrect test method that resulted in this resource to never apply changes.
       * Enable usage of SuiteBarBrandingElementHtml for SharePoint 2016
         (only supported if using a SharePoint 2013 masterpage)            

Version History

Version Downloads Last updated
4.3.0-previe... 0 9/25/2020
4.3.0-previe... 0 9/25/2020
4.2.1-previe... 7,044 7/30/2020
4.2.1-previe... 1,761 7/29/2020
4.2.0 3,603,033 6/14/2020
4.2.0-previe... 1,761 6/13/2020
4.1.0 4,053 6/10/2020
4.1.0-previe... 1,761 6/9/2020
4.1.0-previe... 1,765 6/2/2020
4.1.0-previe... 1,768 5/11/2020
4.0.1-previe... 1,764 5/5/2020
4.0.0 10,262 4/28/2020
4.0.0-previe... 1,767 4/28/2020
4.0.0-previe... 1,767 4/28/2020
4.0.0-previe... 1,770 3/31/2020
4.0.0-previe... 1,763 3/27/2020
3.9.0-previe... 1,765 3/19/2020
3.8.0 14,294 2/27/2020
3.8.0-previe... 1,765 2/25/2020
3.8.0-previe... 1,767 2/18/2020
3.8.0-previe... 1,763 2/18/2020
3.8.0-previe... 1,771 1/24/2020
3.8.0-previe... 1,763 1/17/2020
3.8.0-previe... 1,765 1/16/2020 98,661 10/30/2019 23,496 8/12/2019 12,928 6/26/2019 67,290 5/15/2019 22,539 4/3/2019 35,836 2/20/2019 6,803 11/29/2018 3,216 11/12/2018 (current version) 4,489 10/25/2018 11,796 9/5/2018 11,920 7/25/2018 6,216 6/13/2018 9,794 3/22/2018 4,747 2/8/2018 23,592 12/20/2017 15,349 10/5/2017 9,017 7/12/2017 3,030 5/31/2017 16,176 3/8/2017 4,096 12/14/2016 2,429 11/2/2016 2,614 9/21/2016 2,236 8/10/2016 2,337 6/29/2016 2,033 6/7/2016
Show less