az spring test-endpoint

  • 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 test-endpoint command. Learn more about extensions.

Commands to manage test endpoint in Azure Spring Apps.

Commands

Name Description Type Status
az spring test-endpoint disable

Disable test endpoint of the Azure Spring Apps.

 Extension GA
az spring test-endpoint enable

Enable test endpoint of the Azure Spring Apps.

 Extension GA
az spring test-endpoint list

List test endpoint keys of the Azure Spring Apps.

 Extension GA
az spring test-endpoint renew-key

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

 Extension GA

az spring test-endpoint disable

Disable test endpoint of the Azure Spring Apps.

az spring test-endpoint disable --name
                                --resource-group

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

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 test-endpoint enable

Enable test endpoint of the Azure Spring Apps.

az spring test-endpoint enable --name
                               --resource-group

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

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 test-endpoint list

List test endpoint keys of the Azure Spring Apps.

az spring test-endpoint list --name
                             --resource-group
                             [--app]
                             [--deployment]

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

Optional Parameters

--app

Name of app.

--deployment -d

Name of an existing deployment of the app. Default to the production deployment if not specified.

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 test-endpoint renew-key

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

az spring test-endpoint renew-key --name
                                  --resource-group
                                  --type {Primary, Secondary}

Required Parameters

--name -n

The name of Azure Spring Apps instance.

--resource-group -g

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

--type

Type of test-endpoint key.

accepted values: Primary, Secondary
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.