az spring config-server

Reference

Note

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

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

Commands

Name	Description	Type	Status
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 config-server bind

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

az spring config-server bind --resource-group
                             --service
                             [--app]
                             [--job]

Examples

Bind an app to the default Config Server in service instance MyService.

az spring config-server bind --app MyApp -s MyService -g MyResourceGroup

Bind a job to the default Config Server in service instance MyService.

az spring config-server bind --job job-name -s MyService -g MyResourceGroup

Required Parameters

--resource-group -g

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

--service -s

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

Optional Parameters

--app

Name of app.

--job

The name of job running in the specified Azure Spring Apps instance.

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 config-server clear

Erase all settings in Config Server.

az spring config-server clear --resource-group
                              --service
                              [--yes]

Examples

Update the settings for the default Config Server in service instance MyService to empty.

az spring config-server clear -s MyService -g MyResourceGroup

Required Parameters

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance.

Optional Parameters

--yes -y

Do not prompt for confirmation.

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 config-server create

(Enterprise Tier Only) Create Config Server.

az spring config-server create --resource-group
                               --service

Examples

Create a Config Server without repository settings in service instance MyService.

az spring config-server create -s MyService -g MyResourceGroup

Required Parameters

--resource-group -g

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

--service -s

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

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 config-server delete

(Enterprise Tier Only) Delete Config Server.

az spring config-server delete --resource-group
                               --service
                               [--yes]

Examples

Delete the default Config Server in service instance MyService.

az spring config-server delete -s MyService -g MyResourceGroup

Required Parameters

--resource-group -g

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

--service -s

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

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 config-server disable

(Standard consumption Tier Only) Disable Config Server.

az spring config-server disable --resource-group
                                --service

Required Parameters

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance.

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 config-server enable

(Standard consumption Tier Only) Enable Config Server.

az spring config-server enable --resource-group
                               --service

Required Parameters

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance.

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 config-server set

Set Config Server from a yaml file.

az spring config-server set --config-file
                            --resource-group
                            --service
                            [--no-wait]

Examples

Load from a yaml file and set the default Config Server in service instance MyService.

az spring config-server set -s MyService -g MyResourceGroup --config-file MyConfigFile.yaml

Required Parameters

--config-file

A yaml file path for the configuration of Spring Cloud config server.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance.

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 config-server show

Show Config Server.

az spring config-server show --resource-group
                             --service

Examples

Show the metadata for the default Config Server in service instance MyService.

az spring config-server show -s MyService -g MyResourceGroup

Required Parameters

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance.

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 config-server unbind

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

az spring config-server unbind --resource-group
                               --service
                               [--app]
                               [--job]
                               [--yes]

Examples

Unbind an app from the default Config Server in service instance MyService.

az spring config-server unbind --app MyApp -s MyService -g MyResourceGroup

Unbind a job from the default Config Server in service instance MyService.

az spring config-server unbind --job job-name -s MyService -g MyResourceGroup

Required Parameters

--resource-group -g

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

--service -s

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

Optional Parameters

--app

Name of app.

--job

The name of job running in the specified Azure Spring Apps instance.

--yes -y

Do not prompt for confirmation.

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.

Share via

az spring config-server

Commands

az spring config-server bind

Examples

Required Parameters

Optional Parameters

az spring config-server clear

Examples

Required Parameters

Optional Parameters

az spring config-server create

Examples

Required Parameters

az spring config-server delete

Examples

Required Parameters

Optional Parameters

az spring config-server disable

Required Parameters

az spring config-server enable

Required Parameters

az spring config-server set

Examples

Required Parameters

Optional Parameters

az spring config-server show

Examples

Required Parameters

az spring config-server unbind

Examples

Required Parameters

Optional Parameters

Additional resources