Share via


az spring-cloud connection

This command group is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

Commands to manage spring-cloud connections.

Commands

Name Description Type Status
az spring-cloud connection create

Create a connection between a spring-cloud and a target resource.

Core Deprecated
az spring-cloud connection create app-insights

Create a spring-cloud connection to app-insights.

Core Deprecated
az spring-cloud connection create appconfig

Create a spring-cloud connection to appconfig.

Core Deprecated
az spring-cloud connection create cognitiveservices

Create a spring-cloud connection to cognitiveservices.

Core Deprecated
az spring-cloud connection create confluent-cloud

Create a spring-cloud connection to confluent-cloud.

Core Deprecated
az spring-cloud connection create cosmos-cassandra

Create a spring-cloud connection to cosmos-cassandra.

Core Deprecated
az spring-cloud connection create cosmos-gremlin

Create a spring-cloud connection to cosmos-gremlin.

Core Deprecated
az spring-cloud connection create cosmos-mongo

Create a spring-cloud connection to cosmos-mongo.

Core Deprecated
az spring-cloud connection create cosmos-sql

Create a spring-cloud connection to cosmos-sql.

Core Deprecated
az spring-cloud connection create cosmos-table

Create a spring-cloud connection to cosmos-table.

Core Deprecated
az spring-cloud connection create eventhub

Create a spring-cloud connection to eventhub.

Core Deprecated
az spring-cloud connection create keyvault

Create a spring-cloud connection to keyvault.

Core Deprecated
az spring-cloud connection create mysql

Create a spring-cloud connection to mysql.

Core Deprecated
az spring-cloud connection create mysql-flexible

Create a spring-cloud connection to mysql-flexible.

Core Deprecated
az spring-cloud connection create postgres

Create a spring-cloud connection to postgres.

Core Deprecated
az spring-cloud connection create postgres-flexible

Create a spring-cloud connection to postgres-flexible.

Core Deprecated
az spring-cloud connection create redis

Create a spring-cloud connection to redis.

Core Deprecated
az spring-cloud connection create redis-enterprise

Create a spring-cloud connection to redis-enterprise.

Core Deprecated
az spring-cloud connection create servicebus

Create a spring-cloud connection to servicebus.

Core Deprecated
az spring-cloud connection create signalr

Create a spring-cloud connection to signalr.

Core Deprecated
az spring-cloud connection create sql

Create a spring-cloud connection to sql.

Core Deprecated
az spring-cloud connection create storage-blob

Create a spring-cloud connection to storage-blob.

Core Deprecated
az spring-cloud connection create storage-file

Create a spring-cloud connection to storage-file.

Core Deprecated
az spring-cloud connection create storage-queue

Create a spring-cloud connection to storage-queue.

Core Deprecated
az spring-cloud connection create storage-table

Create a spring-cloud connection to storage-table.

Core Deprecated
az spring-cloud connection create webpubsub

Create a spring-cloud connection to webpubsub.

Core Deprecated
az spring-cloud connection delete

Delete a spring-cloud connection.

Core Deprecated
az spring-cloud connection list

List connections of a spring-cloud.

Core Deprecated
az spring-cloud connection list-configuration

List source configurations of a spring-cloud connection.

Core Deprecated
az spring-cloud connection list-support-types

List client types and auth types supported by spring-cloud connections.

Core Deprecated
az spring-cloud connection show

Get the details of a spring-cloud connection.

Core Deprecated
az spring-cloud connection update

Update a spring-cloud connection.

Core Deprecated
az spring-cloud connection update app-insights

Update a spring-cloud to app-insights connection.

Core Deprecated
az spring-cloud connection update appconfig

Update a spring-cloud to appconfig connection.

Core Deprecated
az spring-cloud connection update cognitiveservices

Update a spring-cloud to cognitiveservices connection.

Core Deprecated
az spring-cloud connection update confluent-cloud

Update a spring-cloud to confluent-cloud connection.

Core Deprecated
az spring-cloud connection update cosmos-cassandra

Update a spring-cloud to cosmos-cassandra connection.

Core Deprecated
az spring-cloud connection update cosmos-gremlin

Update a spring-cloud to cosmos-gremlin connection.

Core Deprecated
az spring-cloud connection update cosmos-mongo

Update a spring-cloud to cosmos-mongo connection.

Core Deprecated
az spring-cloud connection update cosmos-sql

Update a spring-cloud to cosmos-sql connection.

Core Deprecated
az spring-cloud connection update cosmos-table

Update a spring-cloud to cosmos-table connection.

Core Deprecated
az spring-cloud connection update eventhub

Update a spring-cloud to eventhub connection.

Core Deprecated
az spring-cloud connection update keyvault

Update a spring-cloud to keyvault connection.

