Share via


az spring-cloud

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

The command group has been deprecated and will be removed in Nov. 2022. We recommend that you upgrade to the new 'spring' command group by installing the 'spring' extension: run az extension add -n spring. For more information, please visit: https://aka.ms/azure-spring-cloud-rename.

Commands to manage Azure Spring Cloud.

Commands

Name Description Type Status
az spring-cloud api-portal

(Enterprise Tier Only) Commands to manage API portal in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud api-portal clear

Clear all settings of API portal.

Extension Preview and Deprecated
az spring-cloud api-portal custom-domain

Commands to manage custom domains for API portal.

Extension Preview and Deprecated
az spring-cloud api-portal custom-domain bind

Bind a custom domain with the API portal.

Extension Preview and Deprecated
az spring-cloud api-portal custom-domain list

List all custom domains of the API portal.

Extension Preview and Deprecated
az spring-cloud api-portal custom-domain show

Show details of a custom domain.

Extension Preview and Deprecated
az spring-cloud api-portal custom-domain unbind

Unbind a custom-domain of the API portal.

Extension Preview and Deprecated
az spring-cloud api-portal custom-domain update

Update a custom domain of the API portal.

Extension Preview and Deprecated
az spring-cloud api-portal show

Show the settings, provisioning status and runtime status of API portal.

Extension Preview and Deprecated
az spring-cloud api-portal update

Update an existing API portal properties.

Extension Preview and Deprecated
az spring-cloud app

Commands to manage apps in Azure Spring Cloud.

Extension Deprecated
az spring-cloud app-insights

Commands to management Application Insights in Azure Spring Cloud.

Extension Deprecated
az spring-cloud app-insights show

Show Application Insights settings.

Extension Deprecated
az spring-cloud app-insights update

Update Application Insights settings.

Extension Deprecated
az spring-cloud app append-loaded-public-certificate

Append a new loaded public certificate to an app in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud app append-persistent-storage

Append a new persistent storage to an app in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud app binding

Commands to manage bindings with Azure Data Services, you need to manually restart app to make settings take effect.

Extension Deprecated
az spring-cloud app binding cosmos

Commands to manage Azure Cosmos DB bindings.

Extension Deprecated
az spring-cloud app binding cosmos add

Bind an Azure Cosmos DB with the app.

Extension Deprecated
az spring-cloud app binding cosmos update

Update an Azure Cosmos DB service binding of the app.

Extension Deprecated
az spring-cloud app binding list

List all service bindings in an app.

Extension Deprecated
az spring-cloud app binding mysql

Commands to manage Azure Database for MySQL bindings.

Extension Deprecated
az spring-cloud app binding mysql add

Bind an Azure Database for MySQL with the app.

Extension Deprecated
az spring-cloud app binding mysql update

Update an Azure Database for MySQL service binding of the app.

Extension Deprecated
az spring-cloud app binding redis

Commands to manage Azure Cache for Redis bindings.

Extension Deprecated
az spring-cloud app binding redis add

Bind an Azure Cache for Redis with the app.

Extension Deprecated
az spring-cloud app binding redis update

Update an Azure Cache for Redis service binding of the app.

Extension Deprecated
az spring-cloud app binding remove

Remove a service binding of the app.

Extension Deprecated
az spring-cloud app binding show

Show the details of a service binding.

Extension Deprecated
az spring-cloud app create

Create a new app with a default deployment in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud app custom-domain

Commands to manage custom domains.

Extension Deprecated
az spring-cloud app custom-domain bind

Bind a custom domain with the app.

Extension Deprecated
az spring-cloud app custom-domain list

List all custom domains of the app.

Extension Deprecated
az spring-cloud app custom-domain show

Show details of a custom domain.

Extension Deprecated
az spring-cloud app custom-domain unbind

Unbind a custom-domain of the app.

Extension Deprecated
az spring-cloud app custom-domain update

Update a custom domain of the app.

Extension Deprecated
az spring-cloud app delete

Delete an app in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud app deploy

Deploy source code or pre-built binary to an app and update related configurations.

Extension Deprecated
az spring-cloud app deployment

Commands to manage life cycle of deployments of an app in Azure Spring Cloud. More operations on deployments can be done on app level with parameter --deployment. e.g. az spring-cloud app deploy --deployment .

