Share via


az spring

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.

This command group has been deprecated and will be removed in Mar 2028.

Commands to manage Azure Spring Apps.

Commands

Name Description Type Status
az spring api-portal

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

Extension Deprecated
az spring api-portal clear

Clear all settings of API portal.

Extension Deprecated
az spring api-portal create

Create API portal.

Extension Deprecated
az spring api-portal custom-___domain

Commands to manage custom domains for API portal.

Extension Deprecated
az spring api-portal custom-___domain bind

Bind a custom ___domain with the API portal.

Extension Deprecated
az spring api-portal custom-___domain list

List all custom domains of the API portal.

Extension Deprecated
az spring api-portal custom-___domain show

Show details of a custom ___domain.

Extension Deprecated
az spring api-portal custom-___domain unbind

Unbind a custom-___domain of the API portal.

Extension Deprecated
az spring api-portal custom-___domain update

Update a custom ___domain of the API portal.

Extension Deprecated
az spring api-portal delete

Delete API portal.

Extension Deprecated
az spring api-portal show

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

Extension Deprecated
az spring api-portal update

Update an existing API portal properties.

Extension Deprecated
az spring apm

(Enterprise Tier Only) Commands to manage APMs in Azure Spring Apps.

Extension Deprecated
az spring apm create

(Enterprise Tier Only) Create an APM.

Extension Deprecated
az spring apm delete

(Enterprise Tier Only) Delete an APM.

Extension Deprecated
az spring apm disable-globally

(Enterprise Tier Only) Disable an APM globally.

Extension Deprecated
az spring apm enable-globally

(Enterprise Tier Only) Enable an APM globally.

Extension Deprecated
az spring apm list

(Enterprise Tier Only) List all the APMs in the Azure Spring Apps. The secrets will be omitted.

Extension Deprecated
az spring apm list-enabled-globally

(Enterprise Tier Only) List all the APMs enabled globally in the Azure Spring Apps.

Extension Deprecated
az spring apm list-support-types

(Enterprise Tier Only) List all the supported APM types in the Azure Spring Apps.

Extension Deprecated
az spring apm show

(Enterprise Tier Only) Show an APM. The secrets will be masked.

Extension Deprecated
az spring apm update

(Enterprise Tier Only) Update an APM.

Extension Deprecated
az spring app

Commands to manage apps in Azure Spring Apps.

Extension Deprecated
az spring app-insights

Commands to management Application Insights in Azure Spring Apps.

Extension Deprecated
az spring app-insights show

Show Application Insights settings.

Extension Deprecated
az spring app-insights update

Update Application Insights settings.

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

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

Extension Deprecated
az spring app append-persistent-storage

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

Extension Deprecated
az spring app connect

Connect to the interactive shell of an app instance for troubleshooting'.

Extension Deprecated
az spring app create

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

Extension Deprecated
az spring app custom-___domain

Commands to manage custom domains.

Extension Deprecated
az spring app custom-___domain bind

Bind a custom ___domain with the app.

Extension Deprecated
az spring app custom-___domain list

List all custom domains of the app.

Extension Deprecated
az spring app custom-___domain show

Show details of a custom ___domain.

Extension Deprecated
az spring app custom-___domain unbind

Unbind a custom-___domain of the app.

Extension Deprecated
az spring app custom-___domain update

Update a custom ___domain of the app.

Extension Deprecated
az spring app delete

Delete an app in the Azure Spring Apps.

Extension Deprecated
az spring app deploy

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

Extension Deprecated
az spring app deployment

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

Extension Deprecated
az spring app deployment create

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

Extension Deprecated
az spring app deployment delete

Delete a deployment of the app.

Extension Deprecated
az spring app deployment generate-heap-dump

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

Extension Deprecated
az spring app deployment generate-thread-dump

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

Extension Deprecated
az spring app deployment list

List all deployments in an app.

Extension Deprecated
az spring app deployment show

Show details of a deployment.

Extension Deprecated
az spring app deployment start-jfr

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

Extension Deprecated
az spring app disable-remote-debugging

Disable remote debugging for a deployment.

Extension Deprecated
az spring app enable-remote-debugging

Enable remote debugging for a deployment.

Extension Deprecated
az spring app get-remote-debugging-config

Get the remote debugging configuration of a deployment.

Extension Deprecated
az spring app identity

Manage an app's managed identities.

Extension Deprecated
az spring app identity assign

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

Extension Deprecated
az spring app identity force-set

Force set managed identities on an app.

Extension Deprecated
az spring app identity remove

Remove managed identity from an app.

Extension Deprecated
az spring app identity show

Display app's managed identity info.

Extension Deprecated
az spring app list

List all apps in the Azure Spring Apps.

Extension Deprecated
az spring app logs

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

