az ad group

Manage Microsoft Entra groups.

Commands

Name	Description	Type	Status
az ad group create	Create a group.	Core	GA
az ad group delete	Delete a group.	Core	GA
az ad group get-member-groups	Get a collection of object IDs of groups of which the specified group is a member.	Core	GA
az ad group list	List groups in the directory.	Core	GA
az ad group member	Manage group members.	Core	GA
az ad group member add	Add a member to a group.	Core	GA
az ad group member check	Check if a member is in a group.	Core	GA
az ad group member list	Get the members of a group.	Core	GA
az ad group member remove	Remove a member from a group.	Core	GA
az ad group owner	Manage group owners.	Core	GA
az ad group owner add	Add a group owner.	Core	GA
az ad group owner list	List group owners.	Core	GA
az ad group owner remove	Remove a group owner.	Core	GA
az ad group show	Get the details of a group.	Core	GA

az ad group create

Create a group.

az ad group create --display-name
                   --mail-nickname
                   [--description]
                   [--force {false, true}]

Examples

Create a group in the directory. (autogenerated)

az ad group create --display-name MyDisplay --mail-nickname MyDisplay

Required Parameters

--display-name

Object's display name or its prefix.

--mail-nickname

Mail nickname.

Optional Parameters

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

--description

Group description.

--force

Always create a new group instead of updating the one with same display and mail nickname.

Property	Value
Accepted values:	false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ad group delete

Delete a group.

az ad group delete --group

Required Parameters

--group -g

Group's object id or display name(prefix also works if there is a unique match).

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ad group get-member-groups

Get a collection of object IDs of groups of which the specified group is a member.

az ad group get-member-groups --group
                              [--security-enabled-only {false, true}]

Required Parameters

--group -g

Group's object id or display name(prefix also 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.

--security-enabled-only

True to specify that only security groups that the entity is a member of should be returned; false to specify that all groups and directory roles that the entity is a member of should be returned.

Property	Value
Default value:	False
Accepted values:	false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ad group list

List groups in the directory.

az ad group list [--display-name]
                 [--filter]

Optional Parameters

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

--display-name

Object's display name or its prefix.

--filter

OData filter, e.g. --filter "displayname eq 'test' and servicePrincipalType eq 'Application'".

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ad group show

Get the details of a group.

az ad group show --group

Required Parameters

--group -g

Group's object id or display name(prefix also works if there is a unique match).

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False