SharePointDsc.psd1

#
# Module manifest for module 'SharePointDsc'
#
# Generated by: Microsoft Corporation
#
# Generated on: 20/06/2018
#

@{

  # Script module or binary module file associated with this manifest.
  # RootModule = ''

  # Version number of this module.
  ModuleVersion        = '4.0.0'

  # ID used to uniquely identify this module
  GUID                 = '6c1176a0-4fac-4134-8ca2-3fa8a21a7b90'

  # Author of this module
  Author               = 'DSC Community'

  # Company or vendor of this module
  CompanyName          = 'DSC Community'

  # Copyright statement for this module
  Copyright            = 'Copyright the DSC Community contributors. All rights reserved.'

  # Description of the functionality provided by this module
  Description          = '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 version of the Windows PowerShell engine required by this module
  PowerShellVersion    = '4.0'

  # Name of the Windows PowerShell host required by this module
  # PowerShellHostName = ''

  # Minimum version of the Windows PowerShell host required by this module
  # PowerShellHostVersion = ''

  # Minimum version of Microsoft .NET Framework required by this module
  # DotNetFrameworkVersion = ''

  # Minimum version of the common language runtime (CLR) required by this module
  # CLRVersion = ''

  # Processor architecture (None, X86, Amd64) required by this module
  # ProcessorArchitecture = ''

  # Modules that must be imported into the global environment prior to importing this module
  # RequiredModules = @()

  # Assemblies that must be loaded prior to importing this module
  # RequiredAssemblies = @()

  # Script files (.ps1) that are run in the caller's environment prior to importing this module.
  # ScriptsToProcess = @()

  # Type files (.ps1xml) to be loaded when importing this module
  # TypesToProcess = @()

  # Format files (.ps1xml) to be loaded when importing this module
  # FormatsToProcess = @()

  # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
  NestedModules        = @("Modules\SharePointDsc.Util\SharePointDsc.Util.psm1")

  # Functions to export from this module
  FunctionsToExport    = @()

  # Cmdlets to export from this module
  CmdletsToExport      = @("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")

  # Variables to export from this module
  VariablesToExport    = @()

  # Aliases to export from this module
  AliasesToExport      = @()

  # DSCResources to export from this module
  DscResourcesToExport = @(
    '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'
  )

  # List of all modules packaged with this module
  # ModuleList = @()

  # List of all files packaged with this module
  # FileList = @()

  # HelpInfo URI of this module
  # HelpInfoURI = ''

  # Default prefix for commands exported from this module. Override the default prefix using Import-Module -prefix.
  # DefaultCommandPrefix = ''

  # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
  PrivateData          = @{

    PSData = @{
      # Tags applied to this module. These help with module discovery in online galleries.
      Tags         = @('DesiredStateConfiguration', 'DSC', 'DSCResourceKit', 'DSCResource')

      # A URL to the license for this module.
      LicenseUri   = 'https://github.com/dsccommunity/SharePointDsc/blob/master/LICENSE'

      # A URL to the main website for this project.
      ProjectUri   = 'https://github.com/dsccommunity/SharePointDsc'

      # A URL to an icon representing this module.
      IconUri      = 'https://dsccommunity.org/images/DSC_Logo_300p.png'

      # ReleaseNotes of this module
      ReleaseNotes = '## [4.0.0-preview0001] - 2020-03-27

### Added

- SharePointDsc
  - Added verbose logging of the test results in the Test method
  - Added function to create SharePointDsc event log and add log entries
  - Added the logging of all test results to the new SharePointDsc event log
  - Added support in several resources for creating/connecting to farm
    and service applications using a (single) SQL-based credential
    instead of the default Windows credentials. Needed when e.g. using
    Azure SQL Managed Instance as SharePoint''s database server.
    UseSQLAuthentication and DatabaseCredentials parameters will need
    to be considered.

### Changed

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

- SPManagedMetaDataServiceAppDefault
  - Updated resource to allow the configuration of default per service application
    proxy groups instead of per farm
- SPSearchContentSource
  - Discontinued CrawlEverything, CrawlFirstOnly and null as allowable CrawlSetting
    values for a SharePoint based content source, requiring CrawlVirtualServers or
    CrawlSites
- SPUserProfileServiceApp
  - Changed the MySiteHostLocation parameter to a required parameter
- SPWebAppAuthentication
  - Updated resource to add support for Basic Authentication

### Fixed

- SPFarmSolution
  - Corrected bug running Solution Job wait for an Absent solution.
  - Corrected bug trying to remove an already Absent solution.
- SPWebAppAuthentication
  - Updated to support passing of null/empty collections for zones not utilized.

### Removed

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

- SPSearchServiceApp
  - Removed the WindowsServiceAccount parameter that was depricated in v3.1
- SPUserProfileSyncService
  - Removed the FarmAccount parameter that was depricated in v2.2

## [3.8.0] - 2020-02-27

### 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

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

## [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).

'


      # Set to a prerelease string value if the release should be a prerelease.
      Prerelease   = 'preview0001'
    } # End of PSData hashtable

  } # End of PrivateData hashtable
}