az spring-cloud app

Note

This reference is part of the spring-cloud extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az spring-cloud app command. Learn more about extensions.

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

Commands to manage apps in Azure Spring Cloud.

Commands

Name	Description	Type	Status
az spring-cloud app append-loaded-public-certificate	Append a new loaded public certificate to an app in the Azure Spring Cloud.	Extension	Deprecated
az spring-cloud app append-persistent-storage	Append a new persistent storage to an app in the Azure Spring Cloud.	Extension	Deprecated
az spring-cloud app binding	Commands to manage bindings with Azure Data Services, you need to manually restart app to make settings take effect.	Extension	Deprecated
az spring-cloud app binding cosmos	Commands to manage Azure Cosmos DB bindings.	Extension	Deprecated
az spring-cloud app binding cosmos add	Bind an Azure Cosmos DB with the app.	Extension	Deprecated
az spring-cloud app binding cosmos update	Update an Azure Cosmos DB service binding of the app.	Extension	Deprecated
az spring-cloud app binding list	List all service bindings in an app.	Extension	Deprecated
az spring-cloud app binding mysql	Commands to manage Azure Database for MySQL bindings.	Extension	Deprecated
az spring-cloud app binding mysql add	Bind an Azure Database for MySQL with the app.	Extension	Deprecated
az spring-cloud app binding mysql update	Update an Azure Database for MySQL service binding of the app.	Extension	Deprecated
az spring-cloud app binding redis	Commands to manage Azure Cache for Redis bindings.	Extension	Deprecated
az spring-cloud app binding redis add	Bind an Azure Cache for Redis with the app.	Extension	Deprecated
az spring-cloud app binding redis update	Update an Azure Cache for Redis service binding of the app.	Extension	Deprecated
az spring-cloud app binding remove	Remove a service binding of the app.	Extension	Deprecated
az spring-cloud app binding show	Show the details of a service binding.	Extension	Deprecated
az spring-cloud app create	Create a new app with a default deployment in the Azure Spring Cloud.	Extension	Deprecated
az spring-cloud app custom-domain	Commands to manage custom domains.	Extension	Deprecated
az spring-cloud app custom-domain bind	Bind a custom domain with the app.	Extension	Deprecated
az spring-cloud app custom-domain list	List all custom domains of the app.	Extension	Deprecated
az spring-cloud app custom-domain show	Show details of a custom domain.	Extension	Deprecated
az spring-cloud app custom-domain unbind	Unbind a custom-domain of the app.	Extension	Deprecated
az spring-cloud app custom-domain update	Update a custom domain of the app.	Extension	Deprecated
az spring-cloud app delete	Delete an app in the Azure Spring Cloud.	Extension	Deprecated
az spring-cloud app deploy	Deploy source code or pre-built binary to an app and update related configurations.	Extension	Deprecated
az spring-cloud app deployment	Commands to manage life cycle of deployments of an app in Azure Spring Cloud. More operations on deployments can be done on app level with parameter --deployment. e.g. az spring-cloud app deploy --deployment .	Extension	Deprecated
az spring-cloud app deployment create	Create a staging deployment for the app. To deploy code or update setting to an existing deployment, use az spring-cloud app deploy/update --deployment <staging deployment>.	Extension	Deprecated
az spring-cloud app deployment delete	Delete a deployment of the app.	Extension	Deprecated
az spring-cloud app deployment generate-heap-dump	Generate a heap dump of your target app instance to given file path.	Extension	Deprecated
az spring-cloud app deployment generate-thread-dump	Generate a thread dump of your target app instance to given file path.	Extension	Deprecated
az spring-cloud app deployment list	List all deployments in an app.	Extension	Deprecated
az spring-cloud app deployment show	Show details of a deployment.	Extension	Deprecated
az spring-cloud app deployment start-jfr	Start a JFR on your target app instance to given file path.	Extension	Deprecated
az spring-cloud app identity	Manage an app's managed identities.	Extension	Deprecated
az spring-cloud app identity assign	Enable system-assigned managed identity or assign user-assigned managed identities to an app.	Extension	Deprecated
az spring-cloud app identity force-set	Force set managed identities on an app.	Extension	Preview and Deprecated
az spring-cloud app identity remove	Remove managed identity from an app.	Extension	Deprecated
az spring-cloud app identity show	Display app's managed identity info.	Extension	Deprecated
az spring-cloud app list	List all apps in the Azure Spring Cloud.	Extension	Deprecated
az spring-cloud app log	Commands to tail app instances logs with multiple options. If the app has only one instance, the instance name is optional.	Extension	Deprecated
az spring-cloud app log tail	Show logs of an app instance, logs will be streamed when setting '-f/--follow'.	Extension	Deprecated
az spring-cloud app logs	Show logs of an app instance, logs will be streamed when setting '-f/--follow'.	Extension	Deprecated
az spring-cloud app restart	Restart instances of the app, default to production deployment.	Extension	Deprecated
az spring-cloud app scale	Manually scale an app or its deployments.	Extension	Deprecated
az spring-cloud app set-deployment	Set production deployment of an app.	Extension	Deprecated
az spring-cloud app show	Show the details of an app in the Azure Spring Cloud.	Extension	Deprecated
az spring-cloud app show-deploy-log	Show build log of the last deploy, only apply to source code deploy, default to production deployment.	Extension	Deprecated
az spring-cloud app start	Start instances of the app, default to production deployment.	Extension	Deprecated
az spring-cloud app stop	Stop instances of the app, default to production deployment.	Extension	Deprecated
az spring-cloud app unset-deployment	Unset production deployment of an app.	Extension	Deprecated
az spring-cloud app update	Update configurations of an app.	Extension	Deprecated

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

