Share via


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=2025-08-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

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

minLength: 1

The ID of the target subscription.

vaultName
path True

string

The name of the VaultResource

api-version
query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

JobResource

Azure operation completed successfully.

Other Status Codes

ErrorResponse

An unexpected error response.

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=2025-08-01

Sample response

{
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.RecoveryServices/vaults/backupJobs",
  "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000",
  "properties": {
    "activityId": "00000000-0000-0000-0000-000000000000",
    "backupManagementType": "AzureIaasVM",
    "duration": "PT9.8782791S",
    "entityFriendlyName": "testvm",
    "extendedInfo": {
      "propertyBag": {
        "VM Name": "testvm"
      },
      "tasksList": [
        {
          "duration": "PT0S",
          "status": "InProgress",
          "taskId": "Take Snapshot"
        },
        {
          "duration": "PT0S",
          "status": "NotStarted",
          "taskId": "Transfer data to vault"
        }
      ]
    },
    "jobType": "AzureIaaSVMJob",
    "operation": "Backup",
    "startTime": "2017-08-03T05:31:07.014604Z",
    "status": "InProgress",
    "virtualMachineVersion": "Compute"
  }
}

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

Backup management type to execute the current job.

createdByType

The type of identity that created the resource.

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.

ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.

ErrorResponse

Error response

JobResource

Defines workload agnostic properties for a job.

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

systemData

Metadata pertaining to creation and last modification of the resource.

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

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

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

AzureIaaSVMJobTaskDetails[]

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

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

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

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

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

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

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

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

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

Backup management type to execute the current job.

Value Description
Invalid
AzureIaasVM
MAB
DPM
AzureBackupServer
AzureSql
AzureStorage
AzureWorkload
DefaultBackup

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

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

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

DpmJobTaskDetails[]

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.

ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.

Name Type Description
code

string

Error code.

message

string

Error Message related to the Code.

recommendations

string[]

List of recommendation strings.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

JobResource

Defines workload agnostic properties for a job.

Name Type Description
eTag

string

Optional ETag.

id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties Job:

JobResource properties

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

JobSupportedAction

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

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

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 (date-time)

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

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

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

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