az containerapp connection create

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Create a connection between a containerapp and a target resource.

Commands

Name	Description	Type	Status
az containerapp connection create app-insights	Create a containerapp connection to app-insights.	Core	GA
az containerapp connection create appconfig	Create a containerapp connection to appconfig.	Core	GA
az containerapp connection create cognitiveservices	Create a containerapp connection to cognitiveservices.	Core	GA
az containerapp connection create confluent-cloud	Create a containerapp connection to confluent-cloud.	Core	GA
az containerapp connection create containerapp	Create a containerapp-to-containerapp connection.	Core	GA
az containerapp connection create cosmos-cassandra	Create a containerapp connection to cosmos-cassandra.	Core	GA
az containerapp connection create cosmos-gremlin	Create a containerapp connection to cosmos-gremlin.	Core	GA
az containerapp connection create cosmos-mongo	Create a containerapp connection to cosmos-mongo.	Core	GA
az containerapp connection create cosmos-sql	Create a containerapp connection to cosmos-sql.	Core	GA
az containerapp connection create cosmos-table	Create a containerapp connection to cosmos-table.	Core	GA
az containerapp connection create eventhub	Create a containerapp connection to eventhub.	Core	GA
az containerapp connection create keyvault	Create a containerapp connection to keyvault.	Core	GA
az containerapp connection create mysql	Create a containerapp connection to mysql.	Core	Deprecated
az containerapp connection create mysql-flexible	Create a containerapp connection to mysql-flexible.	Core	GA
az containerapp connection create mysql-flexible (serviceconnector-passwordless extension)	Create a containerapp connection to mysql-flexible.	Extension	GA
az containerapp connection create postgres	Create a containerapp connection to postgres.	Core	Deprecated
az containerapp connection create postgres-flexible	Create a containerapp connection to postgres-flexible.	Core	GA
az containerapp connection create postgres-flexible (serviceconnector-passwordless extension)	Create a containerapp connection to postgres-flexible.	Extension	GA
az containerapp connection create redis	Create a containerapp connection to redis.	Core	GA
az containerapp connection create redis-enterprise	Create a containerapp connection to redis-enterprise.	Core	GA
az containerapp connection create servicebus	Create a containerapp connection to servicebus.	Core	GA
az containerapp connection create signalr	Create a containerapp connection to signalr.	Core	GA
az containerapp connection create sql	Create a containerapp connection to sql.	Core	GA
az containerapp connection create sql (serviceconnector-passwordless extension)	Create a containerapp connection to sql.	Extension	GA
az containerapp connection create storage-blob	Create a containerapp connection to storage-blob.	Core	GA
az containerapp connection create storage-file	Create a containerapp connection to storage-file.	Core	GA
az containerapp connection create storage-queue	Create a containerapp connection to storage-queue.	Core	GA
az containerapp connection create storage-table	Create a containerapp connection to storage-table.	Core	GA
az containerapp connection create webpubsub	Create a containerapp connection to webpubsub.	Core	GA

az containerapp connection create app-insights

Create a containerapp connection to app-insights.

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

Examples

Create a connection between containerapp and app-insights interactively

az containerapp connection create app-insights

Create a connection between containerapp and app-insights with resource name

az containerapp connection create app-insights -g ContainerAppRG -n MyContainerApp --tg AppInsightsRG --app-insights MyAppInsights --secret

Create a connection between containerapp and app-insights with resource id

az containerapp connection create app-insights --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/microsoft.insights/components/{appinsights} --secret

Optional Parameters

--app-insights

Name of the app insights. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

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

--secret

The secret auth info.

Usage: --secret.

--source-id

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

--target-id

The resource id of target service. Required if ['--target-resource-group', '--app-insights'] are not specified.

--target-resource-group --tg

The resource group which contains the app insights. Required if '--target-id' is 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 create appconfig

Create a containerapp connection to appconfig.

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

Examples

Create a connection between containerapp and appconfig interactively

az containerapp connection create appconfig