Extension Deprecated
az spring app restart

Restart instances of the app, default to production deployment.

Extension Deprecated
az spring app scale

Manually scale an app or its deployments.

Extension Deprecated
az spring app set-deployment

Set production deployment of an app.

Extension Deprecated
az spring app show

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

Extension Deprecated
az spring 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 app start

Start instances of the app, default to production deployment.

Extension Deprecated
az spring app stop

Stop instances of the app, default to production deployment.

Extension Deprecated
az spring app unset-deployment

Unset production deployment of an app.

Extension Deprecated
az spring app update

Update configurations of an app.

Extension Deprecated
az spring application-accelerator

(Enterprise Tier Only) Commands to manage Application Accelerator in Azure Spring Apps.

Extension Deprecated
az spring application-accelerator create

(Enterprise Tier Only) Create Application Accelerator in Azure Spring Apps instance.

Extension Deprecated
az spring application-accelerator customized-accelerator

(Enterprise Tier Only) Commands to manage customized accelerator in Azure Spring Apps.

Extension Deprecated
az spring application-accelerator customized-accelerator create

(Enterprise Tier Only) Create a customized accelerator.

Extension Deprecated
az spring application-accelerator customized-accelerator delete

(Enterprise Tier Only) Delete a customized accelerator.

Extension Deprecated
az spring application-accelerator customized-accelerator list

(Enterprise Tier Only) List all existing customized accelerators.

Extension Deprecated
az spring application-accelerator customized-accelerator show

(Enterprise Tier Only) Show the settings, provisioning status and runtime status of customized accelerator.

Extension Deprecated
az spring application-accelerator customized-accelerator sync-cert

(Enterprise Tier Only) Sync certificate of a customized accelerator.

Extension Deprecated
az spring application-accelerator customized-accelerator update

(Enterprise Tier Only) Update a customized accelerator.

Extension Deprecated
az spring application-accelerator delete

(Enterprise Tier Only) Delete Application Accelerator from Azure Spring Apps instance.

Extension Deprecated
az spring application-accelerator predefined-accelerator

(Enterprise Tier Only) Commands to manage predefined accelerator in Azure Spring Apps.

Extension Deprecated
az spring application-accelerator predefined-accelerator disable

(Enterprise Tier Only) Disable a predefined accelerator.

Extension Deprecated
az spring application-accelerator predefined-accelerator enable

(Enterprise Tier Only) Enable a predefined accelerator.

Extension Deprecated
az spring application-accelerator predefined-accelerator list

(Enterprise Tier Only) List all existing predefined accelerators.

Extension Deprecated
az spring application-accelerator predefined-accelerator show

(Enterprise Tier Only) Show the settings, provisioning status and runtime status of predefined accelerator.

Extension Deprecated
az spring application-accelerator show

(Enterprise Tier Only) Show the settings, provisioning status and runtime status of Application Accelerator.

Extension Deprecated
az spring application-configuration-service

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

Extension Deprecated
az spring application-configuration-service bind

Bind an app to Application Configuration Service.

Extension Deprecated
az spring application-configuration-service clear

Reset all Application Configuration Service settings.

Extension Deprecated
az spring application-configuration-service config

Commands to manage the configurations pulled by Application Configuration Service from upstream Git repositories.

Extension Deprecated
az spring application-configuration-service config show

Command to show the configurations pulled by Application Configuration Service from upstream Git repositories.

Extension Deprecated
az spring application-configuration-service create

Create Application Configuration Service.

Extension Deprecated
az spring application-configuration-service delete

Delete Application Configuration Service.

Extension Deprecated
az spring application-configuration-service git

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

Extension Deprecated
az spring application-configuration-service git repo

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

Extension Deprecated
az spring application-configuration-service git repo add

Add a Git property to the Application Configuration Service settings.

Extension Deprecated
az spring application-configuration-service git repo list

List all Git settings of Application Configuration Service.

Extension Deprecated
az spring application-configuration-service git repo remove

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

Extension Deprecated
az spring application-configuration-service git repo update

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

Extension Deprecated
az spring application-configuration-service show

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

Extension Deprecated
az spring application-configuration-service unbind

Unbind an app from Application Configuration Service.

Extension Deprecated
az spring application-configuration-service update

Update Application Configuration Service.

Extension Deprecated
az spring application-live-view

(Enterprise Tier Only) Commands to manage Application Live View in Azure Spring Apps. Application Live View presents application instance metrics, and makes it easy for developers to monitor application runtimes.

Extension Deprecated
az spring application-live-view create

Create Application Live View.

Extension Deprecated
az spring application-live-view delete

Delete Application Live View.

Extension Deprecated
az spring application-live-view show

Show the provisioning state, running status and settings of Application Live View.