Extension Deprecated
az spring-cloud app deployment create

Create a staging deployment for the app. To deploy code or update setting to an existing deployment, use az spring-cloud app deploy/update --deployment <staging deployment>.

Extension Deprecated
az spring-cloud app deployment delete

Delete a deployment of the app.

Extension Deprecated
az spring-cloud app deployment generate-heap-dump

Generate a heap dump of your target app instance to given file path.

Extension Deprecated
az spring-cloud app deployment generate-thread-dump

Generate a thread dump of your target app instance to given file path.

Extension Deprecated
az spring-cloud app deployment list

List all deployments in an app.

Extension Deprecated
az spring-cloud app deployment show

Show details of a deployment.

Extension Deprecated
az spring-cloud app deployment start-jfr

Start a JFR on your target app instance to given file path.

Extension Deprecated
az spring-cloud app identity

Manage an app's managed identities.

Extension Deprecated
az spring-cloud app identity assign

Enable system-assigned managed identity or assign user-assigned managed identities to an app.

Extension Deprecated
az spring-cloud app identity force-set

Force set managed identities on an app.

Extension Preview and Deprecated
az spring-cloud app identity remove

Remove managed identity from an app.

Extension Deprecated
az spring-cloud app identity show

Display app's managed identity info.

Extension Deprecated
az spring-cloud app list

List all apps in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud app log

Commands to tail app instances logs with multiple options. If the app has only one instance, the instance name is optional.

Extension Deprecated
az spring-cloud app log tail

Show logs of an app instance, logs will be streamed when setting '-f/--follow'.

Extension Deprecated
az spring-cloud app logs

Show logs of an app instance, logs will be streamed when setting '-f/--follow'.

Extension Deprecated
az spring-cloud app restart

Restart instances of the app, default to production deployment.

Extension Deprecated
az spring-cloud app scale

Manually scale an app or its deployments.

Extension Deprecated
az spring-cloud app set-deployment

Set production deployment of an app.

Extension Deprecated
az spring-cloud app show

Show the details of an app in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud app show-deploy-log

Show build log of the last deploy, only apply to source code deploy, default to production deployment.

Extension Deprecated
az spring-cloud app start

Start instances of the app, default to production deployment.

Extension Deprecated
az spring-cloud app stop

Stop instances of the app, default to production deployment.

Extension Deprecated
az spring-cloud app unset-deployment

Unset production deployment of an app.

Extension Deprecated
az spring-cloud app update

Update configurations of an app.

Extension Deprecated
az spring-cloud application-configuration-service

(Enterprise Tier Only) Commands to manage Application Configuration Service in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud application-configuration-service bind

Bind an app to Application Configuration Service.

Extension Preview and Deprecated
az spring-cloud application-configuration-service clear

Reset all Application Configuration Service settings.

Extension Preview and Deprecated
az spring-cloud application-configuration-service git

Commands to manage Application Configuration Service git property in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud application-configuration-service git repo

Commands to manage Application Configuration Service git repository in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud application-configuration-service git repo add

Add a Git property to the Application Configuration Service settings.

Extension Preview and Deprecated
az spring-cloud application-configuration-service git repo list

List all Git settings of Application Configuration Service.

Extension Preview and Deprecated
az spring-cloud application-configuration-service git repo remove

Delete an existing Git property from the Application Configuration Service settings.

Extension Preview and Deprecated
az spring-cloud application-configuration-service git repo update

Update an existing Git property in the Application Configuration Service settings.

Extension Preview and Deprecated
az spring-cloud application-configuration-service show

Show the provisioning status, runtime status, and settings of Application Configuration Service.

Extension Preview and Deprecated
az spring-cloud application-configuration-service unbind

Unbind an app from Application Configuration Service.

Extension Preview and Deprecated
az spring-cloud build-service

(Enterprise Tier Only) Commands to manage build service in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud build-service builder

(Enterprise Tier Only) Commands to manage builder of build service.

Extension Preview and Deprecated
az spring-cloud build-service builder buildpack-binding

(Enterprise Tier Only) Commands to manage buildpack-binding of builder.

Extension Preview and Deprecated
az spring-cloud build-service builder buildpack-binding create

(Enterprise Tier Only) Create a buildpack binding.

Extension Preview and Deprecated
az spring-cloud build-service builder buildpack-binding delete

