az spring connection create

Create a connection between a spring app and a target resource.

Commands

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

az spring connection create app-insights

Create a spring app connection to app-insights.

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

Examples

Create a connection between spring app and app-insights interactively

az spring connection create app-insights

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

az spring connection create app-insights -g SpringCloudRG --service MySpringService --app MyApp --tg AppInsightsRG --app-insights MyAppInsights --secret

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

az spring connection create app-insights --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/microsoft.insights/components/{appinsights} --secret

Optional Parameters

--app

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

--app-insights

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the 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.

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

--secret

The secret auth info.

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

--target-id

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

--target-resource-group --tg

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create appconfig

Create a spring app connection to appconfig.

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

Examples

Create a connection between spring app and appconfig interactively

az spring connection create appconfig

Create a connection between spring app and appconfig with resource name

az spring connection create appconfig -g SpringCloudRG --service MySpringService --app MyApp --tg AppconfigRG --app-config MyConfigStore --system-identity

Create a connection between spring app and appconfig with resource id

az spring connection create appconfig --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --system-identity

Optional Parameters

--app

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

--app-config

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

--appconfig-id

The app configuration id to store configuration.

--client-type

The client type used on the 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.

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create cognitiveservices

Create a spring app connection to cognitiveservices.

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

Examples

Create a connection between spring app and cognitiveservices interactively

az spring connection create cognitiveservices

Create a connection between spring app and cognitiveservices with resource name

az spring connection create cognitiveservices -g SpringCloudRG --service MySpringService --app MyApp --tg CognitiveServicesRG --account MyAccount --system-identity

Create a connection between spring app and cognitiveservices with resource id

az spring connection create cognitiveservices --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.CognitiveServices/accounts/{account} --system-identity

Optional Parameters

--account

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

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

--client-type

The client type used on the spring.

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

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

--secret

The secret auth info.

Usage: --secret.

--service

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create confluent-cloud

Create a spring app connection to confluent-cloud.

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

Examples

Create a connection between spring app and confluent-cloud

az spring connection create confluent-cloud -g SpringCloudRG --service MySpringService --app MyApp --bootstrap-server xxx.eastus.azure.confluent.cloud:9092 --kafka-key Name --kafka-secret Secret --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret

Required Parameters

--bootstrap-server

Kafka bootstrap server url.

--kafka-key

Kafka API-Key (key).

--kafka-secret

Kafka API-Key (secret).

--schema-key

Schema registry API-Key (key).

--schema-registry

Schema registry url.

--schema-secret

Schema registry API-Key (secret).

Optional Parameters

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

--client-type

The client type used on the spring.

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

--connection

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

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

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

Create a spring app connection to cosmos-cassandra.

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

Examples

Create a connection between spring app and cosmos-cassandra interactively

az spring connection create cosmos-cassandra

Create a connection between spring app and cosmos-cassandra with resource name

az spring connection create cosmos-cassandra -g SpringCloudRG --service MySpringService --app MyApp --tg CosmosRG --account MyAccount --key-space MyKeySpace --system-identity

Create a connection between spring app and cosmos-cassandra with resource id

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

Optional Parameters

--account

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

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

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

--key-space

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

--no-wait

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

Default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

Accepted values: false, true

--resource-group -g

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

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create cosmos-gremlin

Create a spring app connection to cosmos-gremlin.

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

Examples

Create a connection between spring app and cosmos-gremlin interactively

az spring connection create cosmos-gremlin

Create a connection between spring app and cosmos-gremlin with resource name

az spring connection create cosmos-gremlin -g SpringCloudRG --service MySpringService --app MyApp --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --system-identity

Create a connection between spring app and cosmos-gremlin with resource id

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

Optional Parameters

--account

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

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

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

--database

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

--deployment

The deployment name of the app.

--graph

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

--no-wait

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

Default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

Accepted values: false, true

--resource-group -g

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

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create cosmos-mongo

Create a spring app connection to cosmos-mongo.

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

Examples

Create a connection between spring app and cosmos-mongo interactively

az spring connection create cosmos-mongo

Create a connection between spring app and cosmos-mongo with resource name

az spring connection create cosmos-mongo -g SpringCloudRG --service MySpringService --app MyApp --tg CosmosRG --account MyAccount --database MyDB --system-identity

Create a connection between spring app and cosmos-mongo with resource id

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

Optional Parameters

--account

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

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

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

--database

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

--deployment

The deployment name of the app.

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create cosmos-sql

Create a spring app connection to cosmos-sql.

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

Examples

Create a connection between spring app and cosmos-sql interactively

az spring connection create cosmos-sql

Create a connection between spring app and cosmos-sql with resource name

az spring connection create cosmos-sql -g SpringCloudRG --service MySpringService --app MyApp --tg CosmosRG --account MyAccount --database MyDB --system-identity

Create a connection between spring app and cosmos-sql with resource id

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

Optional Parameters

--account

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

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

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

--database

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

--deployment

The deployment name of the app.

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create cosmos-table

Create a spring app connection to cosmos-table.

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

