az spring job execution

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

Command group 'spring job' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

(Enterprise Tier Only) Commands to manage job executions of Azure Spring Apps service.

Commands

Name	Description	Type	Status
az spring job execution cancel	Cancel a job execution.	Extension	Preview
az spring job execution instance	(Enterprise Tier Only) Commands to manage job execution instances of Azure Spring Apps service.	Extension	Preview
az spring job execution instance list	List all instances of the job execution.	Extension	Preview
az spring job execution list	List all executions of the job.	Extension	Preview
az spring job execution show	Show status and results of an execution of the job.	Extension	Preview

az spring job execution cancel

Preview

Command group 'spring job execution' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Cancel a job execution.

az spring job execution cancel --job
                               --name
                               --resource-group
                               --service
                               [--no-wait]

Examples

Cancel a job execution

az spring job execution cancel -n job-execution-name --job job-name -s MyAzureSpringAppsInstance -g MyResourceGroup

Required Parameters

--job

The name of job running in the specified Azure Spring Apps instance.

--name -n

The name of job execution running in the specified Azure Spring Apps instance.

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

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 job execution list

Preview

Command group 'spring job execution' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all executions of the job.

az spring job execution list --job
                             --resource-group
                             --service

Examples

List all executions of the job

az spring job execution list --job job-name -s MyAzureSpringAppsInstance -g MyResourceGroup

Required Parameters

--job

The name of job running in the specified Azure Spring Apps instance.

--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 job execution show

Preview

Command group 'spring job execution' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show status and results of an execution of the job.

az spring job execution show --job
                             --name
                             --resource-group
                             --service

Examples

Show status and results of an execution of the job

az spring job execution show -n job-execution-name --job job-name -s MyAzureSpringAppsInstance -g MyResourceGroup

Required Parameters

--job

The name of job running in the specified Azure Spring Apps instance.

--name -n

The name of job execution running in the specified Azure Spring Apps instance.

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