SharePointDSC

2.2.0.0

This DSC module is used to deploy and configure SharePoint Server 2013 and 2016, 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 2.2.0.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name SharePointDSC -Version 2.2.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

Owners

Copyright

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

Package Details

Author(s)

  • Microsoft Corporation

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 Get-SPDscOSVersion Get-SPDSCAssemblyVersion 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 Resolve-SPDscSecurityIdentifier 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 SPBCSServiceApp SPBlobCacheSettings SPCacheAccounts SPConfigWizard SPContentDatabase SPCreateFarm SPDatabaseAAG SPDesignerSettings SPDiagnosticLoggingSettings SPDiagnosticsProvider SPDistributedCacheClientSettings SPDistributedCacheService SPExcelServiceApp SPFarm SPFarmAdministrators SPFarmPropertyBag SPFarmSolution SPFeature SPHealthAnalyzerRuleState SPInfoPathFormsServiceConfig SPInstall SPInstallLanguagePack SPInstallPrereqs SPIrmSettings SPJoinFarm 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 SPSearchResultSource SPSearchServiceApp SPSearchTopology SPSecureStoreServiceApp SPSecurityTokenServiceConfig SPServiceAppPool SPServiceAppProxyGroup SPServiceAppSecurity SPServiceIdentity SPServiceInstance SPSessionStateService SPShellAdmins SPSite SPStateServiceApp SPSubscriptionSettingsServiceApp SPTimerJobState SPTrustedIdentityTokenIssuer SPTrustedRootAuthority SPUsageApplication SPUserProfileProperty SPUserProfileSection SPUserProfileServiceApp SPUserProfileServiceAppPermissions SPUserProfileSyncConnection SPUserProfileSyncService SPVisioServiceApp SPWeb SPWebAppAuthentication SPWebAppBlockedFileTypes SPWebAppGeneralSettings SPWebApplication SPWebApplicationAppDomain SPWebApplicationExtension SPWebAppPeoplePickerSettings SPWebAppPermissions SPWebAppPolicy SPWebAppProxyGroup SPWebAppSiteUseAndDeletion SPWebAppSuiteBar SPWebAppThrottlingSettings SPWebAppWorkflowSettings SPWordAutomationServiceApp SPWorkflowService SPWorkManagementServiceApp

Dependencies

This module has no dependencies.

Release Notes


     * SPAlternateURL
       * If resource specifies Central Admin webapp and Default Zone, the existing
         AAM will be updated instead of adding a new one
     * SPContentDatabase
       * Fixed issue where mounting a content database which had to be upgraded
         resulted in a reboot.
     * SPDistributedCacheClientSettings
       * Added the new resource
     * SPFarmAdministrators
       * Fixed issue where member comparisons was case sensitive. This had
         to be case insensitive.
     * SPManagedMetadataServiceApp
       * Fixed issue with creating the Content Type Hub on an existing MMS
         service app without Content Type Hub.
     * SPManagedMetadataServiceAppDefault
       * Fixed issue where .GetType().FullName and TypeName were not used
         properly.
     * SPTimerJobState
       * Updated description of WebAppUrl parameter to make it clear that
         N/A has to be used to specify a global timer job.
     * SPUserProfileServiceApp
       * Fixed issue introduced in v2.0, where the Farm Account had to have
         local Administrator permissions for the resource to function properly.
       * Updated resource to retrieve the Farm account from the Managed Accounts
         instead of requiring it as a parameter.
     * SPUserProfileSyncService
       * Fixed issue introduced in v2.0, where the Farm Account had to have
         local Administrator permissions for the resource to function properly.
       * Updated resource to retrieve the Farm account from the Managed Accounts
         instead of requiring it as a parameter.
       * The FarmAccount parameter is deprecated and no longer required. Is ignored
         in the code and will be removed in v3.0.
     * SPVisioServiceApp
       * Fixed an issue where the proxy is not properly getting created
     

FileList

Version History