Create a connection between containerapp and appconfig with resource name

az containerapp connection create appconfig -g ContainerAppRG -n MyContainerApp --tg AppconfigRG --app-config MyConfigStore --system-identity

Create a connection between containerapp and appconfig with resource id

az containerapp connection create appconfig --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --system-identity

Optional Parameters

--app-config

Name of the app configuration. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--app-config'] are not specified.

--target-resource-group --tg

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

--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 create cognitiveservices

Create a containerapp connection to cognitiveservices.

az containerapp connection create cognitiveservices [--account]
                                                    [--appconfig-id]
                                                    [--client-type {dotnet, none, python}]
                                                    [--connection]
                                                    [--container]
                                                    [--customized-keys]
                                                    [--name]
                                                    [--no-wait]
                                                    [--opt-out {auth, configinfo, publicnetwork}]
                                                    [--resource-group]
                                                    [--secret]
                                                    [--service-principal]
                                                    [--source-id]
                                                    [--system-identity]
                                                    [--target-id]
                                                    [--target-resource-group]
                                                    [--user-identity]
                                                    [--vault-id]

Examples

Create a connection between containerapp and cognitiveservices interactively

az containerapp connection create cognitiveservices

Create a connection between containerapp and cognitiveservices with resource name

az containerapp connection create cognitiveservices -g ContainerAppRG -n MyContainerApp --tg CognitiveServicesRG --account MyAccount --system-identity

Create a connection between containerapp and cognitiveservices with resource id

az containerapp connection create cognitiveservices --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.CognitiveServices/accounts/{account} --system-identity

Optional Parameters

--account

Name of the cognitive services account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the containerapp.

Accepted values: dotnet, 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.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the container app. Required if '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the cognitive services. Required if '--target-id' is not specified.

--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 create confluent-cloud

Create a containerapp connection to confluent-cloud.

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

Examples

Create a connection between containerapp and confluent-cloud

az containerapp connection create confluent-cloud -g ContainerAppRG -n MyContainerApp --bootstrap-server xxx.eastus.azure.confluent.cloud:9092 --kafka-key Name --kafka-secret Secret --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret

Required Parameters

--bootstrap-server

Kafka bootstrap server url.

--kafka-key

Kafka API-Key (key).

--kafka-secret

Kafka API-Key (secret).

--schema-key

Schema registry API-Key (key).

--schema-registry

Schema registry url.

--schema-secret

Schema registry API-Key (secret).

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the containerapp.

Accepted values: dotnet, dotnet-internal, go, java, none, python, springBoot

--connection

Name of the 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.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

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

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

Create a containerapp-to-containerapp connection.

