SharePointDSC

5.0.0

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

4.0

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 5.0.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy 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

Author(s)

DSC Community

Copyright

Copyright the DSC Community contributors. All rights reserved.

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

Add-SPDscEvent Add-SPDscUserToLocalAdmin Clear-SPDscKerberosToken Compare-PSCustomObjectArrays Convert-SPDscADGroupIDToName Convert-SPDscADGroupNameToID Convert-SPDscHashtableToString ConvertTo-ReverseString ConvertTo-TwoDigitFlipString Export-SPConfiguration Export-SPDscDiagnosticData Format-OfficePatchGUID Get-SPDscDBForAlias Get-SPDscAssemblyVersion Get-SPDscBuildVersion Get-SPDscClaimTypeMapping Get-SPDscContentService Get-SPDscFarmAccount Get-SPDscFarmAccountName Get-SPDscFarmProductsInfo Get-SPDscFarmVersionInfo Get-SPDscInstalledProductVersion Get-SPDscOSVersion Get-SPDscRegistryKey Get-SPDscRegProductsInfo Get-SPDscServerPatchStatus Get-SPDscServiceAppSecurityMembers Get-SPDscServiceContext Get-SPDscUserProfileSubTypeManager Get-SPDscWebAppHappyHour Get-SPWebPolicyPermissions Invoke-SPDscCommand Read-TargetResource Remove-SPDscGenericObject Remove-SPDscUserToLocalAdmin Remove-SPDscZoneMap Rename-SPDscParamValue Repair-Credentials Resolve-SPDscSecurityIdentifier Set-SPDscObjectPropertyIfValuePresent Set-SPDscZoneMap Set-SPFarmAdministrators Set-SPFarmAdministratorsBlock Set-SPDscTermStoreAdministrators Set-SPDscTermStoreAdministratorsBlock Test-SPDscIsADUser Test-SPDscObjectHasProperty Test-SPDscParameterState Test-SPDscRunningAsFarmAccount Test-SPDscUserIsLocalAdmin

DSCResources

SPAccessServiceApp SPAccessServices2010 SPAlternateUrl SPAntivirusSettings SPAppCatalog SPAppDomain SPAppManagementServiceApp SPAppStoreSettings SPAuthenticationRealm SPAzureAccessControlServiceAppProxy SPBCSServiceApp SPBlobCacheSettings SPCacheAccounts SPCertificate SPCertificateSettings SPConfigWizard SPContentDatabase SPDatabaseAAG SPDesignerSettings SPDiagnosticLoggingSettings SPDiagnosticsProvider SPDistributedCacheClientSettings SPDistributedCacheService SPDocIcon SPExcelServiceApp SPFarm SPFarmAdministrators SPFarmPropertyBag SPFarmSolution SPFeature SPHealthAnalyzerRuleState SPIncomingEmailSettings SPInfoPathFormsServiceConfig SPInstall SPInstallLanguagePack SPInstallPrereqs SPIrmSettings SPLogLevel SPMachineTranslationServiceApp SPManagedAccount SPManagedMetadataServiceApp SPManagedMetadataServiceAppDefault SPManagedPath SPMinRoleCompliance SPOAppPrincipalMgmtServiceAppProxy 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 SPManagedMetaDataServiceApp SPManagedMetaDataServiceAppDefault SPOfficeOnlineServerSupressionSettings SPService SPUsageDefinition SPWebAppHttpThrottlingMonitor

Dependencies

This module has no dependencies.

Release Notes

## [5.0.0] - 2021-12-16

### Added

- SharePointDsc
 - Added support for SharePoint Server Subscription Edition in Util module and unit tests stubs
 - Added SPSE unit tests to the Azure pipeline definitions
- SPCertificate
 - New resource for SharePoint Server Subscription Edition
- SPCertificateSettings
 - New resource for SharePoint Server Subscription Edition
- SPDatabaseAAG
 - Added support for SharePoint Server Subscription Edition
- SPDistributedCacheService
 - Added support for SharePoint Server Subscription Edition
- SPFarm
 - Added support for SharePoint Server Subscription Edition
- SPInstall
 - Added support for SharePoint Server Subscription Edition
- SPInstallPrereqs
 - Added support for SharePoint Server Subscription Edition
- SPOfficeOnlineServerSupressionSettings
 - New resource
- SPSearchServiceApp
 - Added possibility to configure Search Index Deletion Policies settings
- SPWebApplication
 - Added possibility to manage the SiteDataServers property
 - Added support for configuring AllowLegacyEncryption, CertificateThumbprint and UseServerNameIndication
- SPWebApplicationExtension
 - Added support for configuring AllowLegacyEncryption, CertificateThumbprint and UseServerNameIndication

### Changed

- General
 - Updated pipeline definition
- ReverseDsc
 - Changed form Size to dynamic Width
 - Change column width to calc /3 of Form.
 - Export form is now more dynamic / responsive
- SPAccessServiceApp
 - Service app no longer exists in SharePoint Server Subscription Edition. Added logic to check for SPSE.
- SPAccessServices2010
 - Service app no longer exists in SharePoint Server Subscription Edition. Added logic to check for SPSE.
