Skip to content

Latest commit

 

History

History
140 lines (103 loc) · 2.93 KB

Grant-PnPSiteDesignRights.md

File metadata and controls

140 lines (103 loc) · 2.93 KB
Module Name title schema applicable external help file online version
PnP.PowerShell
Grant-PnPSiteDesignRights
2.0.0
SharePoint Online
PnP.PowerShell.dll-Help.xml

Grant-PnPSiteDesignRights

SYNOPSIS

Required Permissions

  • SharePoint: Access to the SharePoint Tenant Administration site

Grants the specified principals rights to use the site design.

SYNTAX

Grant-PnPSiteDesignRights [-Identity] <TenantSiteDesignPipeBind> -Principals <String[]>
 [-Rights <TenantSiteDesignPrincipalRights>] [-Connection <PnPConnection>]

DESCRIPTION

Allows to grant permission to use the site design for specified principal.

EXAMPLES

EXAMPLE 1

Grant-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -Principals "myuser@mydomain.com","myotheruser@mydomain.com"

Grants the specified principals View rights on the site design specified

EXAMPLE 2

Get-PnPSiteDesign -Title "MySiteDesign" -SiteScriptIds 438548fd-60dd-42cf-b843-2db506c8e259 -WebTemplate TeamSite | Grant-PnPSiteDesignRights -Principals "myuser@mydomain.com","myotheruser@mydomain.com"

Grants the specified principals View rights on the site design specified

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

The site design to use.

Type: TenantSiteDesignPipeBind
Parameter Sets: (All)

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Principals

One or more principals to grant rights to.

Type: String[]
Parameter Sets: (All)

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Rights

The rights to set. Defaults to 'View'

Type: TenantSiteDesignPrincipalRights
Parameter Sets: (All)
Accepted values: None, View

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

RELATED LINKS

Microsoft 365 Patterns and Practices