aad o365group list¶
Lists Microsoft 365 Groups in the current tenant
Usage¶
m365 aad o365group list [options]
Options¶
-d, --displayName [displayName]
- Retrieve only groups with displayName starting with the specified value
-m, --mailNickname [displayName]
- Retrieve only groups with mailNickname starting with the specified value
--includeSiteUrl
- Set to retrieve the site URL for each group
--deleted
- Set to only retrieve deleted groups
--orphaned
- Set to only retrieve groups without owners
-h, --help [help]
- Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are
options
,examples
,remarks
,response
,full
. Default isfull
. --query [query]
- JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
- Output type.
json,text,csv,md
. Defaultjson
--verbose
- Runs command with verbose logging
--debug
- Runs command with debug logging
Remarks¶
Using the --includeSiteUrl
option, you can retrieve the URL of the site associated with the particular Microsoft 365 Group. If you however retrieve too many groups and will try to get their site URLs, you will most likely get an error as the command will get throttled, issuing too many requests, too frequently. If you get an error, consider narrowing down the result set using the --displayName
and --mailNickname
filters.
Retrieving the URL of the site associated with the particular Microsoft 365 Group is not possible when retrieving deleted groups.
Using the --orphaned
option, you can retrieve Microsoft 365 Groups without owners.
Examples¶
List all Microsoft 365 Groups in the tenant
m365 aad o365group list
List Microsoft 365 Groups with display name starting with Project
m365 aad o365group list --displayName Project
List Microsoft 365 Groups mail nick name starting with team
m365 aad o365group list --mailNickname team
List deleted Microsoft 365 Groups with display name starting with Project
m365 aad o365group list --displayName Project --deleted
List deleted Microsoft 365 Groups mail nick name starting with team
m365 aad o365group list --mailNickname team --deleted
List Microsoft 365 Groups with display name starting with Project including the URL of the corresponding SharePoint site
m365 aad o365group list --displayName Project --includeSiteUrl
List Microsoft 365 Groups without owners
m365 aad o365group list --orphaned