Get details about a job

 

Jobs are created as part of different Recovery Services operations are triggered. Jobs are an async operation and are significant, that is, jobs can be tracked.

Request

The GET job can be specified as follows. The GET method lists all jobs or a particular Job -Id.

Method Request URI HTTP Version
GET https://<VaultUrl>/backupJobs?api-version=<api-version>
https://<VaultUrl>/backupJobs/{jobName}?api-version=<api-version>
https://<VaultUrl>/backupJobs/?api-version=<api-version>&$filter={filter parameters defined in Query Filters}
HTTP/1.1

Request Header:

Common request headers are described here.

Request Body:

None

Query Filters:

Supported query filters: status, operation, startTime, endTime, backupManagementType

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Response Header:

Common response headers are described here.

Response Body:

List of jobs.

Example Response:

{
  "value": [
    {
      "id": "/Subscriptions/{id}/resourceGroups/{groupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/4660518c-0f70-4633-b699-967b5a597cda",
      "name": " 4660518c-0f70-4633-b699-967b5a597cda",
      "type": "Microsoft.RecoveryServices/vaults/backupJobs",
      "properties": {
        "jobType": "AzureIaaSVMJob",
        "resourceId": "/subscriptions/{id}/resourceGroups/testRG/providers/Microsoft.ClassicCompute/virtualMachines/testVM",
        "backupManagementType": " AzureIaaSVM",
        "operation": "Backup",
        "status": "Completed",
        "startTime": "2015-12-02T01:02:18.3844187Z",
        "endTime": "2015-12-02T01:19:59.7300621Z",
        "duration": " 00:17:41.3456434",
        "actionsInfo": [ "Cancellable" ],
        "activityId": "595233D4-8704-499B-B723-A99487C12E02"
      }
    }
  ],
  "nextLink": "{originalRequestUrl}?$skipToken = {ContinuationToken}"
}

Get of a single job returns extended information.

{
  "id": "/Subscriptions/{id}/resourceGroups/{groupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/4660518c-0f70-4633-b699-967b5a597cda ",
  "name": "4660518c-0f70-4633-b699-967b5a597cda",
  "type": " Microsoft.RecoveryServices/vaults/backupJobs",
  "properties": {
    "jobType": "AzureIaaSVMJob",
    "resourceId": "/subscriptions/{id}/resourceGroups/testRG/providers/Microsoft.ClassicCompute/virtualMachines/testVM",
    "backupManagementType": "AzureIaaSVM",
    "operation": "Backup",
    "status": "Completed",
    "startTime": "2015-12-02T01:02:18.3844187Z",
    "endTime": "2015-12-02T01:19:59.7300621Z",
    "duration": "00:17:41.3456434",
    "actionsInfo": [ "Cancellable" ],
    "activityId": "595233D4-8704-499B-B723-A99487C12E02"
    "extendedInfo": {
      "tasksList": [
        {
          "taskDetailsType": "AzureIaaSVMJobTaskDetails",
          "taskId": "Take Snapshot",
          "duration": "00:00:00",
          "status": "Completed",
        },
        {
          "taskDetailsType": "AzureIaaSVMJobTaskDetails",
          "taskId": "Transfer data to Backup vault",
          "duration": "00:00:00",
          "status": "Completed",
        }
      ],
      "propertyBag": {
        "VM Name": "testVM",
        "Backup Size": "83 MB"
      },
    }
  }
}
Element name Description
name Required, string
Service generated unique name for job
jobType Required, string
Type of the job object, can have one of the following values: AzureIaaSVMJob (to be extended further).
entityFriendlyName Required, string
Friendly name of the entity on which the job is created
backupManagementType Optional, string
Type of the backup provider, can have one of the following values: AzureIaaSVM, MAB, DPM
operation Required, string
Type of the operation, can have one of the following values: Register, UnRegister, ConfigureBackup, Unprotect, DeleteBackupData, Backup, Restore
status Required, string
Job status can one of the following values: InProgress, Completed, Failed, CompletedWithWarnings, Cancelled, Cancelling
startTime Required, string
Start time of the job
endTime Required, string
End time of the job
duration Required: timespan
Duration of the job, either while it is running or the time it took to complete the job.
actionsInfo Required, List<string>
List of job supported actions. Actions can be one of the following values: Cancellable, Retriable
activityId Required, string
Id to facilitate debugging