Core Deprecated
az spring-cloud connection update mysql

Update a spring-cloud to mysql connection.

Core Deprecated
az spring-cloud connection update mysql-flexible

Update a spring-cloud to mysql-flexible connection.

Core Deprecated
az spring-cloud connection update postgres

Update a spring-cloud to postgres connection.

Core Deprecated
az spring-cloud connection update postgres-flexible

Update a spring-cloud to postgres-flexible connection.

Core Deprecated
az spring-cloud connection update redis

Update a spring-cloud to redis connection.

Core Deprecated
az spring-cloud connection update redis-enterprise

Update a spring-cloud to redis-enterprise connection.

Core Deprecated
az spring-cloud connection update servicebus

Update a spring-cloud to servicebus connection.

Core Deprecated
az spring-cloud connection update signalr

Update a spring-cloud to signalr connection.

Core Deprecated
az spring-cloud connection update sql

Update a spring-cloud to sql connection.

Core Deprecated
az spring-cloud connection update storage-blob

Update a spring-cloud to storage-blob connection.

Core Deprecated
az spring-cloud connection update storage-file

Update a spring-cloud to storage-file connection.

Core Deprecated
az spring-cloud connection update storage-queue

Update a spring-cloud to storage-queue connection.

Core Deprecated
az spring-cloud connection update storage-table

Update a spring-cloud to storage-table connection.

Core Deprecated
az spring-cloud connection update webpubsub

Update a spring-cloud to webpubsub connection.

Core Deprecated
az spring-cloud connection validate

Validate a spring-cloud connection.

Core Deprecated
az spring-cloud connection wait

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

Core Deprecated

az spring-cloud connection delete

Deprecated

This command is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

Delete a spring-cloud connection.

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

Examples

Delete a spring-cloud connection interactively

az spring-cloud connection delete

Delete a spring-cloud connection by connection name

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

Delete a spring-cloud connection by connection id

az spring-cloud 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 spring-cloud app. Required if '--id' is not specified.None.

--connection

Name of the spring-cloud connection.

--id

The resource id of the connection. ['--resource-group', '--service', '--app', '--deployment', '--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 the spring-cloud. Required if '--id' is not specified.None.

--service

Name of the spring-cloud service. 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-cloud connection list

Deprecated

This command is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

List connections of a spring-cloud.

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

Examples

List spring-cloud connections interactively

az spring-cloud connection list

List spring-cloud connections by source resource name

az spring-cloud connection list -g SpringCloudRG --service MySpringService --app MyApp --deployment MyDeployment

List spring-cloud connections by source resource id

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

Optional Parameters

--app

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

--resource-group -g

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

--service

Name of the spring-cloud service. Required if '--source-id' is not specified.None.

--source-id

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

Deprecated

This command is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

List source configurations of a spring-cloud connection.

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

Examples

List a connection's source configurations interactively

az spring-cloud connection list-configuration

List a connection's source configurations by connection name

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

List a connection's source configurations by connection id

az spring-cloud 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 spring-cloud app. Required if '--id' is not specified.None.

--connection

Name of the spring-cloud connection.

--id

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

--resource-group -g

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

--service

Name of the spring-cloud service. 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-cloud connection list-support-types

Deprecated

This command is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

List client types and auth types supported by spring-cloud connections.

az spring-cloud connection list-support-types [--target-type {app-insights, appconfig, cognitiveservices, 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-cloud supported target resource types and auth types

az spring-cloud connection list-support-types -o table

List spring-cloud supported auth types for a specific target resource type

az spring-cloud 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, 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-cloud connection show

Deprecated

This command is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

Get the details of a spring-cloud connection.

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

Examples

Get a connection interactively

az spring-cloud connection show

Get a connection by connection name

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

Get a connection by connection id

az spring-cloud 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 spring-cloud app. Required if '--id' is not specified.None.

--connection

Name of the spring-cloud connection.

--id

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

--resource-group -g

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

--service

Name of the spring-cloud service. 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-cloud connection validate

Deprecated

This command is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

Validate a spring-cloud connection.

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

Examples

Validate a connection interactively

az spring-cloud connection validate

Validate a connection by connection name

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

Validate a connection by connection id

az spring-cloud 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 spring-cloud app. Required if '--id' is not specified.None.

--connection

Name of the spring-cloud connection.

--id

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

--resource-group -g

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

--service

Name of the spring-cloud service. 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-cloud connection wait

Deprecated

This command is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

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

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

Examples

Wait until the connection is successfully created.

az spring-cloud 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 spring-cloud app. Required if '--id' is not specified.None.

--connection

Name of the spring-cloud 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', '--service', '--app', '--deployment', '--connection'] are required if '--id' is not specified.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--service

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