Examples

Create a connection between spring app and cosmos-table interactively

az spring connection create cosmos-table

Create a connection between spring app and cosmos-table with resource name

az spring connection create cosmos-table -g SpringCloudRG --service MySpringService --app MyApp --tg CosmosRG --account MyAccount --table MyTable --system-identity

Create a connection between spring app and cosmos-table with resource id

az spring connection create cosmos-table --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --system-identity

Optional Parameters

--account

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

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

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

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--table

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

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create eventhub

Create a spring app connection to eventhub.

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

Examples

Create a connection between spring app and eventhub interactively

az spring connection create eventhub

Create a connection between spring app and eventhub with resource name

az spring connection create eventhub -g SpringCloudRG --service MySpringService --app MyApp --tg EventhubRG --namespace MyNamespace --system-identity

Create a connection between spring app and eventhub with resource id

az spring connection create eventhub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --system-identity

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.

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

--namespace

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

--no-wait

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

Default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

Accepted values: false, true

--resource-group -g

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

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create keyvault

Create a spring app connection to keyvault.

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

Examples

Create a connection between spring app and keyvault interactively

az spring connection create keyvault

Create a connection between spring app and keyvault with resource name

az spring connection create keyvault -g SpringCloudRG --service MySpringService --app MyApp --tg KeyvaultRG --vault MyVault --system-identity

Create a connection between spring app and keyvault with resource id

az spring connection create keyvault --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --system-identity

Create a new keyvault and connect spring app to it interactively

az spring connection create keyvault --new

Create a new keyvault and connect spring app to it

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

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.

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

--new

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

Accepted values: false, true

Default value: False

--no-wait

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

Default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

Accepted values: false, true

--resource-group -g

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

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create mysql

Deprecated

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

Create a spring app connection to mysql.

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

Examples

Create a connection between spring app and mysql interactively

az spring connection create mysql

Create a connection between spring app and mysql with resource name

az spring connection create mysql -g SpringCloudRG --service MySpringService --app MyApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between spring app and mysql with resource id

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

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.

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

--database

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

--deployment

The deployment name of the app.

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

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

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

--server

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

--service

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

--service-endpoint

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

Accepted values: false, true

--source-id

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

--target-id

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

--target-resource-group --tg

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create mysql-flexible

Create a spring app connection to mysql-flexible.

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

Examples

Create a connection between spring app and mysql-flexible interactively

az spring connection create mysql-flexible

Create a connection between spring app and mysql-flexible with resource name

az spring connection create mysql-flexible -g SpringCloudRG --service MySpringService --app MyApp --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between spring app and mysql-flexible with resource id

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

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.

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

--database

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

--deployment

The deployment name of the app.

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

--secret

The secret auth info.

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

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

--server

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

--service

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

--source-id

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

--system-identity

The system assigned identity auth info.

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

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

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create postgres

Deprecated

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

Create a spring app connection to postgres.

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

Examples

Create a connection between spring app and postgres interactively

az spring connection create postgres

Create a connection between spring app and postgres with resource name

az spring connection create postgres -g SpringCloudRG --service MySpringService --app MyApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between spring app and postgres with resource id

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

Create a new postgres and connect spring app to it interactively

az spring connection create postgres --new

Create a new postgres and connect spring app to it

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

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.

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

--database

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

--deployment

The deployment name of the app.

--new

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

Accepted values: false, true

Default value: False

--no-wait

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

Default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

Accepted values: false, true

--resource-group -g

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

--secret

The secret auth info.

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

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

--server

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

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create postgres-flexible

Create a spring app connection to postgres-flexible.

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

Examples

Create a connection between spring app and postgres-flexible interactively

az spring connection create postgres-flexible

Create a connection between spring app and postgres-flexible with resource name

az spring connection create postgres-flexible -g SpringCloudRG --service MySpringService --app MyApp --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between spring app and postgres-flexible with resource id

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

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.

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

--database

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

--deployment

The deployment name of the app.

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

--secret

The secret auth info.

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

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

--server

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

--service

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create redis

Create a spring app connection to redis.

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

Examples

Create a connection between spring app and redis interactively

az spring connection create redis

Create a connection between spring app and redis with resource name

az spring connection create redis -g SpringCloudRG --service MySpringService --app MyApp --tg RedisRG --server MyServer --database MyDB --secret

Create a connection between spring app and redis with resource id

az spring connection create redis --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret

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.

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

--database

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

--deployment

The deployment name of the app.

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--server

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

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

--target-id

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

--target-resource-group --tg

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create redis-enterprise

Create a spring app connection to redis-enterprise.

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

Examples

Create a connection between spring app and redis-enterprise interactively

az spring connection create redis-enterprise

Create a connection between spring app and redis-enterprise with resource name

az spring connection create redis-enterprise -g SpringCloudRG --service MySpringService --app MyApp --tg RedisRG --server MyServer --database MyDB --secret

Create a connection between spring app and redis-enterprise with resource id

az spring connection create redis-enterprise --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret

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.

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

--database

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

--deployment

