Get-SPOSiteGroup
Gets all the groups on the specified site collection.
Syntax
Default (Default)
Get-SPOSiteGroup
-Site <SpoSitePipeBind>
[-Group <String>]
[-Limit <Int32>]
[<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
Applicable: SharePoint Online
Specifies the group name.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Limit
Applicable: SharePoint Online
Specifies the maximum number of groups to return. The default value is 200.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Site
Applicable: SharePoint Online
Specifies the site collection scope.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| 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 |
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.