Jobs - Get

Service:

Data Protection

API Version:

2023-01-01

Gets a job with id in a backup vault

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}?api-version=2023-01-01

URI Parameters

Name	In	Required	Type	Description
jobId	path	True	string	The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
vaultName	path	True	string	The name of the backup vault.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AzureBackupJobResource	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

Sample Request

HTTP

GET https://management.azure.com/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae?api-version=2023-01-01

Java

/** Samples for Jobs Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
     */
    /**
     * Sample code: Get Job.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void getJob(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .jobs()
            .getWithResponse(
                "BugBash1",
                "BugBashVaultForCCYv11",
                "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python get_job.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 = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="62b829ee-7936-40c9-a1c9-47a93f9f3965",
    )

    response = client.jobs.get(
        resource_group_name="BugBash1",
        vault_name="BugBashVaultForCCYv11",
        job_id="3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
    )
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.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 armdataprotection_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
func ExampleJobsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewJobsClient().Get(ctx, "BugBash1", "BugBashVaultForCCYv11", "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", 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.AzureBackupJobResource = armdataprotection.AzureBackupJobResource{
	// 	Name: to.Ptr("3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 	Type: to.Ptr("Microsoft.DataProtection/Backupvaults/backupJobs"),
	// 	ID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// 	Properties: &armdataprotection.AzureBackupJob{
	// 		ActivityID: to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
	// 		BackupInstanceFriendlyName: to.Ptr("mabtestingccybasicv11\\bugbashdb2"),
	// 		BackupInstanceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e"),
	// 		DataSourceID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2"),
	// 		DataSourceLocation: to.Ptr("centraluseuap"),
	// 		DataSourceName: to.Ptr("bugbashdb2"),
	// 		DataSourceSetName: to.Ptr("mabtestingccybasicv11"),
	// 		DataSourceType: to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
	// 		Duration: to.Ptr("00:00:00"),
	// 		ExtendedInfo: &armdataprotection.JobExtendedInfo{
	// 			AdditionalDetails: map[string]*string{
	// 				"PolicyRuleName": to.Ptr("BackupWeekly"),
	// 				"RetentionTag": to.Ptr("Default"),
	// 				"TaskId": to.Ptr("c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"),
	// 			},
	// 			SubTasks: []*armdataprotection.JobSubTask{
	// 				{
	// 					TaskID: to.Ptr[int32](1),
	// 					TaskName: to.Ptr("Trigger Backup"),
	// 					TaskStatus: to.Ptr("Started"),
	// 			}},
	// 		},
	// 		IsUserTriggered: to.Ptr(false),
	// 		Operation: to.Ptr("Backup"),
	// 		OperationCategory: to.Ptr("Backup"),
	// 		PolicyID: to.Ptr("/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy"),
	// 		PolicyName: to.Ptr("jakavetdailypolicy"),
	// 		ProgressEnabled: to.Ptr(false),
	// 		SourceResourceGroup: to.Ptr("DppPostgresTestingCcy"),
	// 		SourceSubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-17T03:00:03.7604146Z"); return t}()),
	// 		Status: to.Ptr("Started"),
	// 		SubscriptionID: to.Ptr("62b829ee-7936-40c9-a1c9-47a93f9f3965"),
	// 		SupportedActions: []*string{
	// 		},
	// 		VaultName: to.Ptr("BugBashVaultForCCYv11"),
	// 	},
	// }
}

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 { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a job with id in a backup vault
 *
 * @summary Gets a job with id in a backup vault
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
 */
async function getJob() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "62b829ee-7936-40c9-a1c9-47a93f9f3965";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "BugBash1";
  const vaultName = "BugBashVaultForCCYv11";
  const jobId = "3c60cb49-63e8-4b21-b9bd-26277b3fdfae";
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.jobs.get(resourceGroupName, vaultName, jobId);
  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

{
  "properties": {
    "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
    "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
    "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
    "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
    "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
    "vaultName": "BugBashVaultForCCYv11",
    "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
    "policyName": "jakavetdailypolicy",
    "sourceResourceGroup": "DppPostgresTestingCcy",
    "dataSourceSetName": "mabtestingccybasicv11",
    "dataSourceName": "bugbashdb2",
    "progressEnabled": false,
    "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
    "startTime": "2021-03-17T03:00:03.7604146Z",
    "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
    "operationCategory": "Backup",
    "operation": "Backup",
    "status": "Started",
    "isUserTriggered": false,
    "supportedActions": [],
    "duration": "00:00:00",
    "dataSourceLocation": "centraluseuap",
    "extendedInfo": {
      "subTasks": [
        {
          "taskId": 1,
          "taskName": "Trigger Backup",
          "taskStatus": "Started"
        }
      ],
      "additionalDetails": {
        "RetentionTag": "Default",
        "PolicyRuleName": "BackupWeekly",
        "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"
      }
    }
  },
  "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
}

