Resource Type: dsc_spsite

Defined in:

lib/puppet/type/dsc_spsite.rb

Providers:

powershell

Overview

The DSC SPSite resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPSite/MSFT_SPSite.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_administrationsitetype

  AdministrationSiteType - Specifies the type of the site collection: Regular site or tenant administration site Valid values are TenantAdministration, None.

• dsc_compatibilitylevel

  CompatibilityLevel - The compatibility level of the site

• dsc_contentdatabase

  ContentDatabase - The name of the content database to create the site in

• dsc_createdefaultgroups

  CreateDefaultGroups - Create the default site groups in the site collection

  Supported values:

  • true
  • false
• dsc_description

  Description - The description to apply to the site collection

• dsc_hostheaderwebapplication

  HostHeaderWebApplication - The URL of the host header web application to create this site in

• dsc_installaccount

  InstallAccount - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

• dsc_language

  Language - The language code of the site

• dsc_name

  Name - The display name of the site collection

• dsc_owneralias

  OwnerAlias - The username of the site collection administrator

• dsc_owneremail

  OwnerEmail - The email address of the site collection administrator

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_quotatemplate

  QuotaTemplate - The quota template to apply to the site collection

• dsc_secondaryemail

  SecondaryEmail - The secondary site collection admin email address

• dsc_secondaryowneralias

  SecondaryOwnerAlias - The secondary site collection admin username

• dsc_template

  Template - The template to apply to the site collection

• dsc_url

  Url - The URL of the site collection

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_spsite` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.