az backup job

Entity which contains details of the job.

Commands

az backup job list

List all backup jobs of a Recovery Services vault.

az backup job show

Show details of a particular job.

az backup job stop

Suspend or terminate a currently running job.

az backup job wait

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

az backup job list

List all backup jobs of a Recovery Services vault.

az backup job list --resource-group
                   --vault-name
                   [--end-date]
                   [--operation {Backup, ConfigureBackup, DeleteBackupData, DisableBackup, Restore}]
                   [--query-examples]
                   [--start-date]
                   [--status {Cancelled, Completed, CompletedWithWarnings, Failed, InProgress}]
                   [--subscription]

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

--end-date

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

--operation

User initiated operation.

accepted values: Backup, ConfigureBackup, DeleteBackupData, DisableBackup, Restore
--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

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

az backup job show

Show details of a particular job.

az backup job show --name
                   [--ids]
                   [--query-examples]
                   [--resource-group]
                   [--subscription]
                   [--vault-name]

Examples

Show details of a particular job. (autogenerated)

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

Required Parameters

--name -n

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

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.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

--vault-name -v

Name of the Recovery services vault.

az backup job stop

Suspend or terminate a currently running job.

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

Examples

Suspend or terminate a currently running job. (autogenerated)

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

Required Parameters

--name -n

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

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.

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

--vault-name -v

Name of the Recovery services vault.

az backup job wait

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

az backup job wait --name
                   [--ids]
                   [--resource-group]
                   [--subscription]
                   [--timeout]
                   [--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

Required Parameters

--name -n

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

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.

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

--vault-name -v

Name of the Recovery services vault.