Definitions

Name	Description
AzureBackupJob	AzureBackup Job Class
AzureBackupJobResource	AzureBackup Job Resource Class
CloudError	CloudError
createdByType	The type of identity that created the resource.
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
InnerError	InnerError
JobExtendedInfo	Extended Information about the job
JobSubTask	Details of Job's Sub Task
RestoreJobRecoveryPointDetails
systemData	Metadata pertaining to creation and last modification of the resource.
UserFacingError	Error object used by layers that have access to localized content, and propagate that to user

AzureBackupJob

AzureBackup Job Class

Name	Type	Description
activityID	string	Job Activity Id
backupInstanceFriendlyName	string	Name of the Backup Instance
backupInstanceId	string	ARM ID of the Backup Instance
dataSourceId	string	ARM ID of the DataSource
dataSourceLocation	string	Location of the DataSource
dataSourceName	string	User Friendly Name of the DataSource
dataSourceSetName	string	Data Source Set Name of the DataSource
dataSourceType	string	Type of DataSource
destinationDataStoreName	string
duration	string	Total run time of the job. ISO 8601 format.
endTime	string	EndTime of the job(in UTC)
errorDetails	UserFacingError[]	A List, detailing the errors related to the job
etag	string
extendedInfo	JobExtendedInfo	Extended Information about the job
isUserTriggered	boolean	Indicated that whether the job is adhoc(true) or scheduled(false)
operation	string	It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure
operationCategory	string	It indicates the type of Job i.e. Backup/Restore/Tiering/Management
policyId	string	ARM ID of the policy
policyName	string	Name of the policy
progressEnabled	boolean	Indicated whether progress is enabled for the job
progressUrl	string	Url which contains job's progress
restoreType	string	It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR
sourceDataStoreName	string
sourceResourceGroup	string	Resource Group Name of the Datasource
sourceSubscriptionID	string	SubscriptionId corresponding to the DataSource
startTime	string	StartTime of the job(in UTC)
status	string	Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning
subscriptionId	string	Subscription Id of the corresponding backup vault
supportedActions	string[]	List of supported actions
vaultName	string	Name of the vault

AzureBackupJobResource

AzureBackup Job Resource Class

Name	Type	Description
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties	AzureBackupJob	AzureBackupJobResource properties
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

CloudError

CloudError

Name	Type	Description
error	Error	The resource management error response.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Error[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

InnerError

InnerError

Name	Type	Description
additionalInfo	object	Any Key value pairs that can be provided to the client for additional verbose information.
code	string	Unique code for this error
embeddedInnerError	InnerError	InnerError Child Inner Error, to allow Nesting.

JobExtendedInfo

Extended Information about the job

Name	Type	Description
additionalDetails	object	Job's Additional Details
backupInstanceState	string	State of the Backup Instance
dataTransferredInBytes	number	Number of bytes transferred
recoveryDestination	string	Destination where restore is done
sourceRecoverPoint	RestoreJobRecoveryPointDetails	Details of the Source Recovery Point
subTasks	JobSubTask[]	List of Sub Tasks of the job
targetRecoverPoint	RestoreJobRecoveryPointDetails	Details of the Target Recovery Point

JobSubTask

Details of Job's Sub Task

Name	Type	Description
additionalDetails	object	Additional details of Sub Tasks
taskId	integer	Task Id of the Sub Task
taskName	string	Name of the Sub Task
taskProgress	string	Progress of the Sub Task
taskStatus	string	Status of the Sub Task

RestoreJobRecoveryPointDetails

Name	Type	Description
recoveryPointID	string
recoveryPointTime	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	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	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.

UserFacingError

Error object used by layers that have access to localized content, and propagate that to user

Name	Type	Description
code	string	Unique code for this error
details	UserFacingError[]	Additional related Errors
innerError	InnerError	InnerError Inner Error
isRetryable	boolean	Whether the operation will be retryable or not
isUserError	boolean	Whether the operation is due to a user error or service error
message	string
properties	object	Any key value pairs that can be injected inside error object
recommendedAction	string[]	RecommendedAction � localized.
target	string	Target of the error.