Skip to content

Latest commit

 

History

History
163 lines (121 loc) · 3.5 KB

New-PnPGroup.md

File metadata and controls

163 lines (121 loc) · 3.5 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

New-PnPGroup

SYNOPSIS

Adds group to the Site Groups List and returns a group object

SYNTAX

New-PnPGroup -Title <String>
             [-Description <String>]
             [-Owner <String>]
             [-AllowRequestToJoinLeave [<SwitchParameter>]]
             [-AutoAcceptRequestToJoinLeave [<SwitchParameter>]]
             [-AllowMembersEditMembership [<SwitchParameter>]]
             [-DisallowMembersViewMembership [<SwitchParameter>]]
             [-RequestToJoinEmail <String>]
             [-Web <WebPipeBind>]
             [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> New-PnPGroup -Title "My Site Users"

PARAMETERS

-AllowMembersEditMembership

A switch parameter that specifies whether group members can modify membership in the group

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-AllowRequestToJoinLeave

A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-AutoAcceptRequestToJoinLeave

A switch parameter that specifies whether users are automatically added or removed when they make a request

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Description

The description for the group

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-DisallowMembersViewMembership

A switch parameter that disallows group members to view membership.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Owner

The owner for the group, which can be a user or another group

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-RequestToJoinEmail

The e-mail address to which membership requests are sent

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Title

The Title of the group

Type: String
Parameter Sets: (All)

Required: True
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

OUTPUTS

RELATED LINKS

SharePoint Developer Patterns and Practices