az bot msteams

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

Manage the Microsoft Teams Channel on a bot.

Commands

Name	Description	Type	Status
az bot msteams create	Create the Microsoft Teams Channel on a bot.	Core	Preview
az bot msteams delete	Delete the Microsoft Teams Channel on a bot.	Core	Preview
az bot msteams show	Get details of the Microsoft Teams Channel on a bot.	Core	Preview

az bot msteams create

Preview

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

Create the Microsoft Teams Channel on a bot.

az bot msteams create --name
                      --resource-group
                      [--add-disabled {false, true}]
                      [--calling-web-hook]
                      [--enable-calling {false, true}]
                      [--location]

Examples

Create the Microsoft Teams Channel for a bot with calling enabled

az bot msteams create -n botName -g MyResourceGroup --enable-calling
--calling-web-hook https://www.myapp.com/

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

--calling-web-hook

The calling web hook to use on Microsoft Teams.

--enable-calling

Enable calling on Microsoft Teams.

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

Preview

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

Delete the Microsoft Teams Channel on a bot.

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

Preview

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

Get details of the Microsoft Teams Channel on a bot.

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