Extension Deprecated
az spring build-service

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

Extension Deprecated
az spring build-service build

(Enterprise Tier Only) Commands to manage Build Resource.

Extension Deprecated
az spring build-service build create

Create a build.

Extension Deprecated
az spring build-service build delete

Delete a build.

Extension Deprecated
az spring build-service build list

List builds.

Extension Deprecated
az spring build-service build result

(Enterprise Tier Only) Commands to view Build Result Resource.

Extension Deprecated
az spring build-service build result list

List build results.

Extension Deprecated
az spring build-service build result show

Show a build result.

Extension Deprecated
az spring build-service build show

Show a build.

Extension Deprecated
az spring build-service build update

Update a build.

Extension Deprecated
az spring build-service builder

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

Extension Deprecated
az spring build-service builder buildpack-binding

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

Extension Deprecated
az spring build-service builder buildpack-binding create

(Enterprise Tier Only) Create a buildpack binding.

Extension Deprecated
az spring build-service builder buildpack-binding delete

(Enterprise Tier Only) Delete a buildpack binding.

Extension Deprecated
az spring build-service builder buildpack-binding list

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

Extension Deprecated
az spring build-service builder buildpack-binding set

(Enterprise Tier Only) Set a buildpack binding.

Extension Deprecated
az spring build-service builder buildpack-binding show

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

Extension Deprecated
az spring build-service builder create

Create a builder.

Extension Deprecated
az spring build-service builder delete

Delete a builder.

Extension Deprecated
az spring build-service builder show

Show a builder.

Extension Deprecated
az spring build-service builder show-deployments

Show deployments.

Extension Deprecated
az spring build-service builder update

Update a builder.

Extension Deprecated
az spring build-service show

Show the build service.

Extension Deprecated
az spring build-service update

Update the build service.

Extension Deprecated
az spring certificate

Commands to manage certificates.

Extension Deprecated
az spring certificate add

Add a certificate in Azure Spring Apps.

Extension Deprecated
az spring certificate list

List all certificates in Azure Spring Apps.

Extension Deprecated
az spring certificate list-reference-app

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

Extension Deprecated
az spring certificate remove

Remove a certificate in Azure Spring Apps.

Extension Deprecated
az spring certificate show

Show a certificate in Azure Spring Apps.

Extension Deprecated
az spring certificate update

Update a certificate in Azure Spring Apps.

Extension Deprecated
az spring component

(Enterprise Tier Only) Commands to handle managed components.

Extension Deprecated
az spring component instance

(Enterprise Tier Only) Commands to handle instances of a managed component.

Extension Deprecated
az spring component instance list

(Enterprise Tier Only) List all available instances of a specific managed component in an Azure Spring Apps instance.

Extension Deprecated
az spring component list

(Enterprise Tier Only) List managed components.

Extension Deprecated
az spring component logs

(Enterprise Tier Only) Show logs for managed components. Logs will be streamed when setting '-f/--follow'. For now, only supports subcomponents of (a) Application Configuration Service (b) Spring Cloud Gateway (c) Spring Cloud Config Server.

Extension Deprecated
az spring config-server

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

Extension Deprecated
az spring config-server bind

(Enterprise Tier Only) Bind an app to Config Server.

Extension Deprecated
az spring config-server clear

Erase all settings in Config Server.

Extension Deprecated
az spring config-server create

(Enterprise Tier Only) Create Config Server.

Extension Deprecated
az spring config-server delete

(Enterprise Tier Only) Delete Config Server.

Extension Deprecated
az spring config-server disable

(Standard consumption Tier Only) Disable Config Server.

Extension Deprecated
az spring config-server enable

(Standard consumption Tier Only) Enable Config Server.

Extension Deprecated
az spring config-server git

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

Extension Deprecated
az spring config-server git repo

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

Extension Deprecated
az spring config-server git repo add

Add a new repository of git property of Config Server.

Extension Deprecated
az spring config-server git repo list

List all repositories of git property of Config Server.

Extension Deprecated
az spring config-server git repo remove

Remove an existing repository of git property of Config Server.

Extension Deprecated
az spring 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 config-server git set

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

Extension Deprecated
az spring config-server set

Set Config Server from a yaml file.

Extension Deprecated
az spring config-server show

Show Config Server.

Extension Deprecated
az spring config-server unbind

(Enterprise Tier Only) Unbind an app from Config Server.

Extension Deprecated
az spring connection

Commands to manage spring app connections.

Core Deprecated
az spring connection create

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

Core Deprecated
az spring connection create app-insights

Create a spring app connection to app-insights.

Core Deprecated
az spring connection create appconfig

Create a spring app connection to appconfig.

Core Deprecated
az spring connection create cognitiveservices

Create a spring app connection to cognitiveservices.

