sharepointdsc
Documentation
Table of Contents
Description
This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v4.4.0. The PowerShell module describes itself like this:
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.
For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.
Requirements
This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.
The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.
The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.
All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!
Usage
You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.
For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.
# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
dsc_name => 'foo',
dsc_ensure => present,
# This location is nonsense, can be any valid folder on your
# machine or in a share, any location the SourceLocation param
# for the DSC resource will accept.
dsc_sourcelocation => 'C:\Program Files',
# You must always pass an enum fully lower-cased;
# Puppet is case sensitive even when PowerShell isn't
dsc_installationpolicy => untrusted,
}
dsc_psrepository { 'Trust public gallery':
dsc_name => 'PSGallery',
dsc_ensure => present,
dsc_installationpolicy => trusted,
}
dsc_psmodule { 'Make Ruby manageable via uru':
dsc_name => 'RubyInstaller',
dsc_ensure => present,
}
For more information about using a built module, check out our narrative documentation.
Properties
Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc.
If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example,
specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies,
before, etc).
Troubleshooting
In general, there are three broad categories of problems:
- Problems with the way the underlying DSC resource works.
- Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
- Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found
Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.
Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.
Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet>
with <value received by DSC>
.
In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives.
We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module.
Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.
For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.
Known Limitations
Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc
module is not compatible with this or any auto-generated DSC module.
Inclusion of both will lead to pluginsync conflicts.
Reference
Table of Contents
Resource types
dsc_spaccessserviceapp
: The DSC SPAccessServiceApp resource type. Automatically generated from version 4.4.0dsc_spaccessservices2010
: The DSC SPAccessServices2010 resource type. Automatically generated from version 4.4.0dsc_spalternateurl
: The DSC SPAlternateUrl resource type. Automatically generated from version 4.4.0dsc_spantivirussettings
: The DSC SPAntivirusSettings resource type. Automatically generated from version 4.4.0dsc_spappcatalog
: The DSC SPAppCatalog resource type. Automatically generated from version 4.4.0dsc_spappdomain
: The DSC SPAppDomain resource type. Automatically generated from version 4.4.0dsc_spappmanagementserviceapp
: The DSC SPAppManagementServiceApp resource type. Automatically generated from version 4.4.0dsc_spappstoresettings
: The DSC SPAppStoreSettings resource type. Automatically generated from version 4.4.0dsc_spauthenticationrealm
: The DSC SPAuthenticationRealm resource type. Automatically generated from version 4.4.0dsc_spazureaccesscontrolserviceappproxy
: The DSC SPAzureAccessControlServiceAppProxy resource type. Automatically generated from version 4.4.0dsc_spbcsserviceapp
: The DSC SPBCSServiceApp resource type. Automatically generated from version 4.4.0dsc_spblobcachesettings
: The DSC SPBlobCacheSettings resource type. Automatically generated from version 4.4.0dsc_spcacheaccounts
: The DSC SPCacheAccounts resource type. Automatically generated from version 4.4.0dsc_spconfigwizard
: The DSC SPConfigWizard resource type. Automatically generated from version 4.4.0dsc_spcontentdatabase
: The DSC SPContentDatabase resource type. Automatically generated from version 4.4.0dsc_spdatabaseaag
: The DSC SPDatabaseAAG resource type. Automatically generated from version 4.4.0dsc_spdesignersettings
: The DSC SPDesignerSettings resource type. Automatically generated from version 4.4.0dsc_spdiagnosticloggingsettings
: The DSC SPDiagnosticLoggingSettings resource type. Automatically generated from version 4.4.0dsc_spdiagnosticsprovider
: The DSC SPDiagnosticsProvider resource type. Automatically generated from version 4.4.0dsc_spdistributedcacheclientsettings
: The DSC SPDistributedCacheClientSettings resource type. Automatically generated from version 4.4.0dsc_spdistributedcacheservice
: The DSC SPDistributedCacheService resource type. Automatically generated from version 4.4.0dsc_spexcelserviceapp
: The DSC SPExcelServiceApp resource type. Automatically generated from version 4.4.0dsc_spfarm
: The DSC SPFarm resource type. Automatically generated from version 4.4.0dsc_spfarmadministrators
: The DSC SPFarmAdministrators resource type. Automatically generated from version 4.4.0dsc_spfarmpropertybag
: The DSC SPFarmPropertyBag resource type. Automatically generated from version 4.4.0dsc_spfarmsolution
: The DSC SPFarmSolution resource type. Automatically generated from version 4.4.0dsc_spfeature
: The DSC SPFeature resource type. Automatically generated from version 4.4.0dsc_sphealthanalyzerrulestate
: The DSC SPHealthAnalyzerRuleState resource type. Automatically generated from version 4.4.0dsc_spincomingemailsettings
: The DSC SPIncomingEmailSettings resource type. Automatically generated from version 4.4.0dsc_spinfopathformsserviceconfig
: The DSC SPInfoPathFormsServiceConfig resource type. Automatically generated from version 4.4.0dsc_spinstall
: The DSC SPInstall resource type. Automatically generated from version 4.4.0dsc_spinstalllanguagepack
: The DSC SPInstallLanguagePack resource type. Automatically generated from version 4.4.0dsc_spinstallprereqs
: The DSC SPInstallPrereqs resource type. Automatically generated from version 4.4.0dsc_spirmsettings
: The DSC SPIrmSettings resource type. Automatically generated from version 4.4.0dsc_sploglevel
: The DSC SPLogLevel resource type. Automatically generated from version 4.4.0dsc_spmachinetranslationserviceapp
: The DSC SPMachineTranslationServiceApp resource type. Automatically generated from version 4.4.0dsc_spmanagedaccount
: The DSC SPManagedAccount resource type. Automatically generated from version 4.4.0dsc_spmanagedmetadataserviceapp
: The DSC SPManagedMetaDataServiceApp resource type. Automatically generated from version 4.4.0dsc_spmanagedmetadataserviceappdefault
: The DSC SPManagedMetaDataServiceAppDefault resource type. Automatically generated from version 4.4.0dsc_spmanagedpath
: The DSC SPManagedPath resource type. Automatically generated from version 4.4.0dsc_spminrolecompliance
: The DSC SPMinRoleCompliance resource type. Automatically generated from version 4.4.0dsc_spoappprincipalmgmtserviceappproxy
: The DSC SPOAppPrincipalMgmtServiceAppProxy resource type. Automatically generated from version 4.4.0dsc_spofficeonlineserverbinding
: The DSC SPOfficeOnlineServerBinding resource type. Automatically generated from version 4.4.0dsc_spoutgoingemailsettings
: The DSC SPOutgoingEmailSettings resource type. Automatically generated from version 4.4.0dsc_sppasswordchangesettings
: The DSC SPPasswordChangeSettings resource type. Automatically generated from version 4.4.0dsc_spperformancepointserviceapp
: The DSC SPPerformancePointServiceApp resource type. Automatically generated from version 4.4.0dsc_sppowerpointautomationserviceapp
: The DSC SPPowerPointAutomationServiceApp resource type. Automatically generated from version 4.4.0dsc_spproductupdate
: The DSC SPProductUpdate resource type. Automatically generated from version 4.4.0dsc_spprojectserveradditionalsettings
: The DSC SPProjectServerAdditionalSettings resource type. Automatically generated from version 4.4.0dsc_spprojectserveradresourcepoolsync
: The DSC SPProjectServerADResourcePoolSync resource type. Automatically generated from version 4.4.0dsc_spprojectserverglobalpermissions
: The DSC SPProjectServerGlobalPermissions resource type. Automatically generated from version 4.4.0dsc_spprojectservergroup
: The DSC SPProjectServerGroup resource type. Automatically generated from version 4.4.0dsc_spprojectserverlicense
: The DSC SPProjectServerLicense resource type. Automatically generated from version 4.4.0dsc_spprojectserverpermissionmode
: The DSC SPProjectServerPermissionMode resource type. Automatically generated from version 4.4.0dsc_spprojectserverserviceapp
: The DSC SPProjectServerServiceApp resource type. Automatically generated from version 4.4.0dsc_spprojectservertimesheetsettings
: The DSC SPProjectServerTimeSheetSettings resource type. Automatically generated from version 4.4.0dsc_spprojectserverusersyncsettings
: The DSC SPProjectServerUserSyncSettings resource type. Automatically generated from version 4.4.0dsc_spprojectserverwsssettings
: The DSC SPProjectServerWssSettings resource type. Automatically generated from version 4.4.0dsc_sppublishserviceapplication
: The DSC SPPublishServiceApplication resource type. Automatically generated from version 4.4.0dsc_spquotatemplate
: The DSC SPQuotaTemplate resource type. Automatically generated from version 4.4.0dsc_spremotefarmtrust
: The DSC SPRemoteFarmTrust resource type. Automatically generated from version 4.4.0dsc_spsearchauthoritativepage
: The DSC SPSearchAuthoritativePage resource type. Automatically generated from version 4.4.0dsc_spsearchcontentsource
: The DSC SPSearchContentSource resource type. Automatically generated from version 4.4.0dsc_spsearchcrawlerimpactrule
: The DSC SPSearchCrawlerImpactRule resource type. Automatically generated from version 4.4.0dsc_spsearchcrawlmapping
: The DSC SPSearchCrawlMapping resource type. Automatically generated from version 4.4.0dsc_spsearchcrawlrule
: The DSC SPSearchCrawlRule resource type. Automatically generated from version 4.4.0dsc_spsearchfiletype
: The DSC SPSearchFileType resource type. Automatically generated from version 4.4.0dsc_spsearchindexpartition
: The DSC SPSearchIndexPartition resource type. Automatically generated from version 4.4.0dsc_spsearchmanagedproperty
: The DSC SPSearchManagedProperty resource type. Automatically generated from version 4.4.0dsc_spsearchmetadatacategory
: The DSC SPSearchMetadataCategory resource type. Automatically generated from version 4.4.0dsc_spsearchresultsource
: The DSC SPSearchResultSource resource type. Automatically generated from version 4.4.0dsc_spsearchserviceapp
: The DSC SPSearchServiceApp resource type. Automatically generated from version 4.4.0dsc_spsearchservicesettings
: The DSC SPSearchServiceSettings resource type. Automatically generated from version 4.4.0dsc_spsearchtopology
: The DSC SPSearchTopology resource type. Automatically generated from version 4.4.0dsc_spsecurestoreserviceapp
: The DSC SPSecureStoreServiceApp resource type. Automatically generated from version 4.4.0dsc_spsecuritytokenserviceconfig
: The DSC SPSecurityTokenServiceConfig resource type. Automatically generated from version 4.4.0dsc_spselfservicesitecreation
: The DSC SPSelfServiceSiteCreation resource type. Automatically generated from version 4.4.0dsc_spserviceapppool
: The DSC SPServiceAppPool resource type. Automatically generated from version 4.4.0dsc_spserviceappproxygroup
: The DSC SPServiceAppProxyGroup resource type. Automatically generated from version 4.4.0dsc_spserviceappsecurity
: The DSC SPServiceAppSecurity resource type. Automatically generated from version 4.4.0dsc_spserviceidentity
: The DSC SPServiceIdentity resource type. Automatically generated from version 4.4.0dsc_spserviceinstance
: The DSC SPServiceInstance resource type. Automatically generated from version 4.4.0dsc_spsessionstateservice
: The DSC SPSessionStateService resource type. Automatically generated from version 4.4.0dsc_spshelladmins
: The DSC SPShellAdmins resource type. Automatically generated from version 4.4.0dsc_spsite
: The DSC SPSite resource type. Automatically generated from version 4.4.0dsc_spsitepropertybag
: The DSC SPSitePropertyBag resource type. Automatically generated from version 4.4.0dsc_spsiteurl
: The DSC SPSiteUrl resource type. Automatically generated from version 4.4.0dsc_spstateserviceapp
: The DSC SPStateServiceApp resource type. Automatically generated from version 4.4.0dsc_spsubscriptionsettingsserviceapp
: The DSC SPSubscriptionSettingsServiceApp resource type. Automatically generated from version 4.4.0dsc_sptimerjobstate
: The DSC SPTimerJobState resource type. Automatically generated from version 4.4.0dsc_sptrustedidentitytokenissuer
: The DSC SPTrustedIdentityTokenIssuer resource type. Automatically generated from version 4.4.0dsc_sptrustedidentitytokenissuerproviderrealms
: The DSC SPTrustedIdentityTokenIssuerProviderRealms resource type. Automatically generated from version 4.4.0dsc_sptrustedrootauthority
: The DSC SPTrustedRootAuthority resource type. Automatically generated from version 4.4.0dsc_sptrustedsecuritytokenissuer
: The DSC SPTrustedSecurityTokenIssuer resource type. Automatically generated from version 4.4.0dsc_spusageapplication
: The DSC SPUsageApplication resource type. Automatically generated from version 4.4.0dsc_spuserprofileproperty
: The DSC SPUserProfileProperty resource type. Automatically generated from version 4.4.0dsc_spuserprofilesection
: The DSC SPUserProfileSection resource type. Automatically generated from version 4.4.0dsc_spuserprofileserviceapp
: The DSC SPUserProfileServiceApp resource type. Automatically generated from version 4.4.0dsc_spuserprofileserviceapppermissions
: The DSC SPUserProfileServiceAppPermissions resource type. Automatically generated from version 4.4.0dsc_spuserprofilesyncconnection
: The DSC SPUserProfileSyncConnection resource type. Automatically generated from version 4.4.0dsc_spuserprofilesyncservice
: The DSC SPUserProfileSyncService resource type. Automatically generated from version 4.4.0dsc_spvisioserviceapp
: The DSC SPVisioServiceApp resource type. Automatically generated from version 4.4.0dsc_spweb
: The DSC SPWeb resource type. Automatically generated from version 4.4.0dsc_spwebappauthentication
: The DSC SPWebAppAuthentication resource type. Automatically generated from version 4.4.0dsc_spwebappblockedfiletypes
: The DSC SPWebAppBlockedFileTypes resource type. Automatically generated from version 4.4.0dsc_spwebappclientcallablesettings
: The DSC SPWebAppClientCallableSettings resource type. Automatically generated from version 4.4.0dsc_spwebappgeneralsettings
: The DSC SPWebAppGeneralSettings resource type. Automatically generated from version 4.4.0dsc_spwebapplication
: The DSC SPWebApplication resource type. Automatically generated from version 4.4.0dsc_spwebapplicationappdomain
: The DSC SPWebApplicationAppDomain resource type. Automatically generated from version 4.4.0dsc_spwebapplicationextension
: The DSC SPWebApplicationExtension resource type. Automatically generated from version 4.4.0dsc_spwebapppeoplepickersettings
: The DSC SPWebAppPeoplePickerSettings resource type. Automatically generated from version 4.4.0dsc_spwebapppermissions
: The DSC SPWebAppPermissions resource type. Automatically generated from version 4.4.0dsc_spwebapppolicy
: The DSC SPWebAppPolicy resource type. Automatically generated from version 4.4.0dsc_spwebapppropertybag
: The DSC SPWebAppPropertyBag resource type. Automatically generated from version 4.4.0dsc_spwebappproxygroup
: The DSC SPWebAppProxyGroup resource type. Automatically generated from version 4.4.0dsc_spwebappsiteuseanddeletion
: The DSC SPWebAppSiteUseAndDeletion resource type. Automatically generated from version 4.4.0dsc_spwebappsuitebar
: The DSC SPWebAppSuiteBar resource type. Automatically generated from version 4.4.0dsc_spwebappthrottlingsettings
: The DSC SPWebAppThrottlingSettings resource type. Automatically generated from version 4.4.0dsc_spwebappworkflowsettings
: The DSC SPWebAppWorkflowSettings resource type. Automatically generated from version 4.4.0dsc_spwordautomationserviceapp
: The DSC SPWordAutomationServiceApp resource type. Automatically generated from version 4.4.0dsc_spworkflowservice
: The DSC SPWorkflowService resource type. Automatically generated from version 4.4.0dsc_spworkmanagementserviceapp
: The DSC SPWorkManagementServiceApp resource type. Automatically generated from version 4.4.0
Resource types
dsc_spaccessserviceapp
The DSC SPAccessServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spaccessserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool to run the service app in
dsc_databaseserver
Data type: String
The name of the database server to host Access Services databases
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
Parameters
The following parameters are available in the dsc_spaccessserviceapp
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spaccessservices2010
The DSC SPAccessServices2010 resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spaccessservices2010
type.
dsc_applicationpool
Data type: String
The name of the application pool to run the service app in
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
Parameters
The following parameters are available in the dsc_spaccessservices2010
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run thsi resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spalternateurl
The DSC SPAlternateUrl resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spalternateurl
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures the URL is set for this zone on this web app, Absent ensures it is removed
dsc_internal
Data type: Optional[Boolean]
Specifies if the URL has to be configured as internal
Parameters
The following parameters are available in the dsc_spalternateurl
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The new alternate URL
dsc_webappname
namevar
Data type: String
The name of the web application to apply the alternate URL to
dsc_zone
namevar
Data type: Enum['Default', 'Intranet', 'Extranet', 'Custom', 'Internet']
The Zone to use for the alternate URL
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spantivirussettings
The DSC SPAntivirusSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spantivirussettings
type.
dsc_allowdownloadinfected
Data type: Optional[Boolean]
Should documents that are infected be allowed to be downloaded
dsc_attempttoclean
Data type: Optional[Boolean]
Should infected documents be handed to the AV engine to attempt cleaning
dsc_numberofthreads
Data type: Optional[Integer[0, 65535]]
How many concurrent threads should the AV engine be able to run on a server
dsc_scanondownload
Data type: Optional[Boolean]
Should documents be scanned before being downloaded
dsc_scanonupload
Data type: Optional[Boolean]
Should documents be scanned on upload
dsc_timeoutduration
Data type: Optional[Integer[0, 65535]]
What is the timeout for an AV scan in seconds
Parameters
The following parameters are available in the dsc_spantivirussettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spappcatalog
The DSC SPAppCatalog resource type. Automatically generated from version 4.4.0
Parameters
The following parameters are available in the dsc_spappcatalog
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_siteurl
namevar
Data type: String
The URL of the site collection that will be the app catalog for the web app that it is in
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spappdomain
The DSC SPAppDomain resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spappdomain
type.
dsc_prefix
Data type: String
The prefix to go on to app URLs
Parameters
The following parameters are available in the dsc_spappdomain
type.
dsc_appdomain
namevar
Data type: String
The domain name for apps to use in this farm
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spappmanagementserviceapp
The DSC SPAppManagementServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spappmanagementserviceapp
type.
dsc_applicationpool
Data type: String
The app pool that should be used to run the service app
dsc_databasename
Data type: Optional[String]
The name of the database for the service application
dsc_databaseserver
Data type: Optional[String]
The name of the server for the database
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spappmanagementserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the app management service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spappstoresettings
The DSC SPAppStoreSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spappstoresettings
type.
dsc_allowapppurchases
Data type: Optional[Boolean]
Specifies if App Purchases from the SharePoint Store are allowed
dsc_allowappsforoffice
Data type: Optional[Boolean]
Specifies if App Purchases for Office applications are allowed
Parameters
The following parameters are available in the dsc_spappstoresettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spauthenticationrealm
The DSC SPAuthenticationRealm resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spauthenticationrealm
type.
dsc_authenticationrealm
Data type: String
The authentication realm to be set
Parameters
The following parameters are available in the dsc_spauthenticationrealm
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spazureaccesscontrolserviceappproxy
The DSC SPAzureAccessControlServiceAppProxy resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spazureaccesscontrolserviceappproxy
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app proxy exists, absent ensures it is removed
dsc_metadataserviceendpointuri
Data type: String
Specifies the URL of the Azure Access Control Service's metadata document.
Parameters
The following parameters are available in the dsc_spazureaccesscontrolserviceappproxy
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the Azure Access Control service application proxy
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spbcsserviceapp
The DSC SPBCSServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spbcsserviceapp
type.
dsc_applicationpool
Data type: String
The application pool it should run in
dsc_databasename
Data type: Optional[String]
Name of the database to create for the service app
dsc_databaseserver
Data type: Optional[String]
Name of the database server to host the database on
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
dsc_proxyname
Data type: Optional[String]
The name of the BCS service application proxy
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spbcsserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the BCS service app
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spblobcachesettings
The DSC SPBlobCacheSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spblobcachesettings
type.
dsc_enablecache
Data type: Boolean
Specify if the blob cache has to be enabled
dsc_filetypes
Data type: Optional[String]
Specify the file types that must be stored by the blob cache
dsc_location
Data type: Optional[String]
The location where the blob cache has to store its files
dsc_maxageinseconds
Data type: Optional[Integer[0, 4294967295]]
The maximum age (in seconds) that a browser caches a blob
dsc_maxsizeingb
Data type: Optional[Integer[0, 65535]]
The maximum size (in GB) of disk space the blob cache is allowed to use
Parameters
The following parameters are available in the dsc_spblobcachesettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
dsc_zone
namevar
Data type: Enum['Default', 'Intranet', 'Internet', 'Custom', 'Extranet']
The zone of the web application for which blob cache has to be configured
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spcacheaccounts
The DSC SPCacheAccounts resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spcacheaccounts
type.
dsc_setwebapppolicy
Data type: Optional[Boolean]
Should the web app policy be set for these accounts?
dsc_superreaderalias
Data type: String
The account name for the super reader
dsc_superuseralias
Data type: String
The account name for the super user
Parameters
The following parameters are available in the dsc_spcacheaccounts
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application to set the accounts for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spconfigwizard
The DSC SPConfigWizard resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spconfigwizard
type.
dsc_databaseupgradedays
Data type: Optional[Array[Enum['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun']]]
Specify on which dates running the Configuration Wizard is allowed
dsc_databaseupgradetime
Data type: Optional[String]
Specify in which time frame running the Configuration Wizard is allowed
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to run the Configuration Wizard. Absent is currently not supported
Parameters
The following parameters are available in the dsc_spconfigwizard
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spcontentdatabase
The DSC SPContentDatabase resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spcontentdatabase
type.
dsc_databaseserver
Data type: Optional[String]
The name of the database server to host the content DB
dsc_enabled
Data type: Optional[Boolean]
Should the database be enabled
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to create this database, absent to ensure it does not exist
dsc_maximumsitecount
Data type: Optional[Integer[0, 65535]]
Specify the site collection maximum limit for the content database
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
dsc_warningsitecount
Data type: Optional[Integer[0, 65535]]
Specify the site collection warning limit for the content database
dsc_webappurl
Data type: String
The URL of the web application
Parameters
The following parameters are available in the dsc_spcontentdatabase
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Specifies the name of the content database
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spdatabaseaag
The DSC SPDatabaseAAG resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spdatabaseaag
type.
dsc_agname
Data type: String
Name of the AlwaysOn group on the SQL server - this must already exist
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the database should be in this AlwaysOn group, or Absent if it should not be in the group
dsc_fileshare
Data type: Optional[String]
The fileshare to use for the SQL backup when adding to the group
Parameters
The following parameters are available in the dsc_spdatabaseaag
type.
dsc_databasename
namevar
Data type: String
The name of the database to put in the AlwaysOn group
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spdesignersettings
The DSC SPDesignerSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spdesignersettings
type.
dsc_allowcreatedeclarativeworkflow
Data type: Optional[Boolean]
Allow users to create declarative workflows with SharePoint Designer
dsc_allowcustomisemasterpage
Data type: Optional[Boolean]
Allow masterpages to be changed by SharePoint Designer
dsc_allowdetachpagesfromdefinition
Data type: Optional[Boolean]
Allow pages to be un-ghosted by SharePoint Designer
dsc_allowmanagesiteurlstructure
Data type: Optional[Boolean]
Allow site URL structure to be changed by SharePoint Designer
dsc_allowsavedeclarativeworkflowastemplate
Data type: Optional[Boolean]
Allow users to save declarative workflows as a template from SharePoint Designer
dsc_allowsavepublishdeclarativeworkflow
Data type: Optional[Boolean]
Allow users to save and re-publish declarative workflows with SharePoint Designer
dsc_allowsharepointdesigner
Data type: Optional[Boolean]
Allow the use of SharePoint Designer
dsc_settingsscope
Data type: Enum['WebApplication', 'SiteCollection']
Define the scope of the configuration - either WebApplication or SiteCollection
Parameters
The following parameters are available in the dsc_spdesignersettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application or site collection to configure
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spdiagnosticloggingsettings
The DSC SPDiagnosticLoggingSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spdiagnosticloggingsettings
type.
dsc_appanalyticsautomaticuploadenabled
Data type: Optional[Boolean]
Should app analytics automatically be uploaded
dsc_customerexperienceimprovementprogramenabled
Data type: Optional[Boolean]
Should the customer experience program be enabled in this farm
dsc_daystokeeplogs
Data type: Optional[Integer[0, 4294967295]]
How many days should ULS logs be kept for
dsc_downloaderrorreportingupdatesenabled
Data type: Optional[Boolean]
Should updates to error reporting tools be automatically downloaded
dsc_errorreportingautomaticuploadenabled
Data type: Optional[Boolean]
Should error reports be automatically uploaded
dsc_errorreportingenabled
Data type: Optional[Boolean]
Should reporting of errors be enabled
dsc_eventlogfloodprotectionenabled
Data type: Optional[Boolean]
Protect event logs with Event Log Flood Protection
dsc_eventlogfloodprotectionnotifyinterval
Data type: Optional[Integer[0, 4294967295]]
What interval should the event logs report a flood event
dsc_eventlogfloodprotectionquietperiod
Data type: Optional[Integer[0, 4294967295]]
What quiet period should reset the event log flood protection thresholds
dsc_eventlogfloodprotectionthreshold
Data type: Optional[Integer[0, 4294967295]]
What is the event log flood protection threshold
dsc_eventlogfloodprotectiontriggerperiod
Data type: Optional[Integer[0, 4294967295]]
What is the time period that will trigger event log flood protection
dsc_logcutinterval
Data type: Optional[Integer[0, 4294967295]]
How many minutes of activity will a ULS log file leep in an individual file
dsc_logmaxdiskspaceusageenabled
Data type: Optional[Boolean]
Will the maximum disk space setting be enabled
dsc_logpath
Data type: String
The physical path on each server to store ULS logs
dsc_logspaceingb
Data type: Integer[0, 4294967295]
The space in GB that should be used to store ULS logs
dsc_scripterrorreportingdelay
Data type: Optional[Integer[0, 4294967295]]
What delay will be set before script error reporting is triggered
dsc_scripterrorreportingenabled
Data type: Optional[Boolean]
Is script error reporting enabled in this farm
dsc_scripterrorreportingrequireauth
Data type: Optional[Boolean]
Require users to be authenticated to allow script errors to be reported
Parameters
The following parameters are available in the dsc_spdiagnosticloggingsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spdiagnosticsprovider
The DSC SPDiagnosticsProvider resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spdiagnosticsprovider
type.
dsc_enabled
Data type: Optional[Boolean]
True enables the Diagnostics Provider
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to configure the diagnostics provider
dsc_maxtotalsizeinbytes
Data type: Optional[Integer[0, 18446744073709551615]]
Sets the maximum retention size in bytes
dsc_retention
Data type: Optional[Integer[0, 65535]]
Sets the retention period in days
Parameters
The following parameters are available in the dsc_spdiagnosticsprovider
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Name of the Diagnostics Provider to configure
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spdistributedcacheclientsettings
The DSC SPDistributedCacheClientSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spdistributedcacheclientsettings
type.
dsc_dacchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Access Cache
dsc_dacmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Access Cache
dsc_dacrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Access Cache
dsc_dafcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Activity Feed LMT Cache
dsc_dafchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Activity Feed Cache
dsc_dafcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Activity Feed LMT Cache
dsc_dafcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Activity Feed LMT Cache
dsc_dafmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Activity Feed Cache
dsc_dafrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Activity Feed Cache
dsc_dbcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Bouncer Cache
dsc_dbcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Bouncer Cache
dsc_dbcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Bouncer Cache
dsc_ddcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Default Cache
dsc_ddcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Default Cache
dsc_ddcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Default Cache
dsc_dfltcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed File Lock Throttler Cache (SP2016 and above)
dsc_dfltcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed File Lock Throttler Cache (SP2016 and above)
dsc_dfltcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed File Lock Throttler Cache (SP2016 and above)
dsc_dhscchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Health Score Cache (SP2016 and above)
dsc_dhscmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Health Score Cache (SP2016 and above)
dsc_dhscrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Health Score Cache (SP2016 and above)
dsc_dltcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Logon Token Cache
dsc_dltcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Logon Token Cache
dsc_dltcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Logon Token Cache
dsc_drtcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Resource Tally Cache (SP2016 and above)
dsc_drtcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Resource Tally Cache (SP2016 and above)
dsc_drtcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Resource Tally Cache (SP2016 and above)
dsc_dscchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Search Cache
dsc_dscmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Search Cache
dsc_dscrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Search Cache
dsc_dstacchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Server to Application Server Cache
dsc_dstacmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Server to Application Server Cache
dsc_dstacrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Server to Application Server Cache
dsc_dswucchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Shared With User Cache (SP2016 and above)
dsc_dswucmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Shared With User Cache (SP2016 and above)
dsc_dswucrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Shared With User Cache (SP2016 and above)
dsc_dtcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Security Trimming Cache
dsc_dtcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Security Trimming Cache
dsc_dtcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Security Trimming Cache
dsc_dugcchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed Unified Groups Cache (SP2016 and above)
dsc_dugcmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed Unified Groups Cache (SP2016 and above)
dsc_dugcrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed Unified Groups Cache (SP2016 and above)
dsc_dvscchannelopentimeout
Data type: Optional[Integer[0, 4294967295]]
Channel timeout for the Distributed View State Cache
dsc_dvscmaxconnectionstoserver
Data type: Optional[Integer[0, 4294967295]]
Maximum number of connections to the Distributed View State Cache
dsc_dvscrequesttimeout
Data type: Optional[Integer[0, 4294967295]]
Request timeout for the Distributed View State Cache
Parameters
The following parameters are available in the dsc_spdistributedcacheclientsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Unique key for the resource. Set to 'Yes' to apply configuration.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spdistributedcacheservice
The DSC SPDistributedCacheService resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spdistributedcacheservice
type.
dsc_cachesizeinmb
Data type: Integer[0, 4294967295]
How many MB should be used for the cache. The maximum supported is 16384
dsc_createfirewallrules
Data type: Boolean
Should the Windows Firewall rules for distributed cache be created?
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to ensure the current server should be running distributed cache, absent to ensure that it isn't running
dsc_serverprovisionorder
Data type: Optional[Array[String]]
A list of servers which specifies the order they should provision the cache in to ensure that two servers do not do it at the same time
dsc_serviceaccount
Data type: String
The name of the service account to run the service as. This should already be registered as a managed account in SharePoint
Parameters
The following parameters are available in the dsc_spdistributedcacheservice
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
A name to assign to this resource - not really used. For example - AppFabricCachingService
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spexcelserviceapp
The DSC SPExcelServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spexcelserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool to run the service app in
dsc_cachingofunusedfilesenable
Data type: Optional[Boolean]
Specifies that files that are no longer used by Excel Services Application can remain in the cache for later use.
dsc_crossdomainaccessallowed
Data type: Optional[Boolean]
Specifies that trusted workbooks and data connection files can be requested and rendered by Web Parts or pages that reside in other HTTP domains.
dsc_encrypteduserconnectionrequired
Data type: Optional[Enum['None', 'Connection']]
Requires that encryption is used between the end-user and the server running Excel Services Application.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
dsc_externaldataconnectionlifetime
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum number of seconds that an external data connection can remain open in the connection pool.
dsc_fileaccessmethod
Data type: Optional[Enum['UseImpersonation', 'UseFileAccessAccount']]
Specifies the authentication method that Excel Services Application uses to retrieve files.
dsc_loadbalancingscheme
Data type: Optional[Enum['RoundRobin', 'Local', 'WorkbookURL']]
Specifies the load-balancing schema that is used by the Excel Services Application Web service application to send requests to different back-end Excel Services Application computers.
dsc_memorycachethreshold
Data type: Optional[Integer[0, 4294967295]]
Specifies the percentage of the maximum private bytes that can be allocated to inactive objects.
dsc_privatebytesmax
Data type: Optional[Integer[-2147483648, 2147483647]]
Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application.
dsc_sessionsperusermax
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum number of sessions allowed for a user.
dsc_sitecollectionanonymoussessionsmax
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum number of anonymous sessions allowed per site collection.
dsc_terminateprocessonaccessviolation
Data type: Optional[Boolean]
Terminates Excel Services Application when an access violation occurs in the process.
dsc_throttleaccessviolationspersitecollection
Data type: Optional[Integer[0, 4294967295]]
Specifies that if a workbook causes an access violation error on Excel Services Application, all files originating from that workbookâ??s site collection are blocked from loading for the specified period (in seconds).
dsc_trustedfilelocations
Data type: Optional[Array[Struct[{ locationtype => Enum['SharePoint', 'UNC', 'HTTP'], description => Optional[String], requestdurationmax => Optional[Integer[0, 4294967295]], shortsessiontimeout => Optional[Integer[0, 4294967295]], udfsallowed => Optional[Boolean], restexternaldataallowed => Optional[Boolean], concurrentdatarequestspersessionmax => Optional[Integer[0, 4294967295]], address => Optional[String], externaldataallowed => Optional[Enum['None', 'Dcl', 'DclandEmbedded']], manualextdatacachelifetime => Optional[Integer[0, 4294967295]], chartandimagesizemax => Optional[Integer[0, 4294967295]], workbooksizemax => Optional[Integer[0, 4294967295]], periodicextdatacachelifetime => Optional[Integer[0, 4294967295]], newworkbooksessiontimeout => Optional[Integer[0, 4294967295]], displaygranularextdataerrors => Optional[Boolean], includechildren => Optional[Boolean], sessiontimeout => Optional[Integer[0, 4294967295]], defaultworkbookcalcmode => Optional[Enum['File', 'Manual', 'Auto', 'AutoDataTables']], abortonrefreshonopenfail => Optional[Boolean], warnondatarefresh => Optional[Boolean], automaticvolatilefunctioncachelifetime => Optional[Integer[0, 4294967295]] }]]]
Trusted file locations for the service app
dsc_unattendedaccountapplicationid
Data type: Optional[String]
Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter.
dsc_unusedobjectagemax
Data type: Optional[Integer[-2147483648, 2147483647]]
Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache.
dsc_workbookcache
Data type: Optional[String]
Specifies the local file system location of the cache that is used to store workbooks that are used by Excel Services Application.
dsc_workbookcachesizemax
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum allowable size, in megabytes, of an individual session.
Parameters
The following parameters are available in the dsc_spexcelserviceapp
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spfarm
The DSC SPFarm resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spfarm
type.
dsc_admincontentdatabasename
Data type: String
The name of the admin content database
dsc_centraladministrationauth
Data type: Optional[Enum['NTLM', 'Kerberos']]
The authentication provider of the CentralAdministration web application
dsc_centraladministrationport
Data type: Optional[Integer[0, 4294967295]]
What port will Central Admin be provisioned to - default is 9999
dsc_centraladministrationurl
Data type: Optional[String]
Vanity URL for Central Administration
dsc_databaseserver
Data type: String
Server that will host the configuration and admin content databases
dsc_developerdashboard
Data type: Optional[Enum['Off', 'On', 'OnDemand']]
Specifies the state of the Developer Dashboard ('OnDemand' is SP2013 only)
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to create/join the farm. Absent is currently not supported
dsc_farmconfigdatabasename
Data type: String
Name of the configuration database
dsc_runcentraladmin
Data type: Boolean
Should the central admin site run on this specific server?
dsc_serverrole
Data type: Optional[Enum['Application', 'ApplicationWithSearch', 'Custom', 'DistributedCache', 'Search', 'SingleServerFarm', 'WebFrontEnd', 'WebFrontEndWithDistributedCache']]
SharePoint 2016 & 2019 only - the MinRole role to enroll this server as
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spfarm
type.
dsc_applicationcredentialkey
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Specifies the application credential key on the local server. Only supported for SP2019.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL login to use to connect to the instance
dsc_farmaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The account to use as the main farm account
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_passphrase
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The passphrase to use to allow servers to join this farm
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spfarmadministrators
The DSC SPFarmAdministrators resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spfarmadministrators
type.
dsc_members
Data type: Optional[Array[String]]
A list of members to set the group to. Those not in this list will be removed
dsc_memberstoexclude
Data type: Optional[Array[String]]
A list of members to remove. Members not in this list will be left in the group
dsc_memberstoinclude
Data type: Optional[Array[String]]
A list of members to add. Members not in this list will be left in the group
Parameters
The following parameters are available in the dsc_spfarmadministrators
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spfarmpropertybag
The DSC SPFarmPropertyBag resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spfarmpropertybag
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Set to present to ensure the SPfarm property exists, or absent to ensure it is removed
dsc_value
Data type: Optional[String]
Value of the SPfarm property bag
Parameters
The following parameters are available in the dsc_spfarmpropertybag
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_key
namevar
Data type: String
The key of the SPFarm property bag
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spfarmsolution
The DSC SPFarmSolution resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spfarmsolution
type.
dsc_deployed
Data type: Optional[Boolean]
Should the solution be deployed to the farm, or just installed to the farm
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the WSP should be deployed, or Absent if it should be removed
dsc_literalpath
Data type: String
The full path to the WSP file
dsc_solutionlevel
Data type: Optional[Enum['14', '15', 'All']]
What compatability level should the WSP be deployed as?
dsc_version
Data type: Optional[String]
The version of the package that is being modified
dsc_webappurls
Data type: Optional[Array[String]]
A list of the web applications to deploy this to
Parameters
The following parameters are available in the dsc_spfarmsolution
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The filename of the WSP package
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spfeature
The DSC SPFeature resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spfeature
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the feature is to be enabled, Absent if it is to be disabled
dsc_featurescope
Data type: Enum['Farm', 'WebApplication', 'Site', 'Web']
The scope to change the feature at - Farm, WebApplication, SiteCollection or Site
dsc_version
Data type: Optional[String]
The version of the feature to check against
Parameters
The following parameters are available in the dsc_spfeature
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the feature
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The URL to change the feature at
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sphealthanalyzerrulestate
The DSC SPHealthAnalyzerRuleState resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sphealthanalyzerrulestate
type.
dsc_enabled
Data type: Boolean
Should the rule be enabled?
dsc_fixautomatically
Data type: Optional[Boolean]
Should the rule fix itself automatically
dsc_rulescope
Data type: Optional[Enum['All Servers', 'Any Server']]
What is the scope of this rule
dsc_schedule
Data type: Optional[Enum['Hourly', 'Daily', 'Weekly', 'Monthly', 'OnDemandOnly']]
How often should the rule check
Parameters
The following parameters are available in the dsc_sphealthanalyzerrulestate
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the rule exactly as it appears in central admin
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spincomingemailsettings
The DSC SPIncomingEmailSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spincomingemailsettings
type.
dsc_distributiongroupsenabled
Data type: Optional[Boolean]
Allow creation of distribution groups from within SharePoint
dsc_dlsrequireauthenticatedsenders
Data type: Optional[Boolean]
SharePoint Distribution lists accept from authenticated senders only
dsc_dropfolder
Data type: Optional[String]
Path to email drop folder if not using Automatic Settings
dsc_ensure
Data type: Enum['Present', 'Absent']
Present ensures Incoming Email is enabled. Absent disables incoming email
dsc_remotedirectorymanagementurl
Data type: Optional[String]
URL to the remote SharePoint Directory Management Web Service
dsc_serveraddress
Data type: Optional[String]
SMTP Server Address when Directory Managment Service mode is used
dsc_serverdisplayaddress
Data type: Optional[String]
Email server display address 'mylist@example.com'
dsc_useautomaticsettings
Data type: Optional[Boolean]
Automatic Settings enables a local SMTP service on the SharePoint server. Set to False to use an external drop folder
dsc_usedirectorymanagementservice
Data type: Optional[Enum['Yes', 'No', 'Remote']]
Set to Yes, the service supports the creation and management of e-mail distribution groups from SharePoint Sites, and creates mail contacts mail enabled SharePoint lists. Set to Remote to use a remote SharePoint Directory Management Web Service
Parameters
The following parameters are available in the dsc_spincomingemailsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spinfopathformsserviceconfig
The DSC SPInfoPathFormsServiceConfig resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spinfopathformsserviceconfig
type.
dsc_activesessionstimeout
Data type: Optional[Integer[0, 65535]]
Timeout in minutes for active sessions
dsc_allowembeddedsqlfordataconnections
Data type: Optional[Boolean]
True sets the InfoPath Forms Service to allow embedded SQL sonnections in Forms
dsc_alloweventpropagation
Data type: Optional[Boolean]
True enables the original performance optimization
dsc_allowudcauthenticationfordataconnections
Data type: Optional[Boolean]
True sets the InfoPath Forms Service to allow User Defined connections
dsc_allowuserformbrowserenabling
Data type: Optional[Boolean]
True sets the InfoPath Forms Service to allow users to browse forms
dsc_allowuserformbrowserrendering
Data type: Optional[Boolean]
True sets the InfoPath Forms Service to render forms in the browser
dsc_allowuserformcrossdomaindataconnections
Data type: Optional[Boolean]
True sets the InfoPath Forms Service to allow Cross-Domain connections
dsc_defaultdataconnectiontimeout
Data type: Optional[Integer[0, 4294967295]]
Sets the default connection timeout in milliseconds
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures the settings are applied
dsc_maxdataconnectionresponsesize
Data type: Optional[Integer[0, 4294967295]]
Sets the maximum response size in kb for the user response
dsc_maxdataconnectiontimeout
Data type: Optional[Integer[0, 4294967295]]
Sets the maximum connection timeout in milliseconds
dsc_maxpostbackspersession
Data type: Optional[Integer[0, 65535]]
Maximum number of postback allowed per session
dsc_maxsizeofuserformstate
Data type: Optional[Integer[0, 65535]]
Maximum size of user session data
dsc_maxuseractionsperpostback
Data type: Optional[Integer[0, 65535]]
Maximum number of actions that can be triggered per postback
dsc_requiresslfordataconnections
Data type: Optional[Boolean]
True sets the InfoPath Forms Service to require SSL for its connections
Parameters
The following parameters are available in the dsc_spinfopathformsserviceconfig
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spinstall
The DSC SPInstall resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spinstall
type.
dsc_binarydir
Data type: String
The directory that contains all of the SharePoint binaries
dsc_datapath
Data type: Optional[String]
The data directory to use in the installation, leave blank to use the setup defaults
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to install SharePoint. Absent is currently not supported
dsc_installpath
Data type: Optional[String]
The install directory to use in the installation, leave blank to use the setup defaults
dsc_productkey
Data type: String
The product key to use during the installation
Parameters
The following parameters are available in the dsc_spinstall
type.
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spinstalllanguagepack
The DSC SPInstallLanguagePack resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spinstalllanguagepack
type.
dsc_binaryinstalldays
Data type: Optional[Array[Enum['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun']]]
Specify on which dates the installation is allowed
dsc_binaryinstalltime
Data type: Optional[String]
Specify in which time frame the installation is allowed
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to install SharePoint. Absent is currently not supported
Parameters
The following parameters are available in the dsc_spinstalllanguagepack
type.
dsc_binarydir
namevar
Data type: String
The directory that contains all of the SharePoint binaries
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spinstallprereqs
The DSC SPInstallPrereqs resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spinstallprereqs
type.
dsc_appfabric
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
dsc_dotnet472
Data type: Optional[String]
The path to the installer for this prerequisite (SP2019 only)
dsc_dotnetfx
Data type: Optional[String]
The path to the installer for this prerequisite (SP2016 only)
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to install the prerequisites. Absent is currently not supported
dsc_idfx
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013 only)
dsc_idfx11
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
dsc_installerpath
Data type: String
The full path to prerequisiteinstaller.exe
dsc_kb2671763
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013 only)
dsc_kb3092423
Data type: Optional[String]
The path to the installer for this prerequisite (SP2016 and SP2019)
dsc_msipcclient
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
dsc_msvcrt11
Data type: Optional[String]
The path to the installer for this prerequisite (SP2016 and SP2019)
dsc_msvcrt14
Data type: Optional[String]
The path to the installer for this prerequisite (SP2016 only)
dsc_msvcrt141
Data type: Optional[String]
The path to the installer for this prerequisite (SP2019 only)
dsc_netfx
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013 only)
dsc_odbc
Data type: Optional[String]
The path to the installer for this prerequisite (SP2016 only)
dsc_onlinemode
Data type: Boolean
Should the installer download prerequisites from the internet or not
dsc_powershell
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013 only)
dsc_sqlncli
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
dsc_sxspath
Data type: Optional[String]
The path to the Windows Server Operating System SXS source files, for use in closed environments without access to Windows Update
dsc_sync
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
dsc_wcfdataservices
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013 only)
dsc_wcfdataservices56
Data type: Optional[String]
The path to the installer for this prerequisite (SP2013, SP2016 and SP2019)
Parameters
The following parameters are available in the dsc_spinstallprereqs
type.
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spirmsettings
The DSC SPIrmSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spirmsettings
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Enable or Disable IRM on this farm
dsc_rmsserver
Data type: Optional[String]
Use the specified RMS server, must provide in URL format
dsc_useadrms
Data type: Optional[Boolean]
Use the RMS server published in this farm's Active Directory
Parameters
The following parameters are available in the dsc_spirmsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sploglevel
The DSC SPLogLevel resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sploglevel
type.
dsc_sploglevelsetting
Data type: Array[Struct[{ eventlevel => Optional[Enum['None', 'ErrorCritical', 'Error', 'Warning', 'Information', 'Verbose', 'Default']], name => Optional[String], tracelevel => Optional[Enum['None', 'Unexpected', 'Monitorable', 'High', 'Medium', 'Verbose', 'VerboseEx', 'Default']], area => Optional[String] }]]
Collection of SPLogLevelItems to set
Parameters
The following parameters are available in the dsc_sploglevel
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Friendly Name used to reference this collection of log level settings
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spmachinetranslationserviceapp
The DSC SPMachineTranslationServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spmachinetranslationserviceapp
type.
dsc_applicationpool
Data type: String
Specifies the application pool to use with the service application.
dsc_databasename
Data type: String
Specifies the name of the database for the service application.
dsc_databaseserver
Data type: String
Specifies the name of the database server for the service application.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spmachinetranslationserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Specifies the name of the service application.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spmanagedaccount
The DSC SPManagedAccount resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spmanagedaccount
type.
dsc_emailnotification
Data type: Optional[Integer[0, 4294967295]]
How many days before a password change should an email be sent
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures managed account exists, absent ensures it is removed
dsc_preexpiredays
Data type: Optional[Integer[0, 4294967295]]
How many days before a password expires should it be changed
dsc_schedule
Data type: Optional[String]
What is the schedule for the password reset
Parameters
The following parameters are available in the dsc_spmanagedaccount
type.
dsc_account
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The credential with password of the account
dsc_accountname
namevar
Data type: String
The username of the account
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spmanagedmetadataserviceapp
The DSC SPManagedMetaDataServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spmanagedmetadataserviceapp
type.
dsc_applicationpool
Data type: String
The application pool that the service app will use
dsc_contenttypehuburl
Data type: Optional[String]
The URL of the content type hub for this app (only set when the app is provisioned)
dsc_contenttypepushdownenabled
Data type: Optional[Boolean]
Specifies that existing instances of changed content types in subsites and libraries will be updated.
dsc_contenttypesyndicationenabled
Data type: Optional[Boolean]
Specifies that this connection will provide access to the content types that are associated with the managed metadata service application.
dsc_databasename
Data type: Optional[String]
The name of the database for the service application
dsc_databaseserver
Data type: Optional[String]
The name of the database server which will host the application
dsc_defaultlanguage
Data type: Optional[Integer[0, 4294967295]]
The LCID of the default language (only set when the app is provisioned)
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
dsc_languages
Data type: Optional[Array[Integer[0, 4294967295]]]
The LCIDs of the working languages (only set when the app is provisioned)
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_termstoreadministrators
Data type: Optional[Array[String]]
A list of the users/groups who are administrators of the term store
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spmanagedmetadataserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the managed metadata service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spmanagedmetadataserviceappdefault
The DSC SPManagedMetaDataServiceAppDefault resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spmanagedmetadataserviceappdefault
type.
dsc_defaultkeywordproxyname
Data type: String
The name of the managed metadata service application proxy used as default keyword terms set
dsc_defaultsitecollectionproxyname
Data type: String
The name of the managed metadata service application proxy used as default column terms set
Parameters
The following parameters are available in the dsc_spmanagedmetadataserviceappdefault
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappproxygroup
namevar
Data type: String
Specifies the Service Application Proxy Group for which to configure the defaults. Use 'default' or the name of the proxy group.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spmanagedpath
The DSC SPManagedPath resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spmanagedpath
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures managed path exists, absent ensures it is removed
dsc_explicit
Data type: Boolean
Should the host header be explicit? If false then it is a wildcard
dsc_hostheader
Data type: Boolean
Is this a host header web application?
Parameters
The following parameters are available in the dsc_spmanagedpath
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_relativeurl
namevar
Data type: String
The relative URL of the managed path
dsc_webappurl
namevar
Data type: String
The URL of the web application to apply the managed path to - this is ignored for host header web applications
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spminrolecompliance
The DSC SPMinRoleCompliance resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spminrolecompliance
type.
dsc_state
Data type: Enum['Compliant', 'NonCompliant']
Should the state be set to compliant
Parameters
The following parameters are available in the dsc_spminrolecompliance
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spoappprincipalmgmtserviceappproxy
The DSC SPOAppPrincipalMgmtServiceAppProxy resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spoappprincipalmgmtserviceappproxy
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app proxy exists, absent ensures it is removed
dsc_onlinetenanturi
Data type: String
URL to SharePoint Online Tenant
Parameters
The following parameters are available in the dsc_spoappprincipalmgmtserviceappproxy
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the SPO application principal management service application proxy
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spofficeonlineserverbinding
The DSC SPOfficeOnlineServerBinding resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spofficeonlineserverbinding
type.
dsc_dnsname
Data type: String
The DNS name of the server/s that are running Office Web Apps
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures the binding for this zone exists, absent ensures it doesn't
Parameters
The following parameters are available in the dsc_spofficeonlineserverbinding
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_zone
namevar
Data type: Enum['Internal-HTTP', 'Internal-HTTPS', 'External-HTTP', 'External-HTTPS']
The zone for this binding
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spoutgoingemailsettings
The DSC SPOutgoingEmailSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spoutgoingemailsettings
type.
dsc_characterset
Data type: String
The character set to use on messages
dsc_fromaddress
Data type: String
The from address to put on messages
dsc_replytoaddress
Data type: String
The email address that replies should be directed to
dsc_smtpport
Data type: Optional[Integer[0, 4294967295]]
The port which is used to connect to the SMTP server (SharePoint 2016 and 2019 only)
dsc_smtpserver
Data type: String
The SMTP server for outgoing mail
dsc_usetls
Data type: Optional[Boolean]
Use TLS when connecting to the SMTP server (SharePoint 2016 and 2019 only)
Parameters
The following parameters are available in the dsc_spoutgoingemailsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application. If you want to set the global settings use the Central Admin URL
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sppasswordchangesettings
The DSC SPPasswordChangeSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sppasswordchangesettings
type.
dsc_daysbeforeexpiry
Data type: Optional[Integer[0, 4294967295]]
The number of days before password expiry to send send emails
dsc_mailaddress
Data type: String
The email address to send notifications of password changes to
dsc_numberofretries
Data type: Optional[Integer[0, 4294967295]]
How many retries if the password change fails
dsc_passwordchangewaittimeseconds
Data type: Optional[Integer[0, 4294967295]]
The duration that a password reset will wait for before it times out
Parameters
The following parameters are available in the dsc_sppasswordchangesettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spperformancepointserviceapp
The DSC SPPerformancePointServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spperformancepointserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool to run the service app in
dsc_databasename
Data type: Optional[String]
The name of the database for the service app
dsc_databaseserver
Data type: Optional[String]
The name of the database server to host the database
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures service app exists, absent ensures it is removed
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spperformancepointserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sppowerpointautomationserviceapp
The DSC SPPowerPointAutomationServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sppowerpointautomationserviceapp
type.
dsc_applicationpool
Data type: Optional[String]
The name of the application pool to run the service app in
dsc_cacheexpirationperiodinseconds
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum time, in seconds, that items remain in the back-end server cache. The default value is 600 seconds (10 minutes).
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Ensure the crawl rule is Present or Absent
dsc_maximumconversionsperworker
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum number of presentations that a conversion worker process can convert before recycling. The default value is 5.
dsc_proxyname
Data type: Optional[String]
The name of the service application proxy
dsc_workerkeepalivetimeoutinseconds
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum time, in seconds, that a conversion worker process can be unresponsive before being terminated. The default value is 120 seconds.
dsc_workerprocesscount
Data type: Optional[Integer[0, 4294967295]]
Specifies the number of active instances of the conversion worker process on each back-end. This value must be less than the Windows Communication Foundation (WCF) connection limit for this computer. The default value is 3.
dsc_workertimeoutinseconds
Data type: Optional[Integer[0, 4294967295]]
Specifies the maximum time, in seconds, that a conversion worker process is given for any single conversion. The default is 300 seconds (5 minutes).
Parameters
The following parameters are available in the dsc_sppowerpointautomationserviceapp
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run thsi resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spproductupdate
The DSC SPProductUpdate resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spproductupdate
type.
dsc_binaryinstalldays
Data type: Optional[Array[Enum['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun']]]
Specify on which dates the installation is allowed
dsc_binaryinstalltime
Data type: Optional[String]
Specify in which time frame the installation is allowed
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to install SharePoint. Absent is currently not supported
dsc_shutdownservices
Data type: Optional[Boolean]
Shutdown SharePoint services to speed up installation
Parameters
The following parameters are available in the dsc_spproductupdate
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_setupfile
namevar
Data type: String
The name of the update setup file
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserveradditionalsettings
The DSC SPProjectServerAdditionalSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserveradditionalsettings
type.
dsc_enforceservercurrency
Data type: Optional[Boolean]
Should all projects be forced to use the server currency?
dsc_projectprofessionalminbuildnumber
Data type: Optional[String]
What is the minimum build number for the Project Professional client that can connect?
dsc_servercurrency
Data type: Optional[String]
What is the default server currency?
Parameters
The following parameters are available in the dsc_spprojectserveradditionalsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to manage settings at
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserveradresourcepoolsync
The DSC SPProjectServerADResourcePoolSync resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserveradresourcepoolsync
type.
dsc_autoreactivateusers
Data type: Optional[Boolean]
Should inactive users found in sync be automatically reactiviated?
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Should the resource sync process be present or absent for this site?
dsc_groupnames
Data type: Optional[Array[String]]
The names of groups in the current domain to sync resources from
Parameters
The following parameters are available in the dsc_spprojectserveradresourcepoolsync
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to set permissions for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserverglobalpermissions
The DSC SPProjectServerGlobalPermissions resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserverglobalpermissions
type.
dsc_allowpermissions
Data type: Optional[Array[String]]
What permissions should be allowed for this entity?
dsc_denypermissions
Data type: Optional[Array[String]]
What permissions should be denied for this entity?
Parameters
The following parameters are available in the dsc_spprojectserverglobalpermissions
type.
dsc_entityname
namevar
Data type: String
The name of the user or group
dsc_entitytype
namevar
Data type: Enum['User', 'Group']
What type of entity are you setting permissions for?
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to manage the group at
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectservergroup
The DSC SPProjectServerGroup resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectservergroup
type.
dsc_adgroup
Data type: Optional[String]
What AD group should be used to synchronise membership to this Project Server group, cannot be used with Members, MembersToInclude or MembersToExclude
dsc_description
Data type: Optional[String]
The description of the group
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_members
Data type: Optional[Array[String]]
A fixed list of members to be in this group, cannot be used with ADGroup, MembersToInclude or MembersToExclude
dsc_memberstoexclude
Data type: Optional[Array[String]]
A list of members to ensure are not in this group, cannot be used with ADGroup or Members
dsc_memberstoinclude
Data type: Optional[Array[String]]
A list of members to ensure are in this group, cannot be used with ADGroup or Members
Parameters
The following parameters are available in the dsc_spprojectservergroup
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the group
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to manage the group at
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserverlicense
The DSC SPProjectServerLicense resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserverlicense
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Should a Project Server license be enabled or disabled
dsc_productkey
Data type: Optional[String]
What is the product key for Project Server
Parameters
The following parameters are available in the dsc_spprojectserverlicense
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserverpermissionmode
The DSC SPProjectServerPermissionMode resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserverpermissionmode
type.
dsc_permissionmode
Data type: Enum['SharePoint', 'ProjectServer']
What permission mode should PWA use
Parameters
The following parameters are available in the dsc_spprojectserverpermissionmode
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to set permissions for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserverserviceapp
The DSC SPProjectServerServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserverserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool to run the service app in
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_proxyname
Data type: Optional[String]
The name of the Project Server Service Application Proxy
Parameters
The following parameters are available in the dsc_spprojectserverserviceapp
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectservertimesheetsettings
The DSC SPProjectServerTimeSheetSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectservertimesheetsettings
type.
dsc_allowfuturetimereporting
Data type: Optional[Boolean]
Allow future time reporting?
dsc_allownewpersonaltasks
Data type: Optional[Boolean]
Allow new personal tasks?
dsc_allowtopleveltimereporting
Data type: Optional[Boolean]
Allow top-level time reporting?
dsc_defaultreportingunit
Data type: Optional[Enum['Hours', 'Days']]
What is the default reporting unit for timesheets
dsc_defaulttimesheetcreationmode
Data type: Optional[Enum['CurrentTaskAssignments', 'CurrentProjects', 'NoPrepopulation']]
What is the default mode for timesheets to be created in
dsc_defaulttrackingmode
Data type: Optional[Enum['PercentComplete', 'ActualDoneAndRemaining', 'HoursPerPeriod', 'FreeForm']]
What is the default tracking mode for tasks?
dsc_defaulttrackingunit
Data type: Optional[Enum['Days', 'Weeks']]
What is the default tracking unit for timesheets
dsc_enableovertimeandnonbillabletracking
Data type: Optional[Boolean]
Should timesheets allow tracking of overtime and non-billable work types
dsc_enabletimesheetauditing
Data type: Optional[Boolean]
Enable timesheet auditing?
dsc_fixedapprovalrouting
Data type: Optional[Boolean]
Enable fixed approval routing?
dsc_forcetrackingmodeforallprojects
Data type: Optional[Boolean]
Force project managers to use the specified tracking mode for each project?
dsc_hoursinstandardday
Data type: Optional[Float]
How many hours are in a standard timesheeet day?
dsc_hoursinstandardweek
Data type: Optional[Float]
How many hours are in a standard timesheeet week?
dsc_maxhoursperday
Data type: Optional[Float]
Maximum hours per day
dsc_maxhourspertimesheet
Data type: Optional[Float]
Maximum hours per timesheet
dsc_minhourspertimesheet
Data type: Optional[Float]
Minimum hours per timesheet
dsc_requirelineapprovalbeforetimesheetapproval
Data type: Optional[Boolean]
Require line approval before timesheet approval?
dsc_requiretaskstatusmanagerapproval
Data type: Optional[Boolean]
Require task status manager approval?
dsc_singleentrymode
Data type: Optional[Boolean]
Enable single entry mode?
Parameters
The following parameters are available in the dsc_spprojectservertimesheetsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to set timesheet settings for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserverusersyncsettings
The DSC SPProjectServerUserSyncSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserverusersyncsettings
type.
dsc_enableprojectsitesync
Data type: Boolean
Enable Project Site Sync
dsc_enableprojectsitesyncforsptasklists
Data type: Boolean
Enable Project Site Sync for SharePoint Task List Projects
dsc_enableprojectwebappsync
Data type: Boolean
Enable Project Web App Sync
Parameters
The following parameters are available in the dsc_spprojectserverusersyncsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to set user sync settings for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spprojectserverwsssettings
The DSC SPProjectServerWssSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spprojectserverwsssettings
type.
dsc_createprojectsitemode
Data type: Enum['AutoCreate', 'UserChoice', 'DontCreate']
How should new SharePoint sites be created?
Parameters
The following parameters are available in the dsc_spprojectserverwsssettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The default zone URL of the Project site to set WSS settings for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sppublishserviceapplication
The DSC SPPublishServiceApplication resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sppublishserviceapplication
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to ensure it runs on this server, or absent to ensure it is stopped
Parameters
The following parameters are available in the dsc_sppublishserviceapplication
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application to publish
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spquotatemplate
The DSC SPQuotaTemplate resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spquotatemplate
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to create this template, absent to ensure it does not exist
dsc_maximumusagepointssolutions
Data type: Optional[Integer[0, 4294967295]]
The maximum number of performance points for sandbox solutions for this template
dsc_storagemaxinmb
Data type: Optional[Integer[0, 4294967295]]
The maximum storage for sites of this template in MB
dsc_storagewarninginmb
Data type: Optional[Integer[0, 4294967295]]
The amount of storage for sites of this template that triggers a warning
dsc_warningusagepointssolutions
Data type: Optional[Integer[0, 4294967295]]
The warning number of performance points for sandbox solutions for this template
Parameters
The following parameters are available in the dsc_spquotatemplate
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the quota template
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spremotefarmtrust
The DSC SPRemoteFarmTrust resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spremotefarmtrust
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Set to present to ensure the trust exists, or absent to ensure it is removed
dsc_localwebappurl
Data type: String
The URL of a local web app to connect the remote farm to
dsc_remotewebappurl
Data type: String
The URL of a web app in the remote farm, must use HTTPS
Parameters
The following parameters are available in the dsc_spremotefarmtrust
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
A name of the remote farm, used to create token issuer and root authority
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchauthoritativepage
The DSC SPSearchAuthoritativePage resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchauthoritativepage
type.
dsc_action
Data type: Optional[Enum['Authoratative', 'Demoted']]
The resource will either make the page authoritative or demoted based on this value
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Ensure the Authoritative is Present or Absent
dsc_level
Data type: Optional[Float]
Level of Authoratitive Page, values between 0.0 and 2.0
Parameters
The following parameters are available in the dsc_spsearchauthoritativepage
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_path
namevar
Data type: String
Source URI for the authoritative page
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
Search Service Application Name
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchcontentsource
The DSC SPSearchContentSource resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchcontentsource
type.
dsc_addresses
Data type: Optional[Array[String]]
A list of the addresses this content source includes
dsc_contentsourcetype
Data type: Enum['SharePoint', 'Website', 'FileShare', 'Business']
The type of content source - currently only SharePoint, Website, File Shares and Business are supported
dsc_continuouscrawl
Data type: Optional[Boolean]
Should this content source use continuous crawl (SharePoint sites only)
dsc_crawlsetting
Data type: Optional[Enum['CrawlEverything', 'CrawlFirstOnly', 'CrawlVirtualServers', 'CrawlSites', 'Custom']]
Should the crawler index everything, just the first site or page, or a custom depth (applies to websites only)
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the source should exist, absent if it should not
dsc_fullschedule
Data type: Optional[Struct[{ crawlschedulemonthsofyear => Optional[Array[Enum['AllMonths', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']]], crawlschedulerepeatinterval => Optional[Integer[0, 4294967295]], crawlscheduledaysofweek => Optional[Array[Enum['Everyday', 'Weekdays', 'Weekends', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']]], crawlschedulerepeatduration => Optional[Integer[0, 4294967295]], crawlscheduleruneveryinterval => Optional[Integer[0, 4294967295]], starthour => Optional[Integer[0, 4294967295]], crawlscheduledaysofmonth => Optional[Integer[0, 4294967295]], scheduletype => Enum['None', 'Daily', 'Weekly', 'Monthly'], startminute => Optional[Integer[0, 4294967295]] }]]
What is the full schedule for this content source
dsc_incrementalschedule
Data type: Optional[Struct[{ crawlschedulemonthsofyear => Optional[Array[Enum['AllMonths', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']]], crawlschedulerepeatinterval => Optional[Integer[0, 4294967295]], crawlscheduledaysofweek => Optional[Array[Enum['Everyday', 'Weekdays', 'Weekends', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']]], crawlschedulerepeatduration => Optional[Integer[0, 4294967295]], crawlscheduleruneveryinterval => Optional[Integer[0, 4294967295]], starthour => Optional[Integer[0, 4294967295]], crawlscheduledaysofmonth => Optional[Integer[0, 4294967295]], scheduletype => Enum['None', 'Daily', 'Weekly', 'Monthly'], startminute => Optional[Integer[0, 4294967295]] }]]
What is the incremental schedule for this content source
dsc_limitpagedepth
Data type: Optional[Integer[0, 4294967295]]
How many pages deep should the crawler go (-1 = unlimited, website sources only)
dsc_limitserverhops
Data type: Optional[Integer[0, 4294967295]]
How many server hops should the crawler make (-1 = unlimtied, website sources only)
dsc_lobsystemset
Data type: Optional[Array[String]]
Line of Business System and System Instance names
dsc_priority
Data type: Optional[Enum['Normal', 'High']]
What is the priority on this content source
Parameters
The following parameters are available in the dsc_spsearchcontentsource
type.
dsc_force
Data type: Optional[Boolean]
Specify true if DSC is allowed to delete and recreate a content source to apply the correct settings, otherwise false will just report errors if a change can not be applied.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the content source
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
The name of the search service app that this content source exists within
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchcrawlerimpactrule
The DSC SPSearchCrawlerImpactRule resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchcrawlerimpactrule
type.
dsc_behavior
Data type: Optional[String]
The Behavior (RequestLimit or WaitTime) for this crawl impact rule
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Ensure the crawl rule is Present or Absent
dsc_requestlimit
Data type: Optional[Integer[0, 4294967295]]
The RequestLimit setting for the crawl impact rule
dsc_waittime
Data type: Optional[Integer[0, 4294967295]]
The WaitTime setting for the crawl impact rule
Parameters
The following parameters are available in the dsc_spsearchcrawlerimpactrule
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The Site for the crawl impact rule
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
Search Service Application Name
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchcrawlmapping
The DSC SPSearchCrawlMapping resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchcrawlmapping
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Ensure the crawl mapping is Present or Absent
dsc_target
Data type: String
Target URI for the crawl mapping
Parameters
The following parameters are available in the dsc_spsearchcrawlmapping
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
Search Service Application Name
dsc_url
namevar
Data type: String
Source URI for the crawl mapping
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchcrawlrule
The DSC SPSearchCrawlRule resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchcrawlrule
type.
dsc_authenticationtype
Data type: Optional[Enum['DefaultRuleAccess', 'BasicAccountRuleAccess', 'CertificateRuleAccess', 'NTLMAccountRuleAccess', 'FormRuleAccess', 'CookieRuleAccess', 'AnonymousAccess']]
Authentication type used by the crawl rule
dsc_certificatename
Data type: Optional[String]
The certificate used for this crawl rule (used for type CertificateRuleAccess)
dsc_crawlconfigurationrules
Data type: Optional[Array[Enum['FollowLinksNoPageCrawl', 'CrawlComplexUrls', 'CrawlAsHTTP']]]
The configuration options for this rule
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the crawl rule should exist, absent if it should not
dsc_ruletype
Data type: Optional[Enum['InclusionRule', 'ExclusionRule']]
The type of the rule
dsc_serviceappname
Data type: String
The name of the search service application
Parameters
The following parameters are available in the dsc_spsearchcrawlrule
type.
dsc_authenticationcredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The credentials used for this crawl rule (used for types BasicAccountRuleAccess and NTLMAccountRuleAccess)
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_path
namevar
Data type: String
The name of the search service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchfiletype
The DSC SPSearchFileType resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchfiletype
type.
dsc_description
Data type: Optional[String]
The description of the file type
dsc_enabled
Data type: Optional[Boolean]
The state of the file type
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the file type should exist, absent if it should not
dsc_mimetype
Data type: Optional[String]
The mime type of the file type
Parameters
The following parameters are available in the dsc_spsearchfiletype
type.
dsc_filetype
namevar
Data type: String
The name of the file type
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
The name of the search service application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchindexpartition
The DSC SPSearchIndexPartition resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchindexpartition
type.
dsc_rootdirectory
Data type: Optional[String]
The directory that the index should use locally on each server to store data
dsc_servers
Data type: Array[String]
A list of the servers that this partition should exist on
Parameters
The following parameters are available in the dsc_spsearchindexpartition
type.
dsc_index
namevar
Data type: Integer[0, 4294967295]
The number of the partition in this farm
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
The name of the search service application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchmanagedproperty
The DSC SPSearchManagedProperty resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchmanagedproperty
type.
dsc_aliases
Data type: Optional[Array[String]]
Aliases of the managed property
dsc_crawledproperties
Data type: Optional[Array[String]]
List of crawled properties that the property is mapped with
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the source should exist, absent if it should not
dsc_hasmultiplevalues
Data type: Optional[Boolean]
Should the property allow for multiple values to be selected
dsc_includeallcrawledproperties
Data type: Optional[Boolean]
Should the property be mapped to all crawled properties
dsc_nowordbreaker
Data type: Optional[Boolean]
Should the property only match exact content
dsc_propertytype
Data type: Enum['Binary', 'DateTime', 'Decimal', 'Double', 'Integer', 'Text', 'YesNo']
The type of managed property - choose between Binary, DateTime, Decimal, Double, Integer, Text, and YesNo
dsc_queryable
Data type: Optional[Boolean]
Should the property be Queryable
dsc_refinable
Data type: Optional[Boolean]
Should the property be Refinable
dsc_retrievable
Data type: Optional[Boolean]
Should the property be Retrievable
dsc_safeforanonymous
Data type: Optional[Boolean]
Should the property be marked as safe for anonymous access
dsc_searchable
Data type: Optional[Boolean]
Should the property be Searchable
dsc_sortable
Data type: Optional[Boolean]
Should the property be Sortable
dsc_tokennormalization
Data type: Optional[Boolean]
Should the property be case sensitive
Parameters
The following parameters are available in the dsc_spsearchmanagedproperty
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the managed property
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
The name of the search service app that this managed property exists within
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchmetadatacategory
The DSC SPSearchMetadataCategory resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchmetadatacategory
type.
dsc_autocreatenewmanagedproperties
Data type: Optional[Boolean]
Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property
dsc_discovernewproperties
Data type: Optional[Boolean]
Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the result source should exist, absent if it should not
dsc_maptocontents
Data type: Optional[Boolean]
Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category.
Parameters
The following parameters are available in the dsc_spsearchmetadatacategory
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the Metadata Category
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
The name of the search service app that this Metadata Category exists within
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchresultsource
The DSC SPSearchResultSource resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchresultsource
type.
dsc_connectionurl
Data type: Optional[String]
The URI to connect to the remote location
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the result source should exist, absent if it should not
dsc_providertype
Data type: String
The provider type to use for the result source
dsc_query
Data type: String
The query to pass to the provider source
dsc_searchserviceappname
Data type: String
The name of the search service application to associate this result source with
Parameters
The following parameters are available in the dsc_spsearchresultsource
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the result source
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_scopename
namevar
Data type: Enum['SSA', 'SPSite', 'SPWeb']
The scope at which the Result Source will be created. Options are SSA, SPSite or SPWeb
dsc_scopeurl
namevar
Data type: String
The URI of the site where to create the result source. Leave empty to have it created globally
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchserviceapp
The DSC SPSearchServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchserviceapp
type.
dsc_alertsenabled
Data type: Optional[Boolean]
Should alerts be enabled for this search service application
dsc_applicationpool
Data type: String
The application pool that it should run in
dsc_cloudindex
Data type: Optional[Boolean]
Should this search service application be a cloud based service app
dsc_databasename
Data type: Optional[String]
The name of the database (noting that some search databases will use this as a prefix)
dsc_databaseserver
Data type: Optional[String]
The server that host the databases for this service application
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_searchcenterurl
Data type: Optional[String]
The URL of the enterprise search center site collection
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spsearchserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_defaultcontentaccessaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The default content access account for this search service app
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the search service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchservicesettings
The DSC SPSearchServiceSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchservicesettings
type.
dsc_contactemail
Data type: Optional[String]
Specifies the contact email used by the crawler
dsc_performancelevel
Data type: Optional[Enum['Reduced', 'PartlyReduced', 'Maximum']]
Specifies the performance level of the crawler
Parameters
The following parameters are available in the dsc_spsearchservicesettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_windowsserviceaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Sets the windows services for search to run as this account
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsearchtopology
The DSC SPSearchTopology resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsearchtopology
type.
dsc_admin
Data type: Array[String]
A list of servers that will run the admin component
dsc_analyticsprocessing
Data type: Array[String]
A list of servers that will run the analytics processing component
dsc_contentprocessing
Data type: Array[String]
A list of servers that will run the content processing component
dsc_crawler
Data type: Array[String]
A list of servers that will run the crawler component
dsc_firstpartitiondirectory
Data type: String
The local directory servers will use to store the first index partition
dsc_indexpartition
Data type: Array[String]
A list of servers that will host the first (0) index partition
dsc_queryprocessing
Data type: Array[String]
A list of servers that will run the query processing component
Parameters
The following parameters are available in the dsc_spsearchtopology
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_serviceappname
namevar
Data type: String
The name of the search service application for this topology
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsecurestoreserviceapp
The DSC SPSecureStoreServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsecurestoreserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool it will run in
dsc_auditingenabled
Data type: Boolean
Is auditing enabled for this service app
dsc_auditlogmaxsize
Data type: Optional[Integer[0, 4294967295]]
What is the maximum size of the audit log in MB
dsc_databasename
Data type: Optional[String]
The name of the database for the service app
dsc_databaseserver
Data type: Optional[String]
The name of the database server to host the database
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_failoverdatabaseserver
Data type: Optional[String]
The name of the database server hosting a failover instance of the database
dsc_partitionmode
Data type: Optional[Boolean]
Is partition mode enabled for this service app
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_sharing
Data type: Optional[Boolean]
Is sharing enabled for this service app
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spsecurestoreserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_masterkey
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Specify the Master Key to be used to encrypt the secrets. Only used during creation of the Service Application
dsc_name
namevar
Data type: String
The name of the secure store service app
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsecuritytokenserviceconfig
The DSC SPSecurityTokenServiceConfig resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsecuritytokenserviceconfig
type.
dsc_allowmetadataoverhttp
Data type: Optional[Boolean]
True set the security token service to allow metadata exchange over HTTP
dsc_allowoauthoverhttp
Data type: Optional[Boolean]
True set the security token service to allow OAuth over HTTP
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures the configurations are applied
dsc_name
Data type: String
The name of the security token service
dsc_nameidentifier
Data type: Optional[String]
The identifier for the security token service
dsc_usesessioncookies
Data type: Optional[Boolean]
True set the security token service to use cookies
Parameters
The following parameters are available in the dsc_spsecuritytokenserviceconfig
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spselfservicesitecreation
The DSC SPSelfServiceSiteCreation resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spselfservicesitecreation
type.
dsc_alternateurl
Data type: Optional[String]
Specifies the URL of the web application in which site collections have to be created (SP2019 only)
dsc_createindividualsite
Data type: Optional[Boolean]
Should Self Service Site Creation create an individual Site, false for a Site Collection
dsc_customformurl
Data type: Optional[String]
Specifies a custom form URL to use for Self Service Site Creation. This is only used when CreateIndividualSite is true. Must be an absolute URL or empty to use built in form (_layouts/_layouts/15/scsignup.aspx)
dsc_enabled
Data type: Boolean
Specifies if users are allowed to create site collections or not
dsc_managedpath
Data type: Optional[String]
Specifies the managed path in which site collections have to be created (SP2019 only)
dsc_onlineenabled
Data type: Optional[Boolean]
Specifies if site collections are created in SharePoint Online in a hybrid configuration. Hybrid configuration needs to be caried out seperately using the Hybrid Picker
dsc_parentsiteurl
Data type: Optional[String]
Specifies the URL of the parent site where new sites are to be created. This is only used when CreateIndividualSite is true. Use [%userid%] to represent the ID of the user who is creating the site, for example: /projects/[%userid%]
dsc_policyoption
Data type: Optional[Enum['MustHavePolicy', 'CanHavePolicy', 'NotHavePolicy']]
Specifies what site classification should be displayed
dsc_quotatemplate
Data type: Optional[String]
The quota template to apply to new site collections. Specify null to not apply any qouta template
dsc_requiresecondarycontact
Data type: Optional[Boolean]
Specifies if users needs to provide one or more additional site administrators
dsc_showstartasitemenuitem
Data type: Optional[Boolean]
Should the Start a Site link be displayed. Must be false or not specified if Enabled is false
dsc_userexperienceversion
Data type: Optional[Enum['Modern', 'Classic', 'Latest']]
Specifies the if the site collection has to be created as modern or classic site (SP2019 only)
Parameters
The following parameters are available in the dsc_spselfservicesitecreation
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The url of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spserviceapppool
The DSC SPServiceAppPool resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spserviceapppool
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app pool should exist, absent if it should not
dsc_serviceaccount
Data type: String
The name of the managed account to run this service account as
Parameters
The following parameters are available in the dsc_spserviceapppool
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of application pool
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spserviceappproxygroup
The DSC SPServiceAppProxyGroup resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spserviceappproxygroup
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present creates the proxy group if it does not already exist, Absent will delete the proxy group if it exists
dsc_serviceappproxies
Data type: Optional[Array[String]]
List of service application proxies that belong in this proxy group, all others will be removed
dsc_serviceappproxiestoexclude
Data type: Optional[Array[String]]
List of service application proxies to remove from this proxy grop, all others will remain
dsc_serviceappproxiestoinclude
Data type: Optional[Array[String]]
List of service application proxies to add to this proxy group, existing proxies will remain
Parameters
The following parameters are available in the dsc_spserviceappproxygroup
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Name of the Proxy Group to create
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spserviceappsecurity
The DSC SPServiceAppSecurity resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spserviceappsecurity
type.
dsc_members
Data type: Optional[Array[Struct[{ username => String, accesslevels => Array[String], }]]]
A list of members to set the group to. Those not in this list will be removed
dsc_memberstoexclude
Data type: Optional[Array[String]]
A list of members to remove. Members not in this list will be left in the group
dsc_memberstoinclude
Data type: Optional[Array[Struct[{ username => String, accesslevels => Array[String], }]]]
A list of members to add. Members not in this list will be left in the group
Parameters
The following parameters are available in the dsc_spserviceappsecurity
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_securitytype
namevar
Data type: Enum['Administrators', 'SharingPermissions']
Administrators will set the administrators for the service app, SharingPermissions will set those granted access through the permissions button seen in the Sharing section of the ribbon in central admin
dsc_serviceappname
namevar
Data type: String
The name of the service application you wish to apply security settings to
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spserviceidentity
The DSC SPServiceIdentity resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spserviceidentity
type.
dsc_managedaccount
Data type: String
The user name of a managed account, LocalService, LocalSystem or NetworkService that will be used to run the service
Parameters
The following parameters are available in the dsc_spserviceidentity
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service instance to manage
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spserviceinstance
The DSC SPServiceInstance resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spserviceinstance
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to ensure it runs on this server, or absent to ensure it is stopped
Parameters
The following parameters are available in the dsc_spserviceinstance
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service instance to manage
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsessionstateservice
The DSC SPSessionStateService resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsessionstateservice
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present is the state service should be enabled, absent if it should be disabled
dsc_sessiontimeout
Data type: Optional[Integer[0, 4294967295]]
What is the timeout on sessions
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spsessionstateservice
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_databasename
namevar
Data type: String
The name of the database for the service
dsc_databaseserver
namevar
Data type: String
The name of the database server for the database
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spshelladmins
The DSC SPShellAdmins resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spshelladmins
type.
dsc_alldatabases
Data type: Optional[Boolean]
Specify if all databases must get the same config as the general config
dsc_databases
Data type: Optional[Array[Struct[{ memberstoexclude => Optional[Array[String]], name => Optional[String], memberstoinclude => Optional[Array[String]], members => Optional[Array[String]], }]]]
Shell Admin configuration of Databases
dsc_excludedatabases
Data type: Optional[Array[String]]
Specify all databases that must be excluded from AllDatabases
dsc_members
Data type: Optional[Array[String]]
Exact list of accounts that will have to get Shell Admin permissions
dsc_memberstoexclude
Data type: Optional[Array[String]]
List of all accounts that are not allowed to have Shell Admin permissions
dsc_memberstoinclude
Data type: Optional[Array[String]]
List of all accounts that must be in the Shell Admins group
Parameters
The following parameters are available in the dsc_spshelladmins
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsite
The DSC SPSite resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsite
type.
dsc_administrationsitetype
Data type: Optional[Enum['TenantAdministration', 'None']]
Specifies the type of the site collection: Regular site or tenant administration site
dsc_compatibilitylevel
Data type: Optional[Integer[0, 4294967295]]
The compatibility level of the site
dsc_contentdatabase
Data type: Optional[String]
The name of the content database to create the site in
dsc_createdefaultgroups
Data type: Optional[Boolean]
Create the default site groups in the site collection
dsc_description
Data type: Optional[String]
The description to apply to the site collection
dsc_hostheaderwebapplication
Data type: Optional[String]
The URL of the host header web application to create this site in
dsc_language
Data type: Optional[Integer[0, 4294967295]]
The language code of the site
dsc_name
Data type: Optional[String]
The display name of the site collection
dsc_owneralias
Data type: String
The username of the site collection administrator
dsc_owneremail
Data type: Optional[String]
The email address of the site collection administrator
dsc_quotatemplate
Data type: Optional[String]
The quota template to apply to the site collection
dsc_secondaryemail
Data type: Optional[String]
The secondary site collection admin email address
dsc_secondaryowneralias
Data type: Optional[String]
The secondary site collection admin username
dsc_template
Data type: Optional[String]
The template to apply to the site collection
Parameters
The following parameters are available in the dsc_spsite
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The URL of the site collection
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsitepropertybag
The DSC SPSitePropertyBag resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsitepropertybag
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Set to present to ensure the SPSite property exists, or absent to ensure it is removed
dsc_value
Data type: Optional[String]
Value of the SPSite property
Parameters
The following parameters are available in the dsc_spsitepropertybag
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_key
namevar
Data type: String
The key of the SPSite property
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The URL of the site collection
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsiteurl
The DSC SPSiteUrl resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsiteurl
type.
dsc_custom
Data type: Optional[String]
The URL of the Custom zone
dsc_extranet
Data type: Optional[String]
The URL of the Extranet zone
dsc_internet
Data type: Optional[String]
The URL of the Internet zone
dsc_intranet
Data type: Optional[String]
The URL of the Intranet zone
Parameters
The following parameters are available in the dsc_spsiteurl
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The URL of the site collection
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spstateserviceapp
The DSC SPStateServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spstateserviceapp
type.
dsc_databasename
Data type: String
The name of the database for the service app
dsc_databaseserver
Data type: Optional[String]
The name of the database server
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database (unlikely, unless using an Azure SQL Managed Instance)?
Parameters
The following parameters are available in the dsc_spstateserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The database credentials for accessing the database
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the state service app
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spsubscriptionsettingsserviceapp
The DSC SPSubscriptionSettingsServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spsubscriptionsettingsserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool the service app runs in
dsc_databasename
Data type: Optional[String]
The name of the database for the service app
dsc_databaseserver
Data type: Optional[String]
The name of the database server
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spsubscriptionsettingsserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the subscription settings service app
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sptimerjobstate
The DSC SPTimerJobState resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sptimerjobstate
type.
dsc_enabled
Data type: Optional[Boolean]
Should the timer job be enabled or not
dsc_schedule
Data type: Optional[String]
The schedule for the timer job to execute on
Parameters
The following parameters are available in the dsc_sptimerjobstate
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_typename
namevar
Data type: String
The type name of the timer job (not the display name)
dsc_webappurl
namevar
Data type: String
The URL of the web application that the timer job belongs to. Use the value 'N/A' if no web application is applicable
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sptrustedidentitytokenissuer
The DSC SPTrustedIdentityTokenIssuer resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sptrustedidentitytokenissuer
type.
dsc_claimprovidername
Data type: Optional[String]
Name of a claims provider to set with this SPTrustedIdentityTokenIssuer
dsc_claimsmappings
Data type: Array[Struct[{ localclaimtype => Optional[String], name => Optional[String], incomingclaimtype => String, }]]
Array of MSFT_SPClaimTypeMapping to use with cmdlet New-SPClaimTypeMapping
dsc_description
Data type: String
Description of the SPTrustedIdentityTokenIssuer
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the SPTrustedIdentityTokenIssuer should be created, or Absent if it should be removed
dsc_identifierclaim
Data type: String
Identity claim type that uniquely identifies the user
dsc_providersignouturi
Data type: Optional[String]
Sign-out URL
dsc_realm
Data type: String
Default Realm that is passed to identity provider
dsc_signingcertificatefilepath
Data type: Optional[String]
Specify the file path to the signing certificate if it is not stored in the local certificate store already
dsc_signingcertificatethumbprint
Data type: Optional[String]
Specify the thumbprint of the signing certificate, which must be located in certificate store LocalMachine\My
dsc_signinurl
Data type: String
URL of the identity provider where user is redirected to for authentication
dsc_usewreplyparameter
Data type: Optional[Boolean]
WReply parameter allows SharePoint to specify the return URL to the 3rd party STS upon successful authentication
Parameters
The following parameters are available in the dsc_sptrustedidentitytokenissuer
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Name of the SPTrustedIdentityTokenIssuer
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sptrustedidentitytokenissuerproviderrealms
The DSC SPTrustedIdentityTokenIssuerProviderRealms resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sptrustedidentitytokenissuerproviderrealms
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the ProviderRealms should be created, or Absent if it should be removed
dsc_providerrealms
Data type: Optional[Array[Struct[{ realmurn => String, realmurl => Optional[String], }]]]
Realms to set. Those not in this list will be removed
dsc_providerrealmstoexclude
Data type: Optional[Array[Struct[{ realmurn => String, realmurl => Optional[String], }]]]
Realms to remove. Realms not in this list will be left
dsc_providerrealmstoinclude
Data type: Optional[Array[Struct[{ realmurn => String, realmurl => Optional[String], }]]]
Realms to add. Realms not in this list will be left
Parameters
The following parameters are available in the dsc_sptrustedidentitytokenissuerproviderrealms
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_issuername
namevar
Data type: String
Name of the SPTrustedIdentityTokenIssuer
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sptrustedrootauthority
The DSC SPTrustedRootAuthority resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sptrustedrootauthority
type.
dsc_certificatefilepath
Data type: Optional[String]
Specify the file path to the certificate if it is not stored in the local certificate store already. Private key should not be present.
dsc_certificatethumbprint
Data type: Optional[String]
Specifies the X.509 certificate of the trusted root authority, as a certificate thumbprint.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present ensures the trusted root authority exists, absent ensures it is removed
Parameters
The following parameters are available in the dsc_sptrustedrootauthority
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Specifies the name of the trusted root authority to create.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_sptrustedsecuritytokenissuer
The DSC SPTrustedSecurityTokenIssuer resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_sptrustedsecuritytokenissuer
type.
dsc_description
Data type: Optional[String]
Description of the SPTrustedSecurityTokenIssuer
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the SPTrustedSecurityTokenIssuer should be created, or Absent if it should be removed
dsc_istrustbroker
Data type: Optional[Boolean]
Specifies whether the trust is established with a self-issuer partner app
dsc_metadataendpoint
Data type: Optional[String]
URL that SharePoint will reach to download the JSON metadata file of the issuer
dsc_registeredissuernameidentifier
Data type: Optional[String]
The security principal identifier of the security token issuer
dsc_registeredissuernamerealm
Data type: Optional[String]
The realm of the security token issuer
dsc_signingcertificatefilepath
Data type: Optional[String]
Specify the file path to the signing certificate if it is not stored in the local certificate store already
dsc_signingcertificatethumbprint
Data type: Optional[String]
Specify the thumbprint of the signing certificate, which must be located in certificate store LocalMachine\My
Parameters
The following parameters are available in the dsc_sptrustedsecuritytokenissuer
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
Name of the SPTrustedSecurityTokenIssuer
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spusageapplication
The DSC SPUsageApplication resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spusageapplication
type.
dsc_databasename
Data type: Optional[String]
The name of the database for the service app
dsc_databaseserver
Data type: Optional[String]
The name of the database server
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_failoverdatabaseserver
Data type: Optional[String]
The name of the failover database server
dsc_usagelogcuttime
Data type: Optional[Integer[0, 4294967295]]
The time in minutes to cut over to new log files
dsc_usageloglocation
Data type: Optional[String]
The location on each server to store the log files
dsc_usagelogmaxfilesizekb
Data type: Optional[Integer[0, 4294967295]]
The maximum file size for log files in KB
dsc_usagelogmaxspacegb
Data type: Optional[Integer[0, 4294967295]]
The total space of all log files on disk in GB
Parameters
The following parameters are available in the dsc_spusageapplication
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The credentials to use to access the database
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spuserprofileproperty
The DSC SPUserProfileProperty resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spuserprofileproperty
type.
dsc_description
Data type: Optional[String]
The description of the property
dsc_displayname
Data type: Optional[String]
The display name of the property
dsc_displayorder
Data type: Optional[Integer[0, 4294967295]]
The display order to put the property in to the list at
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the property should exist, absent if it should be removed
dsc_isalias
Data type: Optional[Boolean]
Is this field an alias that can be used to refer to a user by
dsc_iseventlog
Data type: Optional[Boolean]
Is this field used for event logging
dsc_isreplicable
Data type: Optional[Boolean]
Is this field replicated to Microsoft SharePoint Foundation 2010 sites
dsc_issearchable
Data type: Optional[Boolean]
Is this field able to be searched upon
dsc_isusereditable
Data type: Optional[Boolean]
Is this field able to be edited by a user, or only an administrator
dsc_isvisibleoneditor
Data type: Optional[Boolean]
Is this field visible when editing a users profile, or hidden from editing
dsc_isvisibleonviewer
Data type: Optional[Boolean]
Is this field visible when viewing a users profile
dsc_length
Data type: Optional[Integer[0, 4294967295]]
The length of the field
dsc_policysetting
Data type: Optional[Enum['Mandatory', 'Optin', 'Optout', 'Disabled']]
The policy setting to apply to the property
dsc_privacysetting
Data type: Optional[Enum['Public', 'Contacts', 'Organization', 'Manager', 'Private']]
The privacy setting for the property
dsc_propertymappings
Data type: Optional[Array[Struct[{ propertyname => String, connectionname => String, direction => Enum['Import', 'Export'], }]]]
The details about the property mapping
dsc_termgroup
Data type: Optional[String]
The name of the term store group that terms are in for this field
dsc_termset
Data type: Optional[String]
The name of the term set to allow values to be selected from
dsc_termstore
Data type: Optional[String]
The name of the term store to look up managed terms from
dsc_type
Data type: Optional[Enum['Big Integer', 'Binary', 'Boolean', 'Date', 'DateNoYear', 'Date Time', 'Email', 'Float', 'HTML', 'Integer', 'Person', 'String (Single Value)', 'String (Multi Value)', 'TimeZone', 'Unique Identifier', 'URL']]
The type of the property
dsc_useroverrideprivacy
Data type: Optional[Boolean]
Can users override the default privacy policy
dsc_userprofileservice
Data type: String
The name of the user profile service application
Parameters
The following parameters are available in the dsc_spuserprofileproperty
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The internal name of the user profile property
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spuserprofilesection
The DSC SPUserProfileSection resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spuserprofilesection
type.
dsc_displayname
Data type: Optional[String]
The display name of the section
dsc_displayorder
Data type: Optional[Integer[0, 4294967295]]
A number used to sort sections by
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the section should exist, absent if it should be removed
dsc_userprofileservice
Data type: String
The name of the user profile service application this section exists in
Parameters
The following parameters are available in the dsc_spuserprofilesection
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The internal name of the user profile section
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spuserprofileserviceapp
The DSC SPUserProfileServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spuserprofileserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool to run the service app in
dsc_enablenetbios
Data type: Optional[Boolean]
Whether Farm should resolve NetBIOS domain names
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_mysitehostlocation
Data type: String
The URL of the my site host collection
dsc_mysitemanagedpath
Data type: Optional[String]
The Managed Path of the my site sites
dsc_noilmused
Data type: Optional[Boolean]
Specifies if the service application should be configured to use AD Import
dsc_profiledbname
Data type: Optional[String]
The name of the profile database
dsc_profiledbserver
Data type: Optional[String]
The name of the server to host the profile database
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
dsc_sitenamingconflictresolution
Data type: Optional[Enum['Username_CollisionError', 'Username_CollisionDomain', 'Domain_Username']]
Specifies which SiteNamingConflictResolution should be used
dsc_socialdbname
Data type: Optional[String]
The name of the social database
dsc_socialdbserver
Data type: Optional[String]
The name of the database server to host the social database
dsc_syncdbname
Data type: Optional[String]
The name of the sync database
dsc_syncdbserver
Data type: Optional[String]
The name of the database server to host the sync database
dsc_updateproxygroup
Data type: Optional[Boolean]
Specifies if an issue with Service App Proxy Groups should be automatically corrected (see wiki for more info). Default value is true.
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spuserprofileserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the user profile service
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spuserprofileserviceapppermissions
The DSC SPUserProfileServiceAppPermissions resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spuserprofileserviceapppermissions
type.
dsc_createpersonalsite
Data type: Optional[Array[String]]
A list of user principals that will have the Create personal site permission
dsc_followandeditprofile
Data type: Optional[Array[String]]
A list of user principals that will have the Follow users and edit profile permission
dsc_usetagsandnotes
Data type: Optional[Array[String]]
A list of user principals that will have the Use tags and notes permission
Parameters
The following parameters are available in the dsc_spuserprofileserviceapppermissions
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_proxyname
namevar
Data type: String
The name of the proxy that is attached to the user profile service you wish to set permissions for
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spuserprofilesyncconnection
The DSC SPUserProfileSyncConnection resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spuserprofilesyncconnection
type.
dsc_connectiontype
Data type: Optional[Enum['ActiveDirectory', 'BusinessDataCatalog']]
The type of the connection - currently only Active Directory is supported
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the connection should exist, absent if it should not
dsc_excludedous
Data type: Optional[Array[String]]
A list of the OUs to ignore users from. For SharePoint 2016/2019 matching existing OUs to include are removed.
dsc_forest
Data type: String
The name of the AD forest to read from
dsc_includedous
Data type: Array[String]
A list of the OUs to import users from. For SharePoint 2016/2019 existing OUs will not be removed if not included in this list. Use ExludedOUs for removing OUs in SharePoint 2016/2019
dsc_port
Data type: Optional[Integer[0, 4294967295]]
The specific port to connect to
dsc_server
Data type: Optional[String]
The specific AD server to connect to
dsc_usedisabledfilter
Data type: Optional[Boolean]
Should disabled accounts be filtered
dsc_userprofileservice
Data type: String
The name of the user profile service that this connection is attached to
dsc_usessl
Data type: Optional[Boolean]
Should SSL be used for the connection
Parameters
The following parameters are available in the dsc_spuserprofilesyncconnection
type.
dsc_connectioncredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The credentials to connect to Active Directory with
dsc_force
Data type: Optional[Boolean]
Set to true to run the set method on every call to this resource. Only has effect on SharePoint 2013
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the connection
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spuserprofilesyncservice
The DSC SPUserProfileSyncService resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spuserprofilesyncservice
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to ensure the service is running, absent to ensure it is not
dsc_runonlywhenwriteable
Data type: Optional[Boolean]
Should the sync service only run when the user profile database is in a writeable state?
Parameters
The following parameters are available in the dsc_spuserprofilesyncservice
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_userprofileserviceappname
namevar
Data type: String
The name of the user profile service for this sync instance
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spvisioserviceapp
The DSC SPVisioServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spvisioserviceapp
type.
dsc_applicationpool
Data type: String
The name of the application pool to run the service app in
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the service app should exist, absent if it should not
dsc_proxyname
Data type: Optional[String]
The name of the Visio Service Application Proxy
Parameters
The following parameters are available in the dsc_spvisioserviceapp
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spweb
The DSC SPWeb resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spweb
type.
dsc_addtoquicklaunch
Data type: Optional[Boolean]
True if the web should be in the quick launch of the parent web, otherwise false.
dsc_addtotopnav
Data type: Optional[Boolean]
True if the web should be added to the top nav bar of the parent web, otherwise false.
dsc_description
Data type: Optional[String]
The description to apply to the web
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the web should exist or Absent if it should be removed
dsc_language
Data type: Optional[Integer[0, 4294967295]]
The Lanhuage (LCID) of the web
dsc_name
Data type: Optional[String]
The Name of the web
dsc_requestaccessemail
Data type: Optional[String]
The e-mail address to which requests for access are sent. Set to emtpy string to disable access requests.
dsc_template
Data type: Optional[String]
The WebTemplate to use to create the web
dsc_uniquepermissions
Data type: Optional[Boolean]
True if the web should have unique permissions, otherwise false.
dsc_useparenttopnav
Data type: Optional[Boolean]
True if the web should use the parent nav bar, otherwise false.
Parameters
The following parameters are available in the dsc_spweb
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_url
namevar
Data type: String
The URL of the web
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappauthentication
The DSC SPWebAppAuthentication resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappauthentication
type.
dsc_custom
Data type: Optional[Array[Struct[{ authenticationmethod => Enum['Classic', 'WindowsAuthentication', 'FBA', 'Federated'], membershipprovider => Optional[String], usebasicauth => Optional[Boolean], roleprovider => Optional[String], authenticationprovider => Optional[String], windowsauthmethod => Optional[Enum['NTLM', 'Kerberos']] }]]]
Specifies the authentication for the Custom zone.
dsc_default
Data type: Optional[Array[Struct[{ authenticationmethod => Enum['Classic', 'WindowsAuthentication', 'FBA', 'Federated'], membershipprovider => Optional[String], usebasicauth => Optional[Boolean], roleprovider => Optional[String], authenticationprovider => Optional[String], windowsauthmethod => Optional[Enum['NTLM', 'Kerberos']] }]]]
Specifies the authentication for the Default zone.
dsc_extranet
Data type: Optional[Array[Struct[{ authenticationmethod => Enum['Classic', 'WindowsAuthentication', 'FBA', 'Federated'], membershipprovider => Optional[String], usebasicauth => Optional[Boolean], roleprovider => Optional[String], authenticationprovider => Optional[String], windowsauthmethod => Optional[Enum['NTLM', 'Kerberos']] }]]]
Specifies the authentication for the Extranet zone.
dsc_internet
Data type: Optional[Array[Struct[{ authenticationmethod => Enum['Classic', 'WindowsAuthentication', 'FBA', 'Federated'], membershipprovider => Optional[String], usebasicauth => Optional[Boolean], roleprovider => Optional[String], authenticationprovider => Optional[String], windowsauthmethod => Optional[Enum['NTLM', 'Kerberos']] }]]]
Specifies the authentication for the Internet zone.
dsc_intranet
Data type: Optional[Array[Struct[{ authenticationmethod => Enum['Classic', 'WindowsAuthentication', 'FBA', 'Federated'], membershipprovider => Optional[String], usebasicauth => Optional[Boolean], roleprovider => Optional[String], authenticationprovider => Optional[String], windowsauthmethod => Optional[Enum['NTLM', 'Kerberos']] }]]]
Specifies the authentication for the Intranet zone.
Parameters
The following parameters are available in the dsc_spwebappauthentication
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappblockedfiletypes
The DSC SPWebAppBlockedFileTypes resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappblockedfiletypes
type.
dsc_blocked
Data type: Optional[Array[String]]
This is a fixed list to use for blocked file types in this web app
dsc_ensureallowed
Data type: Optional[Array[String]]
This list of file types that will always be removedfrom the list for this web app. Types not in this list will be left in the list
dsc_ensureblocked
Data type: Optional[Array[String]]
This list of file types that will always be added to the list for this web app. Types not in this list will be left in the list
Parameters
The following parameters are available in the dsc_spwebappblockedfiletypes
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application to set blocked file types for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappclientcallablesettings
The DSC SPWebAppClientCallableSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappclientcallablesettings
type.
dsc_enablerequestusage
Data type: Optional[Boolean]
Sets a Boolean value that specifies whether to log usage data or not
dsc_enablestacktrace
Data type: Optional[Boolean]
Sets a Boolean value that specifies whether the server can send stack trace data to the client
dsc_enablexsdvalidation
Data type: Optional[Boolean]
Sets a Boolean value that specifies whether to enable XSD validation against an XML request or not
dsc_executiontimeout
Data type: Optional[Integer[0, 4294967295]]
Sets the execution timeout for the client request in minutes
dsc_logactionsifhasrequestexception
Data type: Optional[Boolean]
Sets a Boolean value that specifies whether to log usage data when request has an exception or not
dsc_maxobjectpaths
Data type: Optional[Integer[0, 4294967295]]
Sets the maximum number of object paths that can be used within one request
dsc_maxresourcesperrequest
Data type: Optional[Integer[0, 4294967295]]
Sets the maximum number of internal SPRequest objects that can be included in one request
dsc_proxylibraries
Data type: Optional[Array[Struct[{ assemblyname => String, supportappauthentication => Optional[Boolean], }]]]
A list of proxy libraries to set. Those not in this list will be removed
dsc_proxylibrariestoexclude
Data type: Optional[Array[String]]
A list of proxy libraries to remove. Proxy libraries not in this list will be kept
dsc_proxylibrariestoinclude
Data type: Optional[Array[Struct[{ assemblyname => String, supportappauthentication => Optional[Boolean], }]]]
A list of proxy libraries to add. Proxy libraries not in this list will be kept
dsc_requestusageexecutiontimethreshold
Data type: Optional[Integer[0, 4294967295]]
Sets the threshold in milliseconds for logging csom request usage data
dsc_requestxmlmaxdepth
Data type: Optional[Integer[0, 4294967295]]
Sets the maximum depth of the request XML that is sent by the client measured in 'tag' count
Parameters
The following parameters are available in the dsc_spwebappclientcallablesettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application to set blocked file types for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappgeneralsettings
The DSC SPWebAppGeneralSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappgeneralsettings
type.
dsc_alerts
Data type: Optional[Boolean]
Should alerts be enabled for this web app
dsc_alertslimit
Data type: Optional[Integer[0, 4294967295]]
What is the maximum number of alerts that a user can create in this web app
dsc_allowonlinewebpartcatalog
Data type: Optional[Boolean]
Should the Online WebPart Gallery be enabled for this web app
dsc_blogapi
Data type: Optional[Boolean]
Should the Blog API be enabled in this web app
dsc_blogapiauthenticated
Data type: Optional[Boolean]
Is authentication required for the blog API
dsc_browserfilehandling
Data type: Optional[Enum['Strict', 'Permissive']]
What file handling mode should be used in this web app - strict or permissive
dsc_customerexperienceprogram
Data type: Optional[Boolean]
Should the customer experience program be enabled in this web app
dsc_defaultquotatemplate
Data type: Optional[String]
What is the default quota template for this web app
dsc_maximumuploadsize
Data type: Optional[Integer[0, 4294967295]]
What is the maximum file upload size for this web app (in MB)
dsc_presenceenabled
Data type: Optional[Boolean]
Is Skype for Business presence enabled for this web app
dsc_recyclebincleanupenabled
Data type: Optional[Boolean]
Is automatic cleanup of the recycle bin enabled in this web app
dsc_recyclebinenabled
Data type: Optional[Boolean]
Is the recycle bin enabled in this web application
dsc_recyclebinretentionperiod
Data type: Optional[Integer[0, 4294967295]]
How many days does the recycle bin keep content for
dsc_rss
Data type: Optional[Boolean]
Should RSS feeds be enabled in this web app
dsc_secondstagerecyclebinquota
Data type: Optional[Integer[0, 4294967295]]
How much content does the second stage recycle bin keep content for
dsc_securityvalidation
Data type: Optional[Boolean]
Is security validation enforced in this web app
dsc_securityvalidationexpires
Data type: Optional[Boolean]
Does security validation expire after a set time
dsc_securityvalidationtimeoutminutes
Data type: Optional[Integer[0, 4294967295]]
Number of minutes security validation will expire if securityvalidationexpires is set
dsc_selfservicesitecreationenabled
Data type: Optional[Boolean]
Should Self Service Site Creation be enabled
dsc_timezone
Data type: Optional[Integer[0, 4294967295]]
The timezone code to use for this web app. A full list is at https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.spregionalsettings.timezones.aspx
Parameters
The following parameters are available in the dsc_spwebappgeneralsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web app to set the general settings for
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebapplication
The DSC SPWebApplication resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebapplication
type.
dsc_allowanonymous
Data type: Optional[Boolean]
Should anonymous access be enabled for this web app
dsc_applicationpool
Data type: String
The name of the application pool to run this site in
dsc_applicationpoolaccount
Data type: String
The name of the managed account to run the app pool with
dsc_databasename
Data type: Optional[String]
The name of the first content database to be created with this web app
dsc_databaseserver
Data type: Optional[String]
The name of the database server to host the default content DB
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the web app should exist, absent if it should not
dsc_hostheader
Data type: Optional[String]
The host header to use for the web app
dsc_path
Data type: Optional[String]
The path on the local servers to host the IIS web site from
dsc_port
Data type: Optional[String]
The port to run the site on
dsc_useclassic
Data type: Optional[Boolean]
Create the web application with Classic authentication (only used during creation of a new web application)
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
dsc_webappurl
Data type: String
The URL of the web application
Parameters
The following parameters are available in the dsc_spwebapplication
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the web application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebapplicationappdomain
The DSC SPWebApplicationAppDomain resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebapplicationappdomain
type.
dsc_appdomain
Data type: String
The domain for apps in this web app zone
dsc_port
Data type: Optional[String]
The port to run apps on
dsc_ssl
Data type: Optional[Boolean]
Should apps run under SSL
Parameters
The following parameters are available in the dsc_spwebapplicationappdomain
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application to set the app domain for
dsc_zone
namevar
Data type: Enum['Default', 'Internet', 'Intranet', 'Extranet', 'Custom']
The zone that this app domain applies to
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebapplicationextension
The DSC SPWebApplicationExtension resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebapplicationextension
type.
dsc_allowanonymous
Data type: Optional[Boolean]
Should anonymous access be enabled for this web app extension
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present if the web app should exist, absent if it should not
dsc_hostheader
Data type: Optional[String]
The host header to use for the web app extension
dsc_name
Data type: String
The name of the web application extension
dsc_path
Data type: Optional[String]
The path on the local servers to host the IIS web site from
dsc_port
Data type: Optional[String]
The port to run the site on
dsc_url
Data type: String
The URL of the web application extension
dsc_usessl
Data type: Optional[Boolean]
Should this web app extension use SSL
Parameters
The following parameters are available in the dsc_spwebapplicationextension
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the parent web application
dsc_zone
namevar
Data type: Enum['Default', 'Intranet', 'Internet', 'Extranet', 'Custom']
Specifies one of the five zones with which the internal URL of this new extension is to be associated.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebapppeoplepickersettings
The DSC SPWebAppPeoplePickerSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebapppeoplepickersettings
type.
dsc_activedirectorycustomfilter
Data type: Optional[String]
Sets a customized query filter to send to Active Directory
dsc_activedirectorycustomquery
Data type: Optional[String]
Sets the custom query that is sent to Active Directory
dsc_activedirectorysearchtimeout
Data type: Optional[Integer[0, 65535]]
Sets the time-out in seconds when a query is issued to Active Directory
dsc_onlysearchwithinsitecollection
Data type: Optional[Boolean]
Specifies whether to search only the current site collection
dsc_searchactivedirectorydomains
Data type: Optional[Array[Struct[{ fqdn => String, isforest => Boolean, accessaccount => Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]] }]]]
List of all domains/forests that must be searched
Parameters
The following parameters are available in the dsc_spwebapppeoplepickersettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebapppermissions
The DSC SPWebAppPermissions resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebapppermissions
type.
dsc_allpermissions
Data type: Optional[Boolean]
Set all permissions
dsc_listpermissions
Data type: Optional[Array[Enum['Manage Lists', 'Override List Behaviors', 'Add Items', 'Edit Items', 'Delete Items', 'View Items', 'Approve Items', 'Open Items', 'View Versions', 'Delete Versions', 'Create Alerts', 'View Application Pages']]]
List permissions that need to be configured
dsc_personalpermissions
Data type: Optional[Array[Enum['Manage Personal Views', 'Add/Remove Personal Web Parts', 'Update Personal Web Parts']]]
Personal permissions that need to be configured
dsc_sitepermissions
Data type: Optional[Array[Enum['Manage Permissions', 'View Web Analytics Data', 'Create Subsites', 'Manage Web Site', 'Add and Customize Pages', 'Apply Themes and Borders', 'Apply Style Sheets', 'Create Groups', 'Browse Directories', 'Use Self-Service Site Creation', 'View Pages', 'Enumerate Permissions', 'Browse User Information', 'Manage Alerts', 'Use Remote Interfaces', 'Use Client Integration Features', 'Open', 'Edit Personal User Information']]]
Site permissions that need to be configured
Parameters
The following parameters are available in the dsc_spwebapppermissions
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The url of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebapppolicy
The DSC SPWebAppPolicy resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebapppolicy
type.
dsc_members
Data type: Optional[Array[Struct[{ username => String, identitytype => Optional[Enum['Claims', 'Native']], actassystemaccount => Optional[Boolean], permissionlevel => Optional[Array[Enum['Deny All', 'Deny Write', 'Full Read', 'Full Control']]], }]]]
Exact list of accounts that will have to get Web Policy permissions
dsc_memberstoexclude
Data type: Optional[Array[Struct[{ username => String, identitytype => Optional[Enum['Claims', 'Native']], actassystemaccount => Optional[Boolean], permissionlevel => Optional[Array[Enum['Deny All', 'Deny Write', 'Full Read', 'Full Control']]], }]]]
List of all accounts that are not allowed to have any Web Policy permissions
dsc_memberstoinclude
Data type: Optional[Array[Struct[{ username => String, identitytype => Optional[Enum['Claims', 'Native']], actassystemaccount => Optional[Boolean], permissionlevel => Optional[Array[Enum['Deny All', 'Deny Write', 'Full Read', 'Full Control']]], }]]]
List of all accounts that must be in the Web Policy group
dsc_setcacheaccountspolicy
Data type: Optional[Boolean]
Include the Cache Accounts in the policy or not
Parameters
The following parameters are available in the dsc_spwebapppolicy
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebapppropertybag
The DSC SPWebAppPropertyBag resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebapppropertybag
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Set to present to ensure the SPWebApplication property exists, or absent to ensure it is removed
dsc_value
Data type: Optional[String]
Value of the SPWebApplication property
Parameters
The following parameters are available in the dsc_spwebapppropertybag
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_key
namevar
Data type: String
The key of the SPWebApplication property
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappproxygroup
The DSC SPWebAppProxyGroup resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappproxygroup
type.
dsc_serviceappproxygroup
Data type: String
Name of the Service Application Proxy Group
Parameters
The following parameters are available in the dsc_spwebappproxygroup
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappsiteuseanddeletion
The DSC SPWebAppSiteUseAndDeletion resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappsiteuseanddeletion
type.
dsc_automaticallydeleteunusedsitecollections
Data type: Optional[Boolean]
Should unused site collection be automatically deleted
dsc_sendunusedsitecollectionnotifications
Data type: Optional[Boolean]
Should emails be sent to notify site owners of unused site collections
dsc_unusedsitenotificationperiod
Data type: Optional[Integer[0, 4294967295]]
How many days should pass before a site is flagged as unused
dsc_unusedsitenotificationsbeforedeletion
Data type: Optional[Integer[0, 4294967295]]
How many days before an unused site is deleted should an email be sent to the owner
Parameters
The following parameters are available in the dsc_spwebappsiteuseanddeletion
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappsuitebar
The DSC SPWebAppSuiteBar resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappsuitebar
type.
dsc_suitebarbrandingelementhtml
Data type: Optional[String]
SP2013+: HTML to inject in the left hand-side of the Suite Bar. Only works in classic pages with a SharePoint 2013 master page in SharePoint 2016 and newer.
dsc_suitenavbrandinglogonavigationurl
Data type: Optional[String]
SP2016+: Url to take the users to when the suite bar logo is clicked. This only works on classic pages for SP2019 and newer.
dsc_suitenavbrandinglogotitle
Data type: Optional[String]
SP2016+: Alternative text for the Suite Bar Logo. This only works on classic pages for SP2019 and newer.
dsc_suitenavbrandinglogourl
Data type: Optional[String]
SP2016+: URL of the logo for the Suite Bar. This only works on classic pages for SP2019 and newer.
dsc_suitenavbrandingtext
Data type: Optional[String]
SP2016+: Text to display at the left hand side of the suite bar. No built in support of showing this on web pages in SP2019 and newer.
Parameters
The following parameters are available in the dsc_spwebappsuitebar
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappthrottlingsettings
The DSC SPWebAppThrottlingSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappthrottlingsettings
type.
dsc_adminthreshold
Data type: Optional[Integer[0, 4294967295]]
What is the list view threshold for site administrators
dsc_allowobjectmodeloverride
Data type: Optional[Boolean]
Should object model code be able to be override the list view threshold
dsc_changelogenabled
Data type: Optional[Boolean]
Is the change log enabled for this web app
dsc_changelogexpirydays
Data type: Optional[Integer[0, 4294967295]]
How many days does the change log store data for
dsc_eventhandlersenabled
Data type: Optional[Boolean]
Are event handlers enabled in the web application
dsc_happyhour
Data type: Optional[Struct[{ duration => Optional[Integer[0, 4294967295]], hour => Optional[Integer[0, 4294967295]], minute => Optional[Integer[0, 4294967295]], }]]
The time window for happy hour
dsc_happyhourenabled
Data type: Optional[Boolean]
Should the happy hour window be enabled for this web app
dsc_listviewlookupthreshold
Data type: Optional[Integer[0, 4294967295]]
What is the maximum number of lookup fields in a single list view
dsc_listviewthreshold
Data type: Optional[Integer[0, 4294967295]]
What should the list view threshold for this site be set to
dsc_requestthrottling
Data type: Optional[Boolean]
Is request throttling enabled on this web app
dsc_uniquepermissionthreshold
Data type: Optional[Integer[0, 4294967295]]
What is the limit for unique permissions on a single object in this web app
Parameters
The following parameters are available in the dsc_spwebappthrottlingsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwebappworkflowsettings
The DSC SPWebAppWorkflowSettings resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwebappworkflowsettings
type.
dsc_emailtonopermissionworkflowparticipantsenable
Data type: Optional[Boolean]
Are documents sent via email to external participants of workflow
dsc_externalworkflowparticipantsenabled
Data type: Optional[Boolean]
Are external workflow participants enabled in the web app
dsc_userdefinedworkflowsenabled
Data type: Optional[Boolean]
Are user defined workflows enabled in this web app
Parameters
The following parameters are available in the dsc_spwebappworkflowsettings
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_webappurl
namevar
Data type: String
The URL of the web application
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spwordautomationserviceapp
The DSC SPWordAutomationServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spwordautomationserviceapp
type.
dsc_applicationpool
Data type: Optional[String]
The name of the application pool to run the service app in
dsc_conversionprocesses
Data type: Optional[Integer[0, 4294967295]]
How many conversion processes can be run at once
dsc_databasename
Data type: Optional[String]
The name of the database for the service app
dsc_databaseserver
Data type: Optional[String]
The name of the server that will host the database
dsc_disablebinaryfilescan
Data type: Optional[Boolean]
Should binary file scans be disabled
dsc_disableembeddedfonts
Data type: Optional[Boolean]
Should embedded fonts be disabled
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to ensure the app exists, absent to ensure that it does not
dsc_jobconversionfrequency
Data type: Optional[Integer[0, 4294967295]]
How frequently should new jobs be started from the queue (in minutes)
dsc_keepalivetimeout
Data type: Optional[Integer[0, 4294967295]]
How long is the keep alive timeout set to for the service app
dsc_maximumconversionattempts
Data type: Optional[Integer[0, 4294967295]]
What is the maximum number of attempts to convert a document
dsc_maximumconversiontime
Data type: Optional[Integer[0, 4294967295]]
What is the maximum time in seconds for a document conversion to be allowed to run
dsc_maximummemoryusage
Data type: Optional[Integer[0, 4294967295]]
What is the maximum amount of memory the service app should use (in MB)
dsc_maximumsyncconversionrequests
Data type: Optional[Integer[0, 4294967295]]
What is the maximum number of sync conversion requests for the service app
dsc_numberofconversionsperprocess
Data type: Optional[Integer[0, 4294967295]]
How many document conversions should be included in a single process
dsc_recyclethreshold
Data type: Optional[Integer[0, 4294967295]]
What is the recycle threshold for this service app
dsc_supportedfileformats
Data type: Optional[Array[Enum['docx', 'doc', 'mht', 'rtf', 'xml']]]
The list of supported file types
dsc_timebeforeconversionismonitored
Data type: Optional[Integer[0, 4294967295]]
How long can a conversion be run before it becomes monitored
dsc_usesqlauthentication
Data type: Optional[Boolean]
Should SQL Server authentication be used to connect to the database?
Parameters
The following parameters are available in the dsc_spwordautomationserviceapp
type.
dsc_databasecredentials
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
If using SQL authentication, the SQL credentials to use to connect to the instance
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
THe name of the service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spworkflowservice
The DSC SPWorkflowService resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spworkflowservice
type.
dsc_allowoauthhttp
Data type: Optional[Boolean]
Specify whether or not to allow connection to the Workflow Service over Http
dsc_scopename
Data type: Optional[String]
Specify scope name. If not specified SharePoint will use the default scope name 'SharePoint'
Parameters
The following parameters are available in the dsc_spworkflowservice
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_spsiteurl
namevar
Data type: String
The URL of the Site Collection to associate with the Workflow Service Proxy
dsc_workflowhosturi
namevar
Data type: String
The URL of the Workflow Service
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_spworkmanagementserviceapp
The DSC SPWorkManagementServiceApp resource type. Automatically generated from version 4.4.0
Properties
The following properties are available in the dsc_spworkmanagementserviceapp
type.
dsc_applicationpool
Data type: Optional[String]
The name of the application pool this will run in
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Present to ensure the app exists, Absent to ensure it is removed
dsc_minimumtimebetweenewssyncsubscriptionsearches
Data type: Optional[Integer[0, 4294967295]]
The minimum amount of time bween EWS sync subscription searches
dsc_minimumtimebetweenproviderrefreshes
Data type: Optional[Integer[0, 4294967295]]
The minimum time between provider refreshes
dsc_minimumtimebetweensearchqueries
Data type: Optional[Integer[0, 4294967295]]
The minimum time between search queries
dsc_numberofsubscriptionsyncsperewssyncrun
Data type: Optional[Integer[0, 4294967295]]
The number of subscription syncronisations per EWS sync run
dsc_numberofusersewssyncwillprocessatonce
Data type: Optional[Integer[0, 4294967295]]
How many users will EWS calls include at once
dsc_numberofusersperewssyncbatch
Data type: Optional[Integer[0, 4294967295]]
How many users are included in a batch for EWS
dsc_proxyname
Data type: Optional[String]
The proxy name, if not specified will be /Name of service app/ Proxy
Parameters
The following parameters are available in the dsc_spworkmanagementserviceapp
type.
dsc_installaccount
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
dsc_name
namevar
Data type: String
The name of the work management service application
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
[4.4.0] - 2020-11-14
Added
- SharePointDsc
- Added logging to the event log when the code throws an exception
- Added support for trusted domains to Test-SPDscIsADUser helper function
- SPInstall
- Added documentation about a SharePoint 2019 installer issue
Changed
- SharePointDsc
- Updated Convert-SPDscHashtableToString to output the username when parameter is a PSCredential
- SPFarm
- Switched from creating a Lock database to a Lock table in the TempDB. This to allow the use of precreated databases.
- Updated code to properly output used credential parameters to verbose logging
- SPSite
- Added more explanation to documentation on which parameters are checked
- SPWeb
- Added more explanation to documentation on using this resource
Fixed
- SPConfigWizard
- Fixes issue where a CU installation wasn't registered properly in the config database. Added logic to run the Product Version timer job
- SPSearchTopology
- Fixes issue where applying a topology failed when the search service instance was disabled instead of offline
- SPSecureStoreServiceApp
- Fixes issue where custom database name was no longer used since v4.3
- SPShellAdmins
- Fixed issue with Get-DscConfiguration which threw an error when only one item was returned by the Get method
- SPWordAutomationServiceApp
- Fixed issue where provisioning the service app requires a second run to update all specified parameters
- SPWorkflowService
- Fixed issue configuring workflow service when no workflow service is currently configured
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)