Share via

az bot skype

  • Preview

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

Manage the Skype Channel on a bot.

Commands

Name Description Type Status
az bot skype create

Create the Skype Channel on a bot.

 Core Preview
az bot skype delete

Delete the Skype Channel on a bot.

 Core Preview
az bot skype show

Get details of the Skype Channel on a bot.

 Core Preview

az bot skype create

Edit
Preview

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

Create the Skype Channel on a bot.

az bot skype create --name
                    --resource-group
                    [--add-disabled {false, true}]
                    [--calling-web-hook]
                    [--enable-calling {false, true}]
                    [--enable-groups {false, true}]
                    [--enable-media-cards {false, true}]
                    [--enable-messaging {false, true}]
                    [--enable-screen-sharing {false, true}]
                    [--enable-video {false, true}]
                    [--groups-mode]
                    [--location]

Examples

Create the Skype Channel for a bot with messaging and screen sharing enabled

az bot skype create -n botName -g MyResourceGroup --enable-messaging
--enable-screen-sharing

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

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

--add-disabled

Add the channel in a disabled state.

Property Value
Accepted values: false, true
--calling-web-hook

The calling web hook to use on Skype.

--enable-calling

Enable calling on Skype.

Property Value
Accepted values: false, true
--enable-groups

Enable groups on Skype.

Property Value
Accepted values: false, true
--enable-media-cards

Enable media cards on Skype.

Property Value
Accepted values: false, true
--enable-messaging

Enable messaging on Skype.

Property Value
Accepted values: false, true
--enable-screen-sharing

Enable screen sharing on Skype.

Property Value
Accepted values: false, true
--enable-video

Enable video on Skype.

Property Value
Accepted values: false, true
--groups-mode

Select groups mode on Skype.

--location -l

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

Property Value
Default value: global
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 bot skype delete

Edit
Preview

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

Delete the Skype Channel on a bot.

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

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

Edit
Preview

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

Get details of the Skype Channel on a bot.

az bot skype 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

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

--with-secrets

Show secrets in response for the channel.

Property Value
Accepted values: false, true
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