Core Deprecated
az spring connection create confluent-cloud

Create a spring app connection to confluent-cloud.

Core Deprecated
az spring connection create cosmos-cassandra

Create a spring app connection to cosmos-cassandra.

Core Deprecated
az spring connection create cosmos-gremlin

Create a spring app connection to cosmos-gremlin.

Core Deprecated
az spring connection create cosmos-mongo

Create a spring app connection to cosmos-mongo.

Core Deprecated
az spring connection create cosmos-sql

Create a spring app connection to cosmos-sql.

Core Deprecated
az spring connection create cosmos-table

Create a spring app connection to cosmos-table.

Core Deprecated
az spring connection create eventhub

Create a spring app connection to eventhub.

Core Deprecated
az spring connection create fabric-sql

Create a spring app connection to fabric-sql.

Core Deprecated
az spring connection create keyvault

Create a spring app connection to keyvault.

Core Deprecated
az spring connection create mongodb-atlas

Create a spring app connection to mongodb-atlas.

Core Deprecated
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 Deprecated
az spring connection create neon-postgres

Create a spring app connection to neon-postgres.

Core Deprecated
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 Deprecated
az spring connection create redis

Create a spring app connection to redis.

Core Deprecated
az spring connection create redis-enterprise

Create a spring app connection to redis-enterprise.

Core Deprecated
az spring connection create servicebus

Create a spring app connection to servicebus.

Core Deprecated
az spring connection create signalr

Create a spring app connection to signalr.

Core Deprecated
az spring connection create sql

Create a spring app connection to sql.

Core Deprecated
az spring connection create storage-blob

Create a spring app connection to storage-blob.

Core Deprecated
az spring connection create storage-file

Create a spring app connection to storage-file.

Core Deprecated
az spring connection create storage-queue

Create a spring app connection to storage-queue.

Core Deprecated
az spring connection create storage-table

Create a spring app connection to storage-table.

Core Deprecated
az spring connection create webpubsub

Create a spring app connection to webpubsub.

Core Deprecated
az spring connection delete

Delete a spring app connection.

Core Deprecated
az spring connection list

List connections of a spring app.

Core Deprecated
az spring connection list-configuration

List source configurations of a spring app connection.

Core Deprecated
az spring connection list-support-types

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

Core Deprecated
az spring connection show

Get the details of a spring app connection.

Core Deprecated
az spring connection update

Update a spring app connection.

Core Deprecated
az spring connection update app-insights

Update a spring app to app-insights connection.

Core Deprecated
az spring connection update appconfig

Update a spring app to appconfig connection.

Core Deprecated
az spring connection update cognitiveservices

Update a spring app to cognitiveservices connection.

Core Deprecated
az spring connection update confluent-cloud

Update a spring app to confluent-cloud connection.

Core Deprecated
az spring connection update cosmos-cassandra

Update a spring app to cosmos-cassandra connection.

Core Deprecated
az spring connection update cosmos-gremlin

Update a spring app to cosmos-gremlin connection.

Core Deprecated
az spring connection update cosmos-mongo

Update a spring app to cosmos-mongo connection.

Core Deprecated
az spring connection update cosmos-sql

Update a spring app to cosmos-sql connection.

Core Deprecated
az spring connection update cosmos-table

Update a spring app to cosmos-table connection.

Core Deprecated
az spring connection update eventhub

Update a spring app to eventhub connection.

Core Deprecated
az spring connection update fabric-sql

Update a spring app to fabric-sql connection.

Core Deprecated
az spring connection update keyvault

Update a spring app to keyvault connection.

Core Deprecated
az spring connection update mongodb-atlas

Update a spring app to mongodb-atlas connection.

Core Deprecated
az spring connection update mysql

Update a spring app to mysql connection.

Core Deprecated
az spring connection update mysql-flexible

Update a spring app to mysql-flexible connection.

Core Deprecated
az spring connection update neon-postgres

Update a spring app to neon-postgres connection.

Core Deprecated
az spring connection update postgres

Update a spring app to postgres connection.

Core Deprecated
az spring connection update postgres-flexible

Update a spring app to postgres-flexible connection.

Core Deprecated
az spring connection update redis

Update a spring app to redis connection.

Core Deprecated
az spring connection update redis-enterprise

Update a spring app to redis-enterprise connection.

Core Deprecated
az spring connection update servicebus

Update a spring app to servicebus connection.

Core Deprecated
az spring connection update signalr

Update a spring app to signalr connection.

Core Deprecated
az spring connection update sql

Update a spring app to sql connection.

Core Deprecated
az spring connection update storage-blob

Update a spring app to storage-blob connection.

Core Deprecated
az spring connection update storage-file

Update a spring app to storage-file connection.

