SharePointDSC

4.5.0-preview0001

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

This is a prerelease version of SharePointDSC.
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 4.5.0-preview0001 -AllowPrerelease

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

Author(s)

DSC Community

Copyright

Copyright the DSC Community contributors. All rights reserved.

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

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

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 SPTrustedSecurityTokenIssuer 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 MSFT_SPAccessServiceApp MSFT_SPAccessServices2010 MSFT_SPAlternateUrl MSFT_SPAntivirusSettings MSFT_SPAppCatalog MSFT_SPAppDomain MSFT_SPAppManagementServiceApp MSFT_SPAppStoreSettings MSFT_SPAuthenticationRealm MSFT_SPAzureAccessControlServiceAppProxy MSFT_SPBCSServiceApp MSFT_SPBlobCacheSettings MSFT_SPCacheAccounts MSFT_SPConfigWizard MSFT_SPContentDatabase MSFT_SPDatabaseAAG MSFT_SPDesignerSettings MSFT_SPDiagnosticLoggingSettings MSFT_SPDiagnosticsProvider MSFT_SPDistributedCacheClientSettings MSFT_SPDistributedCacheService MSFT_SPExcelServiceApp MSFT_SPFarm MSFT_SPFarmAdministrators MSFT_SPFarmPropertyBag MSFT_SPFarmSolution MSFT_SPFeature MSFT_SPHealthAnalyzerRuleState MSFT_SPIncomingEmailSettings MSFT_SPInfoPathFormsServiceConfig MSFT_SPInstall MSFT_SPInstallLanguagePack MSFT_SPInstallPrereqs MSFT_SPIrmSettings MSFT_SPLogLevel MSFT_SPMachineTranslationServiceApp MSFT_SPManagedAccount MSFT_SPManagedMetadataServiceApp MSFT_SPManagedMetadataServiceAppDefault MSFT_SPManagedPath MSFT_SPMinRoleCompliance MSFT_SPOAppPrincipalMgmtServiceAppProxy MSFT_SPOfficeOnlineServerBinding MSFT_SPOutgoingEmailSettings MSFT_SPPasswordChangeSettings MSFT_SPPerformancePointServiceApp MSFT_SPPowerPointAutomationServiceApp MSFT_SPProductUpdate MSFT_SPProjectServerAdditionalSettings MSFT_SPProjectServerADResourcePoolSync MSFT_SPProjectServerGlobalPermissions MSFT_SPProjectServerGroup MSFT_SPProjectServerLicense MSFT_SPProjectServerPermissionMode MSFT_SPProjectServerServiceApp MSFT_SPProjectServerTimeSheetSettings MSFT_SPProjectServerUserSyncSettings MSFT_SPProjectServerWssSettings MSFT_SPPublishServiceApplication MSFT_SPQuotaTemplate MSFT_SPRemoteFarmTrust MSFT_SPSearchAuthoritativePage MSFT_SPSearchContentSource MSFT_SPSearchCrawlerImpactRule MSFT_SPSearchCrawlMapping MSFT_SPSearchCrawlRule MSFT_SPSearchFileType MSFT_SPSearchIndexPartition MSFT_SPSearchManagedProperty MSFT_SPSearchMetadataCategory MSFT_SPSearchResultSource MSFT_SPSearchServiceApp MSFT_SPSearchServiceSettings MSFT_SPSearchTopology MSFT_SPSecureStoreServiceApp MSFT_SPSecurityTokenServiceConfig MSFT_SPSelfServiceSiteCreation MSFT_SPServiceAppPool MSFT_SPServiceAppProxyGroup MSFT_SPServiceAppSecurity MSFT_SPServiceIdentity MSFT_SPServiceInstance MSFT_SPSessionStateService MSFT_SPShellAdmins MSFT_SPSite MSFT_SPSitePropertyBag MSFT_SPSiteUrl MSFT_SPStateServiceApp MSFT_SPSubscriptionSettingsServiceApp MSFT_SPTimerJobState MSFT_SPTrustedIdentityTokenIssuer MSFT_SPTrustedIdentityTokenIssuerProviderRealms MSFT_SPTrustedRootAuthority MSFT_SPTrustedSecurityTokenIssuer MSFT_SPUsageApplication MSFT_SPUserProfileProperty MSFT_SPUserProfileSection MSFT_SPUserProfileServiceApp MSFT_SPUserProfileServiceAppPermissions MSFT_SPUserProfileSyncConnection MSFT_SPUserProfileSyncService MSFT_SPVisioServiceApp MSFT_SPWeb MSFT_SPWebAppAuthentication MSFT_SPWebAppBlockedFileTypes MSFT_SPWebAppClientCallableSettings MSFT_SPWebAppGeneralSettings MSFT_SPWebApplication MSFT_SPWebApplicationAppDomain MSFT_SPWebApplicationExtension MSFT_SPWebAppPeoplePickerSettings MSFT_SPWebAppPermissions MSFT_SPWebAppPolicy MSFT_SPWebAppPropertyBag MSFT_SPWebAppProxyGroup MSFT_SPWebAppSiteUseAndDeletion MSFT_SPWebAppSuiteBar MSFT_SPWebAppThrottlingSettings MSFT_SPWebAppWorkflowSettings MSFT_SPWordAutomationServiceApp MSFT_SPWorkflowService MSFT_SPWorkManagementServiceApp

Dependencies

This module has no dependencies.

Release Notes