Deprecated

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

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

az spring-cloud app append-loaded-public-certificate --certificate-name
                                                     --load-trust-store {false, true}
                                                     --name
                                                     --resource-group
                                                     --service

Examples

Append a new loaded public certificate to an app.

az spring-cloud app append-loaded-public-certificate --name MyApp --service MyCluster --resource-group MyResourceGroup --certificate-name MyCertName --load-trust-store true

Required Parameters

--certificate-name

Name of the certificate to be appended.

--load-trust-store

If true, the certificate would be loaded into trust store for Java applications.

accepted values: false, true

default value: False

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app append-persistent-storage

Deprecated

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

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

az spring-cloud app append-persistent-storage --mount-path
                                              --name
                                              --persistent-storage-type
                                              --resource-group
                                              --service
                                              --share-name
                                              --storage-name
                                              [--mount-options]
                                              [--read-only {false, true}]

Examples

Append a new persistent storage to an app.

az spring-cloud app append-persistent-storage --persistent-storage-type AzureFileVolume --share-name MyShareName --mount-path /MyMountPath --storage-name MyStorageName -n MyApp -g MyResourceGroup -s MyService

Required Parameters

--mount-path

The path for the persistent storage volume to be mounted.

--name -n

Name of app.

--persistent-storage-type -t

Type of the persistent storage volumed.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

--share-name

The name of the pre-created file share. ShareName should be provided only if the type of the persistent storage volume is AzureFileVolume.

--storage-name

Name of the storage resource you created in Azure Spring Cloud.

Optional Parameters

--mount-options

[optional] The mount options for the persistent storage volume.

--read-only

[optional] If true, the persistent storage volume will be read only.

accepted values: false, true

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app create

Deprecated

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

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

az spring-cloud app create --name
                           --resource-group
                           --service
                           [--assign-endpoint {false, true}]
                           [--cpu]
                           [--disable-probe {false, true}]
                           [--enable-persistent-storage {false, true}]
                           [--env]
                           [--instance-count]
                           [--jvm-options]
                           [--loaded-public-certificate-file]
                           [--memory]
                           [--persistent-storage]
                           [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}]
                           [--system-assigned {false, true}]
                           [--user-assigned]

Examples

Create an app with the default configuration.

az spring-cloud app create -n MyApp -s MyCluster -g MyResourceGroup

Create an public accessible app with 3 instances and 2 cpu cores and 3 GB of memory per instance.

az spring-cloud app create -n MyApp -s MyCluster -g MyResourceGroup --assign-endpoint true --cpu 2 --memory 3 --instance-count 3

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--assign-endpoint

If true, assign endpoint URL for direct access.

accepted values: false, true

default value: False

--cpu

CPU resource quantity. Should be 500m or number of CPU cores.

default value: 1

--disable-probe

If true, disable the liveness and readiness probe.

accepted values: false, true

--enable-persistent-storage

If true, mount a 50G (Standard Pricing tier) or 1G (Basic Pricing tier) disk with default path.

accepted values: false, true

--env

Space-separated environment variables in 'key[=value]' format.

--instance-count

Number of instance.

default value: 1

--jvm-options

A string containing jvm options, use '=' instead of ' ' for this argument to avoid bash parse error, eg: --jvm-options='-Xms1024m -Xmx2048m'.

--loaded-public-certificate-file -f

A json file path indicates the certificates which would be loaded to app.

--memory

Memory resource quantity. Should be 512Mi or #Gi, e.g., 1Gi, 3Gi.

default value: 1Gi