(Enterprise Tier Only) Delete a buildpack binding.

Extension Preview and Deprecated
az spring-cloud build-service builder buildpack-binding list

(Enterprise Tier Only) List all buildpack binding in a builder. The secrets will be masked.

Extension Preview and Deprecated
az spring-cloud build-service builder buildpack-binding set

(Enterprise Tier Only) Set a buildpack binding.

Extension Preview and Deprecated
az spring-cloud build-service builder buildpack-binding show

(Enterprise Tier Only) Show a buildpack binding. The secrets will be masked.

Extension Preview and Deprecated
az spring-cloud build-service builder create

Create a builder.

Extension Preview and Deprecated
az spring-cloud build-service builder delete

Delete a builder.

Extension Preview and Deprecated
az spring-cloud build-service builder show

Show a builder.

Extension Preview and Deprecated
az spring-cloud build-service builder update

Update a builder.

Extension Preview and Deprecated
az spring-cloud certificate

Commands to manage certificates.

Extension Deprecated
az spring-cloud certificate add

Add a certificate in Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate list

List all certificates in Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate list-reference-app

List all the apps reference an existing certificate in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate remove

Remove a certificate in Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate show

Show a certificate in Azure Spring Cloud.

Extension Deprecated
az spring-cloud config-server

(Support Standard Tier and Basic Tier) Commands to manage Config Server in Azure Spring Cloud.

Extension Deprecated
az spring-cloud config-server clear

Erase all settings in Config Server.

Extension Deprecated
az spring-cloud config-server git

Commands to manage Config Server git property in Azure Spring Cloud.

Extension Deprecated
az spring-cloud config-server git repo

Commands to manage Config Server git repository in Azure Spring Cloud.

Extension Deprecated
az spring-cloud config-server git repo add

Add a new repository of git property of Config Server.

Extension Deprecated
az spring-cloud config-server git repo list

List all repositories of git property of Config Server.

Extension Deprecated
az spring-cloud config-server git repo remove

Remove an existing repository of git property of Config Server.

Extension Deprecated
az spring-cloud config-server git repo update

Override an existing repository of git property of Config Server, will totally override the old one.

Extension Deprecated
az spring-cloud config-server git set

Set git property of Config Server, will totally override the old one.

Extension Deprecated
az spring-cloud config-server set

Set Config Server from a yaml file.

Extension Deprecated
az spring-cloud config-server show

Show Config Server.

Extension Deprecated
az spring-cloud connection

Commands to manage spring-cloud connections.

Core Deprecated
az spring-cloud connection create

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

Core Deprecated
az spring-cloud connection create app-insights

Create a spring-cloud connection to app-insights.

Core Deprecated
az spring-cloud connection create appconfig

Create a spring-cloud connection to appconfig.

Core Deprecated
az spring-cloud connection create cognitiveservices

Create a spring-cloud connection to cognitiveservices.

Core Deprecated
az spring-cloud connection create confluent-cloud

Create a spring-cloud connection to confluent-cloud.

Core Deprecated
az spring-cloud connection create cosmos-cassandra

Create a spring-cloud connection to cosmos-cassandra.

Core Deprecated
az spring-cloud connection create cosmos-gremlin

Create a spring-cloud connection to cosmos-gremlin.

Core Deprecated
az spring-cloud connection create cosmos-mongo

Create a spring-cloud connection to cosmos-mongo.

Core Deprecated
az spring-cloud connection create cosmos-sql

Create a spring-cloud connection to cosmos-sql.

Core Deprecated
az spring-cloud connection create cosmos-table

Create a spring-cloud connection to cosmos-table.

Core Deprecated
az spring-cloud connection create eventhub

Create a spring-cloud connection to eventhub.

Core Deprecated
az spring-cloud connection create fabric-sql

Create a spring-cloud connection to fabric-sql.

Core Deprecated
az spring-cloud connection create keyvault

Create a spring-cloud connection to keyvault.

Core Deprecated
az spring-cloud connection create mysql

Create a spring-cloud connection to mysql.

Core Deprecated
az spring-cloud connection create mysql-flexible

Create a spring-cloud connection to mysql-flexible.

Core Deprecated
az spring-cloud connection create postgres

Create a spring-cloud connection to postgres.

Core Deprecated
az spring-cloud connection create postgres-flexible

