az dataprotection job

  • Reference

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az dataprotection job command. Learn more about extensions.

Manage job with dataprotection.

Commands

Name Description Type Status
az dataprotection job list

Returns list of jobs belonging to a backup vault.

 Extension GA
az dataprotection job list-from-resourcegraph

List backup jobs across subscriptions, resource groups and vaults.

 Extension GA
az dataprotection job show

Get a job with id in a backup vault.

 Extension GA

az dataprotection job list

Returns list of jobs belonging to a backup vault.

az dataprotection job list --resource-group
                           --vault-name
                           [--max-items]
                           [--next-token]
                           [--use-secondary-region {false, true}]

Examples

Get Jobs

az dataprotection job list --resource-group "BugBash1" --vault-name "BugBashVaultForCCYv11"

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--use-secondary-region

Use this flag fetch list of jobs from secondary region.

accepted values: false, true
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 dataprotection job list-from-resourcegraph

List backup jobs across subscriptions, resource groups and vaults.

az dataprotection job list-from-resourcegraph [--datasource-id]
                                              [--datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}]
                                              [--end-time]
                                              [--operation {OnDemandBackup, Restore, ScheduledBackup}]
                                              [--resource-groups]
                                              [--start-time]
                                              [--status {Completed, Failed, InProgress}]
                                              [--subscriptions]
                                              [--vaults]

Examples

Get backup jobs across all resource groups in current subscription which have been completed

az dataprotection job list-from-resourcegraph --datasource-type AzureDisk --status Completed

Get backup jobs in a given set of vaults and in a given timerange

az dataprotection job list-from-resourcegraph --datasource-type AzureDisk --vaults MyVault1 MyVault2 --start-time 2020-11-11T01:01:00 --end-time 2020-11-14T01:01:00

Optional Parameters

--datasource-id

Specify datasource id filter to apply.

--datasource-type

Specify the datasource type.

accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService
--end-time

Specify end time of the job in UTC (yyyy-mm-ddTHH:MM:SS).

--operation

Specify job operation values for filter.

accepted values: OnDemandBackup, Restore, ScheduledBackup
--resource-groups

List of resource groups.

--start-time

Specify start time of the job in UTC (yyyy-mm-ddTHH:MM:SS).

--status

Specify job status values for filter.

accepted values: Completed, Failed, InProgress
--subscriptions

List of subscription Ids.

--vaults

List of vault names.

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

Get a job with id in a backup vault.

az dataprotection job show [--ids]
                           [--job-id]
                           [--resource-group]
                           [--subscription]
                           [--use-secondary-region {false, true}]
                           [--vault-name]

Examples

Get Job

az dataprotection job show --job-id "00000000-0000-0000-0000-000000000000" --resource-group "BugBash1" --vault-name "BugBashVaultForCCYv11"

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.

--job-id

The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

--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 fetch list of jobs from secondary region.

accepted values: false, true
--vault-name -v

Name of the backup 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.