Edit

Share via


Grant-SPOSiteDesignRights

Used to apply permissions to a set of users or a security group, effectively scoping the visibility of the site design in the UX. They start off public, but after you set permissions, only those groups or users with permissions can access the site design.

Syntax

Default (Default)

Grant-SPOSiteDesignRights
    [-Identity] <SPOSiteDesignPipeBind>
    -Principals <String[]>
    -Rights <SPOSiteDesignPrincipalRights>
    [<CommonParameters>]

Description

Used to apply permissions to a set of users or a security group, effectively scoping the visibility of the site design in the UX. They start off public, but after you set permissions, only those groups or users with permissions can access the site design.

Examples

Example 1

This example shows how to grant view rights on a site design to Nestor (a user at the fictional Contoso site).

Grant-SPOSiteDesignRights `
         -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
         -Principals "nestorw@contoso.onmicrosoft.com" `
         -Rights View

Parameters

-Identity

Applicable: SharePoint Online

The ID of the site design to get scoping information.

Parameter properties

Type:Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Principals

Applicable: SharePoint Online

One or more principles to add permissions for.

Parameter properties

Type:

System.String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Rights

Applicable: SharePoint Online

Always set to the value View. Any user or group with view permissions can view and use the site design.

Parameter properties

Type:Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPrincipalRights
Default value:None
Accepted values:View
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind

Outputs

System.Object