az containerapp connection create containerapp [--appconfig-id]
                                               [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                               [--connection]
                                               [--container]
                                               [--customized-keys]
                                               [--name]
                                               [--no-wait]
                                               [--opt-out {auth, configinfo, publicnetwork}]
                                               [--resource-group]
                                               [--source-id]
                                               [--target-app-name]
                                               [--target-id]
                                               [--target-resource-group]
                                               [--vault-id]

Examples

Create a connection between containerapp and containerapp interactively

az containerapp connection create containerapp

Create a connection between containerapp and containerapp with resource name

az containerapp connection create containerapp -g ContainerAppRG -n MyContainerApp --tg TargetContainerAppRG --target-app-name MyTargetContainerApp

Create a connection between containerapp and containerapp with resource id

az containerapp connection create containerapp --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.App/containerApps/{target_app_name}

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

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

--source-id

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

--target-app-name

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

--target-id

The resource id of target service. Required if ['--target-resource-group', '--target-app-name'] are not specified.

--target-resource-group --tg

The resource group which contains the target container app. Required if '--target-id' is 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 create cosmos-cassandra

Create a containerapp connection to cosmos-cassandra.

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

Examples

Create a connection between containerapp and cosmos-cassandra interactively

az containerapp connection create cosmos-cassandra

Create a connection between containerapp and cosmos-cassandra with resource name

az containerapp connection create cosmos-cassandra -g ContainerAppRG -n MyContainerApp --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity

Create a connection between containerapp and cosmos-cassandra with resource id

az containerapp connection create cosmos-cassandra --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/cassandraKeyspaces/{key_space} --system-identity

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--key-space

Name of the keyspace. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--key-space'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--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 create cosmos-gremlin

Create a containerapp connection to cosmos-gremlin.

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

Examples

Create a connection between containerapp and cosmos-gremlin interactively

az containerapp connection create cosmos-gremlin

Create a connection between containerapp and cosmos-gremlin with resource name

az containerapp connection create cosmos-gremlin -g ContainerAppRG -n MyContainerApp --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity

Create a connection between containerapp and cosmos-gremlin with resource id

az containerapp connection create cosmos-gremlin --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/gremlinDatabases/{database}/graphs/{graph} --system-identity

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the database. Required if '--target-id' is not specified.

--graph

Name of the graph. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--database', '--graph'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--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 create cosmos-mongo

Create a containerapp connection to cosmos-mongo.

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

Examples

Create a connection between containerapp and cosmos-mongo interactively

az containerapp connection create cosmos-mongo

Create a connection between containerapp and cosmos-mongo with resource name

az containerapp connection create cosmos-mongo -g ContainerAppRG -n MyContainerApp --tg CosmosRG --account MyAccount --database MyDB --system-identity

Create a connection between containerapp and cosmos-mongo with resource id

az containerapp connection create cosmos-mongo --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/mongodbDatabases/{database} --system-identity

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--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 create cosmos-sql

Create a containerapp connection to cosmos-sql.

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

Examples

Create a connection between containerapp and cosmos-sql interactively

az containerapp connection create cosmos-sql

Create a connection between containerapp and cosmos-sql with resource name

az containerapp connection create cosmos-sql -g ContainerAppRG -n MyContainerApp --tg CosmosRG --account MyAccount --database MyDB --system-identity

Create a connection between containerapp and cosmos-sql with resource id

az containerapp connection create cosmos-sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/sqlDatabases/{database} --system-identity

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--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 create cosmos-table

Create a containerapp connection to cosmos-table.

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

Examples

Create a connection between containerapp and cosmos-table interactively

az containerapp connection create cosmos-table

Create a connection between containerapp and cosmos-table with resource name

az containerapp connection create cosmos-table -g ContainerAppRG -n MyContainerApp --tg CosmosRG --account MyAccount --table MyTable --system-identity

Create a connection between containerapp and cosmos-table with resource id

az containerapp connection create cosmos-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --system-identity

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--table

Name of the table. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--table'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--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 create eventhub

Create a containerapp connection to eventhub.

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

Examples

Create a connection between containerapp and eventhub interactively

az containerapp connection create eventhub

Create a connection between containerapp and eventhub with resource name

az containerapp connection create eventhub -g ContainerAppRG -n MyContainerApp --tg EventhubRG --namespace MyNamespace --system-identity

Create a connection between containerapp and eventhub with resource id

az containerapp connection create eventhub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --system-identity

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--name -n

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

--namespace

Name of the eventhub namespace. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--namespace'] are not specified.

--target-resource-group --tg

The resource group which contains the eventhub. Required if '--target-id' is not specified.

--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 create keyvault

Create a containerapp connection to keyvault.

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

Examples

Create a connection between containerapp and keyvault interactively

az containerapp connection create keyvault

Create a connection between containerapp and keyvault with resource name

az containerapp connection create keyvault -g ContainerAppRG -n MyContainerApp --tg KeyvaultRG --vault MyVault --system-identity

Create a connection between containerapp and keyvault with resource id

az containerapp connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --system-identity

Create a new keyvault and connect containerapp to it interactively

az containerapp connection create keyvault --new

Create a new keyvault and connect containerapp to it

az containerapp connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --new

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--name -n

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

--new

Indicates whether to create a new keyvault when creating the containerapp connection.

Accepted values: false, true

Default value: False

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--vault'] are not specified.

--target-resource-group --tg

The resource group which contains the keyvault. Required if '--target-id' is not specified.

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

Name of the keyvault. Required if '--target-id' is 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 create mysql

Deprecated

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

Create a containerapp connection to mysql.

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

Examples

Create a connection between containerapp and mysql interactively

az containerapp connection create mysql

Create a connection between containerapp and mysql with resource name

az containerapp connection create mysql -g ContainerAppRG -n MyContainerApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and mysql with resource id

az containerapp connection create mysql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBForMySQL/servers/{server}/databases/{database} --secret name=XX secret=XX

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the mysql database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--server

Name of the mysql server. Required if '--target-id' is not specified.

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

--source-id

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

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the mysql server. Required if '--target-id' is 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 create mysql-flexible

Create a containerapp connection to mysql-flexible.

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

Examples

Create a connection between containerapp and mysql-flexible interactively

az containerapp connection create mysql-flexible

Create a connection between containerapp and mysql-flexible with resource name

az containerapp connection create mysql-flexible -g ContainerAppRG -n MyContainerApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and mysql-flexible with resource id

az containerapp connection create mysql-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the mysql flexible database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the container app. Required if '--source-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.

--server

Name of the mysql flexible server. Required if '--target-id' is not specified.

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

--source-id

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

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

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the mysql flexible server. Required if '--target-id' is not specified.

--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 create mysql-flexible (serviceconnector-passwordless extension)

Create a containerapp connection to mysql-flexible.

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

Examples

Create a connection between containerapp and mysql-flexible interactively

az containerapp connection create mysql-flexible

Create a connection between containerapp and mysql-flexible with resource name

az containerapp connection create mysql-flexible -g ContainerAppRG -n MyContainerApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and mysql-flexible with resource id

az containerapp connection create mysql-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the mysql flexible database. Required if '--target-id' is not specified.

--name -n

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

--new

Deleting existing users with the same name before creating a new user in database.

Default value: False

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the container app. Required if '--source-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.

--server

Name of the mysql flexible server. Required if '--target-id' is not specified.

--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. mysql-identity-id : Optional. ID of identity used for MySQL flexible server Microsoft Entra Authentication. Ignore it if you are the server Microsoft Entra administrator.

--source-id

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

--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 Microsoft Entra Authentication. Ignore it if you are the server Microsoft Entra administrator.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the mysql flexible server. Required if '--target-id' is not specified.

--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. mysql-identity-id : Optional. ID of identity used for MySQL flexible server Microsoft Entra Authentication. Ignore it if you are the server Microsoft Entra administrator.

--vault-id

The id of key vault to store secret value.

--yes -y

Do not prompt for confirmation.

Default value: False

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 create postgres

Deprecated

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

Create a containerapp connection to postgres.

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

Examples

Create a connection between containerapp and postgres interactively

az containerapp connection create postgres

Create a connection between containerapp and postgres with resource name

az containerapp connection create postgres -g ContainerAppRG -n MyContainerApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and postgres with resource id

az containerapp connection create postgres --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX

Create a new postgres and connect containerapp to it interactively

az containerapp connection create postgres --new

Create a new postgres and connect containerapp to it

az containerapp connection create postgres --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --new

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of postgres database. Required if '--target-id' is not specified.

--name -n

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

--new

Indicates whether to create a new postgres when creating the containerapp connection.

Accepted values: false, true

Default value: False

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--server

Name of postgres server. Required if '--target-id' is not specified.

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the postgres service. Required if '--target-id' is not specified.

--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 create postgres-flexible

Create a containerapp connection to postgres-flexible.

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

Examples

Create a connection between containerapp and postgres-flexible interactively

az containerapp connection create postgres-flexible

Create a connection between containerapp and postgres-flexible with resource name

az containerapp connection create postgres-flexible -g ContainerAppRG -n MyContainerApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and postgres-flexible with resource id

az containerapp connection create postgres-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of postgres flexible database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the container app. Required if '--source-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.

--server

Name of postgres flexible server. Required if '--target-id' is not specified.

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the flexible postgres service. Required if '--target-id' is not specified.

--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 create postgres-flexible (serviceconnector-passwordless extension)

Create a containerapp connection to postgres-flexible.

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

Examples

Create a connection between containerapp and postgres-flexible interactively

az containerapp connection create postgres-flexible

Create a connection between containerapp and postgres-flexible with resource name

az containerapp connection create postgres-flexible -g ContainerAppRG -n MyContainerApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and postgres-flexible with resource id

az containerapp connection create postgres-flexible --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of postgres flexible database. Required if '--target-id' is not specified.

--name -n

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

--new

Deleting existing users with the same name before creating a new user in database.

Default value: False

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

The resource group which contains the container app. Required if '--source-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.

--server

Name of postgres flexible server. Required if '--target-id' is not specified.

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the flexible postgres service. Required if '--target-id' is not specified.

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

--yes -y

Do not prompt for confirmation.

Default value: False

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 create redis

Create a containerapp connection to redis.

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

Examples

Create a connection between containerapp and redis interactively

az containerapp connection create redis

Create a connection between containerapp and redis with resource name

az containerapp connection create redis -g ContainerAppRG -n MyContainerApp --tg RedisRG --server MyServer --database MyDB --secret

Create a connection between containerapp and redis with resource id

az containerapp connection create redis --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the redis database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--server

Name of the redis server. Required if '--target-id' is not specified.

--source-id

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

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the redis server. Required if '--target-id' is 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 create redis-enterprise

Create a containerapp connection to redis-enterprise.

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

Examples

Create a connection between containerapp and redis-enterprise interactively

az containerapp connection create redis-enterprise

Create a connection between containerapp and redis-enterprise with resource name

az containerapp connection create redis-enterprise -g ContainerAppRG -n MyContainerApp --tg RedisRG --server MyServer --database MyDB --secret

Create a connection between containerapp and redis-enterprise with resource id

az containerapp connection create redis-enterprise --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the redis enterprise database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--resource-group -g

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

--secret

The secret auth info.

Usage: --secret.

--server

Name of the redis enterprise server. Required if '--target-id' is not specified.

--source-id

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

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the redis server. Required if '--target-id' is 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 create servicebus

Create a containerapp connection to servicebus.

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

Examples

Create a connection between containerapp and servicebus interactively

az containerapp connection create servicebus

Create a connection between containerapp and servicebus with resource name

az containerapp connection create servicebus -g ContainerAppRG -n MyContainerApp --tg ServicebusRG --namespace MyNamespace --system-identity

Create a connection between containerapp and servicebus with resource id

az containerapp connection create servicebus --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --system-identity

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--name -n

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

--namespace

Name of the servicebus namespace. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--namespace'] are not specified.

--target-resource-group --tg

The resource group which contains the servicebus. Required if '--target-id' is not specified.

--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 create signalr

Create a containerapp connection to signalr.

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

Examples

Create a connection between containerapp and signalr interactively

az containerapp connection create signalr

Create a connection between containerapp and signalr with resource name

az containerapp connection create signalr -g ContainerAppRG -n MyContainerApp --tg SignalrRG --signalr MySignalR --system-identity

Create a connection between containerapp and signalr with resource id

az containerapp connection create signalr --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --system-identity

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--signalr

Name of the signalr service. Required if '--target-id' is not specified.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--signalr'] are not specified.

--target-resource-group --tg

The resource group which contains the signalr. Required if '--target-id' is not specified.

--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 create sql

Create a containerapp connection to sql.

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

Examples

Create a connection between containerapp and sql interactively

az containerapp connection create sql

Create a connection between containerapp and sql with resource name

az containerapp connection create sql -g ContainerAppRG -n MyContainerApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and sql with resource id

az containerapp connection create sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the sql database. Required if '--target-id' is not specified.

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--server

Name of the sql server. Required if '--target-id' is not specified.

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the sql server. Required if '--target-id' is not specified.

--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 create sql (serviceconnector-passwordless extension)

Create a containerapp connection to sql.

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

Examples

Create a connection between containerapp and sql interactively

az containerapp connection create sql

Create a connection between containerapp and sql with resource name

az containerapp connection create sql -g ContainerAppRG -n MyContainerApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between containerapp and sql with resource id

az containerapp connection create sql --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--database

Name of the sql database. Required if '--target-id' is not specified.

--name -n

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

--new

Deleting existing users with the same name before creating a new user in database.

Default value: False

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--server

Name of the sql server. Required if '--target-id' is not specified.

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the sql server. Required if '--target-id' is not specified.

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

--yes -y

Do not prompt for confirmation.

Default value: False

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 create storage-blob

Create a containerapp connection to storage-blob.

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

Examples

Create a connection between containerapp and storage-blob interactively

az containerapp connection create storage-blob

Create a connection between containerapp and storage-blob with resource name

az containerapp connection create storage-blob -g ContainerAppRG -n MyContainerApp --tg StorageRG --account MyAccount --system-identity

Create a connection between containerapp and storage-blob with resource id

az containerapp connection create storage-blob --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/blobServices/default --system-identity

Create a new storage-blob and connect containerapp to it interactively

az containerapp connection create storage-blob --new

Create a new storage-blob and connect containerapp to it

az containerapp connection create storage-blob --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --new

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--name -n

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

--new

Indicates whether to create a new storage-blob when creating the containerapp connection.

Accepted values: false, true

Default value: False

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is not specified.

--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 create storage-file

Create a containerapp connection to storage-file.

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

Examples

Create a connection between containerapp and storage-file interactively

az containerapp connection create storage-file

Create a connection between containerapp and storage-file with resource name

az containerapp connection create storage-file -g ContainerAppRG -n MyContainerApp --tg StorageRG --account MyAccount --secret

Create a connection between containerapp and storage-file with resource id

az containerapp connection create storage-file --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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

--source-id

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

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is 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 create storage-queue

Create a containerapp connection to storage-queue.

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

Examples

Create a connection between containerapp and storage-queue interactively

az containerapp connection create storage-queue

Create a connection between containerapp and storage-queue with resource name

az containerapp connection create storage-queue -g ContainerAppRG -n MyContainerApp --tg StorageRG --account MyAccount --system-identity

Create a connection between containerapp and storage-queue with resource id

az containerapp connection create storage-queue --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/queueServices/default --system-identity

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is not specified.

--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 create storage-table

Create a containerapp connection to storage-table.

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

Examples

Create a connection between containerapp and storage-table interactively

az containerapp connection create storage-table

Create a connection between containerapp and storage-table with resource name

az containerapp connection create storage-table -g ContainerAppRG -n MyContainerApp --tg StorageRG --account MyAccount --system-identity

Create a connection between containerapp and storage-table with resource id

az containerapp connection create storage-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/tableServices/default --system-identity

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is not specified.

--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 create webpubsub

Create a containerapp connection to webpubsub.

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

Examples

Create a connection between containerapp and webpubsub interactively

az containerapp connection create webpubsub

Create a connection between containerapp and webpubsub with resource name

az containerapp connection create webpubsub -g ContainerAppRG -n MyContainerApp --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity

Create a connection between containerapp and webpubsub with resource id

az containerapp connection create webpubsub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.App/containerApps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --system-identity

Optional Parameters

--appconfig-id

The app configuration id to store configuration.

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

--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.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, 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 '--source-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.

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--webpubsub'] are not specified.

--target-resource-group --tg

The resource group which contains the webpubsub. Required if '--target-id' is not specified.

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

--webpubsub

Name of the webpubsub service. Required if '--target-id' is not specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.