Edit

Share via

Get-SPOSiteGroup

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

Gets all the groups on the specified site collection.

Syntax

Get-SPOSiteGroup
   [-Group <String>]
   [-Limit <Int32>]
   -Site <SpoSitePipeBind>
   [<CommonParameters>]

Description

Use the Get-SPOSiteGroup cmdlet to get all the groups on the specified site collection by using the Site parameter.

You must be a SharePoint Online administrator and a site collection administrator to run the cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at SharePoint Online PowerShell.

Examples

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

Get-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA

This example returns all the groups on the specified site collection https://contoso.sharepoint.com/sites/siteA.

Parameters

-Group

Specifies the group name.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-Limit

Specifies the maximum number of groups to return. The default value is 200.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-Site

Specifies the site collection scope.

Type:SpoSitePipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online