Share via

az spring component

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

(Enterprise Tier Only) Commands to handle managed components.

Commands

Name Description Type Status
az spring component instance

(Enterprise Tier Only) Commands to handle instances of a managed component.

 Extension GA
az spring component instance list

(Enterprise Tier Only) List all available instances of a specific managed component in an Azure Spring Apps instance.

 Extension GA
az spring component list

(Enterprise Tier Only) List managed components.

 Extension GA
az spring component logs

(Enterprise Tier Only) Show logs for managed components. Logs will be streamed when setting '-f/--follow'. For now, only supports subcomponents of (a) Application Configuration Service (b) Spring Cloud Gateway (c) Spring Cloud Config Server.

 Extension GA

az spring component list

(Enterprise Tier Only) List managed components.

az spring component list --resource-group
                         --service

Examples

List all managed components

az spring component list --service MyAzureSpringAppsInstance --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=.

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 component logs

(Enterprise Tier Only) Show logs for managed components. Logs will be streamed when setting '-f/--follow'. For now, only supports subcomponents of (a) Application Configuration Service (b) Spring Cloud Gateway (c) Spring Cloud Config Server.

az spring component logs --resource-group
                         --service
                         [--all-instances]
                         [--follow]
                         [--instance]
                         [--limit]
                         [--lines]
                         [--max-log-requests]
                         [--name]
                         [--since]

Examples

Show logs for all instances of flux in Application Configuration Serice (Gen2)

az spring component logs --name flux-source-controller --service MyAzureSpringAppsInstance --resource-group MyResourceGroup --all-instances

Show logs for a specific instance of application-configuration-service in Application Configuration Serice

az spring component logs --name application-configuration-service --service MyAzureSpringAppsInstance --resource-group MyResourceGroup --instance InstanceName

Stream and watch logs for all instances of spring-cloud-gateway

az spring component logs --name spring-cloud-gateway --service MyAzureSpringAppsInstance --resource-group MyResourceGroup --all-instances --follow

Show logs for a specific instance without specify the component name

az spring component logs --service MyAzureSpringAppsInstance --resource-group MyResourceGroup --instance InstanceName

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

--all-instances

The flag to indicate get logs for all instances of the component.

--follow -f

The flag to indicate logs should be streamed.

--instance -i

Name of an existing instance of the component.

--limit

Maximum kibibyte of logs to return. Ceiling number is 2048.

Default value: 2048
--lines

Number of lines to show. Maximum is 10000.

Default value: 50
--max-log-requests

Specify maximum number of concurrent logs to follow when get logs by all-instances.

Default value: 5
--name -n

Name of the component. Find component names from command az spring component list.

--since

Only return logs newer than a relative duration like 5s, 2m, or 1h. Maximum is 1h.

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.