SharePointDSC

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

Installation Options

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

Install-Module -Name SharePointDSC -RequiredVersion 3.5.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

Author(s)

Microsoft Corporation

Copyright

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

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource preview

Cmdlets

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

Functions

Add-SPDscUserToLocalAdmin Clear-SPDscKerberosToken Convert-SPDscADGroupIDToName Convert-SPDscADGroupNameToID Convert-SPDscHashtableToString Get-SPDscOSVersion Get-SPDscAssemblyVersion Get-SPDscBuildVersion Get-SPDscFarmAccount Get-SPDscFarmAccountName Get-SPDscFarmVersionInfo Get-SPDscFarmProductsInfo Get-SPDscRegProductsInfo Get-SPDscRegistryKey Get-SPDscServerPatchStatus Get-SPDscServiceContext Get-SPDscContentService Get-SPDscUserProfileSubTypeManager Get-SPDscInstalledProductVersion Invoke-SPDscCommand Rename-SPDscParamValue Remove-SPDscUserToLocalAdmin Remove-SPDscZoneMap Resolve-SPDscSecurityIdentifier Set-SPDscZoneMap Test-SPDscObjectHasProperty Test-SPDscRunAsCredential Test-SPDscRunningAsFarmAccount Test-SPDscParameterState Test-SPDscUserIsLocalAdmin Test-SPDscIsADUser Set-SPDscObjectPropertyIfValuePresent Remove-SPDscGenericObject Format-OfficePatchGUID ConvertTo-TwoDigitFlipString ConvertTo-ReverseString

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


     * SharePointDsc generic
       * Improved logging in all resource. They are now outputting
         the current and targeted values in the Test method.
       * Updated various resources to comply with coding style guidelines.
       * Updated the following resources to not return Null from the Get
         method anymore, but an hashtable which contains null values:
         SPDesignerSettings, SPDiagnosticLoggingSettings, SPFarmAdministrators,
         SPHealthAnalyzerRuleState, SPIrmSettings, SPOutgoingEmailSettings,
         SPPasswordChangeSettings, SPSearchTopology, SPServiceAppProxyGroup,
         SPTimerJobState, SPUserProfileSection, SPUserProfileSyncConnection,
         SPWebAppBlockedFileTypes, SPWebApplicationAppDomain, SPWebAppPolicy,
         SPWebAppSiteUseAndDeletion, SPWebAppThrottlingSettings,
         SPWordAutomationServiceApp.
     * SPConfigWizard
       * Added check to make sure the Config Wizard is only executed when all
         servers have the binaries installed.
     * SPDistributedCacheService
       * Added ability to check for incorrect service account.
     * SPExcelServiceApp
       * Fixes issue where Get method throws an error when the value of
         PrivateBytesMax and UnusedObjectAgeMax are negative values.
     * SPFarm
       * Throw error in Get method if CentralAdministrationUrl is HTTP.
     * SPInstallPrereqs
       * Fixed bug in version check, where lower versions would be
         detected as higher versions.
     * SPProductUpdate
       * Updated Readme to reflect the new patching possibilities added in v3.3.
     * SPSecureStore
       * Fixed issue where the test issue returned false is the service
         application didn't exist, but the database name/server parameter
         was specified.
     * SPUserProfileSyncConnection
       * Fixed issue where the parameter Server was checked in SP2016
         but isn't used there and therefore always fails.
     * SPWebAppAuthentication
       * Updated the documentation to better explain the use of this resource
         when using Classic authentication.

Version History

Version Downloads Last updated
3.6.0.0 13,288 8/12/2019
3.5.0.0 (current version) 9,351 6/26/2019
3.4.0.0 8,278 5/15/2019
3.3.0.0 15,863 4/3/2019
3.2.0.0 34,054 2/20/2019
3.1.0.0 4,151 11/29/2018
3.0.0.0 1,317 11/12/2018
2.6.0.0 2,722 10/25/2018
2.5.0.0 9,995 9/5/2018
2.4.0.0 10,156 7/25/2018
2.3.0.0 3,568 6/13/2018
2.2.0.0 8,027 3/22/2018
2.1.0.0 2,983 2/8/2018
2.0.0.0 1,737 12/20/2017
1.9.0.0 11,790 10/5/2017
1.8.0.0 7,247 7/12/2017
1.7.0.0 1,266 5/31/2017
1.6.0.0 12,655 3/8/2017
1.5.0.0 1,434 12/14/2016
1.4.0.0 668 11/2/2016
1.3.0.0 853 9/21/2016
1.2.0.0 475 8/10/2016
1.1.0.0 576 6/29/2016
1.0.0.0 272 6/7/2016