## [4.5.0-preview0001] - 2020-12-18

### Changed

- SPTrustedIdentityTokenIssuer
 - Do not set property ProviderSignOutUri in SharePoint 2013 as it does
 not exist
- SPUserProfileServiceApp
 - Changed MySiteHostLocation to not be mandatory
 - Added validation to Set function for testing if SiteNamingConflictResolution parameter
   is defined then also MySiteHostLocation parameters has to be because it is a mandatory
   parameter in the parameter set of New-SPProfileServiceApplication when
   SiteNamingConflictResolution is used.
 - Added "MySiteHostLocation" to Test-SPDscParameterState function in Test-TargetResource

### Fixed

- SPWebAppPolicy
 - Fixed a blocking issue introduced in version 4.4.0 when extracting cache
   accounts

Version History

Version Downloads Last updated
5.2.0 1,292 5/12/2022
5.2.0-previe... 4 5/12/2022
5.2.0-previe... 6 5/4/2022
5.2.0-previe... 19 4/1/2022
5.2.0-previe... 8 3/26/2022
5.1.0 6,779 2/24/2022
5.1.0-previe... 5 2/24/2022
5.1.0-previe... 6 2/17/2022
5.1.0-previe... 5 2/16/2022
5.1.0-previe... 8 2/11/2022
5.1.0-previe... 4 1/19/2022
5.1.0-previe... 2 1/17/2022
5.0.1-previe... 2 1/11/2022
5.0.1-previe... 5 1/7/2022
5.0.0 29,135 12/17/2021
5.0.0-previe... 2 12/16/2021
4.9.0 8,885 11/6/2021
4.8.1-previe... 2 11/5/2021
4.8.1-previe... 3 11/4/2021
4.8.1-previe... 110 10/3/2021
4.8.0 7,167 8/31/2021
4.8.0-previe... 2 8/31/2021
4.8.0-previe... 2 8/31/2021
4.8.0-previe... 3 8/25/2021
4.8.0-previe... 2 8/25/2021
4.8.0-previe... 11 7/9/2021
4.8.0-previe... 6 6/27/2021
4.7.0 10,187 6/10/2021
4.6.1-previe... 2 6/10/2021
4.6.1-previe... 13 4/12/2021
4.6.1-previe... 4 4/9/2021
4.6.1-previe... 4 4/8/2021
4.6.0 11,386 4/2/2021
4.6.0-previe... 4 4/1/2021
4.6.0-previe... 9 3/25/2021
4.5.1 10,279 2/5/2021
4.5.1-previe... 5 2/4/2021
4.5.0 1,207 1/30/2021
4.5.0-previe... 13 1/8/2021
4.5.0-previe... (current version) 9 12/19/2020
4.4.1-previe... 6 11/26/2020
4.4.1-previe... 6 11/18/2020
4.4.0 15,824 11/14/2020
4.4.0-previe... 3 11/14/2020
4.4.0-previe... 3 11/13/2020
4.4.0-previe... 5 11/11/2020
4.4.0-previe... 2 11/11/2020
4.3.1-previe... 5 10/23/2020
4.3.0 10,176 9/30/2020
4.3.0-previe... 1 9/30/2020
4.3.0-previe... 1 9/25/2020
4.3.0-previe... 1 9/25/2020
4.2.1-previe... 12 7/30/2020
4.2.1-previe... 3 7/29/2020
4.2.0 19,661 6/14/2020
4.2.0-previe... 3 6/13/2020
4.1.0 1,423 6/10/2020
4.1.0-previe... 3 6/9/2020
4.1.0-previe... 7 6/2/2020
4.1.0-previe... 10 5/11/2020
4.0.1-previe... 6 5/5/2020
4.0.0 6,764 4/28/2020
4.0.0-previe... 9 4/28/2020
4.0.0-previe... 9 4/28/2020
4.0.0-previe... 12 3/31/2020
4.0.0-previe... 5 3/27/2020
3.9.0-previe... 7 3/19/2020
3.8.0 11,670 2/27/2020
3.8.0-previe... 7 2/25/2020
3.8.0-previe... 9 2/18/2020
3.8.0-previe... 5 2/18/2020
3.8.0-previe... 13 1/24/2020
3.8.0-previe... 5 1/17/2020
3.8.0-previe... 7 1/16/2020
3.7.0.0 23,204 10/30/2019
3.6.0.0 15,597 8/12/2019
3.5.0.0 9,465 6/26/2019
3.4.0.0 10,080 5/15/2019
3.3.0.0 16,528 4/3/2019
3.2.0.0 34,103 2/20/2019
3.1.0.0 4,197 11/29/2018
3.0.0.0 1,492 11/12/2018
2.6.0.0 2,756 10/25/2018
2.5.0.0 10,068 9/5/2018
2.4.0.0 10,185 7/25/2018
2.3.0.0 3,608 6/13/2018
2.2.0.0 8,062 3/22/2018
2.1.0.0 3,013 2/8/2018
2.0.0.0 2,700 12/20/2017
1.9.0.0 11,877 10/5/2017
1.8.0.0 7,286 7/12/2017
1.7.0.0 1,278 5/31/2017
1.6.0.0 12,670 3/8/2017
1.5.0.0 1,466 12/14/2016
1.4.0.0 676 11/2/2016
1.3.0.0 862 9/21/2016
1.2.0.0 484 8/10/2016
1.1.0.0 585 6/29/2016
1.0.0.0 282 6/7/2016
Show less