az spring connection

Commands to manage spring app connections.

Commands

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

az spring connection delete

Delete a spring app connection.

az spring connection delete [--app]
                            [--connection]
                            [--deployment]
                            [--id]
                            [--no-wait]
                            [--resource-group]
                            [--service]
                            [--yes]

Examples

Delete a spring app connection interactively

az spring connection delete

Delete a spring app connection by connection name

az spring connection delete -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection

Delete a spring app connection by connection id

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

Optional Parameters

--app

Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None.

--connection

Name of the spring connection.

--deployment

The deployment name of the app.

--id

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

--no-wait

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

default value: False

--resource-group -g

The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None.

--service

Name of the the Azure Spring Apps resource. 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 spring connection list

List connections of a spring app.

az spring connection list [--app]
                          [--deployment]
                          [--resource-group]
                          [--service]
                          [--source-id]

Examples

List spring app connections interactively

az spring connection list

List spring app connections by source resource name

az spring connection list -g SpringCloudRG --service MySpringService --app MyApp

List spring app connections by source resource id

az spring connection list --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app}

Optional Parameters

--app

Name of the app in the Azure Spring Apps. Required if '--source-id' is not specified.None.

--deployment

The deployment name of the app.

--resource-group -g

The resource group which contains app in the Azure Spring Apps. Required if '--source-id' is not specified.None.

--service

Name of the the Azure Spring Apps resource. Required if '--source-id' is not specified.None.

--source-id

The resource id of a spring. Required if ['--resource-group', '--service', '--app'] 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 spring connection list-configuration

List source configurations of a spring app connection.

az spring connection list-configuration [--app]
                                        [--connection]
                                        [--deployment]
                                        [--id]
                                        [--resource-group]
                                        [--service]

Examples

List a connection's source configurations interactively

az spring connection list-configuration

List a connection's source configurations by connection name

az spring connection list-configuration -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection

List a connection's source configurations by connection id

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

Optional Parameters

--app

Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None.

--connection

Name of the spring connection.

--deployment

The deployment name of the app.

--id

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

--resource-group -g

The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None.

--service

Name of the the Azure Spring Apps resource. 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 spring connection list-support-types

List client types and auth types supported by spring app connections.

az spring connection list-support-types [--target-type {app-insights, appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, 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 spring app supported target resource types and auth types

az spring connection list-support-types -o table

List spring app supported auth types for a specific target resource type

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

Optional Parameters

--target-type -t

The target resource type.

accepted values: app-insights, appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, 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 spring connection show

Get the details of a spring app connection.

az spring connection show [--app]
                          [--connection]
                          [--deployment]
                          [--id]
                          [--resource-group]
                          [--service]

Examples

Get a connection interactively

az spring connection show

Get a connection by connection name

az spring connection show -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection

Get a connection by connection id

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

Optional Parameters

--app

Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None.

--connection

Name of the spring connection.

--deployment

The deployment name of the app.

--id

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

--resource-group -g

The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None.

--service

Name of the the Azure Spring Apps resource. 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 spring connection validate

Validate a spring app connection.

az spring connection validate [--app]
                              [--connection]
                              [--deployment]
                              [--id]
                              [--resource-group]
                              [--service]

Examples

Validate a connection interactively

az spring connection validate

Validate a connection by connection name

az spring connection validate -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection

Validate a connection by connection id

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

Optional Parameters

--app

Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None.

--connection

Name of the spring connection.

--deployment

The deployment name of the app.

--id

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

--resource-group -g

The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None.

--service

Name of the the Azure Spring Apps resource. 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 spring connection wait

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

az spring connection wait [--app]
                          [--connection]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--deployment]
                          [--exists]
                          [--id]
                          [--interval]
                          [--resource-group]
                          [--service]
                          [--timeout]
                          [--updated]

Examples

Wait until the connection is successfully created.

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

Optional Parameters

--app

Name of the app in the Azure Spring Apps. Required if '--id' is not specified.None.

--connection

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

--deployment

The deployment name of the app.

--exists

Wait until the resource exists.

default value: False

--id

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

--interval

Polling interval in seconds.

default value: 30

--resource-group -g

The resource group which contains app in the Azure Spring Apps. Required if '--id' is not specified.None.

--service

Name of the the Azure Spring Apps resource. 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.