Backup Jobs - List
Provides a pageable list of jobs.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs?api-version=2024-10-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs?api-version=2024-10-01&$filter={$filter}&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group where the recovery services vault is present. |
subscription
|
path | True |
string |
The subscription Id. |
vault
|
path | True |
string |
The name of the recovery services vault. |
api-version
|
query | True |
string |
Client Api Version. |
$filter
|
query |
string |
OData filter options. |
|
$skip
|
query |
string |
skipToken Filter. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account. |
Examples
List All Jobs |
List Jobs With Filters |
List Jobs With Time Filter |
List All Jobs
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs?api-version=2024-10-01
Sample response
{
"value": [
{
"id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.RecoveryServices/vaults/backupJobs",
"properties": {
"jobType": "AzureIaaSVMJob",
"duration": "PT12.4272909S",
"virtualMachineVersion": "Compute",
"entityFriendlyName": "testvm",
"backupManagementType": "AzureIaasVM",
"operation": "Backup",
"status": "InProgress",
"startTime": "2017-08-03T05:31:07.014604Z",
"activityId": "00000000-0000-0000-0000-000000000000"
}
},
{
"id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.RecoveryServices/vaults/backupJobs",
"properties": {
"jobType": "AzureIaaSVMJob",
"duration": "PT31.3066291S",
"virtualMachineVersion": "Compute",
"entityFriendlyName": "testvm",
"backupManagementType": "AzureIaasVM",
"operation": "ConfigureBackup",
"status": "Completed",
"startTime": "2017-08-03T05:30:32.4487085Z",
"endTime": "2017-08-03T05:31:03.7553376Z",
"activityId": "00000000-0000-0000-0000-000000000000"
}
}
]
}
List Jobs With Filters
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs?api-version=2024-10-01&$filter=startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM' and operation eq 'Backup' and backupManagementType eq 'AzureIaasVM' and status eq 'InProgress'
Sample response
{
"value": [
{
"id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.RecoveryServices/vaults/backupJobs",
"properties": {
"jobType": "AzureIaaSVMJob",
"duration": "PT12.4272909S",
"virtualMachineVersion": "Compute",
"entityFriendlyName": "testvm",
"backupManagementType": "AzureIaasVM",
"operation": "Backup",
"status": "InProgress",
"startTime": "2017-08-03T05:31:07.014604Z",
"activityId": "00000000-0000-0000-0000-000000000000"
}
}
]
}
List Jobs With Time Filter
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs?api-version=2024-10-01&$filter=startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM'
Sample response
{
"value": [
{
"id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.RecoveryServices/vaults/backupJobs",
"properties": {
"jobType": "AzureIaaSVMJob",
"duration": "PT12.4272909S",
"virtualMachineVersion": "Compute",
"entityFriendlyName": "testvm",
"backupManagementType": "AzureIaasVM",
"operation": "Backup",
"status": "InProgress",
"startTime": "2017-08-03T05:31:07.014604Z",
"activityId": "00000000-0000-0000-0000-000000000000"
}
},
{
"id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.RecoveryServices/vaults/backupJobs",
"properties": {
"jobType": "AzureIaaSVMJob",
"duration": "PT31.3066291S",
"virtualMachineVersion": "Compute",
"entityFriendlyName": "testvm",
"backupManagementType": "AzureIaasVM",
"operation": "ConfigureBackup",
"status": "Completed",
"startTime": "2017-08-03T05:30:32.4487085Z",
"endTime": "2017-08-03T05:31:03.7553376Z",
"activityId": "00000000-0000-0000-0000-000000000000"
}
}
],
"nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs?api-version=2017-07-01&%24filter=startTime+eq+%272016-01-01+00%3a00%3a00+AM%27+and+endTime+eq+%272017-11-29+00%3a00%3a00+AM%27&%24skiptoken=%3c%3fxml+version%3d%221.0%22+encoding%3d%22utf-16%22%3f%3e%0d%0a%3cContinuationToken%3e%0d%0a++%3cContinuationToken%3e%0d%0a++++%3cVersion%3e2.0%3c%2fVersion%3e%0d%0a++++%3cType%3eTable%3c%2fType%3e%0d%0a++++%3cNextPartitionKey%3e1!28!NzI5MTk0OTM1MDkwNjEwODQzMA--%3c%2fNextPartitionKey%3e%0d%0a++++%3cNextRowKey%3e1!108!am9ic3N0YXJ0dGltZWluZGV4XzBfMjUxODkxNDYzNTI2NjE5Nzg5OF8wXzYwOWZkM2JmLTU4MzctNDFkYi1iMjExLTY1MzliNDNlZjM1OA--%3c%2fNextRowKey%3e%0d%0a++++%3cTargetLocation%3ePrimary%3c%2fTargetLocation%3e%0d%0a++%3c%2fContinuationToken%3e%0d%0a%3c%2fContinuationToken%3e"
}
Definitions
Name | Description |
---|---|
Azure |
Azure IaaS VM workload-specific error information. |
Azure |
Azure IaaS VM workload-specific job object. |
Azure |
Azure IaaS VM workload-specific additional information for job. |
Azure |
Azure IaaS VM workload-specific job task details. |
Azure |
Azure IaaS VM workload-specific job object. |
Azure |
Azure storage specific error information |
Azure |
Azure storage specific job. |
Azure |
Azure Storage workload-specific additional information for job. |
Azure |
Azure storage workload specific job task details. |
Azure |
Azure storage specific error information |
Azure |
Azure storage specific job. |
Azure |
Azure VM workload-specific additional information for job. |
Azure |
Azure VM workload specific job task details. |
Backup |
Type of backup management for the backed up item. |
Cloud |
An error response from the Container Instance service. |
Cloud |
An error response from the Container Instance service. |
Dpm |
DPM workload-specific error information. |
Dpm |
DPM workload-specific job object. |
Dpm |
Additional information on the DPM workload-specific job. |
Dpm |
DPM workload-specific job task details. |
Error |
The resource management error additional info. |
Job |
Defines workload agnostic properties for a job. |
Job |
List of Job resources |
Job |
Gets or sets the state/actions applicable on this job like cancel/retry. |
Mab |
MAB workload-specific error information. |
Mab |
MAB workload-specific job. |
Mab |
Additional information for the MAB workload-specific job. |
Mab |
MAB workload-specific job task details. |
Mab |
Server type of MAB container. |
Vault |
Vault level Job |
Vault |
Vault Job specific error information |
Vault |
Vault Job for CMK - has CMK specific info. |
Workload |
Type of workload for the backup management |
AzureIaaSVMErrorInfo
Azure IaaS VM workload-specific error information.
Name | Type | Description |
---|---|---|
errorCode |
integer (int32) |
Error code. |
errorString |
string |
Localized error string. |
errorTitle |
string |
Title: Typically, the entity that the error pertains to. |
recommendations |
string[] |
List of localized recommendations for above error code. |
AzureIaaSVMJob
Azure IaaS VM workload-specific job object.
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
containerName |
string |
Container name of the entity on which the current job is executing. |
duration |
string (duration) |
Time elapsed during the execution of this job. |
endTime |
string (date-time) |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information for this job. |
|
isUserTriggered |
boolean |
Indicated that whether the job is adhoc(true) or scheduled(false) |
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string (date-time) |
The start time. |
status |
string |
Job status. |
virtualMachineVersion |
string |
Specifies whether the backup item is a Classic or an Azure Resource Manager VM. |
AzureIaaSVMJobExtendedInfo
Azure IaaS VM workload-specific additional information for job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
estimatedRemainingDuration |
string |
Time remaining for execution of this job. |
internalPropertyBag |
object |
Job internal properties. |
progressPercentage |
number (double) |
Indicates progress of the job. Null if it has not started or completed. |
propertyBag |
object |
Job properties. |
tasksList |
List of tasks associated with this job. |
AzureIaaSVMJobTaskDetails
Azure IaaS VM workload-specific job task details.
Name | Type | Description |
---|---|---|
duration |
string (duration) |
Time elapsed for task. |
endTime |
string (date-time) |
The end time. |
instanceId |
string |
The instanceId. |
progressPercentage |
number (double) |
Progress of the task. |
startTime |
string (date-time) |
The start time. |
status |
string |
The status. |
taskExecutionDetails |
string |
Details about execution of the task. eg: number of bytes transferred etc |
taskId |
string |
The task display name. |
AzureIaaSVMJobV2
Azure IaaS VM workload-specific job object.
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
containerName |
string |
Container name of the entity on which the current job is executing. |
duration |
string (duration) |
Time elapsed during the execution of this job. |
endTime |
string (date-time) |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information for this job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string (date-time) |
The start time. |
status |
string |
Job status. |
virtualMachineVersion |
string |
Specifies whether the backup item is a Classic or an Azure Resource Manager VM. |
AzureStorageErrorInfo
Azure storage specific error information
Name | Type | Description |
---|---|---|
errorCode |
integer (int32) |
Error code. |
errorString |
string |
Localized error string. |
recommendations |
string[] |
List of localized recommendations for above error code. |
AzureStorageJob
Azure storage specific job.
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string (duration) |
Time elapsed during the execution of this job. |
endTime |
string (date-time) |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information about the job. |
|
isUserTriggered |
boolean |
Indicated that whether the job is adhoc(true) or scheduled(false) |
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string (date-time) |
The start time. |
status |
string |
Job status. |
storageAccountName |
string |
Specifies friendly name of the storage account. |
storageAccountVersion |
string |
Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage account. |
AzureStorageJobExtendedInfo
Azure Storage workload-specific additional information for job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
propertyBag |
object |
Job properties. |
tasksList |
List of tasks for this job |
AzureStorageJobTaskDetails
Azure storage workload specific job task details.
Name | Type | Description |
---|---|---|
status |
string |
The status. |
taskId |
string |
The task display name. |
AzureWorkloadErrorInfo
Azure storage specific error information
Name | Type | Description |
---|---|---|
additionalDetails |
string |
Additional details for above error code. |
errorCode |
integer (int32) |
Error code. |
errorString |
string |
Localized error string. |
errorTitle |
string |
Title: Typically, the entity that the error pertains to. |
recommendations |
string[] |
List of localized recommendations for above error code. |
AzureWorkloadJob
Azure storage specific job.
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string (duration) |
Time elapsed during the execution of this job. |
endTime |
string (date-time) |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information about the job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string (date-time) |
The start time. |
status |
string |
Job status. |
workloadType |
string |
Workload type of the job |
AzureWorkloadJobExtendedInfo
Azure VM workload-specific additional information for job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
propertyBag |
object |
Job properties. |
tasksList |
List of tasks for this job |
AzureWorkloadJobTaskDetails
Azure VM workload specific job task details.
Name | Type | Description |
---|---|---|
status |
string |
The status. |
taskId |
string |
The task display name. |
BackupManagementType
Type of backup management for the backed up item.
Value | Description |
---|---|
Invalid | |
AzureIaasVM | |
MAB | |
DPM | |
AzureBackupServer | |
AzureSql | |
AzureStorage | |
AzureWorkload | |
DefaultBackup |
CloudError
An error response from the Container Instance service.
Name | Type | Description |
---|---|---|
error |
The error object. |
CloudErrorBody
An error response from the Container Instance service.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
DpmErrorInfo
DPM workload-specific error information.
Name | Type | Description |
---|---|---|
errorString |
string |
Localized error string. |
recommendations |
string[] |
List of localized recommendations for above error code. |
DpmJob
DPM workload-specific job object.
Name | Type | Description |
---|---|---|
actionsInfo |
The state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
containerName |
string |
Name of cluster/server protecting current backup item, if any. |
containerType |
string |
Type of container. |
dpmServerName |
string |
DPM server name managing the backup item or backup job. |
duration |
string (duration) |
Time elapsed for job. |
endTime |
string (date-time) |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
The errors. |
|
extendedInfo |
Additional information for this job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string (date-time) |
The start time. |
status |
string |
Job status. |
workloadType |
string |
Type of backup item. |
DpmJobExtendedInfo
Additional information on the DPM workload-specific job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
propertyBag |
object |
The job properties. |
tasksList |
List of tasks associated with this job. |
DpmJobTaskDetails
DPM workload-specific job task details.
Name | Type | Description |
---|---|---|
duration |
string (duration) |
Time elapsed for task. |
endTime |
string (date-time) |
The end time. |
startTime |
string (date-time) |
The start time. |
status |
string |
The status. |
taskId |
string |
The task display name. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
JobResource
Defines workload agnostic properties for a job.
Name | Type | Description |
---|---|---|
eTag |
string |
Optional ETag. |
id |
string |
Resource Id represents the complete path to the resource. |
location |
string |
Resource location. |
name |
string |
Resource name associated with the resource. |
properties | Job: |
JobResource properties |
tags |
object |
Resource tags. |
type |
string |
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... |
JobResourceList
List of Job resources
Name | Type | Description |
---|---|---|
nextLink |
string |
The URI to fetch the next page of resources, with each API call returning up to 200 resources per page. Use ListNext() to fetch the next page if the total number of resources exceeds 200. |
value |
List of resources. |
JobSupportedAction
Gets or sets the state/actions applicable on this job like cancel/retry.
Value | Description |
---|---|
Invalid | |
Cancellable | |
Retriable |
MabErrorInfo
MAB workload-specific error information.
Name | Type | Description |
---|---|---|
errorString |
string |
Localized error string. |
recommendations |
string[] |
List of localized recommendations. |
MabJob
MAB workload-specific job.
Name | Type | Description |
---|---|---|
actionsInfo |
The state/actions applicable on jobs like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string (duration) |
Time taken by job to run. |
endTime |
string (date-time) |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
The errors. |
|
extendedInfo |
Additional information on the job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
mabServerName |
string |
Name of server protecting the DS. |
mabServerType |
Server type of MAB container. |
|
operation |
string |
The operation name. |
startTime |
string (date-time) |
The start time. |
status |
string |
Job status. |
workloadType |
Workload type of backup item. |
MabJobExtendedInfo
Additional information for the MAB workload-specific job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message specific to this job. |
propertyBag |
object |
The job properties. |
tasksList |
List of tasks for this job. |
MabJobTaskDetails
MAB workload-specific job task details.
Name | Type | Description |
---|---|---|
duration |
string (duration) |
Time elapsed for task. |
endTime |
string (date-time) |
The end time. |
startTime |
string (date-time) |
The start time. |
status |
string |
The status. |
taskId |
string |
The task display name. |
MabServerType
Server type of MAB container.
Value | Description |
---|---|
Invalid | |
Unknown | |
IaasVMContainer | |
IaasVMServiceContainer | |
DPMContainer | |
AzureBackupServerContainer | |
MABContainer | |
Cluster | |
AzureSqlContainer | |
Windows | |
VCenter | |
VMAppContainer | |
SQLAGWorkLoadContainer | |
StorageContainer | |
GenericContainer |
VaultJob
Vault level Job
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string (duration) |
Time elapsed during the execution of this job. |
endTime |
string (date-time) |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information about the job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string (date-time) |
The start time. |
status |
string |
Job status. |
VaultJobErrorInfo
Vault Job specific error information
Name | Type | Description |
---|---|---|
errorCode |
integer (int32) |
Error code. |
errorString |
string |
Localized error string. |
recommendations |
string[] |
List of localized recommendations for above error code. |
VaultJobExtendedInfo
Vault Job for CMK - has CMK specific info.
Name | Type | Description |
---|---|---|
propertyBag |
object |
Job properties. |
WorkloadType
Type of workload for the backup management
Value | Description |
---|---|
Invalid | |
VM | |
FileFolder | |
AzureSqlDb | |
SQLDB | |
Exchange | |
Sharepoint | |
VMwareVM | |
SystemState | |
Client | |
GenericDataSource | |
SQLDataBase | |
AzureFileShare | |
SAPHanaDatabase | |
SAPAseDatabase | |
SAPHanaDBInstance |