Job Details - Get

Gets extended information associated with the job.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}?api-version=2023-02-01

URI Parameters

Name In Required Type Description
jobName
path True

string

Name of the job whose details are to be fetched.

resourceGroupName
path True

string

The name of the resource group where the recovery services vault is present.

subscriptionId
path True

string

The subscription Id.

vaultName
path True

string

The name of the recovery services vault.

api-version
query True

string

Client Api Version.

Responses

Name Type Description
200 OK

JobResource

OK

Other Status Codes

CloudError

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

Get Job Details

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000?api-version=2023-02-01

Sample Response

{
  "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": "PT9.8782791S",
    "virtualMachineVersion": "Compute",
    "extendedInfo": {
      "tasksList": [
        {
          "taskId": "Take Snapshot",
          "duration": "PT0S",
          "status": "InProgress"
        },
        {
          "taskId": "Transfer data to vault",
          "duration": "PT0S",
          "status": "NotStarted"
        }
      ],
      "propertyBag": {
        "VM Name": "testvm"
      }
    },
    "entityFriendlyName": "testvm",
    "backupManagementType": "AzureIaasVM",
    "operation": "Backup",
    "status": "InProgress",
    "startTime": "2017-08-03T05:31:07.014604Z",
    "activityId": "00000000-0000-0000-0000-000000000000"
  }
}

Definitions

Name Description
AzureIaaSVMErrorInfo

Azure IaaS VM workload-specific error information.

AzureIaaSVMJob

Azure IaaS VM workload-specific job object.

AzureIaaSVMJobExtendedInfo

Azure IaaS VM workload-specific additional information for job.

AzureIaaSVMJobTaskDetails

Azure IaaS VM workload-specific job task details.

AzureIaaSVMJobV2

Azure IaaS VM workload-specific job object.

AzureStorageErrorInfo

Azure storage specific error information

AzureStorageJob

Azure storage specific job.

AzureStorageJobExtendedInfo

Azure Storage workload-specific additional information for job.

AzureStorageJobTaskDetails

Azure storage workload specific job task details.

AzureWorkloadErrorInfo

Azure storage specific error information

AzureWorkloadJob

Azure storage specific job.

AzureWorkloadJobExtendedInfo

Azure VM workload-specific additional information for job.

AzureWorkloadJobTaskDetails

Azure VM workload specific job task details.

BackupManagementType

Type of backup management for the backed up item.

CloudError

An error response from the Container Instance service.

CloudErrorBody

An error response from the Container Instance service.

DpmErrorInfo

DPM workload-specific error information.

DpmJob

DPM workload-specific job object.

DpmJobExtendedInfo

Additional information on the DPM workload-specific job.

DpmJobTaskDetails

DPM workload-specific job task details.

ErrorAdditionalInfo

The resource management error additional info.

JobResource

Defines workload agnostic properties for a job.

JobSupportedAction

Gets or sets the state/actions applicable on this job like cancel/retry.

MabErrorInfo

MAB workload-specific error information.

MabJob

MAB workload-specific job.

MabJobExtendedInfo

Additional information for the MAB workload-specific job.

MabJobTaskDetails

MAB workload-specific job task details.

MabServerType

Server type of MAB container.

VaultJob

Vault level Job

VaultJobErrorInfo

Vault Job specific error information

VaultJobExtendedInfo

Vault Job for CMK - has CMK specific info.

WorkloadType

Type of workload for the backup management

AzureIaaSVMErrorInfo

Azure IaaS VM workload-specific error information.

Name Type Description
errorCode

integer

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

JobSupportedAction[]

Gets or sets the state/actions applicable on this job like cancel/retry.

activityId

string

ActivityId of job.

backupManagementType

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

Time elapsed during the execution of this job.

endTime

string

The end time.

entityFriendlyName

string

Friendly name of the entity on which the current job is executing.

errorDetails

AzureIaaSVMErrorInfo[]

Error details on execution of this job.

extendedInfo

AzureIaaSVMJobExtendedInfo

Additional information for this job.

isUserTriggered

boolean

Indicated that whether the job is adhoc(true) or scheduled(false)

jobType string:

AzureIaaSVMJob

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

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

Indicates progress of the job. Null if it has not started or completed.

propertyBag

object

Job properties.

tasksList

AzureIaaSVMJobTaskDetails[]

List of tasks associated with this job.

AzureIaaSVMJobTaskDetails

Azure IaaS VM workload-specific job task details.

Name Type Description
duration

string

Time elapsed for task.

endTime

string

The end time.

instanceId

string

The instanceId.

progressPercentage

number

Progress of the task.

startTime

string

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

JobSupportedAction[]

Gets or sets the state/actions applicable on this job like cancel/retry.

activityId

string

ActivityId of job.

backupManagementType

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

Time elapsed during the execution of this job.

endTime

string

The end time.

entityFriendlyName

string

Friendly name of the entity on which the current job is executing.

errorDetails

AzureIaaSVMErrorInfo[]

Error details on execution of this job.

extendedInfo

AzureIaaSVMJobExtendedInfo

Additional information for this job.