Core Deprecated
az spring connection update storage-queue

Update a spring app to storage-queue connection.

Core Deprecated
az spring connection update storage-table

Update a spring app to storage-table connection.

Core Deprecated
az spring connection update webpubsub

Update a spring app to webpubsub connection.

Core Deprecated
az spring connection validate

Validate a spring app connection.

Core Deprecated
az spring connection wait

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

Core Deprecated
az spring container-registry

(Enterprise Tier Only) Commands to manage Container Registry Resource.

Extension Deprecated
az spring container-registry create

Create a container registry.

Extension Deprecated
az spring container-registry delete

Delete a container registry.

Extension Deprecated
az spring container-registry list

List all container registries.

Extension Deprecated
az spring container-registry show

Show a container registry.

Extension Deprecated
az spring container-registry update

Update a container registry.

Extension Deprecated
az spring create

Create an Azure Spring Apps instance.

Extension Deprecated
az spring delete

Delete an Azure Spring Apps.

Extension Deprecated
az spring dev-tool

(Enterprise Tier Only) Commands to manage Dev Tools in Azure Spring Apps. The Dev Tools Portal is an underlying application that hosts the developer tools.

Extension Deprecated
az spring dev-tool create

Create Dev Tool Portal.

Extension Deprecated
az spring dev-tool delete

Delete Dev Tool Portal.

Extension Deprecated
az spring dev-tool show

Show the provisioning state, running status and settings of Dev Tool Portal.

Extension Deprecated
az spring dev-tool update

Update Dev Tool Portal.

Extension Deprecated
az spring eureka-server

(Support Standard consumption Tier) Commands to manage Eureka Server in Azure Spring Apps.

Extension Deprecated
az spring eureka-server disable

(Support Standard consumption Tier) Disable Eureka Server.

Extension Deprecated
az spring eureka-server enable

(Support Standard consumption Tier) Enable Eureka Server.

Extension Deprecated
az spring eureka-server show

(Support Standard consumption Tier) Show Eureka Server.

Extension Deprecated
az spring export

Commands to export target Azure resource definitions from Azure Spring Apps.

Extension Deprecated
az spring flush-virtualnetwork-dns-settings

(Standard and Enterprise Tier Only) Flush Virtual network DNS setting for Azure Spring Apps.

Extension Preview and Deprecated
az spring gateway

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

Extension Deprecated
az spring gateway clear

Clear all settings of gateway.

Extension Deprecated
az spring gateway create

Create Spring Cloud Gateway.

Extension Deprecated
az spring gateway custom-___domain

Commands to manage custom domains for gateway.

Extension Deprecated
az spring gateway custom-___domain bind

Bind a custom ___domain with the gateway.

Extension Deprecated
az spring gateway custom-___domain list

List all custom domains of the gateway.

Extension Deprecated
az spring gateway custom-___domain show

Show details of a custom ___domain.

Extension Deprecated
az spring gateway custom-___domain unbind

Unbind a custom-___domain of the gateway.

Extension Deprecated
az spring gateway custom-___domain update

Update a custom ___domain of the gateway.

Extension Deprecated
az spring gateway delete

Delete Spring Cloud Gateway.

Extension Deprecated
az spring gateway restart

Restart Spring Cloud Gateway.

Extension Deprecated
az spring gateway route-config

Commands to manage gateway route configs in Azure Spring Apps.

Extension Deprecated
az spring gateway route-config create

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

Extension Deprecated
az spring gateway route-config list

List all existing gateway route configs.

Extension Deprecated
az spring gateway route-config remove

Delete an existing gateway route config.

Extension Deprecated
az spring gateway route-config show

Get an existing gateway route config.

Extension Deprecated
az spring gateway route-config update

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

Extension Deprecated
az spring gateway show

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

Extension Deprecated
az spring gateway sync-cert

Sync certificate of gateway.

Extension Deprecated
az spring gateway update

Update an existing gateway properties.

Extension Deprecated
az spring job

(Enterprise Tier Only) Commands to manage jobs of Azure Spring Apps service.

Extension Preview and Deprecated
az spring job create

Create a new job in Azure Spring Apps service.

Extension Preview and Deprecated
az spring job delete

Delete a job in the Azure Spring Apps.

Extension Preview and Deprecated
az spring job deploy

Deploy artifact to a job and update related configurations.

Extension Preview and Deprecated
az spring job execution

(Enterprise Tier Only) Commands to manage job executions of Azure Spring Apps service.

Extension Preview and Deprecated
az spring job execution cancel

Cancel a job execution.

Extension Preview and Deprecated
az spring job execution instance

(Enterprise Tier Only) Commands to manage job execution instances of Azure Spring Apps service.

Extension Preview and Deprecated
az spring job execution instance list

List all instances of the job execution.