--persistent-storage

A json file path for the persistent storages to be mounted to the app.

--runtime-version

Runtime version of used language.

accepted values: Java_11, Java_17, Java_8, NetCore_31

--system-assigned

Enable system-assigned managed identity.

accepted values: false, true

--user-assigned

Preview

Space-separated user-assigned managed identity resource IDs to assgin to an app.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app delete

Deprecated

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

Delete an app in the Azure Spring Cloud.

az spring-cloud app delete --name
                           --resource-group
                           --service

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app deploy

Deprecated

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

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

az spring-cloud app deploy --name
                           --resource-group
                           --service
                           [--artifact-path]
                           [--build-env]
                           [--builder]
                           [--config-file-patterns]
                           [--container-args]
                           [--container-command]
                           [--container-image]
                           [--container-registry]
                           [--deployment]
                           [--disable-probe {false, true}]
                           [--disable-validation {false, true}]
                           [--env]
                           [--jvm-options]
                           [--main-entry]
                           [--no-wait]
                           [--registry-password]
                           [--registry-username]
                           [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}]
                           [--source-path]
                           [--target-module]
                           [--version]

Examples

Deploy source code to an app. This will pack current directory, build binary with Pivotal Build Service and then deploy to the app.

az spring-cloud app deploy -n MyApp -s MyCluster -g MyResourceGroup

Deploy a pre-built jar to an app with jvm options and environment variables.

az spring-cloud app deploy -n MyApp -s MyCluster -g MyResourceGroup --jar-path app.jar --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar

Deploy source code to a specific deployment of an app.

az spring-cloud app deploy -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment

Deploy a container image on Docker Hub to an app.

az spring-cloud app deploy -n MyApp -s MyCluster -g MyResourceGroup --container-image contoso/your-app:v1

Deploy a container image on a private registry to an app.

az spring-cloud app deploy -n MyApp -s MyCluster -g MyResourceGroup --container-image contoso/your-app:v1 --container-registry myacr.azurecr.io --registry-username <username> --registry-password <password>

Deploy with Application Configuration Service config file patterns to an app.

az spring-cloud app deploy -n MyApp -s MyCluster -g MyResourceGroup --config-file-patterns MyPatterns --jar-path app.jar

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--artifact-path

Deploy the specified pre-built artifact (jar or netcore zip).

--build-env

Space-separated environment variables in 'key[=value]' format.

--builder

Preview

(Enterprise Tier Only) Build service builder used to build the executable.

default value: default

--config-file-patterns

Preview

(Enterprise Tier Only) Config file patterns separated with ',' to decide which patterns of Application Configuration Service will be used. Use '""' to clear existing configurations.

--container-args

The arguments of the container image.

--container-command

The command of the container image.

--container-image

The container image tag.

--container-registry

The registry of the container image.

default value: docker.io

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

--disable-probe

If true, disable the liveness and readiness probe.

accepted values: false, true

--disable-validation

If true, disable jar validation.

accepted values: false, true

--env

Space-separated environment variables in 'key[=value]' format.

--jvm-options

A string containing jvm options, use '=' instead of ' ' for this argument to avoid bash parse error, eg: --jvm-options='-Xms1024m -Xmx2048m'.

--main-entry -m

A string containing the path to the .NET executable relative to zip root.

--no-wait

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

default value: False

--registry-password

The password of the container registry.

--registry-username

The username of the container registry.

--runtime-version

Runtime version of used language.

accepted values: Java_11, Java_17, Java_8, NetCore_31

--source-path

Deploy the specified source folder. The folder will be packed into tar, uploaded, and built using kpack. Default to the current folder if no value provided.

--target-module

Child module to be deployed, required for multiple jar packages built from source code.

--version

Deployment version, keep unchanged if not set.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app list

Deprecated

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

List all apps in the Azure Spring Cloud.

az spring-cloud app list --resource-group
                         --service

Examples

Query status of persistent storage of all apps

az spring-cloud app list -s MyCluster -g MyResourceGroup -o json --query '[].{Name:name, PersistentStorage:properties.persistentDisk}'

Required Parameters

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app logs

Deprecated

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

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

az spring-cloud app logs --name
                         --resource-group
                         --service
                         [--deployment]
                         [--follow]
                         [--format-json]
                         [--instance]
                         [--limit]
                         [--lines]
                         [--since]

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

--follow -f

Specify if the logs should be streamed.

default value: False

--format-json

Format JSON logs if structured log is enabled.

--instance -i

Name of an existing instance of the deployment.

--limit

Maximum kilobytes of logs to return. Ceiling number is 2048.

default value: 2048