Version Downloads Last updated
5.5.0 75 4/22/2024
5.5.0-previe... 3 4/20/2024
5.5.0-previe... 215 4/25/2023
5.5.0-previe... 4 4/22/2023
5.4.0 28,232 4/4/2023
5.3.1-previe... 4 4/3/2023
5.3.1-previe... 22 3/18/2023
5.3.1-previe... 4 3/17/2023
5.3.0 5,447 11/15/2022
5.2.1-previe... 8 11/10/2022
5.2.0 16,573 5/12/2022
5.2.0-previe... 15 5/12/2022
5.2.0-previe... 17 5/4/2022
5.2.0-previe... 30 4/1/2022
5.2.0-previe... 20 3/26/2022
5.1.0 6,912 2/24/2022
5.1.0-previe... 16 2/24/2022
5.1.0-previe... 18 2/17/2022
5.1.0-previe... 17 2/16/2022
5.1.0-previe... 19 2/11/2022
5.1.0-previe... 15 1/19/2022
5.1.0-previe... 13 1/17/2022
5.0.1-previe... 13 1/11/2022
5.0.1-previe... 17 1/7/2022
5.0.0 29,192 12/17/2021
5.0.0-previe... 13 12/16/2021
4.9.0 9,112 11/6/2021
4.8.1-previe... 13 11/5/2021
4.8.1-previe... 14 11/4/2021
4.8.1-previe... 121 10/3/2021
4.8.0 7,742 8/31/2021
4.8.0-previe... 13 8/31/2021
4.8.0-previe... 13 8/31/2021
4.8.0-previe... 14 8/25/2021
4.8.0-previe... 13 8/25/2021
4.8.0-previe... 22 7/9/2021
4.8.0-previe... 17 6/27/2021
4.7.0 10,201 6/10/2021
4.6.1-previe... 13 6/10/2021
4.6.1-previe... 24 4/12/2021
4.6.1-previe... 16 4/9/2021
4.6.1-previe... 16 4/8/2021
4.6.0 11,400 4/2/2021
4.6.0-previe... 15 4/1/2021
4.6.0-previe... 21 3/25/2021
4.5.1 10,340 2/5/2021
4.5.1-previe... 16 2/4/2021
4.5.0 1,219 1/30/2021
4.5.0-previe... 25 1/8/2021
4.5.0-previe... 20 12/19/2020
4.4.1-previe... 17 11/26/2020
4.4.1-previe... 17 11/18/2020
4.4.0 15,836 11/14/2020
4.4.0-previe... 14 11/14/2020
4.4.0-previe... 14 11/13/2020
4.4.0-previe... 16 11/11/2020
4.4.0-previe... 13 11/11/2020
4.3.1-previe... 17 10/23/2020
4.3.0 10,193 9/30/2020
4.3.0-previe... 13 9/30/2020
4.3.0-previe... 12 9/25/2020
4.3.0-previe... 12 9/25/2020
4.2.1-previe... 23 7/30/2020
4.2.1-previe... 15 7/29/2020
4.2.0 19,695 6/14/2020
4.2.0-previe... 14 6/13/2020
4.1.0 1,436 6/10/2020
4.1.0-previe... 14 6/9/2020
4.1.0-previe... 18 6/2/2020
4.1.0-previe... 21 5/11/2020
4.0.1-previe... 17 5/5/2020
4.0.0 6,779 4/28/2020
4.0.0-previe... 20 4/28/2020
4.0.0-previe... 20 4/28/2020
4.0.0-previe... 23 3/31/2020
4.0.0-previe... 16 3/27/2020
3.9.0-previe... 18 3/19/2020
3.8.0 11,687 2/27/2020
3.8.0-previe... 18 2/25/2020
3.8.0-previe... 20 2/18/2020
3.8.0-previe... 16 2/18/2020
3.8.0-previe... 24 1/24/2020
3.8.0-previe... 16 1/17/2020
3.8.0-previe... 18 1/16/2020
3.7.0.0 23,239 10/30/2019
3.6.0.0 15,611 8/12/2019
3.5.0.0 9,478 6/26/2019
3.4.0.0 10,199 5/15/2019
3.3.0.0 16,542 4/3/2019
3.2.0.0 34,115 2/20/2019
3.1.0.0 4,210 11/29/2018
3.0.0.0 1,506 11/12/2018
2.6.0.0 2,774 10/25/2018
2.5.0.0 10,081 9/5/2018
2.4.0.0 10,212 7/25/2018
2.3.0.0 3,626 6/13/2018
2.2.0.0 (current version) 8,076 3/22/2018
2.1.0.0 3,025 2/8/2018
2.0.0.0 2,715 12/20/2017
1.9.0.0 11,889 10/5/2017
1.8.0.0 7,303 7/12/2017
1.7.0.0 1,290 5/31/2017
1.6.0.0 12,687 3/8/2017
1.5.0.0 1,481 12/14/2016
1.4.0.0 688 11/2/2016
1.3.0.0 874 9/21/2016
1.2.0.0 496 8/10/2016
1.1.0.0 597 6/29/2016
1.0.0.0 297 6/7/2016
Show less