Skip to content

Latest commit

 

History

History
137 lines (102 loc) · 3.47 KB

Set-PnPGroupPermissions.md

File metadata and controls

137 lines (102 loc) · 3.47 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Set-PnPGroupPermissions

SYNOPSIS

Adds and/or removes permissions of a specific SharePoint group

SYNTAX

ByName

Set-PnPGroupPermissions -Identity <GroupPipeBind>
                        [-List <ListPipeBind>]
                        [-AddRole <String[]>]
                        [-RemoveRole <String[]>]
                        [-Web <WebPipeBind>]
                        [-Connection <SPOnlineConnection>]

EXAMPLES

------------------EXAMPLE 1------------------

PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole Contribute

Adds the 'Contribute' permission to the SharePoint group with the name 'My Site Members'

------------------EXAMPLE 2------------------

PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole 'Full Control' -AddRole 'Read'

Removes the 'Full Control' from and adds the 'Contribute' permissions to the SharePoint group with the name 'My Site Members'

------------------EXAMPLE 3------------------

PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole @('Contribute', 'Design')

Adds the 'Contribute' and 'Design' permissions to the SharePoint group with the name 'My Site Members'

------------------EXAMPLE 4------------------

PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole @('Contribute', 'Design')

Removes the 'Contribute' and 'Design' permissions from the SharePoint group with the name 'My Site Members'

------------------EXAMPLE 5------------------

PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -List 'MyList' -RemoveRole @('Contribute')

Removes the 'Contribute' permissions from the list 'MyList' for the group with the name 'My Site Members'

PARAMETERS

-AddRole

Name of the permission set to add to this SharePoint group

Type: String[]
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Identity

Get the permissions of a specific group by name

Type: GroupPipeBind
Parameter Sets: ByName
Aliases: Name

Required: True
Position: 0
Accept pipeline input: True

-List

The list to apply the command to.

Type: ListPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-RemoveRole

Name of the permission set to remove from this SharePoint group

Type: String[]
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

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

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices