az spring connection update

Update a spring app connection.

Commands

Name	Description	Type	Status
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 update app-insights

Update a spring app to app-insights connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update app-insights -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update app-insights --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

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

Update a spring app to appconfig connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update appconfig -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update appconfig --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update confluent-cloud

Update a spring app to confluent-cloud connection.

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

Examples

Update the client-type of a bootstrap server connection

az spring connection update confluent-cloud -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client python

Update the auth configurations of a bootstrap server connection

az spring connection update confluent-cloud -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --bootstrap-server xxx.eastus.azure.confluent.cloud:9092 --kafka-key Name --kafka-secret Secret

Update the client-type of a schema registry connection

az spring connection update confluent-cloud -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection_schema --client python

Update the auth configurations of a schema registry connection

az spring connection update confluent-cloud -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection_schema --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret

Required Parameters

--connection

Name of the connection.

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--bootstrap-server

Kafka bootstrap server url.

--client-type

The client type used on the spring.

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

--customized-keys

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

--deployment

The deployment name of the app.

--kafka-key

Kafka API-Key (key).

--kafka-secret

Kafka API-Key (secret).

--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 app in the Azure Spring Apps. Required if '--source-id' is not specified.None.

--schema-key

Schema registry API-Key (key).

--schema-registry

Schema registry url.

--schema-secret

Schema registry API-Key (secret).

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

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

Update a spring app to cosmos-cassandra connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update cosmos-cassandra -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update cosmos-cassandra --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update cosmos-gremlin

Update a spring app to cosmos-gremlin connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update cosmos-gremlin -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update cosmos-gremlin --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update cosmos-mongo

Update a spring app to cosmos-mongo connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update cosmos-mongo -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update cosmos-mongo --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update cosmos-sql

Update a spring app to cosmos-sql connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update cosmos-sql -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update cosmos-sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update cosmos-table

Update a spring app to cosmos-table connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update cosmos-table -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update cosmos-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update eventhub

Update a spring app to eventhub connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update eventhub -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update eventhub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update keyvault

Update a spring app to keyvault connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update keyvault -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update keyvault --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update mysql

Deprecated

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

Update a spring app to mysql connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update mysql -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update mysql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service

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

--service-endpoint

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

accepted values: false, true

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

Update a spring app to mysql-flexible connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update mysql-flexible -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update mysql-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service

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

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity mysql-identity-id=xx

mysql-identity-id : Optional. ID of identity used for MySQL flexible server AAD Authentication. Ignore it if you are the server AAD administrator.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update postgres

Deprecated

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

Update a spring app to postgres connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update postgres -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update postgres --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update postgres-flexible

Update a spring app to postgres-flexible connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update postgres-flexible -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update postgres-flexible --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service

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

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update redis

Update a spring app to redis connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update redis -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update redis --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

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

Update a spring app to redis-enterprise connection.

az spring connection update redis-enterprise [--app]
                                             [--appconfig-id]
                                             [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                             [--connection]
                                             [--customized-keys]
                                             [--deployment]
                                             [--id]
                                             [--no-wait]
                                             [--opt-out {auth, configinfo, publicnetwork}]
                                             [--resource-group]
                                             [--secret]
                                             [--service]
                                             [--vault-id]

Examples

Update the client type of a connection with resource name

az spring connection update redis-enterprise -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update redis-enterprise --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

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

Update a spring app to servicebus connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update servicebus -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update servicebus --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update signalr

Update a spring app to signalr connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update signalr -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update signalr --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

accepted values: dotnet, dotnet-internal, none

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update sql

Update a spring app to sql connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update sql -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update sql --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : One of <secret, secret-uri, secret-name> is required. Password or account key for secret auth. secret-uri : One of <secret, secret-uri, secret-name> is required. Keyvault secret uri which stores password. secret-name : One of <secret, secret-uri, secret-name> is required. Keyvault secret name which stores password. It's for AKS only.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update storage-blob

Update a spring app to storage-blob connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update storage-blob -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update storage-blob --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update storage-file

Update a spring app to storage-file connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update storage-file -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update storage-file --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

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

Update a spring app to storage-queue connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update storage-queue -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update storage-queue --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update storage-table

Update a spring app to storage-table connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update storage-table -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update storage-table --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

accepted values: false, true

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring connection update webpubsub

Update a spring app to webpubsub connection.

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

Examples

Update the client type of a connection with resource name

az spring connection update webpubsub -g SpringCloudRG --service MySpringService --app MyApp --connection MyConnection --client-type dotnet

Update the client type of a connection with resource id

az spring connection update webpubsub --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --client-type dotnet

Optional Parameters

--app

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the spring.

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

--connection

Name of the spring connection.

--customized-keys

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

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

--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 app in the Azure Spring Apps. Required if '--id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--user-identity

The user assigned identity auth info.

Usage: --user-identity client-id=XX subs-id=XX

client-id : Required. Client id of the user assigned identity. subs-id : Required. Subscription id of the user assigned identity.

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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