az spring-cloud

Commands to manage Azure Spring Cloud.

Commands

az spring-cloud app

Commands to manage apps in Azure Spring Cloud.

az spring-cloud app binding

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

az spring-cloud app binding cosmos

Commands to manage Azure Cosmos DB bindings.

az spring-cloud app binding cosmos add

Bind an Azure Cosmos DB with the app.

az spring-cloud app binding cosmos update

Update an Azure Cosmos DB service binding of the app.

az spring-cloud app binding list

List all service bindings in an app.

az spring-cloud app binding mysql

Commands to manage Azure Database for MySQL bindings.

az spring-cloud app binding mysql add

Bind an Azure Database for MySQL with the app.

az spring-cloud app binding mysql update

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

az spring-cloud app binding redis

Commands to manage Azure Cache for Redis bindings.

az spring-cloud app binding redis add

Bind an Azure Cache for Redis with the app.

az spring-cloud app binding redis update

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

az spring-cloud app binding remove

Remove a service binding of the app.

az spring-cloud app binding show

Show the details of a service binding.

az spring-cloud app create

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

az spring-cloud app custom-domain

Commands to manage custom domains.

az spring-cloud app custom-domain bind

Bind a custom domain with the app.

az spring-cloud app custom-domain list

List all custom domains of the app.

az spring-cloud app custom-domain show

Show details of a custom domain.

az spring-cloud app custom-domain unbind

Unbind a custom-domain of the app.

az spring-cloud app custom-domain update

Update a custom domain of the app.

az spring-cloud app delete

Delete an app in the Azure Spring Cloud.

az spring-cloud app deploy

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

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 .

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

az spring-cloud app deployment delete

Delete a deployment of the app.

az spring-cloud app deployment list

List all deployments in an app.

az spring-cloud app deployment show

Show details of a deployment.

az spring-cloud app identity

Manage an app's managed service identity.

az spring-cloud app identity assign

Enable managed service identity on an app.

az spring-cloud app identity remove

Remove managed service identity from an app.

az spring-cloud app identity show

Display app's managed identity info.

az spring-cloud app list

List all apps in the Azure Spring Cloud.

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.

az spring-cloud app log tail

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

az spring-cloud app logs

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

az spring-cloud app restart

Restart instances of the app, default to production deployment.

az spring-cloud app scale

Manually scale an app or its deployments.

az spring-cloud app set-deployment

Set production deployment of an app.

az spring-cloud app show

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

az spring-cloud app show-deploy-log

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

az spring-cloud app start

Start instances of the app, default to production deployment.

az spring-cloud app stop

Stop instances of the app, default to production deployment.

az spring-cloud app update

Update configurations of an app.

az spring-cloud certificate

Commands to manage certificates.

az spring-cloud certificate add

Add a certificate in Azure Spring Cloud.

az spring-cloud certificate list

List all certificates in Azure Spring Cloud.

az spring-cloud certificate remove

Remove a certificate in Azure Spring Cloud.

az spring-cloud certificate show

Show a certificate in Azure Spring Cloud.

az spring-cloud config-server

Commands to manage Config Server in Azure Spring Cloud.

az spring-cloud config-server clear

Erase all settings in Config Server.

az spring-cloud config-server git

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

az spring-cloud config-server git repo

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

az spring-cloud config-server git repo add

Set add a new repositry of git property of Config Server.

az spring-cloud config-server git repo list

List all repositries of git property of Config Server.

az spring-cloud config-server git repo remove

Remove an existing repositry of git property of Config Server.

az spring-cloud config-server git repo update

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

az spring-cloud config-server git set

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

az spring-cloud config-server set

Set Config Server from a yaml file.

az spring-cloud config-server show

Show Config Server.

az spring-cloud create

Create an Azure Spring Cloud.

az spring-cloud delete

Delete an Azure Spring Cloud.

az spring-cloud list

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

az spring-cloud show

Show the details for an Azure Spring Cloud.

az spring-cloud test-endpoint

Commands to manage test endpoint in Azure Spring Cloud.

az spring-cloud test-endpoint disable

Disable test endpoint of the Azure Spring Cloud.

az spring-cloud test-endpoint enable

Enable test endpoint of the Azure Spring Cloud.

az spring-cloud test-endpoint list

List test endpoint keys of the Azure Spring Cloud.

az spring-cloud test-endpoint renew-key

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

az spring-cloud update

Update an Azure Spring Cloud.

az spring-cloud create

Create an Azure Spring Cloud.

az spring-cloud create --name
                       --resource-group
                       [--app-insights]
                       [--app-insights-key]
                       [--app-network-resource-group]
                       [--app-subnet]
                       [--disable-distributed-tracing {false, true}]
                       [--location]
                       [--no-wait]
                       [--reserved-cidr-range]
                       [--service-runtime-network-resource-group]
                       [--service-runtime-subnet]
                       [--sku]
                       [--tags]
                       [--vnet]

Examples

Create a new Azure Spring Cloud in westus.

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

Create a new Azure Spring Cloud in westus with an existing Application Insights by using the instrumentation key.

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

Create a new Azure Spring Cloud with distributed tracing disabled.

az spring-cloud create -n MyService -g MyResourceGroup --disable-distributed-tracing

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

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

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

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

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

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

Optional Parameters

--app-insights

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

--app-insights-key

Instrumentation key of the existing Application Insights to be added for the distributed tracing.

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

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

--app-subnet

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

--disable-distributed-tracing

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

accepted values: false, true
--location -l

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

--no-wait

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

--reserved-cidr-range

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

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

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

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

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

--sku

Name of SKU, the value is "Basic" or "Standard".

--tags

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

--vnet

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

az spring-cloud delete

Delete an Azure Spring Cloud.

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

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

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

Optional Parameters

--no-wait

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

az spring-cloud list

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

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

Optional Parameters

--resource-group -g

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

az spring-cloud show

Show the details for an Azure Spring Cloud.

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

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

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

az spring-cloud update

Update an Azure Spring Cloud.

az spring-cloud update --name
                       --resource-group
                       [--app-insights]
                       [--app-insights-key]
                       [--disable-distributed-tracing {false, true}]
                       [--no-wait]
                       [--sku]
                       [--tags]

Examples

Update pricing tier.

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

Enable the distributed tracing of the existing Azure Spring Cloud.

az spring-cloud update -n MyService -g MyResourceGroup --disable-distributed-tracing false

Update the tags of the existing Azure Spring Cloud.

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

Required Parameters

--name -n

Name of Azure Spring Cloud.

--resource-group -g

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

Optional Parameters

--app-insights

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

--app-insights-key

Instrumentation key of the existing Application Insights to be added for the distributed tracing.

--disable-distributed-tracing

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

accepted values: false, true
--no-wait

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

--sku

Name of SKU, the value is "Basic" or "Standard".

--tags

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