SharePointDSC

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

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 3.0.0.0

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

Install-PSResource -Name SharePointDSC -Version 3.0.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-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 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 SPDatabaseAAG SPDesignerSettings SPDiagnosticLoggingSettings SPDiagnosticsProvider SPDistributedCacheClientSettings SPDistributedCacheService SPExcelServiceApp SPFarm SPFarmAdministrators SPFarmPropertyBag SPFarmSolution SPFeature SPHealthAnalyzerRuleState 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 SPSearchTopology SPSecureStoreServiceApp SPSecurityTokenServiceConfig SPSelfServiceSiteCreation SPServiceAppPool SPServiceAppProxyGroup SPServiceAppSecurity SPServiceIdentity SPServiceInstance SPSessionStateService SPShellAdmins SPSite 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


     * Changes to SharePointDsc
       * Added support for SharePoint 2019
       * Added CredSSP requirement to the Readme files
       * Added VSCode Support for running SharePoint 2019 unit tests
       * Removed the deprecated resources SPCreateFarm and SPJoinFarm (replaced
         in v2.0 by SPFarm)
     * SPBlobCacheSettings
       * Updated the Service Instance retrieval to be language independent
     * SPConfigWizard
       * Fixed check for Ensure=Absent in the Set method
     * SPInstallPrereqs
       * Added support for detecting updated installation of Microsoft Visual C++
         2015/2017 Redistributable (x64) for SharePoint 2016 and SharePoint 2019.
     * SPSearchContentSource
       * Added support for Business Content Source Type
     * SPSearchMetadataCategory
       * New resource added
     * SPSearchServiceApp
       * Updated resource to make sure the presence of the service app proxy is
         checked and created if it does not exist
     * SPSecurityTokenServiceConfig
       * The resource only tested for the Ensure parameter. Added more parameters
       * SPServiceAppSecurity
       * Added support for specifying array of access levels.
       * Changed implementation to use Grant-SPObjectSecurity with Replace switch
         instead of using a combination of Revoke-SPObjectSecurity and
         Grant-SPObjectSecurity
       * Added all supported access levels as available values.
       * Removed unknown access levels: Change Permissions, Write, and Read
     * SPUserProfileProperty
       * Removed obsolete parameters (MappingConnectionName, MappingPropertyName,
         MappingDirection) and introduced new parameter PropertyMappings
     * SPUserProfileServiceApp
       * Updated the check for successful creation of the service app to throw an
         error if this is not done correctly

     The following changes will break v2.x and earlier configurations that use these
     resources:

     * Implemented IsSingleInstance parameter to force that the resource can only
       be used once in a configuration for the following resources:
       * SPAntivirusSettings
       * SPConfigWizard
       * SPDiagnosticLoggingSettings
       * SPFarm
       * SPFarmAdministrators
       * SPInfoPathFormsServiceConfig
       * SPInstall
       * SPInstallPrereqs
       * SPIrmSettings
       * SPMinRoleCompliance
       * SPPasswordChangeSettings
       * SPProjectServerLicense
       * SPSecurityTokenServiceConfig
       * SPShellAdmin
     * Standardized Url/WebApplication parameter to default WebAppUrl parameter
       for the following resources:
       * SPDesignerSettings
       * SPFarmSolution
       * SPSelfServiceSiteCreation
       * SPWebAppBlockedFileTypes
       * SPWebAppClientCallableSettings
       * SPWebAppGeneralSettings
       * SPWebApplication
       * SPWebApplicationAppDomain
       * SPWebAppSiteUseAndDeletion
       * SPWebAppThrottlingSettings
       * SPWebAppWorkflowSettings
     * Introduced new mandatory parameters
       * SPSearchResultSource: Added option to create Result Sources at different scopes.
       * SPServiceAppSecurity: Changed parameter AccessLevel to AccessLevels in
         MSFT_SPServiceAppSecurityEntry to support array of access levels.
       * SPUserProfileProperty: New parameter PropertyMappings
     

FileList

Version History

