az communication identity

Reference

Note

This reference is part of the communication extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az communication identity command. Learn more about extensions.

Manage the Communication Resource's managed identities.

Commands

Name	Description	Type	Status
az communication identity assign	Assign a managed identity to the Communication Resource.	Extension	GA
az communication identity remove	Remove a managed identity from the communication resource.	Extension	GA
az communication identity show	Show the Communication Resource's managed identities.	Extension	GA
az communication identity token	Commands to manage user tokens for a Communication Service resource.	Extension	Deprecated
az communication identity token get-for-teams-user	Exchanges an Azure Active Directory (Azure AD) access token of a Teams user for a new ACS Identity access token with a matching expiration time.	Extension	Deprecated
az communication identity token issue	Issues a new access token with the specified scopes for a given User Identity. If no User Identity is specified, creates a new User Identity as well.	Extension	Deprecated
az communication identity token revoke	Revokes all access tokens for the specific ACS Identity.	Extension	Deprecated
az communication identity user	Commands to manage user identities for a Communication Service resource.	Extension	Deprecated
az communication identity user create	Creates a new ACS Identity.	Extension	Deprecated
az communication identity user delete	Deletes an existing ACS Identity, revokes all tokens for that ACS Identity and deletes all associated data.	Extension	Deprecated
az communication identity wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az communication identity assign

Assign a managed identity to the Communication Resource.

az communication identity assign --name
                                 --resource-group
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--user-assigned]

Required Parameters

--name -n

The name of the CommunicationService resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--system-assigned

Enable system assigned identity.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--user-assigned

Space separated resource IDs to add user-assigned identities. Use [] to remove all identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

az communication identity remove

Remove a managed identity from the communication resource.

az communication identity remove --name
                                 --resource-group
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--user-assigned]

Required Parameters

--name -n

The name of the CommunicationService resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--system-assigned

Enable system assigned identity.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--user-assigned

Space separated resource IDs to add user-assigned identities. Use [] to remove all identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

az communication identity show

Show the Communication Resource's managed identities.

az communication identity show --name
                               --resource-group

Required Parameters

--name -n

The name of the CommunicationService resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

az communication identity wait

Place the CLI in a waiting state until a condition is met.

az communication identity wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30

--name -n

The name of the CommunicationService resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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

Share via

az communication identity

Commands

az communication identity assign

Required Parameters

Optional Parameters

az communication identity remove

Required Parameters

Optional Parameters

az communication identity show

Required Parameters

az communication identity wait

Optional Parameters

Additional resources