Extension Preview and Deprecated
az spring job execution list

List all executions of the job.

Extension Preview and Deprecated
az spring job execution show

Show status and results of an execution of the job.

Extension Preview and Deprecated
az spring job list

List all jobs in the Azure Spring Apps.

Extension Preview and Deprecated
az spring job logs

Show logs for job execution instances. Logs will be streamed when setting '-f/--follow'.

Extension Preview and Deprecated
az spring job show

Show the details of a job in the Azure Spring Apps.

Extension Preview and Deprecated
az spring job start

Start an execution of the job.

Extension Preview and Deprecated
az spring job update

Update configurations of a job.

Extension Preview and Deprecated
az spring list

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

Extension Deprecated
az spring list-marketplace-plan

(Enterprise Tier Only) List Marketplace plan to be purchased.

Extension Preview and Deprecated
az spring list-support-server-versions

(Standard and Basic Tier Only) List supported server versions.

Extension Preview and Deprecated
az spring private-dns-zone

Commands to configure constumer private DNS zone with Azure Spring Apps.

Extension Deprecated
az spring private-dns-zone add

Commands to add a constumer private DNS zone with Azure Spring Apps.

Extension Deprecated
az spring private-dns-zone clean

Commands to clean up constumer private DNS zone in Azure Spring Apps.

Extension Deprecated
az spring private-dns-zone update

Commands to update constumer private DNS zone in Azure Spring Apps.

Extension Deprecated
az spring service-registry

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

Extension Deprecated
az spring service-registry bind

Bind an app or a job to Service Registry.

Extension Deprecated
az spring service-registry create

Create Service Registry.

Extension Deprecated
az spring service-registry delete

Delete Service Registry.

Extension Deprecated
az spring service-registry show

Show the provisioning status and runtime status of Service Registry.

Extension Deprecated
az spring service-registry unbind

Unbind an app or a job from Service Registry.

Extension Deprecated
az spring show

Show the details for an Azure Spring Apps.

Extension Deprecated
az spring start

Start an Azure Spring Apps.

Extension Deprecated
az spring stop

Stop an Azure Spring Apps.

Extension Deprecated
az spring storage

Commands to manage Storages in Azure Spring Apps.

Extension Deprecated
az spring storage add

Create a new storage in the Azure Spring Apps.

Extension Deprecated
az spring storage list

List all existing storages in the Azure Spring Apps.

Extension Deprecated
az spring storage list-persistent-storage

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

Extension Deprecated
az spring storage remove

Remove an existing storage in the Azure Spring Apps.

Extension Deprecated
az spring storage show

Get an existing storage in the Azure Spring Apps.

Extension Deprecated
az spring storage update

Update an existing storage in the Azure Spring Apps.

Extension Deprecated
az spring test-endpoint

Commands to manage test endpoint in Azure Spring Apps.

Extension Deprecated
az spring test-endpoint disable

Disable test endpoint of the Azure Spring Apps.

Extension Deprecated
az spring test-endpoint enable

Enable test endpoint of the Azure Spring Apps.

Extension Deprecated
az spring test-endpoint list

List test endpoint keys of the Azure Spring Apps.

Extension Deprecated
az spring test-endpoint renew-key

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

Extension Deprecated
az spring update

Update an Azure Spring Apps.

Extension Deprecated

az spring create

Deprecated

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

Create an Azure Spring Apps instance.

az spring create --name
                 --resource-group
                 [--acs-gen --application-configuration-service-generation {Gen1, Gen2}]
                 [--ap-instance --api-portal-instance-count]
                 [--app-insights]
                 [--app-insights-key]
                 [--app-network-resource-group --app-nrg]
                 [--app-subnet]
                 [--build-pool-size {S1, S2, S3, S4, S5, S6, S7, S8, S9}]
                 [--disable-app-insights {false, true}]
                 [--disable-build-service {false, true}]
                 [--enable-acs --enable-application-configuration-service]
                 [--enable-alv --enable-application-live-view]
                 [--enable-api-portal]
                 [--enable-app-acc --enable-application-accelerator]
                 [--enable-config-server --enable-cs]
                 [--enable-dataplane-public-endpoint --enable-dppa {false, true}]
                 [--enable-gateway]
                 [--enable-private-storage-access --enable-psa {false, true}]
                 [--enable-service-registry --enable-sr]
                 [--gateway-instance-count]
                 [--infra-resource-group]
                 [--ingress-read-timeout]
                 [--___location]
                 [--managed-environment]
                 [--marketplace-plan-id]
                 [--no-wait]
                 [--outbound-type]
                 [--registry-password]
                 [--registry-server]
                 [--registry-username]
                 [--reserved-cidr-range]
                 [--sampling-rate]
                 [--service-runtime-network-resource-group --svc-nrg]
                 [--service-runtime-subnet --svc-subnet]
                 [--sku {Basic, Enterprise, Standard, StandardGen2}]
                 [--tags]
                 [--vnet]
                 [--zone-redundant {false, true}]

