az containerapp connection

Reference

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.

Commands to manage containerapp connections.

Commands

Name	Description	Type	Status
az containerapp connection create	Create a connection between a containerapp and a target resource.	Core and Extension	GA
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 fabric-sql	Create a containerapp connection to fabric-sql.	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 delete	Delete a containerapp connection.	Core	GA
az containerapp connection list	List connections of a containerapp.	Core	GA
az containerapp connection list-configuration	List source configurations of a containerapp connection.	Core	GA
az containerapp connection list-support-types	List client types and auth types supported by containerapp connections.	Core	GA
az containerapp connection show	Get the details of a containerapp connection.	Core	GA
az containerapp connection update	Update a containerapp connection.	Core	GA
az containerapp connection update app-insights	Update a containerapp to app-insights connection.	Core	GA
az containerapp connection update appconfig	Update a containerapp to appconfig connection.	Core	GA
az containerapp connection update cognitiveservices	Update a containerapp to cognitiveservices connection.	Core	GA
az containerapp connection update confluent-cloud	Update a containerapp to confluent-cloud connection.	Core	GA
az containerapp connection update containerapp	Update a containerapp-to-containerapp connection.	Core	GA
az containerapp connection update cosmos-cassandra	Update a containerapp to cosmos-cassandra connection.	Core	GA
az containerapp connection update cosmos-gremlin	Update a containerapp to cosmos-gremlin connection.	Core	GA
az containerapp connection update cosmos-mongo	Update a containerapp to cosmos-mongo connection.	Core	GA
az containerapp connection update cosmos-sql	Update a containerapp to cosmos-sql connection.	Core	GA
az containerapp connection update cosmos-table	Update a containerapp to cosmos-table connection.	Core	GA
az containerapp connection update eventhub	Update a containerapp to eventhub connection.	Core	GA
az containerapp connection update fabric-sql	Update a containerapp to fabric-sql connection.	Core	GA
az containerapp connection update keyvault	Update a containerapp to keyvault connection.	Core	GA
az containerapp connection update mysql	Update a containerapp to mysql connection.	Core	Deprecated
az containerapp connection update mysql-flexible	Update a containerapp to mysql-flexible connection.	Core	GA
az containerapp connection update postgres	Update a containerapp to postgres connection.	Core	Deprecated
az containerapp connection update postgres-flexible	Update a containerapp to postgres-flexible connection.	Core	GA
az containerapp connection update redis	Update a containerapp to redis connection.	Core	GA
az containerapp connection update redis-enterprise	Update a containerapp to redis-enterprise connection.	Core	GA
az containerapp connection update servicebus	Update a containerapp to servicebus connection.	Core	GA
az containerapp connection update signalr	Update a containerapp to signalr connection.	Core	GA
az containerapp connection update sql	Update a containerapp to sql connection.	Core	GA
az containerapp connection update storage-blob	Update a containerapp to storage-blob connection.	Core	GA
az containerapp connection update storage-file	Update a containerapp to storage-file connection.	Core	GA
az containerapp connection update storage-queue	Update a containerapp to storage-queue connection.	Core	GA
az containerapp connection update storage-table	Update a containerapp to storage-table connection.	Core	GA
az containerapp connection update webpubsub	Update a containerapp to webpubsub connection.	Core	GA
az containerapp connection validate	Validate a containerapp connection.	Core	GA
az containerapp connection wait	Place the CLI in a waiting state until a condition of the connection is met.	Core	GA

az containerapp connection delete

Edit

Delete a containerapp connection.

az containerapp connection delete [--connection]
                                  [--id]
                                  [--name]
                                  [--no-wait]
                                  [--resource-group]
                                  [--yes]

Examples

Delete a containerapp connection interactively

az containerapp connection delete

Delete a containerapp connection by connection name

az containerapp connection delete -g ContainerAppRG -n MyContainerApp --connection MyConnection

Delete a containerapp connection by connection id

az containerapp connection delete --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the containerapp connection.

--id

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

--name -n

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

--no-wait

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

Default value: False

--resource-group -g

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

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

Edit

List connections of a containerapp.

az containerapp connection list [--name]
                                [--resource-group]
                                [--source-id]

Examples

List containerapp connections interactively

az containerapp connection list

List containerapp connections by source resource name

az containerapp connection list -g ContainerAppRG -n MyContainerApp

List containerapp connections by source resource id

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

Optional Parameters

--name -n

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

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

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

Edit

List source configurations of a containerapp connection.

az containerapp connection list-configuration [--connection]
                                              [--id]
                                              [--name]
                                              [--resource-group]

Examples

List a connection's source configurations interactively

az containerapp connection list-configuration

List a connection's source configurations by connection name

az containerapp connection list-configuration -g ContainerAppRG -n MyContainerApp --connection MyConnection

List a connection's source configurations by connection id

az containerapp connection list-configuration --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the containerapp connection.

--id

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

--name -n

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

--resource-group -g

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

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 list-support-types

Edit

List client types and auth types supported by containerapp connections.

az containerapp connection list-support-types [--target-type {app-insights, appconfig, cognitiveservices, confluent-cloud, containerapp, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, fabric-sql, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}]

Examples

List all containerapp supported target resource types and auth types

az containerapp connection list-support-types -o table

List containerapp supported auth types for a specific target resource type

az containerapp connection list-support-types --target-type storage-blob -o table

Optional Parameters

--target-type -t

The target resource type.

Accepted values: app-insights, appconfig, cognitiveservices, confluent-cloud, containerapp, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, fabric-sql, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub

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 show

Edit

Get the details of a containerapp connection.

az containerapp connection show [--connection]
                                [--id]
                                [--name]
                                [--resource-group]

Examples

Get a connection interactively

az containerapp connection show

Get a connection by connection name

az containerapp connection show -g ContainerAppRG -n MyContainerApp --connection MyConnection

Get a connection by connection id

az containerapp connection show --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the containerapp connection.

--id

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

--name -n

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

--resource-group -g

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

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 validate

Edit

Validate a containerapp connection.

az containerapp connection validate [--connection]
                                    [--id]
                                    [--name]
                                    [--resource-group]

Examples

Validate a connection interactively

az containerapp connection validate

Validate a connection by connection name

az containerapp connection validate -g ContainerAppRG -n MyContainerApp --connection MyConnection

Validate a connection by connection id

az containerapp connection validate --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

Optional Parameters

--connection

Name of the containerapp connection.

--id

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

--name -n

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

--resource-group -g

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

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 wait

Edit

Place the CLI in a waiting state until a condition of the connection is met.

az containerapp connection wait [--connection]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--id]
                                [--interval]
                                [--name]
                                [--resource-group]
                                [--timeout]
                                [--updated]

Examples

Wait until the connection is successfully created.

az containerapp connection wait --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --created

Optional Parameters

--connection

Name of the containerapp connection.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--id

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

--interval

Polling interval in seconds.

Default value: 30

--name -n

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

--resource-group -g

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

Share via

az containerapp connection

Commands

az containerapp connection delete

Examples

Optional Parameters

az containerapp connection list

Examples

Optional Parameters

az containerapp connection list-configuration

Examples

Optional Parameters

az containerapp connection list-support-types

Examples

Optional Parameters

az containerapp connection show

Examples

Optional Parameters

az containerapp connection validate

Examples

Optional Parameters

az containerapp connection wait

Examples

Optional Parameters

Additional resources