SharePointDSC

3.8.0-preview0006

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 3.8.0-preview0006 -AllowPrerelease

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

Install-PSResource -Name SharePointDSC -Version 3.8.0-preview0006 -Prerelease

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

Copyright the DSC Community contributors. All rights reserved.

Package Details

Author(s)

  • DSC Community

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

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

Dependencies

This module has no dependencies.

Release Notes

## [3.8.0-preview0006] - 2020-02-25

### Added

- SharePointDsc
 - Added automatic release with a new CI pipeline
 - Updated PULL_REQUEST_TEMPLATE.md to match DSC standard
 - Prepared Conceptual Help and Wiki Content generation
- SPAzureAccessControlServiceAppProxy
 - Added new resource to create Azure Access Control Service Application Proxy
- SPExcelServiceApp
 - Documentation update for SharePoint 2016/2019 deprecation.
- SPInstallPrereqs
 - Documentation update for SharePoint 2019 offline install parameters.
- SPFarm
 - Added possibility to set application credential key.
- SPOAppPrincipalMgmtServiceAppProxy
 - Added new resource to create SharePoint Online Application Principal
   Management Service Application Proxy
- SPTrustedSecurityTokenIssuer
 - Fixed RegisteredIssuerNameRealm not applied if specified.
- SPUserProfileProperty
 - Added IsReplicable property.

### Changed

- SharePointDsc
 - Updated all resources and Invoke-SPDscCommand function to automatically
   load Utils module, which broke with the new CI
 - Extended Convert-SPDscHashtableToString function to support complex types
   in arrays and the CIMInstance type
- SPConfigWizard
 - Updated checks in Set method to make sure the resource also runs when
   a language pack is installed
- SPContentDatabase
 - Updated DatabaseServer parameter to support null value
- SPSearchIndexPartition
 - Updated documentation to specifically mention that each index partition
   requires its own dedicated RootDirectory
- SPUserProfileServiceApp
 - Implemented ability to fix incorrectly linked proxy groups
- SPWebApplicationExtension
 - Forced the conversion of Paths to string

### Deprecated

- None

### Removed

- None

### Fixed

- SharePointDsc
 - Corrected schema.mof files of SPSubscriptionSettingServiceApp and
   SPPasswordChangeSettings resources, which caused failed Wiki generation
- SPSearchContentSource
 - Add CrawlVirtualServers and CrawlSites CrawlSetting for SharePoint content
   sources.
- SPSubscriptionSettingServiceApp
 - Corrected incorrect information in Readme file
- SPUserProfileProperty
 - Fixed typo in user profile property test for IsSearchable.

### Security

- None

## [3.7.0.0] - 2019-10-30

### Added

- None

### Changed

- None

### Deprecated

- None

### Removed

- None

### Fixed

- SPConfigWizard
 - Fixed issue with incorrect check for upgrade status of server
- SPDistributedCacheService
 - Improved error message for inclusion of server name into ServerProvisionOrder
   parameters when Present or change to Ensure Absent
- SPFarm
 - Removed SingleServer as ServerRole, since this is an invalid role.
 - Handle case where null or empty CentralAdministrationUrl is passed in
 - Move CentralAdministrationPort validation into parameter definition
   to work with ReverseDsc
 - Add NotNullOrEmpty parameter validation to CentralAdministrationUrl
 - Fixed error when changing developer dashboard display level.
 - Add support for updating Central Admin Authentication Method
- SPFarmSolution
 - Fix for Web Application scoped solutions.
- SPInstall
 - Fixes a terminating error for sources in weird file shares
 - Corrected issue with incorrectly detecting SharePoint after it
   has been uninstalled
 - Corrected issue with detecting a paused installation
- SPInstallLanguagePack
 - Fixes a terminating error for sources in weird file shares
- SPInstallPrereqs
 - Fixes a terminating error for sources in weird file shares
- SPProductUpdate
 - Fixes a terminating error for sources in weird file shares
 - Corrected incorrect farm detection, added in earlier bugfix
- SPSite
 - Fixed issue with incorrectly updating site OwnerAlias and
   SecondaryOwnerAlias
- SPWebAppAuthentication
 - Fixes issue where Test method return false on NON-US OS.

### Security

- None

## [3.6.0.0] - 2019-08-07

### Added

- SPTrustedSecurityTokenIssuer
 - New resource for configuring OAuth trusts

### Changed

- None

### Deprecated

- None

### Removed

- None

### Fixed

- SharePointDsc generic
 - Added new launch actions to vscode to allow code coverage reports for
   the current unit test file.
- SPFarm
 - Moved check for CentralAdministrationUrl is HTTP to Set method,
   to prevent issues with ReverseDsc
- SPInstall
 - Updated error code checks to force reboot.
- SPProductUpdate
 - Fixes an issue using ShutdownServices when no Farm is available.
- SPTrustedRootAuthority
 - Fixes issue where Set method throws an error because the
   parameter CertificateFilePath is not read correctly.

### Security

- None

For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md).

FileList

Version History

Version Downloads Last updated
5.6.0-previe... 7 11/25/2024
5.5.0 16,498 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,425 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,451 11/15/2022
5.2.1-previe... 9 11/10/2022
5.2.0 16,765 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... (current version) 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 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,304 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