Create a spring-cloud connection to postgres-flexible.

Core Deprecated
az spring-cloud connection create redis

Create a spring-cloud connection to redis.

Core Deprecated
az spring-cloud connection create redis-enterprise

Create a spring-cloud connection to redis-enterprise.

Core Deprecated
az spring-cloud connection create servicebus

Create a spring-cloud connection to servicebus.

Core Deprecated
az spring-cloud connection create signalr

Create a spring-cloud connection to signalr.

Core Deprecated
az spring-cloud connection create sql

Create a spring-cloud connection to sql.

Core Deprecated
az spring-cloud connection create storage-blob

Create a spring-cloud connection to storage-blob.

Core Deprecated
az spring-cloud connection create storage-file

Create a spring-cloud connection to storage-file.

Core Deprecated
az spring-cloud connection create storage-queue

Create a spring-cloud connection to storage-queue.

Core Deprecated
az spring-cloud connection create storage-table

Create a spring-cloud connection to storage-table.

Core Deprecated
az spring-cloud connection create webpubsub

Create a spring-cloud connection to webpubsub.

Core Deprecated
az spring-cloud connection delete

Delete a spring-cloud connection.

Core Deprecated
az spring-cloud connection list

List connections of a spring-cloud.

Core Deprecated
az spring-cloud connection list-configuration

List source configurations of a spring-cloud connection.

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

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

Core Deprecated
az spring-cloud connection show

Get the details of a spring-cloud connection.

Core Deprecated
az spring-cloud connection update

Update a spring-cloud connection.

Core Deprecated
az spring-cloud connection update app-insights

Update a spring-cloud to app-insights connection.

Core Deprecated
az spring-cloud connection update appconfig

Update a spring-cloud to appconfig connection.

Core Deprecated
az spring-cloud connection update cognitiveservices

Update a spring-cloud to cognitiveservices connection.

Core Deprecated
az spring-cloud connection update confluent-cloud

Update a spring-cloud to confluent-cloud connection.

Core Deprecated
az spring-cloud connection update cosmos-cassandra

Update a spring-cloud to cosmos-cassandra connection.

Core Deprecated
az spring-cloud connection update cosmos-gremlin

Update a spring-cloud to cosmos-gremlin connection.

Core Deprecated
az spring-cloud connection update cosmos-mongo

Update a spring-cloud to cosmos-mongo connection.

Core Deprecated
az spring-cloud connection update cosmos-sql

Update a spring-cloud to cosmos-sql connection.

Core Deprecated
az spring-cloud connection update cosmos-table

Update a spring-cloud to cosmos-table connection.

Core Deprecated
az spring-cloud connection update eventhub

Update a spring-cloud to eventhub connection.

Core Deprecated
az spring-cloud connection update fabric-sql

Update a spring-cloud to fabric-sql connection.

Core Deprecated
az spring-cloud connection update keyvault

Update a spring-cloud to keyvault connection.

Core Deprecated
az spring-cloud connection update mysql

Update a spring-cloud to mysql connection.

Core Deprecated
az spring-cloud connection update mysql-flexible

Update a spring-cloud to mysql-flexible connection.

Core Deprecated
az spring-cloud connection update postgres

Update a spring-cloud to postgres connection.

Core Deprecated
az spring-cloud connection update postgres-flexible

Update a spring-cloud to postgres-flexible connection.

Core Deprecated
az spring-cloud connection update redis

Update a spring-cloud to redis connection.

Core Deprecated
az spring-cloud connection update redis-enterprise

Update a spring-cloud to redis-enterprise connection.

Core Deprecated
az spring-cloud connection update servicebus

Update a spring-cloud to servicebus connection.

Core Deprecated
az spring-cloud connection update signalr

Update a spring-cloud to signalr connection.

Core Deprecated
az spring-cloud connection update sql

Update a spring-cloud to sql connection.

Core Deprecated
az spring-cloud connection update storage-blob

Update a spring-cloud to storage-blob connection.

Core Deprecated
az spring-cloud connection update storage-file

Update a spring-cloud to storage-file connection.

Core Deprecated
az spring-cloud connection update storage-queue

Update a spring-cloud to storage-queue connection.

Core Deprecated
az spring-cloud connection update storage-table

Update a spring-cloud to storage-table connection.

Core Deprecated
az spring-cloud connection update webpubsub

