Share via

az spring dev-tool

  • 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 dev-tool command. Learn more about extensions.

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

Commands

Name Description Type Status
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 dev-tool create

Create Dev Tool Portal.

az spring dev-tool create --resource-group
                          --service
                          [--assign-endpoint {false, true}]
                          [--client-id]
                          [--client-secret]
                          [--metadata-url]
                          [--no-wait]
                          [--scopes]

Examples

Create Dev Tool Portal with public endpoint exposed

az spring dev-tool create -s MyService -g MyResourceGroup --assign-endpoint

Create Dev Tool Portal with SSO enabled

az spring dev-tool create -s MyService -g MyResourceGroup --client-id 00000000-0000-0000-000000000000 --scopes scope1,scope2  --client-secret MySecret --metadata-url "https://example.com/.well-known/openid-configuration" --assign-endpoint

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

--assign-endpoint

If true, assign endpoint URL for direct access.

Accepted values: false, true
Default value: False
--client-id

The public identifier for the application.

--client-secret

The secret known only to the application and the authorization server.

--metadata-url

The URI of Issuer Identifier.

--no-wait

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

Default value: False
--scopes

Comma-separated list of the specific actions applications can be allowed to do on a user's behalf.

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 dev-tool delete

Delete Dev Tool Portal.

az spring dev-tool delete --resource-group
                          --service
                          [--no-wait]
                          [--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

--no-wait

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

Default value: False
--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 dev-tool show

Show the provisioning state, running status and settings of Dev Tool Portal.

az spring dev-tool 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 dev-tool update

Update Dev Tool Portal.

az spring dev-tool update --resource-group
                          --service
                          [--assign-endpoint {false, true}]
                          [--client-id]
                          [--client-secret]
                          [--metadata-url]
                          [--no-wait]
                          [--scopes]

Examples

Update Dev Tool Portal with public endpoint exposed

az spring dev-tool update -s MyService -g MyResourceGroup --assign-endpoint

Update Dev Tool Portal with SSO enabled

az spring dev-tool update -s MyService -g MyResourceGroup --client-id 00000000-0000-0000-000000000000 --scopes scope1,scope2  --client-secret MySecret --metadata-url "https://example.com/.well-known/openid-configuration" --assign-endpoint

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

--assign-endpoint

If true, assign endpoint URL for direct access.

Accepted values: false, true
--client-id

The public identifier for the application.

--client-secret

The secret known only to the application and the authorization server.

--metadata-url

The URI of Issuer Identifier.

--no-wait

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

Default value: False
--scopes

Comma-separated list of the specific actions applications can be allowed to do on a user's behalf.

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.