Share via

az bot authsetting

  • Reference

Manage OAuth connection settings on a bot.

Commands

Name Description Type Status
az bot authsetting create

Create an OAuth connection setting on a bot.

 Core GA
az bot authsetting delete

Delete an OAuth connection setting on a bot.

 Core GA
az bot authsetting list

Show all OAuth connection settings on a bot.

 Core GA
az bot authsetting list-providers

List details for all service providers available for creating OAuth connection settings.

 Core GA
az bot authsetting show

Show details of an OAuth connection setting on a bot.

 Core GA

az bot authsetting create

Edit

Create an OAuth connection setting on a bot.

az bot authsetting create --client-id
                          --client-secret
                          --name
                          --provider-scope-string
                          --resource-group
                          --service
                          --setting-name
                          [--parameters]

Examples

Create a new OAuth connection setting on a bot.

az bot authsetting create -g MyResourceGroup -n botName -c myConnectionName \
--client-id clientId --client-secret secret --provider-scope-string "scope1 scope2"\
--service google --parameters id=myid

Required Parameters

--client-id

Client ID associated with the service provider setting.

--client-secret

Client secret associated with the service provider setting.

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

--provider-scope-string

The scope string associated with the service provider setting.The string should be delimited as needed for the service provider.

--resource-group -g

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

--service

Name of the service provider. For a list of all service providers, use az bot connection listserviceproviders.

--setting-name -c

Name of the oauth connection setting.

Optional Parameters

--parameters

Parameter values for service provider parameters. Usage: --parameters key=value key1=value1.

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

Edit

Delete an OAuth connection setting on a bot.

az bot authsetting delete --name
                          --resource-group
                          --setting-name

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

--setting-name -c

Name of the oauth connection setting.

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 authsetting list

Edit

Show all OAuth connection settings on a bot.

az bot authsetting list --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 authsetting list-providers

Edit

List details for all service providers available for creating OAuth connection settings.

az bot authsetting list-providers [--provider-name]

Examples

List all service providers.

az bot authsetting list-providers

Filter by a particular type of service provider.

az bot authsetting list-providers --provider-name google

Optional Parameters

--provider-name

Service provider name for which to fetch details.

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 authsetting show

Edit

Show details of an OAuth connection setting on a bot.

az bot authsetting show --name
                        --resource-group
                        --setting-name

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

--setting-name -c

Name of the oauth connection setting.

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.