Update a spring-cloud to webpubsub connection.

Core Deprecated
az spring-cloud connection validate

Validate a spring-cloud connection.

Core Deprecated
az spring-cloud connection wait

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

Core Deprecated
az spring-cloud create

Create an Azure Spring Cloud.

Extension Deprecated
az spring-cloud delete

Delete an Azure Spring Cloud.

Extension Deprecated
az spring-cloud gateway

(Enterprise Tier Only) Commands to manage gateway in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud gateway clear

Clear all settings of gateway.

Extension Preview and Deprecated
az spring-cloud gateway custom-domain

Commands to manage custom domains for gateway.

Extension Preview and Deprecated
az spring-cloud gateway custom-domain bind

Bind a custom domain with the gateway.

Extension Preview and Deprecated
az spring-cloud gateway custom-domain list

List all custom domains of the gateway.

Extension Preview and Deprecated
az spring-cloud gateway custom-domain show

Show details of a custom domain.

Extension Preview and Deprecated
az spring-cloud gateway custom-domain unbind

Unbind a custom-domain of the gateway.

Extension Preview and Deprecated
az spring-cloud gateway custom-domain update

Update a custom domain of the gateway.

Extension Preview and Deprecated
az spring-cloud gateway route-config

Commands to manage gateway route configs in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud gateway route-config create

Create a gateway route config with routing rules of Json array format.

Extension Preview and Deprecated
az spring-cloud gateway route-config list

List all existing gateway route configs.

Extension Preview and Deprecated
az spring-cloud gateway route-config remove

Delete an existing gateway route config.

Extension Preview and Deprecated
az spring-cloud gateway route-config show

Get an existing gateway route config.

Extension Preview and Deprecated
az spring-cloud gateway route-config update

Update an existing gateway route config with routing rules of Json array format.

Extension Preview and Deprecated
az spring-cloud gateway show

Show the settings, provisioning status and runtime status of gateway.

Extension Preview and Deprecated
az spring-cloud gateway update

Update an existing gateway properties.

Extension Preview and Deprecated
az spring-cloud list

List all Azure Spring Cloud in the given resource group, otherwise list the subscription's.

Extension Deprecated
az spring-cloud service-registry

(Enterprise Tier Only) Commands to manage Service Registry in Azure Spring Cloud.

Extension Preview and Deprecated
az spring-cloud service-registry bind

Bind an app to Service Registry.

Extension Preview and Deprecated
az spring-cloud service-registry show

Show the provisioning status and runtime status of Service Registry.

Extension Preview and Deprecated
az spring-cloud service-registry unbind

Unbind an app from Service Registry.

Extension Preview and Deprecated
az spring-cloud show

Show the details for an Azure Spring Cloud.

Extension Deprecated
az spring-cloud start

Start an Azure Spring Cloud.

Extension Deprecated
az spring-cloud stop

Stop an Azure Spring Cloud.

Extension Deprecated
az spring-cloud storage

Commands to manage Storages in Azure Spring Cloud.

Extension Deprecated
az spring-cloud storage add

Create a new storage in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud storage list

List all existing storages in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud storage list-persistent-storage

List all the persistent storages related to an existing storage in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud storage remove

Remove an existing storage in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud storage show

Get an existing storage in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud storage update

Update an existing storage in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud test-endpoint

Commands to manage test endpoint in Azure Spring Cloud.

Extension Deprecated
az spring-cloud test-endpoint disable

Disable test endpoint of the Azure Spring Cloud.

Extension Deprecated
az spring-cloud test-endpoint enable

Enable test endpoint of the Azure Spring Cloud.

Extension Deprecated
az spring-cloud test-endpoint list

List test endpoint keys of the Azure Spring Cloud.

Extension Deprecated
az spring-cloud test-endpoint renew-key

Regenerate a test-endpoint key for the Azure Spring Cloud.

Extension Deprecated
az spring-cloud update

Update an Azure Spring Cloud.

Extension Deprecated

az spring-cloud create

Deprecated

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

Create an Azure Spring Cloud.

