az msgraph group

Manage Microsoft Entra groups.

Commands

Name Description Type Status
az msgraph group list

List Microsoft Entra groups.

Core Preview
az msgraph group member

Manage members of a Microsoft Entra group.

Core Preview
az msgraph group member check

Check whether a directory object is a member of a Microsoft Entra group.

Core Preview
az msgraph group member list

List the members of a Microsoft Entra group.

Core Preview
az msgraph group show

Get the details of a Microsoft Entra group.

Core Preview

az msgraph group list

Preview

List Microsoft Entra groups.

List groups in your Microsoft Entra tenant. Filter results by a display name prefix or an OData $filter expression. You can also project custom fields with --select, include relationships with --expand, and use advanced OData options like --orderby and --search. Some advanced filters may require --consistency-level eventual.

az msgraph group list [--append-selected]
                      [--consistency-level]
                      [--display-name]
                      [--expand]
                      [--filter]
                      [--orderby]
                      [--search]
                      [--select]

Examples

List all groups

az msgraph group list

List groups whose display name starts with a prefix

az msgraph group list --display-name Sales

List groups with a custom filter expression

az msgraph group list --filter "securityEnabled eq true" --consistency-level eventual

List groups with a supported string filter expression

az msgraph group list --filter "startswith(displayName,'Team')"

List groups with custom projection and default fields

az msgraph group list --select id displayName mailNickname --append-selected

Search groups by display name

az msgraph group list --search "\"displayName:sales\"" --consistency-level eventual

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--append-selected

When set with Select, include the default property set alongside the values in Select rather than replacing them.

--consistency-level

Set to 'eventual' to enable advanced query features such as $search, $count, or $orderby on non-indexed properties.

--display-name

List groups whose display name starts with the specified prefix.

--expand

Related properties to include in the response, for example members.

--filter

OData $filter expression, for example "securityEnabled eq true".

--orderby

OData $orderby values, for example 'displayName' or 'createdDateTime desc'.

--search

OData $search expression, for example "displayName:contoso". Requires ConsistencyLevel eventual.

--select

Properties to return. Combine with AppendSelected to include the default properties as well.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h -help -? --?

Show help for the command or group and exit.

--no-cache

Bypass the extension discovery cache and reload extensions from disk.

--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, table, tsv, yaml, yamlc
--query

JMESPath query string to filter/project the command result before rendering.

az msgraph group show

Preview

Get the details of a Microsoft Entra group.

Retrieve full details for a group. Accepts either the group's object ID or its display name (prefix works if there is a unique match).

az msgraph group show --group
                      [--append-selected]
                      [--expand]
                      [--select]

Examples

Show a group by object ID

az msgraph group show --group 11111111-2222-3333-4444-555555555555

Show a group by display name

az msgraph group show --group Sales

Show a group with selected fields only

az msgraph group show --group Sales --select id displayName mailNickname

Show a group with selected fields plus default fields

az msgraph group show --group Sales --select id displayName mailNickname --append-selected

Required Parameters

--group -g

The group's object ID or display name (prefix works if there is a unique match).

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--append-selected

When set with Select, include the default property set alongside the values in Select rather than replacing them.

--expand

Related properties to include in the response, for example members.

--select

Properties to return. Combine with AppendSelected to include the default properties as well.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h -help -? --?

Show help for the command or group and exit.

--no-cache

Bypass the extension discovery cache and reload extensions from disk.

--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, table, tsv, yaml, yamlc
--query

JMESPath query string to filter/project the command result before rendering.