az webapp connection update
Update a webapp connection.
Commands
Name | Description | Type | Status |
---|---|---|---|
az webapp connection update app-insights |
Update a webapp to app-insights connection. |
Core | GA |
az webapp connection update appconfig |
Update a webapp to appconfig connection. |
Core | GA |
az webapp connection update cognitiveservices |
Update a webapp to cognitiveservices connection. |
Core | GA |
az webapp connection update confluent-cloud |
Update a webapp to confluent-cloud connection. |
Core | GA |
az webapp connection update cosmos-cassandra |
Update a webapp to cosmos-cassandra connection. |
Core | GA |
az webapp connection update cosmos-gremlin |
Update a webapp to cosmos-gremlin connection. |
Core | GA |
az webapp connection update cosmos-mongo |
Update a webapp to cosmos-mongo connection. |
Core | GA |
az webapp connection update cosmos-sql |
Update a webapp to cosmos-sql connection. |
Core | GA |
az webapp connection update cosmos-table |
Update a webapp to cosmos-table connection. |
Core | GA |
az webapp connection update eventhub |
Update a webapp to eventhub connection. |
Core | GA |
az webapp connection update fabric-sql |
Update a webapp to fabric-sql connection. |
Core | GA |
az webapp connection update keyvault |
Update a webapp to keyvault connection. |
Core | GA |
az webapp connection update mysql |
Update a webapp to mysql connection. |
Core | Deprecated |
az webapp connection update mysql-flexible |
Update a webapp to mysql-flexible connection. |
Core | GA |
az webapp connection update postgres |
Update a webapp to postgres connection. |
Core | Deprecated |
az webapp connection update postgres-flexible |
Update a webapp to postgres-flexible connection. |
Core | GA |
az webapp connection update redis |
Update a webapp to redis connection. |
Core | GA |
az webapp connection update redis-enterprise |
Update a webapp to redis-enterprise connection. |
Core | GA |
az webapp connection update servicebus |
Update a webapp to servicebus connection. |
Core | GA |
az webapp connection update signalr |
Update a webapp to signalr connection. |
Core | GA |
az webapp connection update sql |
Update a webapp to sql connection. |
Core | GA |
az webapp connection update storage-blob |
Update a webapp to storage-blob connection. |
Core | GA |
az webapp connection update storage-file |
Update a webapp to storage-file connection. |
Core | GA |
az webapp connection update storage-queue |
Update a webapp to storage-queue connection. |
Core | GA |
az webapp connection update storage-table |
Update a webapp to storage-table connection. |
Core | GA |
az webapp connection update webpubsub |
Update a webapp to webpubsub connection. |
Core | GA |
az webapp connection update app-insights
Update a webapp to app-insights connection.
az webapp connection update app-insights [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--slot]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update app-insights -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update app-insights --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The name of the slot. Default to the production slot if not specified.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update appconfig
Update a webapp to appconfig connection.
az webapp connection update appconfig [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update appconfig -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update appconfig --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update cognitiveservices
Update a webapp to cognitiveservices connection.
az webapp connection update cognitiveservices [--appconfig-id]
[--client-type {dotnet, none, python}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update cognitiveservices -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update cognitiveservices --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update confluent-cloud
Update a webapp to confluent-cloud connection.
az webapp connection update confluent-cloud --connection
[--appconfig-id]
[--bootstrap-server]
[--client-type {dotnet, dotnet-internal, go, java, none, python, springBoot}]
[--customized-keys]
[--kafka-key]
[--kafka-secret]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--schema-key]
[--schema-registry]
[--schema-secret]
[--slot]
[--source-id]
[--vault-id]
Examples
Update the client-type of a bootstrap server connection
az webapp connection update confluent-cloud -g WebAppRG -n MyWebApp --connection MyConnection --client python
Update the auth configurations of a bootstrap server connection
az webapp connection update confluent-cloud -g WebAppRG -n MyWebApp --connection MyConnection --bootstrap-server xxx.eastus.azure.confluent.cloud:9092 --kafka-key Name --kafka-secret Secret
Update the client-type of a schema registry connection
az webapp connection update confluent-cloud -g WebAppRG -n MyWebApp --connection MyConnection_schema --client python
Update the auth configurations of a schema registry connection
az webapp connection update confluent-cloud -g WebAppRG -n MyWebApp --connection MyConnection_schema --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret
Required Parameters
Name of the connection.
Optional Parameters
The app configuration id to store configuration.
Kafka bootstrap server url.
The client type used on the webapp.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
Kafka API-Key (key).
Kafka API-Key (secret).
Name of the webapp. Required if '--source-id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the webapp. Required if '--source-id' is not specified.None.
Schema registry API-Key (key).
Schema registry url.
Schema registry API-Key (secret).
The name of the slot. Default to the production slot if not specified.
The resource id of a webapp. Required if ['--resource-group', '--name'] are not specified.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update cosmos-cassandra
Update a webapp to cosmos-cassandra connection.
az webapp connection update cosmos-cassandra [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update cosmos-cassandra -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update cosmos-cassandra --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update cosmos-gremlin
Update a webapp to cosmos-gremlin connection.
az webapp connection update cosmos-gremlin [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update cosmos-gremlin -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update cosmos-gremlin --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update cosmos-mongo
Update a webapp to cosmos-mongo connection.
az webapp connection update cosmos-mongo [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update cosmos-mongo -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update cosmos-mongo --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update cosmos-sql
Update a webapp to cosmos-sql connection.
az webapp connection update cosmos-sql [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update cosmos-sql -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update cosmos-sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update cosmos-table
Update a webapp to cosmos-table connection.
az webapp connection update cosmos-table [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update cosmos-table -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update cosmos-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update eventhub
Update a webapp to eventhub connection.
az webapp connection update eventhub [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update eventhub -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update eventhub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update fabric-sql
Update a webapp to fabric-sql connection.
az webapp connection update fabric-sql [--appconfig-id]
[--client-type {dotnet, go, java, none, php, python}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update fabric-sql -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update fabric-sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update keyvault
Update a webapp to keyvault connection.
az webapp connection update keyvault [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update keyvault -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update keyvault --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update mysql
This command has been deprecated and will be removed in a future release.
Update a webapp to mysql connection.
az webapp connection update mysql [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--config-connstr {false, true}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--slot]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update mysql -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update mysql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Store configuration into connection strings, only could be used together with dotnet client_type.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The name of the slot. Default to the production slot if not specified.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update mysql-flexible
Update a webapp to mysql-flexible connection.
az webapp connection update mysql-flexible [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--config-connstr {false, true}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update mysql-flexible -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update mysql-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Store configuration into connection strings, only could be used together with dotnet client_type.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity mysql-identity-id=xx
mysql-identity-id : Optional. ID of identity used for MySQL flexible server AAD Authentication. Ignore it if you are the server AAD administrator.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update postgres
This command has been deprecated and will be removed in a future release.
Update a webapp to postgres connection.
az webapp connection update postgres [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--config-connstr {false, true}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update postgres -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update postgres --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Store configuration into connection strings, only could be used together with dotnet client_type.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update postgres-flexible
Update a webapp to postgres-flexible connection.
az webapp connection update postgres-flexible [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--config-connstr {false, true}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update postgres-flexible -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update postgres-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Store configuration into connection strings, only could be used together with dotnet client_type.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update redis
Update a webapp to redis connection.
az webapp connection update redis [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--slot]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update redis -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update redis --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The name of the slot. Default to the production slot if not specified.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update redis-enterprise
Update a webapp to redis-enterprise connection.
az webapp connection update redis-enterprise [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--resource-group]
[--secret]
[--slot]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update redis-enterprise -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update redis-enterprise --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The name of the slot. Default to the production slot if not specified.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update servicebus
Update a webapp to servicebus connection.
az webapp connection update servicebus [--appconfig-id]
[--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update servicebus -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update servicebus --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update signalr
Update a webapp to signalr connection.
az webapp connection update signalr [--appconfig-id]
[--client-type {dotnet, dotnet-internal, none}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update signalr -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update signalr --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update sql
Update a webapp to sql connection.
az webapp connection update sql [--appconfig-id]
[--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
[--config-connstr {false, true}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update sql -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Store configuration into connection strings, only could be used together with dotnet client_type.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX
name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update storage-blob
Update a webapp to storage-blob connection.
az webapp connection update storage-blob [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update storage-blob -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update storage-blob --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update storage-file
Update a webapp to storage-file connection.
az webapp connection update storage-file [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--slot]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update storage-file -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update storage-file --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The name of the slot. Default to the production slot if not specified.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update storage-queue
Update a webapp to storage-queue connection.
az webapp connection update storage-queue [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update storage-queue -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update storage-queue --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update storage-table
Update a webapp to storage-table connection.
az webapp connection update storage-table [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-endpoint {false, true}]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update storage-table -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update storage-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az webapp connection update webpubsub
Update a webapp to webpubsub connection.
az webapp connection update webpubsub [--appconfig-id]
[--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
[--connection]
[--connstr-props]
[--customized-keys]
[--id]
[--name]
[--no-wait]
[--opt-out {auth, configinfo, publicnetwork}]
[--private-endpoint {false, true}]
[--resource-group]
[--secret]
[--service-principal]
[--slot]
[--system-identity]
[--user-identity]
[--vault-id]
Examples
Update the client type of a connection with resource name
az webapp connection update webpubsub -g WebAppRG -n MyWebApp --connection MyConnection --client-type dotnet
Update the client type of a connection with resource id
az webapp connection update webpubsub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet
Optional Parameters
The app configuration id to store configuration.
The client type used on the webapp.
Name of the webapp connection.
The addtional connection string properties used to for building connection string.
The customized keys used to change default configuration names. Key is the original name, value is the customized name.
The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.
Name of the webapp. Required if '--id' is not specified.None.
Do not wait for the long-running operation to finish.
Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.
Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.
The resource group which contains the webapp. Required if '--id' is not specified.None.
The secret auth info.
Usage: --secret.
The service principal auth info.
Usage: --service-principal client-id=XX secret=XX
client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.
The name of the slot. Default to the production slot if not specified.
The system assigned identity auth info.
Usage: --system-identity.
The user assigned identity auth info.
Usage: --user-identity client-id=XX subs-id=XX
client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.
The id of key vault to store secret value.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.