Version Downloads Last updated
5.6.0-previe... 5 12/27/2024
5.6.0-previe... 8 11/25/2024
5.5.0 18,400 4/22/2024
5.5.0-previe... 5 4/20/2024
5.5.0-previe... 216 4/25/2023
5.5.0-previe... 5 4/22/2023
5.4.0 28,441 4/4/2023
5.3.1-previe... 5 4/3/2023
5.3.1-previe... 23 3/18/2023
5.3.1-previe... 5 3/17/2023
5.3.0 5,455 11/15/2022
5.2.1-previe... 9 11/10/2022
5.2.0 16,768 5/12/2022
5.2.0-previe... 16 5/12/2022
5.2.0-previe... 18 5/4/2022
5.2.0-previe... 31 4/1/2022
5.2.0-previe... 21 3/26/2022
5.1.0 6,919 2/24/2022
5.1.0-previe... 17 2/24/2022
5.1.0-previe... 19 2/17/2022
5.1.0-previe... 18 2/16/2022
5.1.0-previe... 20 2/11/2022
5.1.0-previe... 16 1/19/2022
5.1.0-previe... 14 1/17/2022
5.0.1-previe... 14 1/11/2022
5.0.1-previe... 18 1/7/2022
5.0.0 29,204 12/17/2021
5.0.0-previe... 14 12/16/2021
4.9.0 9,134 11/6/2021
4.8.1-previe... 14 11/5/2021
4.8.1-previe... 15 11/4/2021
4.8.1-previe... 122 10/3/2021
4.8.0 7,757 8/31/2021
4.8.0-previe... 14 8/31/2021
4.8.0-previe... 14 8/31/2021
4.8.0-previe... 15 8/25/2021
4.8.0-previe... 14 8/25/2021
4.8.0-previe... 23 7/9/2021
4.8.0-previe... 18 6/27/2021
4.7.0 10,210 6/10/2021
4.6.1-previe... 14 6/10/2021
4.6.1-previe... 25 4/12/2021
4.6.1-previe... 17 4/9/2021
4.6.1-previe... 17 4/8/2021
4.6.0 11,403 4/2/2021
4.6.0-previe... 16 4/1/2021
4.6.0-previe... 22 3/25/2021
4.5.1 10,343 2/5/2021
4.5.1-previe... 17 2/4/2021
4.5.0 1,220 1/30/2021
4.5.0-previe... 26 1/8/2021
4.5.0-previe... 21 12/19/2020
4.4.1-previe... 18 11/26/2020
4.4.1-previe... 18 11/18/2020
4.4.0 15,839 11/14/2020
4.4.0-previe... 15 11/14/2020
4.4.0-previe... 15 11/13/2020
4.4.0-previe... 17 11/11/2020
4.4.0-previe... 14 11/11/2020
4.3.1-previe... 18 10/23/2020
4.3.0 10,198 9/30/2020
4.3.0-previe... 14 9/30/2020
4.3.0-previe... 13 9/25/2020
4.3.0-previe... 13 9/25/2020
4.2.1-previe... 24 7/30/2020
4.2.1-previe... 16 7/29/2020
4.2.0 19,699 6/14/2020
4.2.0-previe... 15 6/13/2020
4.1.0 1,437 6/10/2020
4.1.0-previe... 15 6/9/2020
4.1.0-previe... 19 6/2/2020
4.1.0-previe... 22 5/11/2020
4.0.1-previe... 18 5/5/2020
4.0.0 6,780 4/28/2020
4.0.0-previe... 21 4/28/2020
4.0.0-previe... 21 4/28/2020
4.0.0-previe... 24 3/31/2020
4.0.0-previe... 17 3/27/2020
3.9.0-previe... 19 3/19/2020
3.8.0 11,690 2/27/2020
3.8.0-previe... 19 2/25/2020
3.8.0-previe... 21 2/18/2020
3.8.0-previe... 17 2/18/2020
3.8.0-previe... 25 1/24/2020
3.8.0-previe... 17 1/17/2020
3.8.0-previe... 19 1/16/2020
3.7.0.0 23,252 10/30/2019
3.6.0.0 15,614 8/12/2019
3.5.0.0 9,479 6/26/2019
3.4.0.0 10,202 5/15/2019
3.3.0.0 16,546 4/3/2019
3.2.0.0 34,118 2/20/2019
3.1.0.0 4,211 11/29/2018
3.0.0.0 (current version) 1,507 11/12/2018
2.6.0.0 2,775 10/25/2018
2.5.0.0 10,084 9/5/2018
2.4.0.0 10,215 7/25/2018
2.3.0.0 3,627 6/13/2018
2.2.0.0 8,077 3/22/2018
2.1.0.0 3,026 2/8/2018
2.0.0.0 2,716 12/20/2017
1.9.0.0 11,892 10/5/2017
1.8.0.0 7,305 7/12/2017
1.7.0.0 1,291 5/31/2017
1.6.0.0 12,690 3/8/2017
1.5.0.0 1,482 12/14/2016
1.4.0.0 689 11/2/2016
1.3.0.0 875 9/21/2016
1.2.0.0 497 8/10/2016
1.1.0.0 598 6/29/2016
1.0.0.0 298 6/7/2016
Show less