- SPPerformancePointServiceApp
 - Service app no longer exists in SharePoint Server Subscription Edition. Added logic to check for SPSE.
- SPWebApplicationExtension
 - Updated so it infers the UseSSL value from the URL, just like the SPWebApplication resouce

### Fixed

- SPLogLevel
 - Corrected issue in creating ReverseDsc export

### Removed

- SharePointDsc
 - [BREAKING CHANGE] Removed PowerShell v4.0 support by removing the InstallAccount parameter
   from all resources.
- SPWebApplicationExtension
 - [BREAKING CHANGE] Removed UseSSL parameter

Version History

Version Downloads Last updated
5.2.0 1,321 5/12/2022
5.2.0-previe... 4 5/12/2022
5.2.0-previe... 6 5/4/2022
5.2.0-previe... 19 4/1/2022
5.2.0-previe... 8 3/26/2022
5.1.0 6,779 2/24/2022
5.1.0-previe... 5 2/24/2022
5.1.0-previe... 6 2/17/2022
5.1.0-previe... 5 2/16/2022
5.1.0-previe... 8 2/11/2022
5.1.0-previe... 4 1/19/2022
5.1.0-previe... 2 1/17/2022
5.0.1-previe... 2 1/11/2022
5.0.1-previe... 5 1/7/2022
5.0.0 (current version) 29,135 12/17/2021
5.0.0-previe... 2 12/16/2021
4.9.0 8,887 11/6/2021
4.8.1-previe... 2 11/5/2021
4.8.1-previe... 3 11/4/2021
4.8.1-previe... 110 10/3/2021
4.8.0 7,169 8/31/2021
4.8.0-previe... 2 8/31/2021
4.8.0-previe... 2 8/31/2021
4.8.0-previe... 3 8/25/2021
4.8.0-previe... 2 8/25/2021
4.8.0-previe... 11 7/9/2021
4.8.0-previe... 6 6/27/2021
4.7.0 10,187 6/10/2021
4.6.1-previe... 2 6/10/2021
4.6.1-previe... 13 4/12/2021
4.6.1-previe... 4 4/9/2021
4.6.1-previe... 4 4/8/2021
4.6.0 11,386 4/2/2021
4.6.0-previe... 4 4/1/2021
4.6.0-previe... 9 3/25/2021
4.5.1 10,283 2/5/2021
4.5.1-previe... 5 2/4/2021
4.5.0 1,207 1/30/2021
4.5.0-previe... 13 1/8/2021
4.5.0-previe... 9 12/19/2020
4.4.1-previe... 6 11/26/2020
4.4.1-previe... 6 11/18/2020
4.4.0 15,824 11/14/2020
4.4.0-previe... 3 11/14/2020
4.4.0-previe... 3 11/13/2020
4.4.0-previe... 5 11/11/2020
4.4.0-previe... 2 11/11/2020
4.3.1-previe... 5 10/23/2020
4.3.0 10,176 9/30/2020
4.3.0-previe... 1 9/30/2020
4.3.0-previe... 1 9/25/2020
4.3.0-previe... 1 9/25/2020
4.2.1-previe... 12 7/30/2020
4.2.1-previe... 3 7/29/2020
4.2.0 19,661 6/14/2020
4.2.0-previe... 3 6/13/2020
4.1.0 1,423 6/10/2020
4.1.0-previe... 3 6/9/2020
4.1.0-previe... 7 6/2/2020
4.1.0-previe... 10 5/11/2020
4.0.1-previe... 6 5/5/2020
4.0.0 6,764 4/28/2020
4.0.0-previe... 9 4/28/2020
4.0.0-previe... 9 4/28/2020
4.0.0-previe... 12 3/31/2020
4.0.0-previe... 5 3/27/2020
3.9.0-previe... 7 3/19/2020
3.8.0 11,670 2/27/2020
3.8.0-previe... 7 2/25/2020
3.8.0-previe... 9 2/18/2020
3.8.0-previe... 5 2/18/2020
3.8.0-previe... 13 1/24/2020
3.8.0-previe... 5 1/17/2020
3.8.0-previe... 7 1/16/2020
3.7.0.0 23,204 10/30/2019
3.6.0.0 15,597 8/12/2019
3.5.0.0 9,465 6/26/2019
3.4.0.0 10,080 5/15/2019
3.3.0.0 16,528 4/3/2019
3.2.0.0 34,103 2/20/2019
3.1.0.0 4,197 11/29/2018
3.0.0.0 1,492 11/12/2018
2.6.0.0 2,756 10/25/2018
2.5.0.0 10,068 9/5/2018
2.4.0.0 10,185 7/25/2018
2.3.0.0 3,608 6/13/2018
2.2.0.0 8,062 3/22/2018
2.1.0.0 3,013 2/8/2018
2.0.0.0 2,700 12/20/2017
1.9.0.0 11,877 10/5/2017
1.8.0.0 7,286 7/12/2017
1.7.0.0 1,278 5/31/2017
1.6.0.0 12,670 3/8/2017
1.5.0.0 1,466 12/14/2016
1.4.0.0 676 11/2/2016
1.3.0.0 862 9/21/2016
1.2.0.0 484 8/10/2016
1.1.0.0 585 6/29/2016
1.0.0.0 282 6/7/2016
Show less