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.
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 | GA |
| az spring api-portal clear |
Clear all settings of API portal. |
Extension | GA |
| az spring api-portal create |
Create API portal. |
Extension | GA |
| az spring api-portal custom-domain |
Commands to manage custom domains for API portal. |
Extension | GA |
| az spring api-portal custom-domain bind |
Bind a custom domain with the API portal. |
Extension | GA |
| az spring api-portal custom-domain list |
List all custom domains of the API portal. |
Extension | GA |
| az spring api-portal custom-domain show |
Show details of a custom domain. |
Extension | GA |
| az spring api-portal custom-domain unbind |
Unbind a custom-domain of the API portal. |
Extension | GA |
| az spring api-portal custom-domain update |
Update a custom domain of the API portal. |
Extension | GA |
| az spring api-portal delete |
Delete API portal. |
Extension | GA |
| az spring api-portal show |
Show the settings, provisioning status and runtime status of API portal. |
Extension | GA |
| az spring api-portal update |
Update an existing API portal properties. |
Extension | GA |
| az spring apm |
(Enterprise Tier Only) Commands to manage APMs in Azure Spring Apps. |
Extension | GA |
| az spring apm create |
(Enterprise Tier Only) Create an APM. |
Extension | GA |
| az spring apm delete |
(Enterprise Tier Only) Delete an APM. |
Extension | GA |
| az spring apm disable-globally |
(Enterprise Tier Only) Disable an APM globally. |
Extension | GA |
| az spring apm enable-globally |
(Enterprise Tier Only) Enable an APM globally. |
Extension | GA |
| az spring apm list |
(Enterprise Tier Only) List all the APMs in the Azure Spring Apps. The secrets will be omitted. |
Extension | GA |
| az spring apm list-enabled-globally |
(Enterprise Tier Only) List all the APMs enabled globally in the Azure Spring Apps. |
Extension | GA |
| az spring apm list-support-types |
(Enterprise Tier Only) List all the supported APM types in the Azure Spring Apps. |
Extension | GA |
| az spring apm show |
(Enterprise Tier Only) Show an APM. The secrets will be masked. |
Extension | GA |
| az spring apm update |
(Enterprise Tier Only) Update an APM. |
Extension | GA |
| az spring app |
Commands to manage apps in Azure Spring Apps. |
Extension | GA |
| az spring app-insights |
Commands to management Application Insights in Azure Spring Apps. |
Extension | GA |
| az spring app-insights show |
Show Application Insights settings. |
Extension | GA |
| az spring app-insights update |
Update Application Insights settings. |
Extension | GA |
| az spring app append-loaded-public-certificate |
Append a new loaded public certificate to an app in the Azure Spring Apps. |
Extension | GA |
| az spring app append-persistent-storage |
Append a new persistent storage to an app in the Azure Spring Apps. |
Extension | GA |
| az spring 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 app binding cosmos |
Commands to manage Azure Cosmos DB bindings. |
Extension | Deprecated |
| az spring app binding cosmos add |
Bind an Azure Cosmos DB with the app. |
Extension | Deprecated |
| az spring app binding cosmos update |
Update an Azure Cosmos DB service binding of the app. |
Extension | Deprecated |
| az spring app binding list |
List all service bindings in an app. |
Extension | Deprecated |
| az spring app binding mysql |
Commands to manage Azure Database for MySQL bindings. |
Extension | Deprecated |
| az spring app binding mysql add |
Bind an Azure Database for MySQL with the app. |
Extension | Deprecated |
| az spring app binding mysql update |
Update an Azure Database for MySQL service binding of the app. |
Extension | Deprecated |
| az spring app binding redis |
Commands to manage Azure Cache for Redis bindings. |
Extension | Deprecated |
| az spring app binding redis add |
Bind an Azure Cache for Redis with the app. |
Extension | Deprecated |
| az spring app binding redis update |
Update an Azure Cache for Redis service binding of the app. |
Extension | Deprecated |
| az spring app binding remove |
Remove a service binding of the app. |
Extension | Deprecated |
| az spring app binding show |
Show the details of a service binding. |
Extension | Deprecated |
| az spring app connect |
Connect to the interactive shell of an app instance for troubleshooting'. |
Extension | GA |
| az spring app create |
Create a new app with a default deployment in the Azure Spring Apps instance. |
Extension | GA |
| az spring app custom-domain |
Commands to manage custom domains. |
Extension | GA |
| az spring app custom-domain bind |
Bind a custom domain with the app. |
Extension | GA |
| az spring app custom-domain list |
List all custom domains of the app. |
Extension | GA |
| az spring app custom-domain show |
Show details of a custom domain. |
Extension | GA |
| az spring app custom-domain unbind |
Unbind a custom-domain of the app. |
Extension | GA |
| az spring app custom-domain update |
Update a custom domain of the app. |
Extension | GA |
| az spring app delete |
Delete an app in the Azure Spring Apps. |
Extension | GA |
| az spring app deploy |
Deploy source code or pre-built binary to an app and update related configurations. |
Extension | GA |
| 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 . |
Extension | GA |
| az spring app deployment create |
Create a staging deployment for the app. To deploy code or update setting to an existing deployment, use |
Extension | GA |
| az spring app deployment delete |
Delete a deployment of the app. |
Extension | GA |
| az spring app deployment generate-heap-dump |
Generate a heap dump of your target app instance to given file path. |
Extension | GA |
| az spring app deployment generate-thread-dump |
Generate a thread dump of your target app instance to given file path. |
Extension | GA |
| az spring app deployment list |
List all deployments in an app. |
Extension | GA |
| az spring app deployment show |
Show details of a deployment. |
Extension | GA |
| az spring app deployment start-jfr |
Start a JFR on your target app instance to given file path. |
Extension | GA |
| az spring app disable-remote-debugging |
Disable remote debugging for a deployment. |
Extension | GA |
| az spring app enable-remote-debugging |
Enable remote debugging for a deployment. |
Extension | GA |
| az spring app get-remote-debugging-config |
Get the remote debugging configuration of a deployment. |
Extension | GA |
| az spring app identity |
Manage an app's managed identities. |
Extension | GA |
| az spring app identity assign |
Enable system-assigned managed identity or assign user-assigned managed identities to an app. |
Extension | GA |
| az spring app identity force-set |
Force set managed identities on an app. |
Extension | GA |
| az spring app identity remove |
Remove managed identity from an app. |
Extension | GA |
| az spring app identity show |
Display app's managed identity info. |
Extension | GA |
| az spring app list |
List all apps in the Azure Spring Apps. |
Extension | GA |
| az spring 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 app log tail |
Show logs of an app instance, logs will be streamed when setting '-f/--follow'. |
Extension | Deprecated |
| az spring app logs |
Show logs of an app instance, logs will be streamed when setting '-f/--follow'. |
Extension | GA |
| az spring app restart |
Restart instances of the app, default to production deployment. |
Extension | GA |
| az spring app scale |
Manually scale an app or its deployments. |
Extension | GA |
| az spring app set-deployment |
Set production deployment of an app. |
Extension | GA |
| az spring app show |
Show the details of an app in the Azure Spring Apps. |
Extension | GA |
| az spring app show-deploy-log |
Show build log of the last deploy, only apply to source code deploy, default to production deployment. |
Extension | GA |
| az spring app start |
Start instances of the app, default to production deployment. |
Extension | GA |
| az spring app stop |
Stop instances of the app, default to production deployment. |
Extension | GA |
| az spring app unset-deployment |
Unset production deployment of an app. |
Extension | GA |
| az spring app update |
Update configurations of an app. |
Extension | GA |
| az spring application-accelerator |
(Enterprise Tier Only) Commands to manage Application Accelerator in Azure Spring Apps. |
Extension | GA |
| az spring application-accelerator create |
(Enterprise Tier Only) Create Application Accelerator in Azure Spring Apps instance. |
Extension | GA |
| az spring application-accelerator customized-accelerator |
(Enterprise Tier Only) Commands to manage customized accelerator in Azure Spring Apps. |
Extension | GA |
| az spring application-accelerator customized-accelerator create |
(Enterprise Tier Only) Create a customized accelerator. |
Extension | GA |
| az spring application-accelerator customized-accelerator delete |
(Enterprise Tier Only) Delete a customized accelerator. |
Extension | GA |
| az spring application-accelerator customized-accelerator list |
(Enterprise Tier Only) List all existing customized accelerators. |
Extension | GA |
| az spring application-accelerator customized-accelerator show |
(Enterprise Tier Only) Show the settings, provisioning status and runtime status of customized accelerator. |
Extension | GA |
| az spring application-accelerator customized-accelerator sync-cert |
(Enterprise Tier Only) Sync certificate of a customized accelerator. |
Extension | GA |
| az spring application-accelerator customized-accelerator update |
(Enterprise Tier Only) Update a customized accelerator. |
Extension | GA |
| az spring application-accelerator delete |
(Enterprise Tier Only) Delete Application Accelerator from Azure Spring Apps instance. |
Extension | GA |
| az spring application-accelerator predefined-accelerator |
(Enterprise Tier Only) Commands to manage predefined accelerator in Azure Spring Apps. |
Extension | GA |
| az spring application-accelerator predefined-accelerator disable |
(Enterprise Tier Only) Disable a predefined accelerator. |
Extension | GA |
| az spring application-accelerator predefined-accelerator enable |
(Enterprise Tier Only) Enable a predefined accelerator. |
Extension | GA |
| az spring application-accelerator predefined-accelerator list |
(Enterprise Tier Only) List all existing predefined accelerators. |
Extension | GA |
| az spring application-accelerator predefined-accelerator show |
(Enterprise Tier Only) Show the settings, provisioning status and runtime status of predefined accelerator. |
Extension | GA |
| az spring application-accelerator show |
(Enterprise Tier Only) Show the settings, provisioning status and runtime status of Application Accelerator. |
Extension | GA |
| az spring application-configuration-service |
(Enterprise Tier Only) Commands to manage Application Configuration Service in Azure Spring Apps. |
Extension | GA |
| az spring application-configuration-service bind |
Bind an app to Application Configuration Service. |
Extension | GA |
| az spring application-configuration-service clear |
Reset all Application Configuration Service settings. |
Extension | GA |
| az spring application-configuration-service config |
Commands to manage the configurations pulled by Application Configuration Service from upstream Git repositories. |
Extension | GA |
| az spring application-configuration-service config show |
Command to show the configurations pulled by Application Configuration Service from upstream Git repositories. |
Extension | GA |
| az spring application-configuration-service create |
Create Application Configuration Service. |
Extension | GA |
| az spring application-configuration-service delete |
Delete Application Configuration Service. |
Extension | GA |
| az spring application-configuration-service git |
Commands to manage Application Configuration Service git property in Azure Spring Apps. |
Extension | GA |
| az spring application-configuration-service git repo |
Commands to manage Application Configuration Service git repository in Azure Spring Apps. |
Extension | GA |
| az spring application-configuration-service git repo add |
Add a Git property to the Application Configuration Service settings. |
Extension | GA |
| az spring application-configuration-service git repo list |
List all Git settings of Application Configuration Service. |
Extension | GA |
| az spring application-configuration-service git repo remove |
Delete an existing Git property from the Application Configuration Service settings. |
Extension | GA |
| az spring application-configuration-service git repo update |
Update an existing Git property in the Application Configuration Service settings. |
Extension | GA |
| az spring application-configuration-service show |
Show the provisioning status, runtime status, and settings of Application Configuration Service. |
Extension | GA |
| az spring application-configuration-service unbind |
Unbind an app from Application Configuration Service. |
Extension | GA |
| az spring application-configuration-service update |
Update Application Configuration Service. |
Extension | GA |
| 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 | GA |
| az spring application-live-view create |
Create Application Live View. |
Extension | GA |
| az spring application-live-view delete |
Delete Application Live View. |
Extension | GA |
| az spring application-live-view show |
Show the provisioning state, running status and settings of Application Live View. |
Extension | GA |
| az spring build-service |
(Enterprise Tier Only) Commands to manage build service in Azure Spring Apps. |
Extension | GA |
| az spring build-service build |
(Enterprise Tier Only) Commands to manage Build Resource. |
Extension | GA |
| az spring build-service build create |
Create a build. |
Extension | GA |
| az spring build-service build delete |
Delete a build. |
Extension | GA |
| az spring build-service build list |
List builds. |
Extension | GA |
| az spring build-service build result |
(Enterprise Tier Only) Commands to view Build Result Resource. |
Extension | GA |
| az spring build-service build result list |
List build results. |
Extension | GA |
| az spring build-service build result show |
Show a build result. |
Extension | GA |
| az spring build-service build show |
Show a build. |
Extension | GA |
| az spring build-service build update |
Update a build. |
Extension | GA |
| az spring build-service builder |
(Enterprise Tier Only) Commands to manage builder of build service. |
Extension | GA |
| az spring build-service builder buildpack-binding |
(Enterprise Tier Only) Commands to manage buildpack-binding of builder. |
Extension | GA |
| az spring build-service builder buildpack-binding create |
(Enterprise Tier Only) Create a buildpack binding. |
Extension | GA |
| az spring build-service builder buildpack-binding delete |
(Enterprise Tier Only) Delete a buildpack binding. |
Extension | GA |
| az spring build-service builder buildpack-binding list |
(Enterprise Tier Only) List all buildpack binding in a builder. The secrets will be masked. |
Extension | GA |
| az spring build-service builder buildpack-binding set |
(Enterprise Tier Only) Set a buildpack binding. |
Extension | GA |
| az spring build-service builder buildpack-binding show |
(Enterprise Tier Only) Show a buildpack binding. The secrets will be masked. |
Extension | GA |
| az spring build-service builder create |
Create a builder. |
Extension | GA |
| az spring build-service builder delete |
Delete a builder. |
Extension | GA |
| az spring build-service builder show |
Show a builder. |
Extension | GA |
| az spring build-service builder show-deployments |
Show deployments. |
Extension | GA |
| az spring build-service builder update |
Update a builder. |
Extension | GA |
| az spring build-service show |
Show the build service. |
Extension | GA |
| az spring build-service update |
Update the build service. |
Extension | GA |
| az spring certificate |
Commands to manage certificates. |
Extension | GA |
| az spring certificate add |
Add a certificate in Azure Spring Apps. |
Extension | GA |
| az spring certificate list |
List all certificates in Azure Spring Apps. |
Extension | GA |
| az spring certificate list-reference-app |
List all the apps reference an existing certificate in the Azure Spring Apps. |
Extension | GA |
| az spring certificate remove |
Remove a certificate in Azure Spring Apps. |
Extension | GA |
| az spring certificate show |
Show a certificate in Azure Spring Apps. |
Extension | GA |
| az spring certificate update |
Update a certificate in Azure Spring Apps. |
Extension | GA |
| az spring component |
(Enterprise Tier Only) Commands to handle managed components. |
Extension | GA |
| az spring component instance |
(Enterprise Tier Only) Commands to handle instances of a managed component. |
Extension | GA |
| az spring component instance list |
(Enterprise Tier Only) List all available instances of a specific managed component in an Azure Spring Apps instance. |
Extension | GA |
| az spring component list |
(Enterprise Tier Only) List managed components. |
Extension | GA |
| 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 | GA |
| az spring config-server |
(Support Standard Tier and Basic Tier) Commands to manage Config Server in Azure Spring Apps. |
Extension | GA |
| az spring config-server bind |
(Enterprise Tier Only) Bind an app to Config Server. |
Extension | GA |
| az spring config-server clear |
Erase all settings in Config Server. |
Extension | GA |
| az spring config-server create |
(Enterprise Tier Only) Create Config Server. |
Extension | GA |
| az spring config-server delete |
(Enterprise Tier Only) Delete Config Server. |
Extension | GA |
| az spring config-server disable |
(Standard consumption Tier Only) Disable Config Server. |
Extension | GA |
| az spring config-server enable |
(Standard consumption Tier Only) Enable Config Server. |
Extension | GA |
| az spring config-server git |
Commands to manage Config Server git property in Azure Spring Apps. |
Extension | GA |
| az spring config-server git repo |
Commands to manage Config Server git repository in Azure Spring Apps. |
Extension | GA |
| az spring config-server git repo add |
Add a new repository of git property of Config Server. |
Extension | GA |
| az spring config-server git repo list |
List all repositories of git property of Config Server. |
Extension | GA |
| az spring config-server git repo remove |
Remove an existing repository of git property of Config Server. |
Extension | GA |
| az spring config-server git repo update |
Override an existing repository of git property of Config Server, will totally override the old one. |
Extension | GA |
| az spring config-server git set |
Set git property of Config Server, will totally override the old one. |
Extension | GA |
| az spring config-server set |
Set Config Server from a yaml file. |
Extension | GA |
| az spring config-server show |
Show Config Server. |
Extension | GA |
| az spring config-server unbind |
(Enterprise Tier Only) Unbind an app from Config Server. |
Extension | GA |
| az spring connection |
Commands to manage spring app connections. |
Core | GA |
| az spring connection create |
Create a connection between a spring app and a target resource. |
Core | GA |
| az spring connection create app-insights |
Create a spring app connection to app-insights. |
Core | GA |
| az spring connection create appconfig |
Create a spring app connection to appconfig. |
Core | GA |
| az spring connection create cognitiveservices |
Create a spring app connection to cognitiveservices. |
Core | GA |
| az spring connection create confluent-cloud |
Create a spring app connection to confluent-cloud. |
Core | GA |
| az spring connection create cosmos-cassandra |
Create a spring app connection to cosmos-cassandra. |
Core | GA |
| az spring connection create cosmos-gremlin |
Create a spring app connection to cosmos-gremlin. |
Core | GA |
| az spring connection create cosmos-mongo |
Create a spring app connection to cosmos-mongo. |
Core | GA |
| az spring connection create cosmos-sql |
Create a spring app connection to cosmos-sql. |
Core | GA |
| az spring connection create cosmos-table |
Create a spring app connection to cosmos-table. |
Core | GA |
| az spring connection create eventhub |
Create a spring app connection to eventhub. |
Core | GA |
| az spring connection create fabric-sql |
Create a spring app connection to fabric-sql. |
Core | GA |
| az spring connection create keyvault |
Create a spring app connection to keyvault. |
Core | GA |
| az spring connection create mysql |
Create a spring app connection to mysql. |
Core | Deprecated |
| az spring connection create mysql-flexible |
Create a spring app connection to mysql-flexible. |
Core | GA |
| az spring connection create postgres |
Create a spring app connection to postgres. |
Core | Deprecated |
| az spring connection create postgres-flexible |
Create a spring app connection to postgres-flexible. |
Core | GA |
| az spring connection create redis |
Create a spring app connection to redis. |
Core | GA |
| az spring connection create redis-enterprise |
Create a spring app connection to redis-enterprise. |
Core | GA |
| az spring connection create servicebus |
Create a spring app connection to servicebus. |
Core | GA |
| az spring connection create signalr |
Create a spring app connection to signalr. |
Core | GA |
| az spring connection create sql |
Create a spring app connection to sql. |
Core | GA |
| az spring connection create storage-blob |
Create a spring app connection to storage-blob. |
Core | GA |
| az spring connection create storage-file |
Create a spring app connection to storage-file. |
Core | GA |
| az spring connection create storage-queue |
Create a spring app connection to storage-queue. |
Core | GA |
| az spring connection create storage-table |
Create a spring app connection to storage-table. |
Core | GA |
| az spring connection create webpubsub |
Create a spring app connection to webpubsub. |
Core | GA |
| az spring connection delete |
Delete a spring app connection. |
Core | GA |
| az spring connection list |
List connections of a spring app. |
Core | GA |
| az spring connection list-configuration |
List source configurations of a spring app connection. |
Core | GA |
| az spring connection list-support-types |
List client types and auth types supported by spring app connections. |
Core | GA |
| az spring connection show |
Get the details of a spring app connection. |
Core | GA |
| az spring connection update |
Update a spring app connection. |
Core | GA |
| az spring connection update app-insights |
Update a spring app to app-insights connection. |
Core | GA |
| az spring connection update appconfig |
Update a spring app to appconfig connection. |
Core | GA |
| az spring connection update cognitiveservices |
Update a spring app to cognitiveservices connection. |
Core | GA |
| az spring connection update confluent-cloud |
Update a spring app to confluent-cloud connection. |
Core | GA |
| az spring connection update cosmos-cassandra |
Update a spring app to cosmos-cassandra connection. |
Core | GA |
| az spring connection update cosmos-gremlin |
Update a spring app to cosmos-gremlin connection. |
Core | GA |
| az spring connection update cosmos-mongo |
Update a spring app to cosmos-mongo connection. |
Core | GA |
| az spring connection update cosmos-sql |
Update a spring app to cosmos-sql connection. |
Core | GA |
| az spring connection update cosmos-table |
Update a spring app to cosmos-table connection. |
Core | GA |
| az spring connection update eventhub |
Update a spring app to eventhub connection. |
Core | GA |
| az spring connection update fabric-sql |
Update a spring app to fabric-sql connection. |
Core | GA |
| az spring connection update keyvault |
Update a spring app to keyvault connection. |
Core | GA |
| az spring connection update mysql |
Update a spring app to mysql connection. |
Core | Deprecated |
| az spring connection update mysql-flexible |
Update a spring app to mysql-flexible connection. |
Core | GA |
| az spring connection update postgres |
Update a spring app to postgres connection. |
Core | Deprecated |
| az spring connection update postgres-flexible |
Update a spring app to postgres-flexible connection. |
Core | GA |
| az spring connection update redis |
Update a spring app to redis connection. |
Core | GA |
| az spring connection update redis-enterprise |
Update a spring app to redis-enterprise connection. |
Core | GA |
| az spring connection update servicebus |
Update a spring app to servicebus connection. |
Core | GA |
| az spring connection update signalr |
Update a spring app to signalr connection. |
Core | GA |
| az spring connection update sql |
Update a spring app to sql connection. |
Core | GA |
| az spring connection update storage-blob |
Update a spring app to storage-blob connection. |
Core | GA |
| az spring connection update storage-file |
Update a spring app to storage-file connection. |
Core | GA |
| az spring connection update storage-queue |
Update a spring app to storage-queue connection. |
Core | GA |
| az spring connection update storage-table |
Update a spring app to storage-table connection. |
Core | GA |
| az spring connection update webpubsub |
Update a spring app to webpubsub connection. |
Core | GA |
| az spring connection validate |
Validate a spring app connection. |
Core | GA |
| az spring connection wait |
Place the CLI in a waiting state until a condition of the connection is met. |
Core | GA |
| az spring container-registry |
(Enterprise Tier Only) Commands to manage Container Registry Resource. |
Extension | GA |
| az spring container-registry create |
Create a container registry. |
Extension | GA |
| az spring container-registry delete |
Delete a container registry. |
Extension | GA |
| az spring container-registry list |
List all container registries. |
Extension | GA |
| az spring container-registry show |
Show a container registry. |
Extension | GA |
| az spring container-registry update |
Update a container registry. |
Extension | GA |
| az spring create |
Create an Azure Spring Apps instance. |
Extension | GA |
| az spring delete |
Delete an Azure Spring Apps. |
Extension | GA |
| 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 | GA |
| az spring dev-tool create |
Create Dev Tool Portal. |
Extension | GA |
| az spring dev-tool delete |
Delete Dev Tool Portal. |
Extension | GA |
| az spring dev-tool show |
Show the provisioning state, running status and settings of Dev Tool Portal. |
Extension | GA |
| az spring dev-tool update |
Update Dev Tool Portal. |
Extension | GA |
| az spring eureka-server |
(Support Standard consumption Tier) Commands to manage Eureka Server in Azure Spring Apps. |
Extension | GA |
| az spring eureka-server disable |
(Support Standard consumption Tier) Disable Eureka Server. |
Extension | GA |
| az spring eureka-server enable |
(Support Standard consumption Tier) Enable Eureka Server. |
Extension | GA |
| az spring eureka-server show |
(Support Standard consumption Tier) Show Eureka Server. |
Extension | GA |
| az spring flush-virtualnetwork-dns-settings |
(Standard and Enterprise Tier Only) Flush Virtual network DNS setting for Azure Spring Apps. |
Extension | Preview |
| az spring gateway |
(Enterprise Tier Only) Commands to manage gateway in Azure Spring Apps. |
Extension | GA |
| az spring gateway clear |
Clear all settings of gateway. |
Extension | GA |
| az spring gateway create |
Create Spring Cloud Gateway. |
Extension | GA |
| az spring gateway custom-domain |
Commands to manage custom domains for gateway. |
Extension | GA |
| az spring gateway custom-domain bind |
Bind a custom domain with the gateway. |
Extension | GA |
| az spring gateway custom-domain list |
List all custom domains of the gateway. |
Extension | GA |
| az spring gateway custom-domain show |
Show details of a custom domain. |
Extension | GA |
| az spring gateway custom-domain unbind |
Unbind a custom-domain of the gateway. |
Extension | GA |
| az spring gateway custom-domain update |
Update a custom domain of the gateway. |
Extension | GA |
| az spring gateway delete |
Delete Spring Cloud Gateway. |
Extension | GA |
| az spring gateway restart |
Restart Spring Cloud Gateway. |
Extension | GA |
| az spring gateway route-config |
Commands to manage gateway route configs in Azure Spring Apps. |
Extension | GA |
| az spring gateway route-config create |
Create a gateway route config with routing rules of Json array format. |
Extension | GA |
| az spring gateway route-config list |
List all existing gateway route configs. |
Extension | GA |
| az spring gateway route-config remove |
Delete an existing gateway route config. |
Extension | GA |
| az spring gateway route-config show |
Get an existing gateway route config. |
Extension | GA |
| az spring gateway route-config update |
Update an existing gateway route config with routing rules of Json array format. |
Extension | GA |
| az spring gateway show |
Show the settings, provisioning status and runtime status of gateway. |
Extension | GA |
| az spring gateway sync-cert |
Sync certificate of gateway. |
Extension | GA |
| az spring gateway update |
Update an existing gateway properties. |
Extension | GA |
| az spring job |
(Enterprise Tier Only) Commands to manage jobs of Azure Spring Apps service. |
Extension | Preview |
| az spring job create |
Create a new job in Azure Spring Apps service. |
Extension | Preview |
| az spring job delete |
Delete a job in the Azure Spring Apps. |
Extension | Preview |
| az spring job deploy |
Deploy artifact to a job and update related configurations. |
Extension | Preview |
| az spring job execution |
(Enterprise Tier Only) Commands to manage job executions of Azure Spring Apps service. |
Extension | Preview |
| az spring job execution cancel |
Cancel a job execution. |
Extension | Preview |
| az spring job execution instance |
(Enterprise Tier Only) Commands to manage job execution instances of Azure Spring Apps service. |
Extension | Preview |
| az spring job execution instance list |
List all instances of the job execution. |
Extension | Preview |
| az spring job execution list |
List all executions of the job. |
Extension | Preview |
| az spring job execution show |
Show status and results of an execution of the job. |
Extension | Preview |
| az spring job list |
List all jobs in the Azure Spring Apps. |
Extension | Preview |
| az spring job logs |
Show logs for job execution instances. Logs will be streamed when setting '-f/--follow'. |
Extension | Preview |
| az spring job show |
Show the details of a job in the Azure Spring Apps. |
Extension | Preview |
| az spring job start |
Start an execution of the job. |
Extension | Preview |
| az spring job update |
Update configurations of a job. |
Extension | Preview |
| az spring list |
List all Azure Spring Apps in the given resource group, otherwise list the subscription's. |
Extension | GA |
| az spring list-marketplace-plan |
(Enterprise Tier Only) List Marketplace plan to be purchased. |
Extension | Preview |
| az spring list-support-server-versions |
(Standard and Basic Tier Only) List supported server versions. |
Extension | Preview |
| az spring private-dns-zone |
Commands to configure constumer private DNS zone with Azure Spring Apps. |
Extension | GA |
| az spring private-dns-zone add |
Commands to add a constumer private DNS zone with Azure Spring Apps. |
Extension | GA |
| az spring private-dns-zone clean |
Commands to clean up constumer private DNS zone in Azure Spring Apps. |
Extension | GA |
| az spring private-dns-zone update |
Commands to update constumer private DNS zone in Azure Spring Apps. |
Extension | GA |
| az spring service-registry |
(Enterprise Tier Only) Commands to manage Service Registry in Azure Spring Apps. |
Extension | GA |
| az spring service-registry bind |
Bind an app or a job to Service Registry. |
Extension | GA |
| az spring service-registry create |
Create Service Registry. |
Extension | GA |
| az spring service-registry delete |
Delete Service Registry. |
Extension | GA |
| az spring service-registry show |
Show the provisioning status and runtime status of Service Registry. |
Extension | GA |
| az spring service-registry unbind |
Unbind an app or a job from Service Registry. |
Extension | GA |
| az spring show |
Show the details for an Azure Spring Apps. |
Extension | GA |
| az spring start |
Start an Azure Spring Apps. |
Extension | GA |
| az spring stop |
Stop an Azure Spring Apps. |
Extension | GA |
| az spring storage |
Commands to manage Storages in Azure Spring Apps. |
Extension | GA |
| az spring storage add |
Create a new storage in the Azure Spring Apps. |
Extension | GA |
| az spring storage list |
List all existing storages in the Azure Spring Apps. |
Extension | GA |
| az spring storage list-persistent-storage |
List all the persistent storages related to an existing storage in the Azure Spring Apps. |
Extension | GA |
| az spring storage remove |
Remove an existing storage in the Azure Spring Apps. |
Extension | GA |
| az spring storage show |
Get an existing storage in the Azure Spring Apps. |
Extension | GA |
| az spring storage update |
Update an existing storage in the Azure Spring Apps. |
Extension | GA |
| az spring test-endpoint |
Commands to manage test endpoint in Azure Spring Apps. |
Extension | GA |
| az spring test-endpoint disable |
Disable test endpoint of the Azure Spring Apps. |
Extension | GA |
| az spring test-endpoint enable |
Enable test endpoint of the Azure Spring Apps. |
Extension | GA |
| az spring test-endpoint list |
List test endpoint keys of the Azure Spring Apps. |
Extension | GA |
| az spring test-endpoint renew-key |
Regenerate a test-endpoint key for the Azure Spring Apps. |
Extension | GA |
| az spring update |
Update an Azure Spring Apps. |
Extension | GA |
az spring create
Create an Azure Spring Apps instance.
az spring create --name
--resource-group
[--acs-gen {Gen1, Gen2}]
[--ap-instance]
[--app-insights]
[--app-insights-key]
[--app-network-resource-group]
[--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-alv]
[--enable-api-portal]
[--enable-app-acc]
[--enable-config-server]
[--enable-dataplane-public-endpoint {false, true}]
[--enable-gateway]
[--enable-java-agent {false, true}]
[--enable-log-stream-public-endpoint {false, true}]
[--enable-private-storage-access {false, true}]
[--enable-service-registry]
[--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]
[--service-runtime-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 westusCreate 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 appInsightsNameCreate 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 10Create a new Azure Spring Apps with Application Insights disabled.
az spring create -n MyService -g MyResourceGroup --disable-app-insightsCreate 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 MyServiceRuntimeSubnetCreate 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/16Create 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 EnterpriseCreate 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-acceleratorRequired Parameters
The name of Azure Spring Apps instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
(Enterprise Tier Only) Application Configuration Service Generation to enable.
(Enterprise Tier Only) Number of API portal instances.
Name of the existing Application Insights in the same Resource Group. Or Resource ID of the existing Application Insights in a different Resource Group.
Connection string (recommended) or Instrumentation key of the existing Application Insights.
The resource group where all network resources for apps will be created in.
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.
(Enterprise Tier Only) Size of build agent pool. See https://aka.ms/azure-spring-cloud-build-service-docs for size info.
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.
(Enterprise Tier Only) Disable build service.
(Enterprise Tier Only) Enable Application Configuration Service.
(Enterprise Tier Only) Enable Application Live View.
(Enterprise Tier Only) Enable API portal.
(Enterprise Tier Only) Enable Application Accelerator.
(Enterprise Tier Only) Enable Config Server.
If true, assign public endpoint for log streaming, remote debugging, app connect in vnet injection instance which could be accessed out of virtual network.
(Enterprise Tier Only) Enable Spring Cloud Gateway.
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.
Option '--enable-log-stream-public-endpoint' has been deprecated and will be removed in a future release. Use '--enable-dataplane-public-endpoint' instead.
If true, assign public endpoint for log streaming in vnet injection instance which could be accessed out of virtual network.
If true, set private network access to backend storage in vnet injection instance.
(Enterprise Tier Only) Enable Service Registry.
(Enterprise Tier Only) Number of Spring Cloud Gateway instances.
The name of the resource group that contains the infrastructure resources.
Ingress read timeout value in seconds. Default 300, Minimum is 1, maximum is 1800.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The resource Id of the Container App Environment that the Spring Apps instance builds on.
(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.
Do not wait for the long-running operation to finish.
The outbound type of Azure Spring Apps VNet instance.
(Enterprise Tier Only) The container registry password used in build service.
(Enterprise Tier Only) The container registry server used in build service.
(Enterprise Tier Only) The container registry username used in build service.
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.
Sampling Rate of application insights. Minimum is 0, maximum is 100.
The resource group where all network resources for Azure Spring Apps service runtime will be created in.
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.
Name of SKU.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The name or ID of an existing Virtual Network into which to deploy the Spring Apps instance.
Create your Azure Spring Apps service in an Azure availability zone or not, this could only be supported in several regions at the moment.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring delete
Delete an Azure Spring Apps.
az spring delete --name
--resource-group
[--no-wait]Required Parameters
The name of Azure Spring Apps instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring flush-virtualnetwork-dns-settings
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
(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
The name of Azure Spring Apps instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring list
List all Azure Spring Apps in the given resource group, otherwise list the subscription's.
az spring list [--resource-group]Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring list-marketplace-plan
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
(Enterprise Tier Only) List Marketplace plan to be purchased.
az spring list-marketplace-planExamples
List all plans.
az spring list-marketplace-plan -o tableGlobal Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring list-support-server-versions
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
(Standard and Basic Tier Only) List supported server versions.
az spring list-support-server-versions --resource-group
--serviceExamples
List supported server versions.
az spring list-support-server-versions -o table -s MyService -g MyResourceGroupRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring show
Show the details for an Azure Spring Apps.
az spring show --name
--resource-groupRequired Parameters
The name of Azure Spring Apps instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring start
Start an Azure Spring Apps.
az spring start --name
--resource-group
[--no-wait]Required Parameters
The name of Azure Spring Apps instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring stop
Stop an Azure Spring Apps.
az spring stop --name
--resource-group
[--no-wait]Required Parameters
The name of Azure Spring Apps instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az spring update
Update an Azure Spring Apps.
az spring update --name
--resource-group
[--app-insights]
[--app-insights-key]
[--build-pool-size {S1, S2, S3, S4, S5, S6, S7, S8, S9}]
[--disable-app-insights {false, true}]
[--enable-dataplane-public-endpoint {false, true}]
[--enable-log-stream-public-endpoint {false, true}]
[--enable-planned-maintenance]
[--enable-private-storage-access {false, true}]
[--ingress-read-timeout]
[--no-wait]
[--planned-maintenance-day {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
[--planned-maintenance-start-hour]
[--sku {Basic, Enterprise, Standard, StandardGen2}]
[--tags]Examples
Update pricing tier.
az spring update -n MyService --sku Standard -g MyResourceGroupUpdate the tags of the existing Azure Spring Apps.
az spring update -n MyService -g MyResourceGroup --tags key1=value1 key2=value2Configure planned maintenance
az spring update -n MyService -g MyResourceGroup --enable-planned-maintenance --planned-maintenance-day Friday --planned-maintenance-start-hour 10Required Parameters
The name of Azure Spring Apps instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Argument 'az spring update --app-insights' has been deprecated and will be removed in a future release. Use 'az spring 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.
Argument 'az spring update --app-insights-key' has been deprecated and will be removed in a future release. Use 'az spring app-insights update --app-insights-key' instead.
Connection string (recommended) or Instrumentation key of the existing Application Insights.
(Enterprise Tier Only) Size of build agent pool. See https://aka.ms/azure-spring-cloud-build-service-docs for size info.
Argument 'az spring update --disable-app-insights' has been deprecated and will be removed in a future release. Use 'az spring 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.
If true, assign public endpoint for log streaming, remote debugging, app connect in vnet injection instance which could be accessed out of virtual network.
Option '--enable-log-stream-public-endpoint' has been deprecated and will be removed in a future release. Use '--enable-dataplane-public-endpoint' instead.
If true, assign public endpoint for log streaming in vnet injection instance which could be accessed out of virtual network.
If set, enable planned maintenance for the instance.
If true, set private network access to backend storage in vnet injection instance.
Ingress read timeout value in seconds. Minimum is 1, maximum is 1800.
Do not wait for the long-running operation to finish.
Day of the week which planned maintenance will be scheduled on.
Start time of the planned maintenance window in UTC. Must be between 0 and 23.
Name of SKU.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI