Share via


az communication

Note

This reference is part of the communication extension for the Azure CLI (version 2.67.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 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 smtp-username

Manage smtp-username with communication.

Extension GA
az communication smtp-username create

Create an SmtpUsernameResource.

Extension GA
az communication smtp-username delete

Delete to delete a single SmtpUsername resource.

Extension GA
az communication smtp-username list

List all SmtpUsernameResources for a Communication resource.

Extension GA
az communication smtp-username show

Get a SmtpUsernameResource.

Extension GA
az communication smtp-username update

Update an SmtpUsernameResource.

Extension GA
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 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

--data-location

The location where the communication service stores its data at rest.

Property Value
Parameter group: Properties Arguments
--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

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

--linked-domains

List of email Domain resource Ids. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Parameters Arguments
--mi-system-assigned

Enable system assigned identity.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

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

--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Parameters Arguments
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.

--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.

Property Value
Default value: False

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

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

--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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

Links an Azure Notification Hub to this communication service.

az communication link-notification-hub [--connection-string]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--resource-id]
                                       [--subscription]

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

--connection-string

Connection string for the notification hub.

Property Value
Parameter group: LinkNotificationHubParameters Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--resource-id

The resource ID of the notification hub.

Property Value
Parameter group: LinkNotificationHubParameters Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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 communication list

List requests to list all resources in a resource group.

az communication list [--resource-group]

Optional Parameters

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

--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.

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.

--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.

Property Value
Default value: False

az communication list-key

Get the access keys of the CommunicationService resource.

az communication list-key [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]

Optional Parameters

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

--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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 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

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

--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.

Property Value
Parameter group: Resource Id Arguments
--key-type

The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).

Property Value
Parameter group: Parameters Arguments
Accepted values: Primary, Secondary
--name -n

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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 communication show

Get the CommunicationService and its properties.

az communication show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Optional Parameters

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

--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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 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

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

--add

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>.

Property Value
Parameter group: Generic Update Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--linked-domains

List of email Domain resource Ids. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--name -n

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Parameters Arguments
--type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Property Value
Parameter group: Identity Arguments
Accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--user-assigned-identities -i

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.

Property Value
Parameter group: Identity Arguments
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 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

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

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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