SharePointDSC

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


     * SharePointDsc generic
       * Implemented workaround for PSSA v1.18 issue. No further impact for
         the rest of the resources
       * Fixed issue where powershell session was never removed and leaded to
         memory leak
       * Added readme.md file to Examples folder, which directs users to the
         Wiki on Github
     * SPAppManagementServiceApp
       * Added ability to create Service App Proxy if this is not present
     * SPConfigWizard
       * Improved logging
     * SPFarm
       * Corrected issue where the resource would try to join a farm, even when
         the farm was not yet created
       * Fixed issue where an error was thrown when no DeveloperDashboard
         parameter was specfied
     * SPInstall
       * Added 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
     * SPInstallLanguagePack
       * Added check to unblock setup file if it is blocked because it is coming
         from a network location. This to prevent endless wait
       * Corrected issue with Norwegian language pack not being correctly
         detected
       * 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
     * SPProductUpdate
       * 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
       * Major refactor of this resource to remove the dependency on the
         existence of the farm. This allows the installation of product updates
         before farm creation.
     * SPSearchContentSource
       * Corrected typo that prevented a correct check for ContinuousCrawl
     * SPSearchServiceApp
       * Added possibility to manage AlertsEnabled setting
     * SPSelfServiceSiteCreation
       * Added new SharePoint 2019 properties
     * SPSitePropertyBag
       * Added new resource
     * SPWebAppThrottlingSettings
       * Fixed issue with ChangeLogRetentionDays not being applied

Version History

Version Downloads Last updated
3.4.0.0 1,466 5/15/2019
3.3.0.0 (current version) 15,078 4/3/2019
3.2.0.0 34,016 2/20/2019
3.1.0.0 4,108 11/29/2018
3.0.0.0 1,221 11/12/2018
2.6.0.0 2,697 10/25/2018
2.5.0.0 9,848 9/5/2018
2.4.0.0 10,133 7/25/2018
2.3.0.0 3,542 6/13/2018
2.2.0.0 8,009 3/22/2018
2.1.0.0 2,954 2/8/2018
2.0.0.0 1,547 12/20/2017
1.9.0.0 11,772 10/5/2017
1.8.0.0 7,228 7/12/2017
1.7.0.0 1,261 5/31/2017
1.6.0.0 12,650 3/8/2017
1.5.0.0 1,429 12/14/2016
1.4.0.0 660 11/2/2016
1.3.0.0 848 9/21/2016
1.2.0.0 470 8/10/2016
1.1.0.0 571 6/29/2016
1.0.0.0 267 6/7/2016