Share via

az spring apm

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 apm command. Learn more about extensions.

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

Commands

Name Description Type Status
az spring apm create

(Enterprise Tier Only) Create an APM.

 Extension GA
az spring apm delete

(Enterprise Tier Only) Delete an APM.

 Extension GA
az spring apm disable-globally

(Enterprise Tier Only) Disable an APM globally.

 Extension GA
az spring apm enable-globally

(Enterprise Tier Only) Enable an APM globally.

 Extension GA
az spring apm list

(Enterprise Tier Only) List all the APMs in the Azure Spring Apps. The secrets will be omitted.

 Extension GA
az spring apm list-enabled-globally

(Enterprise Tier Only) List all the APMs enabled globally in the Azure Spring Apps.

 Extension GA
az spring apm list-support-types

(Enterprise Tier Only) List all the supported APM types in the Azure Spring Apps.

 Extension GA
az spring apm show

(Enterprise Tier Only) Show an APM. The secrets will be masked.

 Extension GA
az spring apm update

(Enterprise Tier Only) Update an APM.

 Extension GA

az spring apm create

(Enterprise Tier Only) Create an APM.

az spring apm create --name
                     --resource-group
                     --service
                     --type
                     [--no-wait]
                     [--properties]
                     [--secrets]

Examples

Create an APM with secrets only.

az spring apm create --name first-apm --type ApplicationInsights --secrets k1=v1 k2=v2 --service MyCluster --resource-group MyResourceGroup

Create an APM with properties only.

az spring apm create --name first-apm --type ApplicationInsights --properties a=b c=d --service MyCluster --resource-group MyResourceGroup

Create an APM with properties and secrets.

az spring apm create --name first-apm --type ApplicationInsights --properties a=b c=d --secrets k1=v1 k2=v2 --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

APM name.

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

--type

Required type for APM. Run "az spring apm list-support-types"to get all the supported APM types.

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
--properties

Non-sensitive properties for APM. Format "key[=value]".

--secrets

Sensitive properties for APM. Once put, it will be encrypted and never return to user. Format "key[=value]".

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 apm delete

(Enterprise Tier Only) Delete an APM.

az spring apm delete --name
                     --resource-group
                     --service
                     [--no-wait]
                     [--yes]

Examples

Delete an APM.

az spring apm delete --name first-apm --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

APM name.

--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 apm disable-globally

(Enterprise Tier Only) Disable an APM globally.

az spring apm disable-globally --name
                               --resource-group
                               --service
                               [--no-wait]

Examples

Disable an APM globally.

az spring apm disable-globally --name first-apm --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

APM name.

--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
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 apm enable-globally

(Enterprise Tier Only) Enable an APM globally.

az spring apm enable-globally --name
                              --resource-group
                              --service
                              [--no-wait]

Examples

Enable an APM globally.

az spring apm enable-globally --name first-apm --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

APM name.

--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
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 apm list

(Enterprise Tier Only) List all the APMs in the Azure Spring Apps. The secrets will be omitted.

az spring apm list --resource-group
                   --service

Examples

List all the APMs in the Azure Spring Apps.

az spring apm list --service MyCluster --resource-group 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=<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 apm list-enabled-globally

(Enterprise Tier Only) List all the APMs enabled globally in the Azure Spring Apps.

az spring apm list-enabled-globally --resource-group
                                    --service

Examples

List all the APMs enabled globally in the Azure Spring Apps.

az spring apm list-enabled-globally --service MyCluster --resource-group 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=<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 apm list-support-types

(Enterprise Tier Only) List all the supported APM types in the Azure Spring Apps.

az spring apm list-support-types --resource-group
                                 --service

Examples

List all the supported APM types in the Azure Spring Apps.

az spring apm list-support-types --service MyCluster --resource-group 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=<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 apm show

(Enterprise Tier Only) Show an APM. The secrets will be masked.

az spring apm show --name
                   --resource-group
                   --service

Examples

Show an APM.

az spring apm show --name first-apm --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

APM name.

--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 apm update

(Enterprise Tier Only) Update an APM.

az spring apm update --name
                     --resource-group
                     --service
                     --type
                     [--no-wait]
                     [--properties]
                     [--secrets]

Examples

Update an APM with properties and secrets.

az spring apm update --name first-apm --type ApplicationInsights --properties a=b c=d --secrets k1=v1 k2=v2 --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

APM name.

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

--type

Required type for APM. Run "az spring apm list-support-types"to get all the supported APM types.

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
--properties

Non-sensitive properties for APM. Format "key[=value]".

--secrets

Sensitive properties for APM. Once put, it will be encrypted and never return to user. Format "key[=value]".

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