Job Details - Get

Service:

Recovery Services - Backup

API Version:

2024-04-01

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=2024-04-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

HTTP

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=2024-04-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicesbackup.activestamp import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python get_job_details.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.job_details.get(
        vault_name="NetSDKTestRsVault",
        resource_group_name="SwaggerTestRg",
        job_name="00000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Common/GetJobDetails.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/33c4457b1d13f83965f4fe3367dca4a6df898100/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Common/GetJobDetails.json
func ExampleJobDetailsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewJobDetailsClient().Get(ctx, "NetSDKTestRsVault", "SwaggerTestRg", "00000000-0000-0000-0000-000000000000", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.JobResource = armrecoveryservicesbackup.JobResource{
	// 	Name: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults/backupJobs"),
	// 	ID: to.Ptr("/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000"),
	// 	Properties: &armrecoveryservicesbackup.AzureIaaSVMJob{
	// 		ActivityID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		BackupManagementType: to.Ptr(armrecoveryservicesbackup.BackupManagementTypeAzureIaasVM),
	// 		EntityFriendlyName: to.Ptr("testvm"),
	// 		JobType: to.Ptr("AzureIaaSVMJob"),
	// 		Operation: to.Ptr("Backup"),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-03T05:31:07.014Z"); return t}()),
	// 		Status: to.Ptr("InProgress"),
	// 		Duration: to.Ptr("PT9.8782791S"),
	// 		ExtendedInfo: &armrecoveryservicesbackup.AzureIaaSVMJobExtendedInfo{
	// 			PropertyBag: map[string]*string{
	// 				"VM Name": to.Ptr("testvm"),
	// 			},
	// 			TasksList: []*armrecoveryservicesbackup.AzureIaaSVMJobTaskDetails{
	// 				{
	// 					Duration: to.Ptr("PT0S"),
	// 					Status: to.Ptr("InProgress"),
	// 					TaskID: to.Ptr("Take Snapshot"),
	// 				},
	// 				{
	// 					Duration: to.Ptr("PT0S"),
	// 					Status: to.Ptr("NotStarted"),
	// 					TaskID: to.Ptr("Transfer data to vault"),
	// 			}},
	// 		},
	// 		VirtualMachineVersion: to.Ptr("Compute"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets extended information associated with the job.
 *
 * @summary Gets extended information associated with the job.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/Common/GetJobDetails.json
 */
async function getJobDetails() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "NetSDKTestRsVault";
  const resourceGroupName = process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "SwaggerTestRg";
  const jobName = "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.jobDetails.get(vaultName, resourceGroupName, jobName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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: AzureIaaSVMJob AzureIaaSVMJobV2 AzureStorageJob AzureWorkloadJob DpmJob MabJob VaultJob	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