az spring-cloud create --name
                       --resource-group
                       [--ap-instance]
                       [--app-insights]
                       [--app-insights-key]
                       [--app-network-resource-group]
                       [--app-subnet]
                       [--build-pool-size {S1, S2, S3, S4, S5}]
                       [--disable-app-insights {false, true}]
                       [--enable-acs]
                       [--enable-api-portal]
                       [--enable-gateway]
                       [--enable-java-agent {false, true}]
                       [--enable-service-registry]
                       [--gateway-instance-count]
                       [--location]
                       [--no-wait]
                       [--reserved-cidr-range]
                       [--sampling-rate]
                       [--service-runtime-network-resource-group]
                       [--service-runtime-subnet]
                       [--sku {Basic, Enterprise, Standard}]
                       [--tags]
                       [--vnet]
                       [--zone-redundant {false, true}]

Examples

Create a new Azure Spring Cloud in westus.

az spring-cloud create -n MyService -g MyResourceGroup -l westus

Create a new Azure Spring Cloud in westus with an existing Application Insights by using the Connection string (recommended) or Instrumentation key.

az spring-cloud create -n MyService -g MyResourceGroup -l westus --app-insights-key "MyConnectionString"

Create a new Azure Spring Cloud in westus with an existing Application Insights.

az spring-cloud create -n MyService -g MyResourceGroup -l westus --app-insights appInsightsName

Create a new Azure Spring Cloud in westus with an existing Application Insights and specify the sampling rate.

az spring-cloud create -n MyService -g MyResourceGroup -l westus --app-insights appInsightsName --sampling-rate 10

Create a new Azure Spring Cloud with Application Insights disabled.

az spring-cloud create -n MyService -g MyResourceGroup --disable-app-insights

Create a new Azure Spring Cloud with VNet-injected via giving VNet name in current resource group

az spring-cloud create -n MyService -g MyResourceGroup --vnet MyVNet --app-subnet MyAppSubnet --service-runtime-subnet MyServiceRuntimeSubnet

Create a new Azure Spring Cloud with VNet-injected via giving subnets resource ID

az spring-cloud create -n MyService -g MyResourceGroup --app-subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyVnetRg/providers/Microsoft.Network/VirtualNetworks/test-vnet/subnets/app --service-runtime-subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyVnetRg/providers/Microsoft.Network/VirtualNetworks/test-vnet/subnets/svc --reserved-cidr-range 10.0.0.0/16,10.1.0.0/16,10.2.0.1/16

Create a Azure Spring Cloud Enterprise instance if the Azure Subscription never hosts Azure Spring Cloud Enterprise instance

az provider register -n Microsoft.SaaS
az term accept --publisher vmware-inc --product azure-spring-cloud-vmware-tanzu-2 --plan tanzu-asc-ent-mtr
az spring-cloud create -n MyService -g MyResourceGroup --sku Enterprise

Create a Azure Spring Cloud Enterprise instance with Tanzu components enabled.

az spring-cloud create -n MyService -g MyResourceGroup --sku Enterprise --enable-application-configuration-service --enable-service-registry --enable-gateway --enable-api-portal

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--ap-instance --api-portal-instance-count
Preview

(Enterprise Tier Only) Number of API portal instances.

--app-insights

Name of the existing Application Insights in the same Resource Group. Or Resource ID of the existing Application Insights in a different Resource Group.

--app-insights-key

Connection string (recommended) or Instrumentation key of the existing Application Insights.

--app-network-resource-group --app-nrg

The resource group where all network resources for apps will be created in.

--app-subnet

The name or ID of an existing subnet in "vnet" into which to deploy the Spring Cloud app. Required when deploying into a Virtual Network. Smaller subnet sizes are supported, please refer: https://aka.ms/azure-spring-cloud-smaller-subnet-vnet-docs.

--build-pool-size
Preview

(Enterprise Tier Only) Size of build agent pool. See aka.ms/azure-spring-cloud-build-service-docs for size info.

Accepted values: S1, S2, S3, S4, S5
--disable-app-insights

Disable Application Insights, if not disabled and no existing Application Insights specified with --app-insights-key or --app-insights, will create a new Application Insights instance in the same resource group.

Accepted values: false, true
--enable-acs --enable-application-configuration-service
Preview

(Enterprise Tier Only) Enable Application Configuration Service.

Default value: False
--enable-api-portal
Preview

(Enterprise Tier Only) Enable API portal.

Default value: False
--enable-gateway
Preview

(Enterprise Tier Only) Enable Spring Cloud Gateway.

