Reference

Table of Contents

Resource types

dsc_spaccessserviceapp: The DSC SPAccessServiceApp resource type. Automatically generated from version 5.6.1
dsc_spaccessservices2010: The DSC SPAccessServices2010 resource type. Automatically generated from version 5.6.1
dsc_spalternateurl: The DSC SPAlternateUrl resource type. Automatically generated from version 5.6.1
dsc_spantivirussettings: The DSC SPAntivirusSettings resource type. Automatically generated from version 5.6.1
dsc_spappcatalog: The DSC SPAppCatalog resource type. Automatically generated from version 5.6.1
dsc_spappdomain: The DSC SPAppDomain resource type. Automatically generated from version 5.6.1
dsc_spappmanagementserviceapp: The DSC SPAppManagementServiceApp resource type. Automatically generated from version 5.6.1
dsc_spappstoresettings: The DSC SPAppStoreSettings resource type. Automatically generated from version 5.6.1
dsc_spauthenticationrealm: The DSC SPAuthenticationRealm resource type. Automatically generated from version 5.6.1
dsc_spazureaccesscontrolserviceappproxy: The DSC SPAzureAccessControlServiceAppProxy resource type. Automatically generated from version 5.6.1
dsc_spbcsserviceapp: The DSC SPBCSServiceApp resource type. Automatically generated from version 5.6.1
dsc_spblobcachesettings: The DSC SPBlobCacheSettings resource type. Automatically generated from version 5.6.1
dsc_spcacheaccounts: The DSC SPCacheAccounts resource type. Automatically generated from version 5.6.1
dsc_spcertificate: The DSC SPCertificate resource type. Automatically generated from version 5.6.1
dsc_spcertificatesettings: The DSC SPCertificateSettings resource type. Automatically generated from version 5.6.1
dsc_spconfigwizard: The DSC SPConfigWizard resource type. Automatically generated from version 5.6.1
dsc_spcontentdatabase: The DSC SPContentDatabase resource type. Automatically generated from version 5.6.1
dsc_spdatabaseaag: The DSC SPDatabaseAAG resource type. Automatically generated from version 5.6.1
dsc_spdesignersettings: The DSC SPDesignerSettings resource type. Automatically generated from version 5.6.1
dsc_spdiagnosticloggingsettings: The DSC SPDiagnosticLoggingSettings resource type. Automatically generated from version 5.6.1
dsc_spdiagnosticsprovider: The DSC SPDiagnosticsProvider resource type. Automatically generated from version 5.6.1
dsc_spdistributedcacheclientsettings: The DSC SPDistributedCacheClientSettings resource type. Automatically generated from version 5.6.1
dsc_spdistributedcacheservice: The DSC SPDistributedCacheService resource type. Automatically generated from version 5.6.1
dsc_spdocicon: The DSC SPDocIcon resource type. Automatically generated from version 5.6.1
dsc_spexcelserviceapp: The DSC SPExcelServiceApp resource type. Automatically generated from version 5.6.1
dsc_spfarm: The DSC SPFarm resource type. Automatically generated from version 5.6.1
dsc_spfarmadministrators: The DSC SPFarmAdministrators resource type. Automatically generated from version 5.6.1
dsc_spfarmpropertybag: The DSC SPFarmPropertyBag resource type. Automatically generated from version 5.6.1
dsc_spfarmsolution: The DSC SPFarmSolution resource type. Automatically generated from version 5.6.1
dsc_spfeature: The DSC SPFeature resource type. Automatically generated from version 5.6.1
dsc_sphealthanalyzerrulestate: The DSC SPHealthAnalyzerRuleState resource type. Automatically generated from version 5.6.1
dsc_spincomingemailsettings: The DSC SPIncomingEmailSettings resource type. Automatically generated from version 5.6.1
dsc_spinfopathformsserviceconfig: The DSC SPInfoPathFormsServiceConfig resource type. Automatically generated from version 5.6.1
dsc_spinstall: The DSC SPInstall resource type. Automatically generated from version 5.6.1
dsc_spinstalllanguagepack: The DSC SPInstallLanguagePack resource type. Automatically generated from version 5.6.1
dsc_spinstallprereqs: The DSC SPInstallPrereqs resource type. Automatically generated from version 5.6.1
dsc_spirmsettings: The DSC SPIrmSettings resource type. Automatically generated from version 5.6.1
dsc_sploglevel: The DSC SPLogLevel resource type. Automatically generated from version 5.6.1
dsc_spmachinetranslationserviceapp: The DSC SPMachineTranslationServiceApp resource type. Automatically generated from version 5.6.1
dsc_spmanagedaccount: The DSC SPManagedAccount resource type. Automatically generated from version 5.6.1
dsc_spmanagedmetadataserviceapp: The DSC SPManagedMetaDataServiceApp resource type. Automatically generated from version 5.6.1
dsc_spmanagedmetadataserviceappdefault: The DSC SPManagedMetaDataServiceAppDefault resource type. Automatically generated from version 5.6.1
dsc_spmanagedpath: The DSC SPManagedPath resource type. Automatically generated from version 5.6.1
dsc_spminrolecompliance: The DSC SPMinRoleCompliance resource type. Automatically generated from version 5.6.1
dsc_spoappprincipalmgmtserviceappproxy: The DSC SPOAppPrincipalMgmtServiceAppProxy resource type. Automatically generated from version 5.6.1
dsc_spofficeonlineserverbinding: The DSC SPOfficeOnlineServerBinding resource type. Automatically generated from version 5.6.1
dsc_spofficeonlineserversupressionsettings: The DSC SPOfficeOnlineServerSupressionSettings resource type. Automatically generated from version 5.6.1
dsc_spoutgoingemailsettings: The DSC SPOutgoingEmailSettings resource type. Automatically generated from version 5.6.1
dsc_sppasswordchangesettings: The DSC SPPasswordChangeSettings resource type. Automatically generated from version 5.6.1
dsc_spperformancepointserviceapp: The DSC SPPerformancePointServiceApp resource type. Automatically generated from version 5.6.1
dsc_sppowerpointautomationserviceapp: The DSC SPPowerPointAutomationServiceApp resource type. Automatically generated from version 5.6.1
dsc_spproductupdate: The DSC SPProductUpdate resource type. Automatically generated from version 5.6.1
dsc_spprojectserveradditionalsettings: The DSC SPProjectServerAdditionalSettings resource type. Automatically generated from version 5.6.1
dsc_spprojectserveradresourcepoolsync: The DSC SPProjectServerADResourcePoolSync resource type. Automatically generated from version 5.6.1
dsc_spprojectserverglobalpermissions: The DSC SPProjectServerGlobalPermissions resource type. Automatically generated from version 5.6.1
dsc_spprojectservergroup: The DSC SPProjectServerGroup resource type. Automatically generated from version 5.6.1
dsc_spprojectserverlicense: The DSC SPProjectServerLicense resource type. Automatically generated from version 5.6.1
dsc_spprojectserverpermissionmode: The DSC SPProjectServerPermissionMode resource type. Automatically generated from version 5.6.1
dsc_spprojectserverserviceapp: The DSC SPProjectServerServiceApp resource type. Automatically generated from version 5.6.1
dsc_spprojectservertimesheetsettings: The DSC SPProjectServerTimeSheetSettings resource type. Automatically generated from version 5.6.1
dsc_spprojectserverusersyncsettings: The DSC SPProjectServerUserSyncSettings resource type. Automatically generated from version 5.6.1
dsc_spprojectserverwsssettings: The DSC SPProjectServerWssSettings resource type. Automatically generated from version 5.6.1
dsc_sppublishserviceapplication: The DSC SPPublishServiceApplication resource type. Automatically generated from version 5.6.1
dsc_spquotatemplate: The DSC SPQuotaTemplate resource type. Automatically generated from version 5.6.1
dsc_spremotefarmtrust: The DSC SPRemoteFarmTrust resource type. Automatically generated from version 5.6.1
dsc_spsearchauthoritativepage: The DSC SPSearchAuthoritativePage resource type. Automatically generated from version 5.6.1
dsc_spsearchcontentsource: The DSC SPSearchContentSource resource type. Automatically generated from version 5.6.1
dsc_spsearchcrawldatabase: The DSC SPSearchCrawlDatabase resource type. Automatically generated from version 5.6.1
dsc_spsearchcrawlerimpactrule: The DSC SPSearchCrawlerImpactRule resource type. Automatically generated from version 5.6.1
dsc_spsearchcrawlmapping: The DSC SPSearchCrawlMapping resource type. Automatically generated from version 5.6.1
dsc_spsearchcrawlrule: The DSC SPSearchCrawlRule resource type. Automatically generated from version 5.6.1
dsc_spsearchfiletype: The DSC SPSearchFileType resource type. Automatically generated from version 5.6.1
dsc_spsearchindexpartition: The DSC SPSearchIndexPartition resource type. Automatically generated from version 5.6.1
dsc_spsearchmanagedproperty: The DSC SPSearchManagedProperty resource type. Automatically generated from version 5.6.1
dsc_spsearchmetadatacategory: The DSC SPSearchMetadataCategory resource type. Automatically generated from version 5.6.1
dsc_spsearchresultsource: The DSC SPSearchResultSource resource type. Automatically generated from version 5.6.1
dsc_spsearchserviceapp: The DSC SPSearchServiceApp resource type. Automatically generated from version 5.6.1
dsc_spsearchservicesettings: The DSC SPSearchServiceSettings resource type. Automatically generated from version 5.6.1
dsc_spsearchtopology: The DSC SPSearchTopology resource type. Automatically generated from version 5.6.1
dsc_spsecurestoreserviceapp: The DSC SPSecureStoreServiceApp resource type. Automatically generated from version 5.6.1
dsc_spsecuritytokenserviceconfig: The DSC SPSecurityTokenServiceConfig resource type. Automatically generated from version 5.6.1
dsc_spselfservicesitecreation: The DSC SPSelfServiceSiteCreation resource type. Automatically generated from version 5.6.1
dsc_spservice: The DSC SPService resource type. Automatically generated from version 5.6.1
dsc_spserviceapppool: The DSC SPServiceAppPool resource type. Automatically generated from version 5.6.1
dsc_spserviceappproxygroup: The DSC SPServiceAppProxyGroup resource type. Automatically generated from version 5.6.1
dsc_spserviceappsecurity: The DSC SPServiceAppSecurity resource type. Automatically generated from version 5.6.1
dsc_spserviceidentity: The DSC SPServiceIdentity resource type. Automatically generated from version 5.6.1
dsc_spserviceinstance: The DSC SPServiceInstance resource type. Automatically generated from version 5.6.1
dsc_spsessionstateservice: The DSC SPSessionStateService resource type. Automatically generated from version 5.6.1
dsc_spshelladmins: The DSC SPShellAdmins resource type. Automatically generated from version 5.6.1
dsc_spsite: The DSC SPSite resource type. Automatically generated from version 5.6.1
dsc_spsitepropertybag: The DSC SPSitePropertyBag resource type. Automatically generated from version 5.6.1
dsc_spsiteurl: The DSC SPSiteUrl resource type. Automatically generated from version 5.6.1
dsc_spstateserviceapp: The DSC SPStateServiceApp resource type. Automatically generated from version 5.6.1
dsc_spsubscriptionsettingsserviceapp: The DSC SPSubscriptionSettingsServiceApp resource type. Automatically generated from version 5.6.1
dsc_sptimerjobstate: The DSC SPTimerJobState resource type. Automatically generated from version 5.6.1
dsc_sptrustedidentitytokenissuer: The DSC SPTrustedIdentityTokenIssuer resource type. Automatically generated from version 5.6.1
dsc_sptrustedidentitytokenissuerproviderrealms: The DSC SPTrustedIdentityTokenIssuerProviderRealms resource type. Automatically generated from version 5.6.1
dsc_sptrustedrootauthority: The DSC SPTrustedRootAuthority resource type. Automatically generated from version 5.6.1
dsc_sptrustedsecuritytokenissuer: The DSC SPTrustedSecurityTokenIssuer resource type. Automatically generated from version 5.6.1
dsc_spusageapplication: The DSC SPUsageApplication resource type. Automatically generated from version 5.6.1
dsc_spusagedefinition: The DSC SPUsageDefinition resource type. Automatically generated from version 5.6.1
dsc_spuserprofileproperty: The DSC SPUserProfileProperty resource type. Automatically generated from version 5.6.1
dsc_spuserprofilesection: The DSC SPUserProfileSection resource type. Automatically generated from version 5.6.1
dsc_spuserprofileserviceapp: The DSC SPUserProfileServiceApp resource type. Automatically generated from version 5.6.1
dsc_spuserprofileserviceapppermissions: The DSC SPUserProfileServiceAppPermissions resource type. Automatically generated from version 5.6.1
dsc_spuserprofilesyncconnection: The DSC SPUserProfileSyncConnection resource type. Automatically generated from version 5.6.1
dsc_spuserprofilesyncservice: The DSC SPUserProfileSyncService resource type. Automatically generated from version 5.6.1
dsc_spvisioserviceapp: The DSC SPVisioServiceApp resource type. Automatically generated from version 5.6.1
dsc_spweb: The DSC SPWeb resource type. Automatically generated from version 5.6.1
dsc_spwebappauthentication: The DSC SPWebAppAuthentication resource type. Automatically generated from version 5.6.1
dsc_spwebappblockedfiletypes: The DSC SPWebAppBlockedFileTypes resource type. Automatically generated from version 5.6.1
dsc_spwebappclientcallablesettings: The DSC SPWebAppClientCallableSettings resource type. Automatically generated from version 5.6.1
dsc_spwebappgeneralsettings: The DSC SPWebAppGeneralSettings resource type. Automatically generated from version 5.6.1
dsc_spwebapphttpthrottlingmonitor: The DSC SPWebAppHttpThrottlingMonitor resource type. Automatically generated from version 5.6.1
dsc_spwebapplication: The DSC SPWebApplication resource type. Automatically generated from version 5.6.1
dsc_spwebapplicationappdomain: The DSC SPWebApplicationAppDomain resource type. Automatically generated from version 5.6.1
dsc_spwebapplicationextension: The DSC SPWebApplicationExtension resource type. Automatically generated from version 5.6.1
dsc_spwebapppeoplepickersettings: The DSC SPWebAppPeoplePickerSettings resource type. Automatically generated from version 5.6.1
dsc_spwebapppermissions: The DSC SPWebAppPermissions resource type. Automatically generated from version 5.6.1
dsc_spwebapppolicy: The DSC SPWebAppPolicy resource type. Automatically generated from version 5.6.1
dsc_spwebapppropertybag: The DSC SPWebAppPropertyBag resource type. Automatically generated from version 5.6.1
dsc_spwebappproxygroup: The DSC SPWebAppProxyGroup resource type. Automatically generated from version 5.6.1
dsc_spwebappsiteuseanddeletion: The DSC SPWebAppSiteUseAndDeletion resource type. Automatically generated from version 5.6.1
dsc_spwebappsuitebar: The DSC SPWebAppSuiteBar resource type. Automatically generated from version 5.6.1
dsc_spwebappthrottlingsettings: The DSC SPWebAppThrottlingSettings resource type. Automatically generated from version 5.6.1
dsc_spwebappworkflowsettings: The DSC SPWebAppWorkflowSettings resource type. Automatically generated from version 5.6.1
dsc_spwordautomationserviceapp: The DSC SPWordAutomationServiceApp resource type. Automatically generated from version 5.6.1
dsc_spworkflowservice: The DSC SPWorkflowService resource type. Automatically generated from version 5.6.1
dsc_spworkmanagementserviceapp: The DSC SPWorkManagementServiceApp resource type. Automatically generated from version 5.6.1

