SharePointDSC

4.4.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 4.4.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

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 Format-OfficePatchGUID Get-SPDscAssemblyVersion Get-SPDscBuildVersion Get-SPDscContentService Get-SPDscFarmAccount Get-SPDscFarmAccountName Get-SPDscFarmProductsInfo Get-SPDscFarmVersionInfo Get-SPDscInstalledProductVersion Get-SPDscOSVersion Get-SPDscRegistryKey Get-SPDscRegProductsInfo Get-SPDscServerPatchStatus Get-SPDscServiceContext Get-SPDscUserProfileSubTypeManager Invoke-SPDscCommand Remove-SPDscGenericObject Remove-SPDscUserToLocalAdmin Remove-SPDscZoneMap Rename-SPDscParamValue Resolve-SPDscSecurityIdentifier Set-SPDscObjectPropertyIfValuePresent Set-SPDscZoneMap Test-SPDscIsADUser Test-SPDscObjectHasProperty Test-SPDscParameterState Test-SPDscRunAsCredential Test-SPDscRunningAsFarmAccount Test-SPDscUserIsLocalAdmin

DSCResources

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

Dependencies

This module has no dependencies.

Release Notes

## [4.4.0] - 2020-11-14

### Added

- SharePointDsc
 - Added logging to the event log when the code throws an exception
 - Added support for trusted domains to Test-SPDscIsADUser helper function
- SPInstall
 - Added documentation about a SharePoint 2019 installer issue

### Changed

- SharePointDsc
 - Updated Convert-SPDscHashtableToString to output the username when
   parameter is a PSCredential
- SPFarm
 - Switched from creating a Lock database to a Lock table in the TempDB.
   This to allow the use of precreated databases.
 - Updated code to properly output used credential parameters to verbose
   logging
- SPSite
 - Added more explanation to documentation on which parameters are checked
- SPWeb
 - Added more explanation to documentation on using this resource

### Fixed

- SPConfigWizard
 - Fixes issue where a CU installation wasn't registered properly in the
   config database. Added logic to run the Product Version timer job
- SPSearchTopology
 - Fixes issue where applying a topology failed when the search service
   instance was disabled instead of offline
- SPSecureStoreServiceApp
 - Fixes issue where custom database name was no longer used since v4.3
- SPShellAdmins
 - Fixed issue with Get-DscConfiguration which threw an error when only one
   item was returned by the Get method
- SPWordAutomationServiceApp
 - Fixed issue where provisioning the service app requires a second run to
   update all specified parameters
- SPWorkflowService
 - Fixed issue configuring workflow service when no workflow service is
   currently configured

Version History

Version Downloads Last updated
4.4.1-previe... 2 11/26/2020
4.4.1-previe... 6 11/18/2020
4.4.0 (current version) 3,066 11/14/2020
4.4.0-previe... 3 11/14/2020
4.4.0-previe... 3 11/13/2020
4.4.0-previe... 4 11/11/2020
4.4.0-previe... 2 11/11/2020
4.3.1-previe... 5 10/23/2020
4.3.0 9,871 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,272 6/14/2020
4.2.0-previe... 3 6/13/2020
4.1.0 1,419 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,749 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,661 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,087 10/30/2019
3.6.0.0 15,590 8/12/2019
3.5.0.0 9,416 6/26/2019
3.4.0.0 9,394 5/15/2019
3.3.0.0 16,388 4/3/2019
3.2.0.0 34,080 2/20/2019
3.1.0.0 4,168 11/29/2018
3.0.0.0 1,461 11/12/2018
2.6.0.0 2,734 10/25/2018
2.5.0.0 10,040 9/5/2018
2.4.0.0 10,163 7/25/2018
2.3.0.0 3,581 6/13/2018
2.2.0.0 8,038 3/22/2018
2.1.0.0 2,991 2/8/2018
2.0.0.0 2,587 12/20/2017
1.9.0.0 11,837 10/5/2017
1.8.0.0 7,262 7/12/2017
1.7.0.0 1,274 5/31/2017
1.6.0.0 12,662 3/8/2017
1.5.0.0 1,461 12/14/2016
1.4.0.0 673 11/2/2016
1.3.0.0 858 9/21/2016
1.2.0.0 480 8/10/2016
1.1.0.0 581 6/29/2016
1.0.0.0 277 6/7/2016