Share via

az spring service-registry

  • 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 service-registry command. Learn more about extensions.

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

Commands

Name Description Type Status
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 service-registry bind

Bind an app or a job to Service Registry.

az spring service-registry bind --resource-group
                                --service
                                [--app]
                                [--job]

Examples

Bind an app to Service Registry.

az spring service-registry bind --app MyApp -s MyService -g MyResourceGroup

Bind a job to Service Registry.

az spring service-registry 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
Preview

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 service-registry create

Create Service Registry.

az spring service-registry create --resource-group
                                  --service

Examples

Create Service Registry.

az spring service-registry 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 service-registry delete

Delete Service Registry.

az spring service-registry delete --resource-group
                                  --service
                                  [--yes]

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 service-registry show

Show the provisioning status and runtime status of Service Registry.

az spring service-registry show --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, 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 service-registry unbind

Unbind an app or a job from Service Registry.

az spring service-registry unbind --resource-group
                                  --service
                                  [--app]
                                  [--job]

Examples

Unbind an app from Service Registry.

az spring service-registry unbind --app MyApp -s MyService -g MyResourceGroup

Unbind a job from Service Registry.

az spring service-registry 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
Preview

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.