Resource Type: dsc_sposite

Defined in:

lib/puppet/type/dsc_sposite.rb

Overview

The DSC SPOSite resource type. Automatically generated from version 1.21.1222.1

Properties

• dsc_allowselfserviceupgrade

  Specifies if the site administrator can upgrade the site collection.

• dsc_anonymouslinkexpirationindays

  Specifies that all anonymous/anyone links that have been created (or will be created) will expire after the set number of days. Only applies if OverrideTenantAnonymousLinkExpirationPolicy is set to true. To remove the expiration requirement, set the value to zero (0)

• dsc_applicationid

  Id of the Azure Active Directory application to authenticate with.

• dsc_applicationsecret

  Secret of the Azure Active Directory application to authenticate with.

• dsc_certificatepath

  Path to certificate used in service principal usually a PFX file.

• dsc_certificatethumbprint

  Thumbprint of the Azure Active Directory application’s authentication certificate to use for authentication.

• dsc_commentsonsitepagesdisabled

  Specifies if comments on site pages are enabled or disabled.

• dsc_defaultlinkpermission

  Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to ‘view’ permissions. Edit - Sets the default link permission for the site to ‘edit’ permissions.

• dsc_defaultsharinglinktype

  Specifies the default link type for the site collection. None - Respect the organization default sharing link type. AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link. Internal - Sets the default sharing link for this site to the ‘organization’ link or company shareable link. Direct - Sets the default sharing link for this site to the ‘Specific people’ link.

• dsc_denyaddandcustomizepages

  Determines whether the Add And Customize Pages right is denied on the site collection. For more information about permission levels, see User permissions and permission levels in SharePoint.

• dsc_disableappviews

  Disables App Views.

• dsc_disablecompanywidesharinglinks

  Disables Company wide sharing links.

• dsc_disableflows

  Disables Microsoft Flow for this site.

• dsc_ensure

  Present ensures the site collection exists, absent ensures it is removed

• dsc_huburl

  The URL of the Hub site the site collection needs to get connected to.

• dsc_localeid

  Specifies the language of the new site collection. Defaults to the current language of the web connected to.

• dsc_overridetenantanonymouslinkexpirationpolicy

  False - Respect the organization-level policy for anonymous or anyone link expiration. True - Override the organization-level policy for anonymous or anyone link expiration (can be more or less restrictive)

• dsc_owner

  Specifies the owner of the site.

• dsc_restrictedtoregion

  Defines geo-restriction settings for this site

• dsc_sharingalloweddomainlist

  Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter.

• dsc_sharingblockeddomainlist

  Specifies a list of email domains that is blocked for sharing with the external collaborators.

• dsc_sharingcapability

  Specifies what the sharing capabilities are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly.

• dsc_sharingdomainrestrictionmode

  Specifies the external sharing mode for domains.

• dsc_showpeoplepickersuggestionsforguestusers

  To enable the option to search for existing guest users at Site Collection Level, set this parameter to $true.

• dsc_socialbaronsitepagesdisabled

  Disables or enables the Social Bar for Site Collection.

• dsc_storagemaximumlevel

  Specifies the storage quota for this site collection in megabytes. This value must not exceed the company’s available quota.

• dsc_storagewarninglevel

  Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter.

• dsc_template

  Specifies with template of site to create.

• dsc_tenantid

  Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com

• dsc_timezoneid

  TimeZone ID of the site collection.

• dsc_title

  The title of the site collection.

Parameters

• dsc_certificatepassword

  Username can be made up to anything but password will be used for certificatePassword

• dsc_credential

  Credentials of the account to authenticate with.

• dsc_psdscrunascredential
• dsc_url (namevar)

  The URL of the site collection.

• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

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