jobType string:

AzureIaaSVMJobV2

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

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

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

JobSupportedAction[]

Gets or sets the state/actions applicable on this job like cancel/retry.

activityId

string

ActivityId of job.

backupManagementType

BackupManagementType

Backup management type to execute the current job.

duration

string

Time elapsed during the execution of this job.

endTime

string

The end time.

entityFriendlyName

string

Friendly name of the entity on which the current job is executing.

errorDetails

AzureStorageErrorInfo[]

Error details on execution of this job.

extendedInfo

AzureStorageJobExtendedInfo

Additional information about the job.

isUserTriggered

boolean

Indicated that whether the job is adhoc(true) or scheduled(false)

jobType string:

AzureStorageJob

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

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

AzureStorageJobTaskDetails[]

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

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

JobSupportedAction[]

Gets or sets the state/actions applicable on this job like cancel/retry.

activityId

string

ActivityId of job.

backupManagementType

BackupManagementType

Backup management type to execute the current job.

duration

string

Time elapsed during the execution of this job.

endTime

string

The end time.

entityFriendlyName

string

Friendly name of the entity on which the current job is executing.

errorDetails

AzureWorkloadErrorInfo[]

Error details on execution of this job.

extendedInfo

AzureWorkloadJobExtendedInfo

Additional information about the job.

jobType string:

AzureWorkloadJob

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

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

AzureWorkloadJobTaskDetails[]

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.

Name Type Description
AzureBackupServer

string

AzureIaasVM

string

AzureSql

string

AzureStorage

string

AzureWorkload

string

DPM

string

DefaultBackup

string

Invalid

string

MAB

string

CloudError

An error response from the Container Instance service.

Name Type Description
error

CloudErrorBody

The error object.

CloudErrorBody

An error response from the Container Instance service.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

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

JobSupportedAction[]

The state/actions applicable on this job like cancel/retry.

activityId

string

ActivityId of job.

backupManagementType

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

Time elapsed for job.

endTime

string

The end time.

entityFriendlyName

string

Friendly name of the entity on which the current job is executing.

errorDetails

DpmErrorInfo[]

The errors.

extendedInfo

DpmJobExtendedInfo

Additional information for this job.

jobType string:

DpmJob

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

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

DpmJobTaskDetails[]

List of tasks associated with this job.

DpmJobTaskDetails

DPM workload-specific job task details.

Name Type Description
duration

string

Time elapsed for task.

endTime

string

The end time.

startTime

string

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

JobSupportedAction

Gets or sets the state/actions applicable on this job like cancel/retry.

Name Type Description
Cancellable

string

Invalid

string

Retriable

string

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

JobSupportedAction[]

The state/actions applicable on jobs like cancel/retry.

activityId

string

ActivityId of job.

backupManagementType

BackupManagementType

Backup management type to execute the current job.

duration

string

Time taken by job to run.

endTime

string

The end time.

entityFriendlyName

string

Friendly name of the entity on which the current job is executing.

errorDetails

MabErrorInfo[]

The errors.

extendedInfo

MabJobExtendedInfo

Additional information on the job.

jobType string:

MabJob

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

MabServerType

Server type of MAB container.

operation

string

The operation name.

startTime

string

The start time.

status

string

Job status.

workloadType

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

MabJobTaskDetails[]

List of tasks for this job.

MabJobTaskDetails

MAB workload-specific job task details.

Name Type Description
duration

string

Time elapsed for task.

endTime

string

The end time.

startTime

string

The start time.

status

string

The status.

taskId

string

The task display name.

MabServerType

Server type of MAB container.

Name Type Description
AzureBackupServerContainer

string

AzureSqlContainer

string

Cluster

string

DPMContainer

string

GenericContainer

string

IaasVMContainer

string

IaasVMServiceContainer

string

Invalid

string

MABContainer

string

SQLAGWorkLoadContainer

string

StorageContainer

string

Unknown

string

VCenter

string

VMAppContainer

string

Windows

string

VaultJob

Vault level Job

Name Type Description
actionsInfo

JobSupportedAction[]

Gets or sets the state/actions applicable on this job like cancel/retry.

activityId

string

ActivityId of job.

backupManagementType

BackupManagementType

Backup management type to execute the current job.

duration

string

Time elapsed during the execution of this job.

endTime

string

The end time.

entityFriendlyName

string

Friendly name of the entity on which the current job is executing.

errorDetails

VaultJobErrorInfo[]

Error details on execution of this job.

extendedInfo

VaultJobExtendedInfo

Additional information about the job.

jobType string:

VaultJob

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

The start time.

status

string

Job status.

VaultJobErrorInfo

Vault Job specific error information

Name Type Description
errorCode

integer

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

Name Type Description
AzureFileShare

string

AzureSqlDb

string

Client

string

Exchange

string

FileFolder

string

GenericDataSource

string

Invalid

string

SAPAseDatabase

string

SAPHanaDBInstance

string

SAPHanaDatabase

string

SQLDB

string

SQLDataBase

string

Sharepoint

string

SystemState

string

VM

string

VMwareVM

string