az communication
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 command. Learn more about extensions.
Manage communication service with communication.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az communication chat |
Commands to interact with Azure Communication Services Chat gateway. |
Extension | Preview |
| az communication chat message |
Commands to manage messages in a chat thread of a Communication Service resource. |
Extension | Preview |
| az communication chat message delete |
Deletes a message from a chat thread by id. |
Extension | Preview |
| az communication chat message get |
Gets a message from a chat thread by id. |
Extension | Preview |
| az communication chat message list |
Gets list of messages from a chat thread. |
Extension | Preview |
| az communication chat message receipt |
Commands to manage message read-receipts in a chat thread of a Communication Service resource. |
Extension | Preview |
| az communication chat message receipt list |
Gets read receipts of a chat thread. |
Extension | Preview |
| az communication chat message receipt send |
Posts a read receipt event to a chat thread, on behalf of a user. |
Extension | Preview |
| az communication chat message send |
Sends a message to a chat thread. |
Extension | Preview |
| az communication chat message update |
Updates a message. |
Extension | Preview |
| az communication chat participant |
Commands to manage participants in a chat thread of a Communication Service resource. |
Extension | Preview |
| az communication chat participant add |
Adds a participant to a chat thread. |
Extension | Preview |
| az communication chat participant list |
Gets the participants of a chat thread. |
Extension | Preview |
| az communication chat participant remove |
Removes a participant from a chat thread. |
Extension | Preview |
| az communication chat thread |
Commands to manage chat thread of a Communication Service resource. |
Extension | Preview |
| az communication chat thread create |
Creates a chat thread. |
Extension | Preview |
| az communication chat thread delete |
Deletes a chat thread. |
Extension | Preview |
| az communication chat thread list |
Gets the list of chat threads of a user. |
Extension | Preview |
| az communication chat thread update-topic |
Updates the topic of a chat thread. |
Extension | Preview |
| az communication create |
Create a new CommunicationService or update an existing CommunicationService. |
Extension | GA |
| az communication delete |
Delete to delete a CommunicationService. |
Extension | GA |
| az communication email |
Manage Communication Email. |
Extension | Preview |
| az communication email create |
Create a new EmailService or update an existing EmailService. |
Extension | Preview |
| az communication email delete |
Delete to delete a EmailService. |
Extension | Preview |
| az communication email domain |
Manage Communication Email Domain. |
Extension | Preview |
| az communication email domain cancel-verification |
Cancel verification of DNS record. |
Extension | Preview |
| az communication email domain create |
Create a new Domains resource under the parent EmailService resource or update an existing Domains resource. |
Extension | Preview |
| az communication email domain delete |
Delete to delete a Domains resource. |
Extension | Preview |
| az communication email domain initiate-verification |
Initiate verification of DNS record. |
Extension | Preview |
| az communication email domain list |
List requests to list all Domains resources under the parent EmailServices resource. |
Extension | Preview |
| az communication email domain sender-username |
Manage Communication Email Domain Sender-Username. |
Extension | Preview |
| az communication email domain sender-username create |
Create a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource. |
Extension | Preview |
| az communication email domain sender-username delete |
Delete to delete a SenderUsernames resource. |
Extension | Preview |
| az communication email domain sender-username list |
List all valid sender usernames for a domains resource. |
Extension | Preview |
| az communication email domain sender-username show |
Get a valid sender username for a domains resource. |
Extension | Preview |
| az communication email domain sender-username update |
Update a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource. |
Extension | Preview |
| az communication email domain show |
Get the Domains resource and its properties. |
Extension | Preview |
| az communication email domain update |
Update a new Domains resource under the parent EmailService resource or update an existing Domains resource. |
Extension | Preview |
| az communication email domain wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
| az communication email list |
List requests to list all resources in a subscription. |
Extension | Preview |
| az communication email send |
Send an email and get final status. |
Extension | Preview |
| az communication email show |
Get the EmailService and its properties. |
Extension | Preview |
| az communication email status |
Commands to get the status of emails previously sent using Azure Communication Services Email service. |
Extension | Preview |
| az communication email status get |
Get status of an email previously sent. |
Extension | Preview |
| az communication email update |
Update a new EmailService or update an existing EmailService. |
Extension | Preview |
| az communication email wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
| az communication identity |
Manage the Communication Resource's managed identities. |
Extension | GA |
| 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 link-notification-hub |
Links an Azure Notification Hub to this communication service. |
Extension | GA |
| az communication list |
List requests to list all resources in a resource group. |
Extension | GA |
| az communication list-key |
Get the access keys of the CommunicationService resource. |
Extension | GA |
| az communication phonenumber |
Commands to manage phone numbers for a Communication Service resource. |
Extension | Preview |
| az communication phonenumber list |
Lists all phone numbers associated with the Communication Service resource. |
Extension | Preview |
| az communication phonenumber show |
Shows the details for a phone number associated with the Communication Service resource. |
Extension | Preview |
| az communication phonenumbers |
Commands to manage phone numbers for a Communication Service resource. |
Extension | Deprecated |
| az communication phonenumbers list-phonenumbers |
Lists all phone numbers associated with the Communication Service resource. |
Extension | Deprecated |
| az communication phonenumbers show-phonenumber |
Shows the details for a phone number associated with the Communication Service resource. |
Extension | Deprecated |
| az communication regenerate-key |
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time. |
Extension | GA |
| az communication rooms |
Commands to interact with Azure Communication Services Rooms gateway. |
Extension | GA |
| az communication rooms create |
Create a new room. |
Extension | GA |
| az communication rooms delete |
Delete an existing room. |
Extension | GA |
| az communication rooms get |
Return attributes of an existing room. |
Extension | GA |
| az communication rooms list |
List all active rooms belonging to a current Communication Service resource. |
Extension | GA |
| az communication rooms participant |
Commands to manage participants of an existing room. |
Extension | GA |
| az communication rooms participant add-or-update |
Add or update participants in a room. |
Extension | GA |
| az communication rooms participant get |
Get participants of a room. |
Extension | GA |
| az communication rooms participant remove |
Remove participants from a room. |
Extension | GA |
| az communication rooms update |
Update attributes of an existing room. |
Extension | GA |
| az communication show |
Get the CommunicationService and its properties. |
Extension | GA |
| az communication sms |
Commands to manage SMS for a Communication Service resource. |
Extension | GA |
| az communication sms send |
Sends an SMS from the sender phone number to the recipient(s) phone number(s). |
Extension | Preview |
| az communication sms send-sms |
Sends an SMS from the sender phone number to the recipient(s) phone number(s). |
Extension | Deprecated |
| az communication update |
Update a new CommunicationService or update an existing CommunicationService. |
Extension | GA |
| az communication user-identity |
Commands to manage user identities and their tokens for a Communication Service resource. |
Extension | Preview |
| az communication user-identity issue-access-token |
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 | Preview and Deprecated |
| az communication user-identity token |
Commands to manage user tokens for a Communication Service resource. |
Extension | Preview |
| az communication user-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 | Preview |
| az communication user-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 | Preview |
| az communication user-identity token revoke |
Revokes all access tokens for the specific ACS Identity. |
Extension | Preview |
| az communication user-identity user |
Commands to manage user identities for a Communication Service resource. |
Extension | Preview |
| az communication user-identity user create |
Creates a new ACS Identity. |
Extension | Preview |
| az communication user-identity user delete |
Deletes an existing ACS Identity, revokes all tokens for that ACS Identity and deletes all associated data. |
Extension | Preview |
| az communication wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az communication create
Create a new CommunicationService or update an existing CommunicationService.
az communication create --data-location
--name
--resource-group
[--linked-domains]
[--location]
[--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
[--mi-user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]Required Parameters
The location where the communication service stores its data at rest.
The name of the CommunicationService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
List of email Domain resource Ids. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Enable system assigned identity.
Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication delete
Delete to delete a CommunicationService.
az communication delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Optional Parameters
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.
The name of the CommunicationService resource.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication link-notification-hub
Links an Azure Notification Hub to this communication service.
az communication link-notification-hub [--connection-string]
[--ids]
[--name]
[--resource-group]
[--resource-id]
[--subscription]Optional Parameters
Connection string for the notification hub.
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.
The name of the CommunicationService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The resource ID of the notification hub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication list
List requests to list all resources in a resource group.
az communication list [--resource-group]Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication list-key
Get the access keys of the CommunicationService resource.
az communication list-key [--ids]
[--name]
[--resource-group]
[--subscription]Optional Parameters
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.
The name of the CommunicationService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication regenerate-key
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
az communication regenerate-key [--ids]
[--key-type {Primary, Secondary}]
[--name]
[--resource-group]
[--subscription]Optional Parameters
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.
The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).
The name of the CommunicationService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication show
Get the CommunicationService and its properties.
az communication show [--ids]
[--name]
[--resource-group]
[--subscription]Optional Parameters
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.
The name of the CommunicationService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication update
Update a new CommunicationService or update an existing CommunicationService.
az communication update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--linked-domains]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
[--type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
[--user-assigned-identities]Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
List of email Domain resource Ids. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the CommunicationService resource.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az communication wait
Place the CLI in a waiting state until a condition is met.
az communication wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the CommunicationService resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
