Share via

az backup job

  • Reference

Entity which contains details of the job.

Commands

Name Description Type Status
az backup job list

List all backup jobs of a Recovery Services vault.

 Core GA
az backup job show

Show details of a particular job.

 Core GA
az backup job stop

Suspend or terminate a currently running job.

 Core GA
az backup job wait

Wait until either the job completes or the specified timeout value is reached.

 Core GA

az backup job list

Edit

List all backup jobs of a Recovery Services vault.

az backup job list --resource-group
                   --vault-name
                   [--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload, MAB}]
                   [--end-date]
                   [--operation {Backup, ConfigureBackup, DeleteBackupData, DisableBackup, Restore}]
                   [--start-date]
                   [--status {Cancelled, Completed, CompletedWithWarnings, Failed, InProgress}]
                   [--use-secondary-region]

Examples

List all backup jobs of a Recovery Services vault

az backup job list --resource-group MyResourceGroup --vault-name MyVault

Required Parameters

--resource-group -g

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

--vault-name -v

Name of the Recovery services vault.

Optional Parameters

--backup-management-type

Specify the backup management type. Define how Azure Backup manages the backup of entities within the ARM resource. For eg: AzureWorkloads refers to workloads installed within Azure VMs, AzureStorage refers to entities within Storage account. Required only if friendly name is used as Container name.

Accepted values: AzureIaasVM, AzureStorage, AzureWorkload, MAB
--end-date

The end date of the range in UTC (d-m-Y).

--operation

User initiated operation.

Accepted values: Backup, ConfigureBackup, DeleteBackupData, DisableBackup, Restore
--start-date

The start date of the range in UTC (d-m-Y).

--status

Status of the Job.

Accepted values: Cancelled, Completed, CompletedWithWarnings, Failed, InProgress
--use-secondary-region

Use this flag to show recoverypoints in secondary region.

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

Edit

Show details of a particular job.

az backup job show [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]
                   [--use-secondary-region]
                   [--vault-name]

Examples

Show details of a particular job. (autogenerated)

az backup job show --name MyJob --resource-group MyResourceGroup --vault-name MyVault

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the job. You can use the backup job list command to get the name of a job.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--use-secondary-region

Use this flag to show recoverypoints in secondary region.

--vault-name -v

Name of the Recovery services vault.

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 backup job stop

Edit

Suspend or terminate a currently running job.

az backup job stop [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]
                   [--use-secondary-region]
                   [--vault-name]

Examples

Suspend or terminate a currently running job. (autogenerated)

az backup job stop --name MyJob --resource-group MyResourceGroup --vault-name MyVault

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the job. You can use the backup job list command to get the name of a job.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--use-secondary-region

Use this flag to show recoverypoints in secondary region.

--vault-name -v

Name of the Recovery services vault.

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 backup job wait

Edit

Wait until either the job completes or the specified timeout value is reached.

az backup job wait [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]
                   [--timeout]
                   [--use-secondary-region]
                   [--vault-name]

Examples

Wait until either the job completes or the specified timeout value is reached

az backup job wait --name MyJob --resource-group MyResourceGroup --vault-name MyVault

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the job. You can use the backup job list command to get the name of a job.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum time, in seconds, to wait before aborting.

--use-secondary-region

Use this flag to show recoverypoints in secondary region.

--vault-name -v

Name of the Recovery services vault.

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.