Resource types

`dsc_spaccessserviceapp`

The DSC SPAccessServiceApp resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', 'absent']]

Present ensures service app exists, absent ensures it is removed

Parameters

The following parameters are available in the dsc_spaccessserviceapp type.

dsc_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_name`

namevar

Data type: String

The name of the service application

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spaccessservices2010`

The DSC SPAccessServices2010 resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', 'absent']]

Present ensures service app exists, absent ensures it is removed

Parameters

The following parameters are available in the dsc_spaccessservices2010 type.

dsc_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_name`

namevar

Data type: String

The name of the service application

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spalternateurl`

The DSC SPAlternateUrl resource type. Automatically generated from version 5.6.1

Properties

The following properties are available in the dsc_spalternateurl type.

`dsc_ensure`

Data type: Optional[Enum['Present', 'present', 'Absent', '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_psdscrunascredential
dsc_timeout
dsc_url
dsc_webappname
dsc_zone
name
validation_mode

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`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', 'default', 'Intranet', 'intranet', 'Extranet', 'extranet', 'Custom', 'custom', 'Internet', 'internet']

The Zone to use for the alternate URL

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spantivirussettings`

The DSC SPAntivirusSettings resource type. Automatically generated from version 5.6.1

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_issingleinstance
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_issingleinstance`

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spappcatalog`

The DSC SPAppCatalog resource type. Automatically generated from version 5.6.1

Parameters

The following parameters are available in the dsc_spappcatalog type.

dsc_psdscrunascredential
dsc_siteurl
dsc_timeout
name
validation_mode

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], 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

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spappdomain`

The DSC SPAppDomain resource type. Automatically generated from version 5.6.1

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
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_appdomain`

namevar

Data type: String

The domain name for apps to use in this farm

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spappmanagementserviceapp`

The DSC SPAppManagementServiceApp resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', '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
dsc_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_databasecredentials`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

If using SQL authentication, the SQL credentials to use to connect to the instance

`dsc_name`

namevar

Data type: String

The name of the app management service application

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spappstoresettings`

The DSC SPAppStoreSettings resource type. Automatically generated from version 5.6.1

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_psdscrunascredential
dsc_timeout
dsc_webappurl
name
validation_mode

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

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

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spauthenticationrealm`

The DSC SPAuthenticationRealm resource type. Automatically generated from version 5.6.1

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_issingleinstance
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_issingleinstance`

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spazureaccesscontrolserviceappproxy`

The DSC SPAzureAccessControlServiceAppProxy resource type. Automatically generated from version 5.6.1

Properties

The following properties are available in the dsc_spazureaccesscontrolserviceappproxy type.

`dsc_ensure`

Data type: Optional[Enum['Present', 'present', 'Absent', '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_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`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 => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spbcsserviceapp`

The DSC SPBCSServiceApp resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', '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
dsc_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_databasecredentials`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

If using SQL authentication, the SQL credentials to use to connect to the instance

`dsc_name`

namevar

Data type: String

The name of the BCS service app

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spblobcachesettings`

The DSC SPBlobCacheSettings resource type. Automatically generated from version 5.6.1

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_psdscrunascredential
dsc_timeout
dsc_webappurl
dsc_zone
name
validation_mode

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`dsc_webappurl`

namevar

Data type: String

The URL of the web application

`dsc_zone`

namevar

Data type: Enum['Default', 'default', 'Intranet', 'intranet', 'Internet', 'internet', 'Custom', 'custom', 'Extranet', '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.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spcacheaccounts`

The DSC SPCacheAccounts resource type. Automatically generated from version 5.6.1

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_psdscrunascredential
dsc_timeout
dsc_webappurl
name
validation_mode

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

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

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spcertificate`

The DSC SPCertificate resource type. Automatically generated from version 5.6.1

Properties

The following properties are available in the dsc_spcertificate type.

`dsc_ensure`

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Present ensures certificate exists, absent ensures it is removed

`dsc_exportable`

Data type: Optional[Boolean]

Specifies if the certificate should be exportable after import

`dsc_store`

Data type: Optional[Enum['EndEntity', 'endentity', 'Intermediate', 'intermediate', 'Pending', 'pending', 'Root', 'root']]

Specifies the store in which the certificate should be placed

Parameters

The following parameters are available in the dsc_spcertificate type.

dsc_certificatefilepath
dsc_certificatepassword
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_certificatefilepath`

namevar

Data type: String

Specifies path to the certificate file (PFX or CER)

`dsc_certificatepassword`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

The password of the PFX file

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spcertificatesettings`

The DSC SPCertificateSettings resource type. Automatically generated from version 5.6.1

Properties

The following properties are available in the dsc_spcertificatesettings type.

`dsc_certificateexpirationattentionthreshold`

Data type: Optional[Integer[0, 4294967295]]

Specifies the certificate expiration attention threshold

`dsc_certificateexpirationerrorthreshold`

Data type: Optional[Integer[0, 4294967295]]

Specifies the certificate expiration error threshold

`dsc_certificateexpirationwarningthreshold`

Data type: Optional[Integer[0, 4294967295]]

Specifies the certificate expiration warning threshold

`dsc_certificatenotificationcontacts`

Data type: Optional[Array[String]]

Specifies the certificate notification contacts

`dsc_country`

Data type: Optional[String]

Specifies the default country

`dsc_ellipticcurve`

Data type: Optional[Enum['nistP256', 'nistp256', 'nistP384', 'nistp384', 'nistP521', 'nistp521']]

Specifies the default elliptic curve (Default=nistP256)

`dsc_hashalgorithm`

Data type: Optional[Enum['SHA256', 'sha256', 'SHA384', 'sha384', 'SHA512', 'sha512']]

Specifies the default hash algorithm (Default=SHA256

`dsc_keyalgorithm`

Data type: Optional[Enum['ECC', 'ecc', 'RSA', 'rsa']]

Specifies the default key algorithm

`dsc_keysize`

Data type: Optional[Enum['0', '2048', '4096', '8192', '16384']]

Specifies the default key size (Default=2048)

`dsc_locality`

Data type: Optional[String]

Specifies the default locality

`dsc_organization`

Data type: Optional[String]

Specifies the default organization

`dsc_organizationalunit`

Data type: Optional[String]

Specifies the default organizational unit

`dsc_rsasignaturepadding`

Data type: Optional[Enum['Pkcs1', 'pkcs1', 'Pss', 'pss']]

Specifies the default RSA signature padding (Default=Pkcs1)

`dsc_state`

Data type: Optional[String]

Specifies the default state

Parameters

The following parameters are available in the dsc_spcertificatesettings type.

dsc_issingleinstance
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_issingleinstance`

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spconfigwizard`

The DSC SPConfigWizard resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', 'absent']]

Present to run the Configuration Wizard. Absent is currently not supported

Parameters

The following parameters are available in the dsc_spconfigwizard type.

dsc_issingleinstance
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_issingleinstance`

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spcontentdatabase`

The DSC SPContentDatabase resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', '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
dsc_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_databasecredentials`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

If using SQL authentication, the SQL credentials to use to connect to the instance

`dsc_name`

namevar

Data type: String

Specifies the name of the content database

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spdatabaseaag`

The DSC SPDatabaseAAG resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', '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
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_databasename`

namevar

Data type: String

The name of the database to put in the AlwaysOn group

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spdesignersettings`

The DSC SPDesignerSettings resource type. Automatically generated from version 5.6.1

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', 'webapplication', 'SiteCollection', 'sitecollection']

Define the scope of the configuration - either WebApplication or SiteCollection

Parameters

The following parameters are available in the dsc_spdesignersettings type.

dsc_psdscrunascredential
dsc_timeout
dsc_webappurl
name
validation_mode

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

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

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spdiagnosticloggingsettings`

The DSC SPDiagnosticLoggingSettings resource type. Automatically generated from version 5.6.1

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_issingleinstance
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_issingleinstance`

namevar

Data type: Enum['Yes', 'yes']

Specifies the resource is a single instance, the value must be 'Yes'

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spdiagnosticsprovider`

The DSC SPDiagnosticsProvider resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', '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_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_name`

namevar

Data type: String

Name of the Diagnostics Provider to configure

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spdistributedcacheclientsettings`

The DSC SPDistributedCacheClientSettings resource type. Automatically generated from version 5.6.1

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_ddbfcchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed Db Level Failover Cache (SP2019 and above)

`dsc_ddbfcmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed Db Level Failover Cache (SP2019 and above)

`dsc_ddbfcrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed Db Level Failover Cache (SP2019 and above)

`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_dehcchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed Edge Header Cache (SP2019 and above)

`dsc_dehcmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed Edge Header Cache (SP2019 and above)

`dsc_dehcrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed Edge Header Cache (SP2019 and above)

`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_dfsptcchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed File Store Performance Trace Cache (SP2019 and above)

`dsc_dfsptcmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed File Store Performance Trace Cache (SP2019 and above)

`dsc_dfsptcrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed File Store Performance Trace Cache (SP2019 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_dsgcchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed Stop Gap Cache (SP2019 and above)

`dsc_dsgcmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed Stop Gap Cache (SP2019 and above)

`dsc_dsgcrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed Stop Gap Cache (SP2019 and above)

`dsc_dspabscchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed SP Abs Blob Cache (SP2019 and above)

`dsc_dspabscmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed SP Abs Blob Cache (SP2019 and above)

`dsc_dspabscrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed SP Abs Blob Cache (SP2019 and above)

`dsc_dspcvcchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed SP Certificate Validator Cache (SP2019 and above)

`dsc_dspcvcmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed SP Certificate Validator Cache (SP2019 and above)

`dsc_dspcvcrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed SP Certificate Validator Cache (SP2019 and above)

`dsc_dspoatcchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed SP OAuth Token Cache (SP2019 and above)

`dsc_dspoatcmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed SP OAuth Token Cache (SP2019 and above)

`dsc_dspoatcrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed SP OAuth Token Cache (SP2019 and above)

`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_duacchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed Unified Apps Cache (SP2019 and above)

`dsc_duacmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed Unified Apps Cache (SP2019 and above)

`dsc_duacrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed Unified Apps Cache (SP2019 and above)

`dsc_duaucchannelopentimeout`

Data type: Optional[Integer[0, 4294967295]]

Channel timeout for the Distributed Unified Audit Cache (SP2019 and above)

`dsc_duaucmaxconnectionstoserver`

Data type: Optional[Integer[0, 4294967295]]

Maximum number of connections to the Distributed Unified Audit Cache (SP2019 and above)

`dsc_duaucrequesttimeout`

Data type: Optional[Integer[0, 4294967295]]

Request timeout for the Distributed Unified Audit Cache (SP2019 and above)

`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_issingleinstance
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_issingleinstance`

namevar

Data type: Enum['Yes', 'yes']

Unique key for the resource. Set to 'Yes' to apply configuration.

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spdistributedcacheservice`

The DSC SPDistributedCacheService resource type. Automatically generated from version 5.6.1

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', 'present', 'Absent', '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_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`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 => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spdocicon`

The DSC SPDocIcon resource type. Automatically generated from version 5.6.1

Properties

The following properties are available in the dsc_spdocicon type.

`dsc_edittext`

Data type: Optional[String]

Specifies the edit text for the file type

`dsc_ensure`

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Present to configure the file type. Absent is remove the file type

`dsc_iconfile`

Data type: Optional[String]

Specifies the full path to the image file for the file type

`dsc_opencontrol`

Data type: Optional[String]

Specifies the Open Control command for the file type

Parameters

The following parameters are available in the dsc_spdocicon type.

dsc_filetype
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_filetype`

namevar

Data type: String

Specifies the file type to configure the docicon for

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spexcelserviceapp`

The DSC SPExcelServiceApp resource type. Automatically generated from version 5.6.1

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', 'none', 'Connection', 'connection']]

Requires that encryption is used between the end-user and the server running Excel Services Application.

`dsc_ensure`

Data type: Optional[Enum['Present', 'present', 'Absent', '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', 'useimpersonation', 'UseFileAccessAccount', 'usefileaccessaccount']]

Specifies the authentication method that Excel Services Application uses to retrieve files.

`dsc_loadbalancingscheme`

Data type: Optional[Enum['RoundRobin', 'roundrobin', 'Local', 'local', 'WorkbookURL', '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', 'sharepoint', 'UNC', 'unc', 'HTTP', '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', 'none', 'Dcl', 'dcl', 'DclandEmbedded', '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', 'file', 'Manual', 'manual', 'Auto', 'auto', 'AutoDataTables', '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_name
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_name`

namevar

Data type: String

The name of the service application

`dsc_psdscrunascredential`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], Sensitive[String[1]]] }]]

