az containerapp connection update

Update a containerapp connection.

Commands

Name Description Type Status
az containerapp connection update app-insights

Update a containerapp to app-insights connection.

Core GA
az containerapp connection update appconfig

Update a containerapp to appconfig connection.

Core GA
az containerapp connection update confluent-cloud

Update a containerapp to confluent-cloud connection.

Core GA
az containerapp connection update cosmos-cassandra

Update a containerapp to cosmos-cassandra connection.

Core GA
az containerapp connection update cosmos-gremlin

Update a containerapp to cosmos-gremlin connection.

Core GA
az containerapp connection update cosmos-mongo

Update a containerapp to cosmos-mongo connection.

Core GA
az containerapp connection update cosmos-sql

Update a containerapp to cosmos-sql connection.

Core GA
az containerapp connection update cosmos-table

Update a containerapp to cosmos-table connection.

Core GA
az containerapp connection update eventhub

Update a containerapp to eventhub connection.

Core GA
az containerapp connection update keyvault

Update a containerapp to keyvault connection.

Core GA
az containerapp connection update mysql

Update a containerapp to mysql connection.

Core Deprecated
az containerapp connection update mysql-flexible

Update a containerapp to mysql-flexible connection.

Core GA
az containerapp connection update postgres

Update a containerapp to postgres connection.

Core Deprecated
az containerapp connection update postgres-flexible

Update a containerapp to postgres-flexible connection.

Core GA
az containerapp connection update redis

Update a containerapp to redis connection.

Core GA
az containerapp connection update redis-enterprise

Update a containerapp to redis-enterprise connection.

Core GA
az containerapp connection update servicebus

Update a containerapp to servicebus connection.

Core GA
az containerapp connection update signalr

Update a containerapp to signalr connection.

Core GA
az containerapp connection update sql

Update a containerapp to sql connection.

Core GA
az containerapp connection update storage-blob

Update a containerapp to storage-blob connection.

Core GA
az containerapp connection update storage-file

Update a containerapp to storage-file connection.

Core GA
az containerapp connection update storage-queue

Update a containerapp to storage-queue connection.

Core GA
az containerapp connection update storage-table

Update a containerapp to storage-table connection.

Core GA
az containerapp connection update webpubsub

Update a containerapp to webpubsub connection.

Core GA

az containerapp connection update app-insights

Update a containerapp to app-insights connection.

