SharePointDSC

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

Author(s)

Microsoft Corporation

Copyright

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

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

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


     * SPDistributedCacheClientSettings
       * Added 15 new SharePoint 2016 parameters.
     * SPFarm
       * Implemented Null check in Get method to prevent errors
       * Add support to provision Central Administration on HTTPS
     * SPInfoPathFormsServiceConfig
       * Added the AllowEventPropagation parameter.
     * SPInstall
       * Improved logging ouput
       * Updated blocked setup file check to prevent errors when BinaryDir
         is a CD-ROM drive or mounted ISO
     * SPInstallLanguagePack
       * Improved logging ouput
       * Updated blocked setup file check to prevent errors when BinaryDir
         is a CD-ROM drive or mounted ISO
     * SPInstallPrereqs
       * Improved logging ouput
       * Added the updated check to unblock setup file if it is blocked because
         it is coming from a network location. This to prevent endless wait.
       * Added ability to install from a UNC path, by adding server
         to IE Local Intranet Zone. This will prevent an endless wait
         caused by security warning.
       * Fixed an issue that would prevent the resource failing a test when the
         prerequisites have been installed successfully on Windows Server 2019
     * SPManagedMetadataServiceApp
       * Fixed issue where Get-TargetResource method throws an error when the
         service app proxy does not exist and no proxy name is specified.
     * SPProductUpdate
       * Improved logging ouput
       * Updated blocked setup file check to prevent errors when SetupFile
         is a CD-ROM drive or mounted ISO
     * SPSearchContent Source
       * Removed check that prevents configuring an incremental schedule when
         using continuous crawl.
     * SPSitePropertyBag
       * Fixed issue where properties were set on the wrong level.
     * SPSubscriptionSettingsServiceApp
       * Fixed issue where the service app proxy isn't created when it wasn't
         created during initial deployment.
     * SPTrustedRootAuthority
       * Added possibility to get certificate from file.

Version History

Version Downloads Last updated
3.6.0.0 11,973 8/12/2019
3.5.0.0 9,349 6/26/2019
3.4.0.0 (current version) 8,277 5/15/2019
3.3.0.0 15,854 4/3/2019
3.2.0.0 34,054 2/20/2019
3.1.0.0 4,150 11/29/2018
3.0.0.0 1,316 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,721 12/20/2017
1.9.0.0 11,786 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