Share via

az bot directline

  • Preview
  • Reference

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

Manage the Directline Channel on a bot.

Commands

Name Description Type Status
az bot directline create

Create the DirectLine Channel on a bot with only v3 protocol enabled.

 Core Preview
az bot directline delete

Delete the Directline Channel on a bot.

 Core Preview
az bot directline show

Get details of the Directline Channel on a bot.

 Core Preview
az bot directline update

Update the DirectLine Channel on a bot with only v3 protocol enabled.

 Core Preview

az bot directline create

Edit
Preview

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

Create the DirectLine Channel on a bot with only v3 protocol enabled.

az bot directline create --name
                         --resource-group
                         [--add-disabled {false, true}]
                         [--disablev1 {false, true}]
                         [--disablev3 {false, true}]
                         [--enable-enhanced-auth {false, true}]
                         [--location]
                         [--site-name]
                         [--trusted-origins]

Examples

Create the DirectLine Channel for a bot.

az bot directline create -n botName -g MyResourceGroup --disablev1

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

--add-disabled

Add the channel in a disabled state.

Accepted values: false, true
--disablev1

If true, v1 protocol will be disabled on the channel.

Accepted values: false, true
--disablev3

If true, v3 protocol will be disabled on the channel.

Accepted values: false, true
--enable-enhanced-auth

If true, enables enhanced authentication features. Must be true for --trusted-origins parameters to work.

Accepted values: false, true
Default value: False
--location -l

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

Default value: global
--site-name -s

Name of the Directline channel site.

Default value: Default Site
--trusted-origins

Space separated Trusted Origins URLs (must use HTTPS) e.g. --trusted-origins https://mybotsite1.azurewebsites.net https://mybotsite2.azurewebsites.net.

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 directline delete

Edit
Preview

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

Delete the Directline Channel on a bot.

az bot directline 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 directline show

Edit
Preview

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

Get details of the Directline Channel on a bot.

az bot directline 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.

az bot directline update

Edit
Preview

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

Update the DirectLine Channel on a bot with only v3 protocol enabled.

az bot directline update --name
                         --resource-group
                         [--add-disabled {false, true}]
                         [--disablev1 {false, true}]
                         [--disablev3 {false, true}]
                         [--enable-enhanced-auth {false, true}]
                         [--site-name]
                         [--trusted-origins]

Examples

Update the DirectLine Channel for a bot.

az bot directline update -n botName -g MyResourceGroup --disablev1

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

--add-disabled

Add the channel in a disabled state.

Accepted values: false, true
--disablev1

If true, v1 protocol will be disabled on the channel.

Accepted values: false, true
--disablev3

If true, v3 protocol will be disabled on the channel.

Accepted values: false, true
--enable-enhanced-auth

If true, enables enhanced authentication features. Must be true for --trusted-origins parameters to work.

Accepted values: false, true
Default value: False
--site-name -s

Name of the Directline channel site.

Default value: Default Site
--trusted-origins

Space separated Trusted Origins URLs (must use HTTPS) e.g. --trusted-origins https://mybotsite1.azurewebsites.net https://mybotsite2.azurewebsites.net.

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.