Resource Type: dsc_spohubsite

Defined in:
lib/puppet/type/dsc_spohubsite.rb

Overview

The DSC SPOHubSite resource type. Automatically generated from version 1.21.1222.1

Properties

  • dsc_allowedtojoin

    The users or mail-enabled security groups which are allowed to associate their site with a hub site

  • 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_description

    The description of the hub site

  • dsc_ensure

    Present ensures the site collection is registered as hub site, absent ensures it is unregistered

  • dsc_logourl

    The url to the logo of the hub site

  • dsc_requiresjoinapproval

    Does the hub site require approval to join

  • dsc_sitedesignid

    The guid of the site design to link to the hub site

  • dsc_tenantid

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

  • dsc_title

    The title of the hub site

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