Share via


az spring dev-tool

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.

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

(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 Deprecated
az spring dev-tool delete

Delete Dev Tool Portal.

Extension Deprecated
az spring dev-tool show

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

Extension Deprecated
az spring dev-tool update

Update Dev Tool Portal.

Extension Deprecated

az spring dev-tool create

Deprecated

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--assign-endpoint

If true, assign endpoint URL for direct access.

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

The public identifier for the application.

Property Value
Parameter group: Single Sign On (SSO) Arguments
--client-secret

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

Property Value
Parameter group: Single Sign On (SSO) Arguments
--metadata-url

The URI of Issuer Identifier.

Property Value
Parameter group: Single Sign On (SSO) Arguments
--no-wait

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

Property Value
Default value: False
--scopes

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

Property Value
Parameter group: Single Sign On (SSO) Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring dev-tool delete

Deprecated

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring dev-tool show

Deprecated

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring dev-tool update

Deprecated

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--assign-endpoint

If true, assign endpoint URL for direct access.

Property Value
Accepted values: false, true
--client-id

The public identifier for the application.

Property Value
Parameter group: Single Sign On (SSO) Arguments
--client-secret

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

Property Value
Parameter group: Single Sign On (SSO) Arguments
--metadata-url

The URI of Issuer Identifier.

Property Value
Parameter group: Single Sign On (SSO) Arguments
--no-wait

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

Property Value
Default value: False
--scopes

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

Property Value
Parameter group: Single Sign On (SSO) Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False