The deployment name of the app.

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

--secret

The secret auth info.

Usage: --secret.

--server

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

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

--target-id

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

--target-resource-group --tg

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create servicebus

Create a spring app connection to servicebus.

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

Examples

Create a connection between spring app and servicebus interactively

az spring connection create servicebus

Create a connection between spring app and servicebus with resource name

az spring connection create servicebus -g SpringCloudRG --service MySpringService --app MyApp --tg ServicebusRG --namespace MyNamespace --system-identity

Create a connection between spring app and servicebus with resource id

az spring connection create servicebus --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --system-identity

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.

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

--namespace

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

--no-wait

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

Default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

Accepted values: false, true

--resource-group -g

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

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create signalr

Create a spring app connection to signalr.

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

Examples

Create a connection between spring app and signalr interactively

az spring connection create signalr

Create a connection between spring app and signalr with resource name

az spring connection create signalr -g SpringCloudRG --service MySpringService --app MyApp --tg SignalrRG --signalr MySignalR --system-identity

Create a connection between spring app and signalr with resource id

az spring connection create signalr --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --system-identity

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.

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

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--signalr

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create sql

Create a spring app connection to sql.

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

Examples

Create a connection between spring app and sql interactively

az spring connection create sql

Create a connection between spring app and sql with resource name

az spring connection create sql -g SpringCloudRG --service MySpringService --app MyApp --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection between spring app and sql with resource id

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

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.

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

--database

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

--deployment

The deployment name of the app.

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

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

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

--server

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

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create storage-blob

Create a spring app connection to storage-blob.

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

Examples

Create a connection between spring app and storage-blob interactively

az spring connection create storage-blob

Create a connection between spring app and storage-blob with resource name

az spring connection create storage-blob -g SpringCloudRG --service MySpringService --app MyApp --tg StorageRG --account MyAccount --system-identity

Create a connection between spring app and storage-blob with resource id

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

Create a new storage-blob and connect spring app to it interactively

az spring connection create storage-blob --new

Create a new storage-blob and connect spring app to it

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

Optional Parameters

--account

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

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

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

--new

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

Accepted values: false, true

Default value: False

--no-wait

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

Default value: False

--opt-out

Whether to disable some configuration steps. Use configinfo to disbale configuration information changes on source. Use publicnetwork to disable public network access configuration.Use auth to skip auth configuration such as enabling managed identity and granting RBAC roles.

Accepted values: auth, configinfo, publicnetwork

--private-endpoint

Connect target service by private endpoint. The private endpoint in source virtual network must be created ahead.

Accepted values: false, true

--resource-group -g

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

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create storage-file

Create a spring app connection to storage-file.

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

Examples

Create a connection between spring app and storage-file interactively

az spring connection create storage-file

Create a connection between spring app and storage-file with resource name

az spring connection create storage-file -g SpringCloudRG --service MySpringService --app MyApp --tg StorageRG --account MyAccount --secret

Create a connection between spring app and storage-file with resource id

az spring connection create storage-file --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret

Optional Parameters

--account

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

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

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

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--source-id

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

--target-id

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

--target-resource-group --tg

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create storage-queue

Create a spring app connection to storage-queue.

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

Examples

Create a connection between spring app and storage-queue interactively

az spring connection create storage-queue

Create a connection between spring app and storage-queue with resource name

az spring connection create storage-queue -g SpringCloudRG --service MySpringService --app MyApp --tg StorageRG --account MyAccount --system-identity

Create a connection between spring app and storage-queue with resource id

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

Optional Parameters

--account

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

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

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

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create storage-table

Create a spring app connection to storage-table.

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

Examples

Create a connection between spring app and storage-table interactively

az spring connection create storage-table

Create a connection between spring app and storage-table with resource name

az spring connection create storage-table -g SpringCloudRG --service MySpringService --app MyApp --tg StorageRG --account MyAccount --system-identity

Create a connection between spring app and storage-table with resource id

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

Optional Parameters

--account

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

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

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

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--service-endpoint

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

Accepted values: false, true

--service-principal

The service principal auth info.

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

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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

az spring connection create webpubsub

Create a spring app connection to webpubsub.

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

Examples

Create a connection between spring app and webpubsub interactively

az spring connection create webpubsub

Create a connection between spring app and webpubsub with resource name

az spring connection create webpubsub -g SpringCloudRG --service MySpringService --app MyApp --tg WebpubsubRG --webpubsub MyWebPubSub --system-identity

Create a connection between spring app and webpubsub with resource id

az spring connection create webpubsub --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.AppPlatform/Spring/{spring}/apps/{app} --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --system-identity

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.

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

--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 '--source-id' is not specified.None.

--secret

The secret auth info.

Usage: --secret.

--service

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

--source-id

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

--system-identity

The system assigned identity auth info.

Usage: --system-identity.

--target-id

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

--target-resource-group --tg

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

--user-identity

The user assigned identity auth info.

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

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

--vault-id

The id of key vault to store secret value.

--webpubsub

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Default value: json

--query

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

--subscription

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

--verbose

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