`dsc_timeout`

Data type: Optional[Integer]

The maximum time in seconds to wait for the DSC resource to complete.

`name`

namevar

Data type: String

Description of the purpose for this resource declaration.

`validation_mode`

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

`dsc_spfarm`

The DSC SPFarm resource type. Automatically generated from version 5.6.1

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', 'ntlm', 'Kerberos', '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', 'off', 'On', 'on', 'OnDemand', 'ondemand']]

Specifies the state of the Developer Dashboard ('OnDemand' is SP2013 only)

`dsc_ensure`

Data type: Optional[Enum['Present', 'present', 'Absent', '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', 'application', 'ApplicationWithSearch', 'applicationwithsearch', 'Custom', 'custom', 'DistributedCache', 'distributedcache', 'Search', 'search', 'SingleServerFarm', 'singleserverfarm', 'WebFrontEnd', 'webfrontend', 'WebFrontEndWithDistributedCache', 'webfrontendwithdistributedcache']]

SharePoint 2016 & 2019 only - the MinRole role to enroll this server as

`dsc_skipregisterasdistributedcachehost`

Data type: Optional[Boolean]

Set to true to not register the server computer as a distributed cache host

`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
dsc_databasecredentials
dsc_farmaccount
dsc_issingleinstance
dsc_passphrase
dsc_psdscrunascredential
dsc_timeout
name
validation_mode

`dsc_applicationcredentialkey`

Data type: Optional[Struct[{ user => String[1], password => Variant[String[1], 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 => Variant[String[1], 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 => Variant[String[1], Sensitive[String[1]]] }]]