Default value: False
--enable-java-agent
Deprecated

Option '--enable-java-agent' has been deprecated and will be removed in a future release.

Java in process agent is now GA-ed and used by default when Application Insights enabled. This parameter is no longer needed and will be removed in future release.

Accepted values: false, true
--enable-service-registry --enable-sr
Preview

(Enterprise Tier Only) Enable Service Registry.

Default value: False
--gateway-instance-count
Preview

(Enterprise Tier Only) Number of Spring Cloud Gateway instances.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Default value: False
--reserved-cidr-range

Comma-separated list of IP address ranges in CIDR format. The IP ranges are reserved to host underlying Azure Spring Cloud infrastructure, which should be 3 at least /16 unused IP ranges, must not overlap with any Subnet IP ranges.

--sampling-rate

Sampling Rate of application insights. Minimum is 0, maximum is 100.

--service-runtime-network-resource-group --svc-nrg

The resource group where all network resources for Azure Spring Cloud service runtime will be created in.

--service-runtime-subnet --svc-subnet

The name or ID of an existing subnet in "vnet" into which to deploy the Spring Cloud service runtime. Required when deploying into a Virtual Network.

--sku

Name of SKU. Enterprise is still in Preview.

Accepted values: Basic, Enterprise, Standard
Default value: Standard
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--vnet

The name or ID of an existing Virtual Network into which to deploy the Spring Cloud instance.

--zone-redundant
Preview

Create your Azure Spring Cloud service in an Azure availability zone or not, this could only be supported in several regions at the moment.

Accepted values: false, true
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az spring-cloud delete

Deprecated

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

Delete an Azure Spring Cloud.

az spring-cloud delete --name
                       --resource-group
                       [--no-wait]

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

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

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az spring-cloud list

Deprecated

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

List all Azure Spring Cloud in the given resource group, otherwise list the subscription's.

az spring-cloud list [--resource-group]

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az spring-cloud show

Deprecated

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

Show the details for an Azure Spring Cloud.

az spring-cloud show --name
                     --resource-group

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az spring-cloud start

Deprecated

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

Start an Azure Spring Cloud.

az spring-cloud start --name
                      --resource-group
                      [--no-wait]

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

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

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az spring-cloud stop

Deprecated

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

Stop an Azure Spring Cloud.

az spring-cloud stop --name
                     --resource-group
                     [--no-wait]

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

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

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az spring-cloud update

Deprecated

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

Update an Azure Spring Cloud.

az spring-cloud update --name
                       --resource-group
                       [--app-insights]
                       [--app-insights-key]
                       [--build-pool-size {S1, S2, S3, S4, S5}]
                       [--disable-app-insights {false, true}]
                       [--no-wait]
                       [--sku {Basic, Enterprise, Standard}]
                       [--tags]

Examples

Update pricing tier.

az spring-cloud update -n MyService --sku Standard -g MyResourceGroup

Update the tags of the existing Azure Spring Cloud.

az spring-cloud update -n MyService -g MyResourceGroup --tags key1=value1 key2=value2

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--app-insights
Deprecated

Argument 'az spring-cloud update --app-insights' has been deprecated and will be removed in a future release. Use 'az spring-cloud app-insights update --app-insights' instead.

Name of the existing Application Insights in the same Resource Group. Or Resource ID of the existing Application Insights in a different Resource Group.

--app-insights-key
Deprecated

Argument 'az spring-cloud update --app-insights-key' has been deprecated and will be removed in a future release. Use 'az spring-cloud app-insights update --app-insights-key' instead.

Connection string (recommended) or Instrumentation key of the existing Application Insights.

--build-pool-size
Preview

(Enterprise Tier Only) Size of build agent pool. See aka.ms/azure-spring-cloud-build-service-docs for size info.

Accepted values: S1, S2, S3, S4, S5
--disable-app-insights
Deprecated

Argument 'az spring-cloud update --disable-app-insights' has been deprecated and will be removed in a future release. Use 'az spring-cloud app-insights update --disable' instead.

Disable Application Insights, if not disabled and no existing Application Insights specified with --app-insights-key or --app-insights, will create a new Application Insights instance in the same resource group.

Accepted values: false, true
--no-wait

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

Default value: False
--sku

Name of SKU. Enterprise is still in Preview.

Accepted values: Basic, Enterprise, Standard
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.