az dataprotection job

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.67.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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Accepted values:	false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--datasource-id

Specify datasource id filter to apply.

--datasource-type

Specify the datasource type.

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

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

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--job-id

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--use-secondary-region

Use this flag fetch list of jobs from secondary region.

Property	Value
Accepted values:	false, true

--vault-name -v

Name of the backup vault.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Share via

az dataprotection job

Commands

az dataprotection job list

Examples

Required Parameters

Optional Parameters

az dataprotection job list-from-resourcegraph

Examples

Optional Parameters

az dataprotection job show

Examples

Optional Parameters

Feedback