Examples

Create a new Azure Spring Apps in westus.

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

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

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

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

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

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

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

Create a new Azure Spring Apps with Application Insights disabled.

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

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

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

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

az spring 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 Apps Enterprise instance if the Azure Subscription never hosts Azure Spring Apps Enterprise instance

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

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

az provider register -n Microsoft.SaaS
az term accept --publisher vmware-inc --product azure-spring-cloud-vmware-tanzu-2 --plan asa-ent-hr-mtr
az spring create -n MyService -g MyResourceGroup --sku Enterprise --enable-application-configuration-service --enable-config-server --enable-service-registry --enable-gateway --enable-api-portal --enable-application-live-view  --enable-application-accelerator

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acs-gen --application-configuration-service-generation

(Enterprise Tier Only) Application Configuration Service Generation to enable.

Property Value
Parameter group: Application Configuration Service Arguments
Accepted values: Gen1, Gen2
--ap-instance --api-portal-instance-count

(Enterprise Tier Only) Number of API portal instances.

Property Value
Parameter group: API portal Arguments
--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.

Property Value
Parameter group: Application Insights Arguments
--app-insights-key

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

Property Value
Parameter group: Application Insights Arguments
--app-network-resource-group --app-nrg

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

Property Value
Parameter group: VNet Injection Arguments
--app-subnet

The name or ID of an existing subnet in "vnet" into which to deploy the Spring Apps 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.

Property Value
Parameter group: VNet Injection Arguments
--build-pool-size

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

Property Value
Parameter group: Build Service Arguments
Accepted values: S1, S2, S3, S4, S5, S6, S7, S8, S9
--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.

Property Value
Parameter group: Application Insights Arguments
Accepted values: false, true
--disable-build-service

(Enterprise Tier Only) Disable build service.

Property Value
Parameter group: Build Service Arguments
Default value: False
Accepted values: false, true
--enable-acs --enable-application-configuration-service

(Enterprise Tier Only) Enable Application Configuration Service.

Property Value
Parameter group: Application Configuration Service Arguments
Default value: False
--enable-alv --enable-application-live-view

(Enterprise Tier Only) Enable Application Live View.

Property Value
Default value: False
--enable-api-portal

(Enterprise Tier Only) Enable API portal.

Property Value
Parameter group: API portal Arguments
Default value: False
--enable-app-acc --enable-application-accelerator

(Enterprise Tier Only) Enable Application Accelerator.

Property Value
Default value: False
--enable-config-server --enable-cs

(Enterprise Tier Only) Enable Config Server.

Property Value
Parameter group: Config Server Arguments
Default value: False
--enable-dataplane-public-endpoint --enable-dppa

If true, assign public endpoint for log streaming, remote debugging, app connect in vnet injection instance which could be accessed out of virtual network.

Property Value
Accepted values: false, true
--enable-gateway

(Enterprise Tier Only) Enable Spring Cloud Gateway.

Property Value
Parameter group: Spring Cloud Gateway Arguments
Default value: False
--enable-private-storage-access --enable-psa
Preview

If true, set private network access to backend storage in vnet injection instance.

Property Value
Parameter group: VNet Injection Arguments
Accepted values: false, true
--enable-service-registry --enable-sr

(Enterprise Tier Only) Enable Service Registry.

Property Value
Default value: False
--gateway-instance-count

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

Property Value
Parameter group: Spring Cloud Gateway Arguments
--infra-resource-group

The name of the resource group that contains the infrastructure resources.

Property Value
Parameter group: StandardGen2 Arguments
--ingress-read-timeout

Ingress read timeout value in seconds. Default 300, Minimum is 1, maximum is 1800.

--___location -l

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

--managed-environment

The resource Id of the Container App Environment that the Spring Apps instance builds on.

Property Value
Parameter group: StandardGen2 Arguments
--marketplace-plan-id
Preview

(Enterprise Tier Only) Specify a different Marketplace plan to purchase with Spring instance. List all plans by running az spring list-marketplace-plan -o table.

--no-wait

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

Property Value
Default value: False
--outbound-type

The outbound type of Azure Spring Apps VNet instance.

Property Value
Parameter group: VNet Injection Arguments
Default value: loadBalancer
--registry-password

(Enterprise Tier Only) The container registry password used in build service.

--registry-server

(Enterprise Tier Only) The container registry server used in build service.

--registry-username

(Enterprise Tier Only) The container registry username used in build service.

--reserved-cidr-range

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

