Share via

az webapp config connection-string

  • Reference

Manage a web app's connection strings.

Commands

Name Description Type Status
az webapp config connection-string delete

Delete a web app's connection strings.

 Core GA
az webapp config connection-string list

Get a web app's connection strings.

 Core GA
az webapp config connection-string set

Update a web app's connection strings.

 Core GA

az webapp config connection-string delete

Delete a web app's connection strings.

Note that connection string values are now redacted in the result. Please use the az webapp config connection-string list command to view the values.

az webapp config connection-string delete --setting-names
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--slot]
                                          [--subscription]

Examples

Delete a web app's connection strings. (autogenerated)

az webapp config connection-string delete --name MyWebApp --resource-group MyResourceGroup --setting-names {setting-names}

Required Parameters

--setting-names

Space-separated connection-string names.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the web app. You can configure the default using az configure --defaults web=<name>. If --ids is provided this should NOT be specified.

--resource-group -g

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

--slot -s

The name of the slot. Default to the productions slot if not specified.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 webapp config connection-string list

Get a web app's connection strings.

az webapp config connection-string list --name
                                        --resource-group
                                        [--slot]

Examples

Get a web app's connection strings. (autogenerated)

az webapp config connection-string list --name MyWebapp --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

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

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 webapp config connection-string set

Update a web app's connection strings.

Note that connection string values are now redacted in the result. Please use the az webapp config connection-string list command to view the values.

az webapp config connection-string set [--connection-string-type {ApiHub, Custom, DocDb, EventHub, MySql, NotificationHub, PostgreSQL, RedisCache, SQLAzure, SQLServer, ServiceBus}]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--settings]
                                       [--slot]
                                       [--slot-settings]
                                       [--subscription]

Examples

Add a mysql connection string.

az webapp config connection-string set -g MyResourceGroup -n MyUniqueApp -t mysql \
    --settings mysql1='Server=myServer;Database=myDB;Uid=myUser;Pwd=myPwd;'

Optional Parameters

--connection-string-type -t

Connection string type.

Accepted values: ApiHub, Custom, DocDb, EventHub, MySql, NotificationHub, PostgreSQL, RedisCache, SQLAzure, SQLServer, ServiceBus
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the web app. You can configure the default using az configure --defaults web=<name>. If --ids is provided this should NOT be specified.

--resource-group -g

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

--settings

Space-separated connection-string in a format of <name>=<value>.

--slot -s

The name of the slot. Default to the productions slot if not specified.

--slot-settings

Space-separated slot connection-string in a format of either <name>=<value> or @<json_file>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.