az bot sms

  • Preview
  • Reference

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage the SMS Channel on a bot.

Commands

Name Description Type Status
az bot sms create

Create the SMS Channel on a bot.

 Core Preview
az bot sms delete

Delete the SMS Channel on a bot.

 Core Preview
az bot sms show

Get details of the SMS Channel on a bot.

 Core Preview

az bot sms create

Edit
Preview

Command group 'bot sms' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the SMS Channel on a bot.

az bot sms create --account-sid
                  --auth-token
                  --name
                  --phone
                  --resource-group
                  [--add-disabled {false, true}]
                  [--is-validated {false, true}]
                  [--location]

Examples

Create the SMS Channel for a bot.

az bot sms create -n botName -g MyResourceGroup --account-sid sid \
--auth-token token --is-validated --phone 1234567890

Required Parameters

--account-sid

The account SID for the Twilio account.

--auth-token

The token token for the Twilio account.

--name -n

The resource name of the bot. Bot name must be between 4 and 42 characters in length. Bot name can only have the following characters -, a - z, A - Z, 0 - 9, and _.

--phone

The phone number for the Twilio account.

--resource-group -g

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

Optional Parameters

--add-disabled

Add the channel in a disabled state.

accepted values: false, true
--is-validated

Whether or not the Twilio account has been validated for use with the bot.

accepted values: false, true
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

default value: global
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 bot sms delete

Edit
Preview

Command group 'bot sms' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the SMS Channel on a bot.

az bot sms delete --name
                  --resource-group

Required Parameters

--name -n

The resource name of the bot. Bot name must be between 4 and 42 characters in length. Bot name can only have the following characters -, a - z, A - Z, 0 - 9, and _.

--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 bot sms show

Edit
Preview

Command group 'bot sms' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get details of the SMS Channel on a bot.

az bot sms show --name
                --resource-group
                [--with-secrets {false, true}]

Required Parameters

--name -n

The resource name of the bot. Bot name must be between 4 and 42 characters in length. Bot name can only have the following characters -, a - z, A - Z, 0 - 9, and _.

--resource-group -g

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

Optional Parameters

--with-secrets

Show secrets in response for the channel.

accepted values: false, true
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.