Property Value
Parameter group: VNet Injection Arguments
--sampling-rate

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

Property Value
Parameter group: Application Insights Arguments
--service-runtime-network-resource-group --svc-nrg

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

Property Value
Parameter group: VNet Injection Arguments
--service-runtime-subnet --svc-subnet

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

Property Value
Parameter group: VNet Injection Arguments
--sku

Name of SKU.

Property Value
Default value: Standard
Accepted values: Basic, Enterprise, Standard, StandardGen2
--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 Apps instance.

Property Value
Parameter group: VNet Injection Arguments
--zone-redundant
Preview

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

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

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring delete

Deprecated

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

Delete an Azure Spring Apps.

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

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring export

Deprecated

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

Commands to export target Azure resource definitions from Azure Spring Apps.

az spring export --resource-group
                 --service
                 [--output-folder]
                 [--target {aca, azure-container-apps}]

Examples

Generate corresponding bicep files and README doc to create Azure Container Apps service.

az spring export --target aca --service MyAzureSpringAppsInstance --resource-group MyResourceGroup --output-folder output

Required Parameters

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-folder

The output folder for the generated Bicep files.

--target

The target Azure service to migrate to.

Property Value
Default value: aca
Accepted values: aca, azure-container-apps
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring flush-virtualnetwork-dns-settings

Preview Deprecated

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

(Standard and Enterprise Tier Only) Flush Virtual network DNS setting for Azure Spring Apps.

az spring flush-virtualnetwork-dns-settings --name
                                            --resource-group
                                            [--no-wait]

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring list

Deprecated

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

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

az spring list [--resource-group]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring list-marketplace-plan

Preview Deprecated

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

(Enterprise Tier Only) List Marketplace plan to be purchased.

az spring list-marketplace-plan

Examples

List all plans.

az spring list-marketplace-plan -o table
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring list-support-server-versions

Preview Deprecated

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

(Standard and Basic Tier Only) List supported server versions.

az spring list-support-server-versions --resource-group
                                       --service

Examples

List supported server versions.

az spring list-support-server-versions -o table -s MyService -g MyResourceGroup

Required Parameters

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring show

Deprecated

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

Show the details for an Azure Spring Apps.

az spring show --name
               --resource-group

Required Parameters

--name -n

The name of Azure Spring Apps instance.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring start

Deprecated

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

Start an Azure Spring Apps.

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

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring stop

Deprecated

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

Stop an Azure Spring Apps.

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

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring update

Deprecated

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

Update an Azure Spring Apps.

az spring update --name
                 --resource-group
                 [--build-pool-size {S1, S2, S3, S4, S5, S6, S7, S8, S9}]
                 [--enable-dataplane-public-endpoint --enable-dppa {false, true}]
                 [--enable-planned-maintenance --enable-pm]
                 [--enable-private-storage-access --enable-psa {false, true}]
                 [--ingress-read-timeout]
                 [--no-wait]
                 [--planned-maintenance-day --pm-day {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                 [--planned-maintenance-start-hour --pm-start-hour]
                 [--sku {Basic, Enterprise, Standard, StandardGen2}]
                 [--tags]

Examples

Update pricing tier.

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

Update the tags of the existing Azure Spring Apps.

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

Configure planned maintenance

az spring update -n MyService -g MyResourceGroup --enable-planned-maintenance --planned-maintenance-day Friday --planned-maintenance-start-hour 10

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--build-pool-size

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

Property Value
Accepted values: S1, S2, S3, S4, S5, S6, S7, S8, S9
--enable-dataplane-public-endpoint --enable-dppa

If true, assign public endpoint for log streaming, remote debugging, app connect in vnet injection instance which could be accessed out of virtual network.

Property Value
Accepted values: false, true
--enable-planned-maintenance --enable-pm
Preview

If set, enable planned maintenance for the instance.

Property Value
Parameter group: Planned Maintenance Arguments
Default value: False
--enable-private-storage-access --enable-psa
Preview

If true, set private network access to backend storage in vnet injection instance.

Property Value
Parameter group: VNet Injection Arguments
Accepted values: false, true
--ingress-read-timeout

Ingress read timeout value in seconds. Minimum is 1, maximum is 1800.

--no-wait

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

Property Value
Default value: False
--planned-maintenance-day --pm-day
Preview

Day of the week which planned maintenance will be scheduled on.

Property Value
Parameter group: Planned Maintenance Arguments
Accepted values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday
--planned-maintenance-start-hour --pm-start-hour
Preview

Start time of the planned maintenance window in UTC. Must be between 0 and 23.

Property Value
Parameter group: Planned Maintenance Arguments
--sku

Name of SKU.

Property Value
Accepted values: Basic, Enterprise, Standard, StandardGen2
--tags

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False