--lines

Number of lines to show. Maximum is 10000.

default value: 50

--since

Only return logs newer than a relative duration like 5s, 2m, or 1h. Maximum is 1h.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app restart

Deprecated

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

Restart instances of the app, default to production deployment.

az spring-cloud app restart --name
                            --resource-group
                            --service
                            [--deployment]
                            [--no-wait]

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

--no-wait

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

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app scale

Deprecated

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

Manually scale an app or its deployments.

az spring-cloud app scale --name
                          --resource-group
                          --service
                          [--cpu]
                          [--deployment]
                          [--instance-count]
                          [--memory]
                          [--no-wait]

Examples

Scale up an app to 4 cpu cores and 8 Gb of memory per instance.

az spring-cloud app scale -n MyApp -s MyCluster -g MyResourceGroup --cpu 3 --memory 8

Scale out a deployment of the app to 5 instances.

az spring-cloud app scale -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --instance-count 5

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--cpu

CPU resource quantity. Should be 500m or number of CPU cores.

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

--instance-count

Number of instance.

--memory

Memory resource quantity. Should be 512Mi or #Gi, e.g., 1Gi, 3Gi.

--no-wait

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

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app set-deployment

Deprecated

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

Set production deployment of an app.

az spring-cloud app set-deployment --deployment
                                   --name
                                   --resource-group
                                   --service
                                   [--no-wait]

Examples

Swap a staging deployment of an app to production.

az spring-cloud app set-deployment -d green-deployment -n MyApp -s MyCluster -g MyResourceGroup

Required Parameters

--deployment -d

Name of an existing deployment of the app.

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--no-wait

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

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app show

Deprecated

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

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

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

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app show-deploy-log

Deprecated

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

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

az spring-cloud app show-deploy-log --name
                                    --resource-group
                                    --service
                                    [--deployment]

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app start

Deprecated

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

Start instances of the app, default to production deployment.

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

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

--no-wait

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

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app stop

Deprecated

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

Stop instances of the app, default to production deployment.

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

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

--no-wait

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

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app unset-deployment

Deprecated

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

Unset production deployment of an app.

az spring-cloud app unset-deployment --name
                                     --resource-group
                                     --service
                                     [--no-wait]

Examples

Swap the production deployment of an app to staging if the app has the production deployment.

az spring-cloud app unset-deployment -n MyApp -s MyCluster -g MyResourceGroup

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--no-wait

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

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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

az spring-cloud app update

Deprecated

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

Update configurations of an app.

az spring-cloud app update --name
                           --resource-group
                           --service
                           [--assign-endpoint {false, true}]
                           [--config-file-patterns]
                           [--deployment]
                           [--disable-probe {false, true}]
                           [--enable-ingress-to-app-tls {false, true}]
                           [--enable-persistent-storage {false, true}]
                           [--env]
                           [--https-only {false, true}]
                           [--jvm-options]
                           [--loaded-public-certificate-file]
                           [--main-entry]
                           [--no-wait]
                           [--persistent-storage]
                           [--runtime-version {Java_11, Java_17, Java_8, NetCore_31}]

Examples

Add an environment variable for the app.

az spring-cloud app update -n MyApp -s MyCluster -g MyResourceGroup --env foo=bar

Required Parameters

--name -n

Name of app.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--assign-endpoint

If true, assign endpoint URL for direct access.

accepted values: false, true

--config-file-patterns

Preview

(Enterprise Tier Only) Config file patterns separated with ',' to decide which patterns of Application Configuration Service will be used. Use '""' to clear existing configurations.

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

--disable-probe

If true, disable the liveness and readiness probe.

accepted values: false, true

--enable-ingress-to-app-tls

If true, enable ingress to app tls.

accepted values: false, true

--enable-persistent-storage

If true, mount a 50G (Standard Pricing tier) or 1G (Basic Pricing tier) disk with default path.

accepted values: false, true

--env

Space-separated environment variables in 'key[=value]' format.

--https-only

If true, access app via https.

accepted values: false, true

default value: False

--jvm-options

A string containing jvm options, use '=' instead of ' ' for this argument to avoid bash parse error, eg: --jvm-options='-Xms1024m -Xmx2048m'.

--loaded-public-certificate-file -f

A json file path indicates the certificates which would be loaded to app.

--main-entry -m

The path to the .NET executable relative to zip root.

--no-wait

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

default value: False

--persistent-storage

A json file path for the persistent storages to be mounted to the app.

--runtime-version

Runtime version of used language.

accepted values: Java_11, Java_17, Java_8, NetCore_31

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

default value: json

--query

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

--subscription

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

--verbose

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