az containerapp connection update app-insights [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python}]
                                               [--connection]
                                               [--container]
                                               [--customized-keys]
                                               [--id]
                                               [--name]
                                               [--no-wait]
                                               [--opt-out {configinfo, publicnetwork}]
                                               [--resource-group]
                                               [--secret]
                                               [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update app-insights -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--vault-id

The id of key vault to store secret value.

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 containerapp connection update appconfig

Update a containerapp to appconfig connection.

az containerapp connection update appconfig [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                                            [--connection]
                                            [--container]
                                            [--customized-keys]
                                            [--id]
                                            [--name]
                                            [--no-wait]
                                            [--opt-out {configinfo, publicnetwork}]
                                            [--private-endpoint {false, true}]
                                            [--resource-group]
                                            [--secret]
                                            [--service-principal]
                                            [--system-identity]
                                            [--user-identity]
                                            [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update appconfig -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update confluent-cloud

Update a containerapp to confluent-cloud connection.

az containerapp connection update confluent-cloud --connection
                                                  [--bootstrap-server]
                                                  [--client-type {dotnet, dotnet-internal, go, java, none, python, springBoot}]
                                                  [--customized-keys]
                                                  [--kafka-key]
                                                  [--kafka-secret]
                                                  [--name]
                                                  [--no-wait]
                                                  [--opt-out {configinfo, publicnetwork}]
                                                  [--resource-group]
                                                  [--schema-key]
                                                  [--schema-registry]
                                                  [--schema-secret]
                                                  [--source-id]
                                                  [--vault-id]

Examples

Update the client-type of a bootstrap server connection

az containerapp connection update confluent-cloud -g ContainerAppRG -n MyContainerApp --connection MyConnection --client python

Update the auth configurations of a bootstrap server connection

az containerapp connection update confluent-cloud -g ContainerAppRG -n MyContainerApp --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 containerapp connection update confluent-cloud -g ContainerAppRG -n MyContainerApp --connection MyConnection_schema --client python

Update the auth configurations of a schema registry connection

az containerapp connection update confluent-cloud -g ContainerAppRG -n MyContainerApp --connection MyConnection_schema --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret

Required Parameters

--connection

Name of the connection.

Optional Parameters

--bootstrap-server

Kafka bootstrap server url.

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, none, python, springBoot
--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--kafka-key

Kafka API-Key (key).

--kafka-secret

Kafka API-Key (secret).

--name -n

Name of the container app. Required if '--source-id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--resource-group -g

The resource group which contains the container app. Required if '--source-id' is not specified.None.

--schema-key

Schema registry API-Key (key).

--schema-registry

Schema registry url.

--schema-secret

Schema registry API-Key (secret).

--source-id

The resource id of a containerapp. Required if ['--resource-group', '--name'] are not specified.

--vault-id

The id of key vault to store secret value.

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 containerapp connection update cosmos-cassandra

Update a containerapp to cosmos-cassandra connection.

az containerapp connection update cosmos-cassandra [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                                   [--connection]
                                                   [--container]
                                                   [--customized-keys]
                                                   [--id]
                                                   [--name]
                                                   [--no-wait]
                                                   [--opt-out {configinfo, publicnetwork}]
                                                   [--private-endpoint {false, true}]
                                                   [--resource-group]
                                                   [--secret]
                                                   [--service-endpoint {false, true}]
                                                   [--service-principal]
                                                   [--system-identity]
                                                   [--user-identity]
                                                   [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update cosmos-cassandra -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update cosmos-gremlin

Update a containerapp to cosmos-gremlin connection.

az containerapp connection update cosmos-gremlin [--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python}]
                                                 [--connection]
                                                 [--container]
                                                 [--customized-keys]
                                                 [--id]
                                                 [--name]
                                                 [--no-wait]
                                                 [--opt-out {configinfo, publicnetwork}]
                                                 [--private-endpoint {false, true}]
                                                 [--resource-group]
                                                 [--secret]
                                                 [--service-endpoint {false, true}]
                                                 [--service-principal]
                                                 [--system-identity]
                                                 [--user-identity]
                                                 [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update cosmos-gremlin -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, php, python
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update cosmos-mongo

Update a containerapp to cosmos-mongo connection.

az containerapp connection update cosmos-mongo [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, springBoot}]
                                               [--connection]
                                               [--container]
                                               [--customized-keys]
                                               [--id]
                                               [--name]
                                               [--no-wait]
                                               [--opt-out {configinfo, publicnetwork}]
                                               [--private-endpoint {false, true}]
                                               [--resource-group]
                                               [--secret]
                                               [--service-endpoint {false, true}]
                                               [--service-principal]
                                               [--system-identity]
                                               [--user-identity]
                                               [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update cosmos-mongo -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update cosmos-sql

Update a containerapp to cosmos-sql connection.

az containerapp connection update cosmos-sql [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                             [--connection]
                                             [--container]
                                             [--customized-keys]
                                             [--id]
                                             [--name]
                                             [--no-wait]
                                             [--opt-out {configinfo, publicnetwork}]
                                             [--private-endpoint {false, true}]
                                             [--resource-group]
                                             [--secret]
                                             [--service-endpoint {false, true}]
                                             [--service-principal]
                                             [--system-identity]
                                             [--user-identity]
                                             [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update cosmos-sql -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update cosmos-table

Update a containerapp to cosmos-table connection.

az containerapp connection update cosmos-table [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                               [--connection]
                                               [--container]
                                               [--customized-keys]
                                               [--id]
                                               [--name]
                                               [--no-wait]
                                               [--opt-out {configinfo, publicnetwork}]
                                               [--private-endpoint {false, true}]
                                               [--resource-group]
                                               [--secret]
                                               [--service-endpoint {false, true}]
                                               [--service-principal]
                                               [--system-identity]
                                               [--user-identity]
                                               [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update cosmos-table -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update eventhub

Update a containerapp to eventhub connection.

az containerapp connection update eventhub [--client-type {dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot}]
                                           [--connection]
                                           [--container]
                                           [--customized-keys]
                                           [--id]
                                           [--name]
                                           [--no-wait]
                                           [--opt-out {configinfo, publicnetwork}]
                                           [--private-endpoint {false, true}]
                                           [--resource-group]
                                           [--secret]
                                           [--service-endpoint {false, true}]
                                           [--service-principal]
                                           [--system-identity]
                                           [--user-identity]
                                           [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update eventhub -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update keyvault

Update a containerapp to keyvault connection.

az containerapp connection update keyvault [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                           [--connection]
                                           [--container]
                                           [--customized-keys]
                                           [--id]
                                           [--name]
                                           [--no-wait]
                                           [--opt-out {configinfo, publicnetwork}]
                                           [--private-endpoint {false, true}]
                                           [--resource-group]
                                           [--service-endpoint {false, true}]
                                           [--service-principal]
                                           [--system-identity]
                                           [--user-identity]
                                           [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update keyvault -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update mysql

Deprecated

This command has been deprecated and will be removed in a future release.

Update a containerapp to mysql connection.

az containerapp connection update mysql [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                        [--connection]
                                        [--container]
                                        [--customized-keys]
                                        [--id]
                                        [--name]
                                        [--no-wait]
                                        [--opt-out {configinfo, publicnetwork}]
                                        [--private-endpoint {false, true}]
                                        [--resource-group]
                                        [--secret]
                                        [--service-endpoint {false, true}]
                                        [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update mysql -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

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.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--vault-id

The id of key vault to store secret value.

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 containerapp connection update mysql-flexible

Update a containerapp to mysql-flexible connection.

az containerapp connection update mysql-flexible [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                                 [--connection]
                                                 [--container]
                                                 [--customized-keys]
                                                 [--id]
                                                 [--name]
                                                 [--no-wait]
                                                 [--opt-out {configinfo, publicnetwork}]
                                                 [--resource-group]
                                                 [--secret]
                                                 [--service-principal]
                                                 [--system-identity]
                                                 [--user-identity]
                                                 [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update mysql-flexible -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

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.

--service-principal

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.

--system-identity

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.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update postgres

Deprecated

This command has been deprecated and will be removed in a future release.

Update a containerapp to postgres connection.

az containerapp connection update postgres [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                           [--connection]
                                           [--container]
                                           [--customized-keys]
                                           [--id]
                                           [--name]
                                           [--no-wait]
                                           [--opt-out {configinfo, publicnetwork}]
                                           [--private-endpoint {false, true}]
                                           [--resource-group]
                                           [--secret]
                                           [--service-endpoint {false, true}]
                                           [--service-principal]
                                           [--system-identity]
                                           [--user-identity]
                                           [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update postgres -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

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.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update postgres-flexible

Update a containerapp to postgres-flexible connection.

az containerapp connection update postgres-flexible [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                                    [--connection]
                                                    [--container]
                                                    [--customized-keys]
                                                    [--id]
                                                    [--name]
                                                    [--no-wait]
                                                    [--opt-out {configinfo, publicnetwork}]
                                                    [--resource-group]
                                                    [--secret]
                                                    [--service-principal]
                                                    [--system-identity]
                                                    [--user-identity]
                                                    [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update postgres-flexible -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

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.

--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update redis

Update a containerapp to redis connection.

az containerapp connection update redis [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                        [--connection]
                                        [--container]
                                        [--customized-keys]
                                        [--id]
                                        [--name]
                                        [--no-wait]
                                        [--opt-out {configinfo, publicnetwork}]
                                        [--private-endpoint {false, true}]
                                        [--resource-group]
                                        [--secret]
                                        [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update redis -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--vault-id

The id of key vault to store secret value.

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 containerapp connection update redis-enterprise

Update a containerapp to redis-enterprise connection.

az containerapp connection update redis-enterprise [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                                   [--connection]
                                                   [--container]
                                                   [--customized-keys]
                                                   [--id]
                                                   [--name]
                                                   [--no-wait]
                                                   [--opt-out {configinfo, publicnetwork}]
                                                   [--resource-group]
                                                   [--secret]
                                                   [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update redis-enterprise -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--vault-id

The id of key vault to store secret value.

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 containerapp connection update servicebus

Update a containerapp to servicebus connection.

az containerapp connection update servicebus [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                             [--connection]
                                             [--container]
                                             [--customized-keys]
                                             [--id]
                                             [--name]
                                             [--no-wait]
                                             [--opt-out {configinfo, publicnetwork}]
                                             [--private-endpoint {false, true}]
                                             [--resource-group]
                                             [--secret]
                                             [--service-endpoint {false, true}]
                                             [--service-principal]
                                             [--system-identity]
                                             [--user-identity]
                                             [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update servicebus -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update signalr

Update a containerapp to signalr connection.

az containerapp connection update signalr [--client-type {dotnet, dotnet-internal, none}]
                                          [--connection]
                                          [--container]
                                          [--customized-keys]
                                          [--id]
                                          [--name]
                                          [--no-wait]
                                          [--opt-out {configinfo, publicnetwork}]
                                          [--private-endpoint {false, true}]
                                          [--resource-group]
                                          [--secret]
                                          [--service-principal]
                                          [--system-identity]
                                          [--user-identity]
                                          [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update signalr -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, none
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update sql

Update a containerapp to sql connection.

az containerapp connection update sql [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                      [--connection]
                                      [--container]
                                      [--customized-keys]
                                      [--id]
                                      [--name]
                                      [--no-wait]
                                      [--opt-out {configinfo, publicnetwork}]
                                      [--private-endpoint {false, true}]
                                      [--resource-group]
                                      [--secret]
                                      [--service-endpoint {false, true}]
                                      [--service-principal]
                                      [--system-identity]
                                      [--user-identity]
                                      [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update sql -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

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.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update storage-blob

Update a containerapp to storage-blob connection.

az containerapp connection update storage-blob [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                               [--connection]
                                               [--container]
                                               [--customized-keys]
                                               [--id]
                                               [--name]
                                               [--no-wait]
                                               [--opt-out {configinfo, publicnetwork}]
                                               [--private-endpoint {false, true}]
                                               [--resource-group]
                                               [--secret]
                                               [--service-endpoint {false, true}]
                                               [--service-principal]
                                               [--system-identity]
                                               [--user-identity]
                                               [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update storage-blob -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update storage-file

Update a containerapp to storage-file connection.

az containerapp connection update storage-file [--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot}]
                                               [--connection]
                                               [--container]
                                               [--customized-keys]
                                               [--id]
                                               [--name]
                                               [--no-wait]
                                               [--opt-out {configinfo, publicnetwork}]
                                               [--private-endpoint {false, true}]
                                               [--resource-group]
                                               [--secret]
                                               [--service-endpoint {false, true}]
                                               [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update storage-file -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--vault-id

The id of key vault to store secret value.

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 containerapp connection update storage-queue

Update a containerapp to storage-queue connection.

az containerapp connection update storage-queue [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                                [--connection]
                                                [--container]
                                                [--customized-keys]
                                                [--id]
                                                [--name]
                                                [--no-wait]
                                                [--opt-out {configinfo, publicnetwork}]
                                                [--private-endpoint {false, true}]
                                                [--resource-group]
                                                [--secret]
                                                [--service-endpoint {false, true}]
                                                [--service-principal]
                                                [--system-identity]
                                                [--user-identity]
                                                [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update storage-queue -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update storage-table

Update a containerapp to storage-table connection.

az containerapp connection update storage-table [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                                                [--connection]
                                                [--container]
                                                [--customized-keys]
                                                [--id]
                                                [--name]
                                                [--no-wait]
                                                [--opt-out {configinfo, publicnetwork}]
                                                [--private-endpoint {false, true}]
                                                [--resource-group]
                                                [--secret]
                                                [--service-endpoint {false, true}]
                                                [--service-principal]
                                                [--system-identity]
                                                [--user-identity]
                                                [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update storage-table -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-endpoint

Connect target service by service endpoint. Source resource must be in the VNet and target SKU must support service endpoint feature.

accepted values: false, true
--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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 containerapp connection update webpubsub

Update a containerapp to webpubsub connection.

az containerapp connection update webpubsub [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                                            [--connection]
                                            [--container]
                                            [--customized-keys]
                                            [--id]
                                            [--name]
                                            [--no-wait]
                                            [--opt-out {configinfo, publicnetwork}]
                                            [--private-endpoint {false, true}]
                                            [--resource-group]
                                            [--secret]
                                            [--service-principal]
                                            [--system-identity]
                                            [--user-identity]
                                            [--vault-id]

Examples

Update the client type of a connection with resource name

az containerapp connection update webpubsub -g ContainerAppRG -n MyContainerApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az containerapp 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

--client-type

The client type used on the containerapp.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python
--connection

Name of the containerapp connection.

--container -c

The container where the connection information will be saved (as environment variables).

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--id

The resource id of the connection. ['--resource-group', '--name', '--connection'] are required if '--id' is not specified.

--name -n

Name of the container app. Required if '--id' is not specified.None.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.

accepted values: configinfo, publicnetwork
--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

accepted values: false, true
--resource-group -g

The resource group which contains the container app. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service-principal

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.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

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

--vault-id

The id of key vault to store secret value.

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.