Share via

AzureBackupJob interface

Package:
@azure/arm-dataprotection

AzureBackup Job Class

Properties

activityID

Job Activity Id
backupInstanceFriendlyName

Name of the Backup Instance
backupInstanceId

ARM ID of the Backup Instance
dataSourceId

ARM ID of the DataSource
dataSourceLocation

Location of the DataSource
dataSourceName

User Friendly Name of the DataSource
dataSourceSetName

Data Source Set Name of the DataSource
dataSourceType

Type of DataSource
destinationDataStoreName
duration

Total run time of the job. ISO 8601 format.
endTime

EndTime of the job(in UTC)
errorDetails

A List, detailing the errors related to the job
etag
extendedInfo

Extended Information about the job
isUserTriggered

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

It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure
operationCategory

It indicates the type of Job i.e. Backup/Restore/Tiering/Management
policyId

ARM ID of the policy
policyName

Name of the policy
progressEnabled

Indicated whether progress is enabled for the job
progressUrl

Url which contains job's progress
rehydrationPriority

Priority to be used for rehydration
restoreType

It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR
sourceDataStoreName
sourceResourceGroup

Resource Group Name of the Datasource
sourceSubscriptionID

SubscriptionId corresponding to the DataSource
startTime

StartTime of the job(in UTC)
status

Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused
subscriptionId

Subscription Id of the corresponding backup vault
supportedActions

List of supported actions
vaultName

Name of the vault

Property Details

activityID

Job Activity Id

activityID: string

Property Value

string

backupInstanceFriendlyName

Name of the Backup Instance

backupInstanceFriendlyName: string

Property Value

string

backupInstanceId

ARM ID of the Backup Instance

backupInstanceId?: string

Property Value

string

dataSourceId

ARM ID of the DataSource

dataSourceId: string

Property Value

string

dataSourceLocation

Location of the DataSource

dataSourceLocation: string

Property Value

string

dataSourceName

User Friendly Name of the DataSource

dataSourceName: string

Property Value

string

dataSourceSetName

Data Source Set Name of the DataSource

dataSourceSetName?: string

Property Value

string

dataSourceType

Type of DataSource

dataSourceType: string

Property Value

string

destinationDataStoreName 

destinationDataStoreName?: string

Property Value

string

duration

Total run time of the job. ISO 8601 format.

duration?: string

Property Value

string

endTime

EndTime of the job(in UTC)

endTime?: Date

Property Value

Date

errorDetails

A List, detailing the errors related to the job

errorDetails?: UserFacingError[]

Property Value

UserFacingError[]

etag 

etag?: string

Property Value

string

extendedInfo

Extended Information about the job

extendedInfo?: JobExtendedInfo

Property Value

JobExtendedInfo

isUserTriggered

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

isUserTriggered: boolean

Property Value

boolean

operation

It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure

operation: string

Property Value

string

operationCategory

It indicates the type of Job i.e. Backup/Restore/Tiering/Management

operationCategory: string

Property Value

string

policyId

ARM ID of the policy

policyId?: string

Property Value

string

policyName

Name of the policy

policyName?: string

Property Value

string

progressEnabled

Indicated whether progress is enabled for the job

progressEnabled: boolean

Property Value

boolean

progressUrl

Url which contains job's progress

progressUrl?: string

Property Value

string

rehydrationPriority

Priority to be used for rehydration

rehydrationPriority?: string

Property Value

string

restoreType

It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR

restoreType?: string

Property Value

string

sourceDataStoreName 

sourceDataStoreName?: string

Property Value

string

sourceResourceGroup

Resource Group Name of the Datasource

sourceResourceGroup: string

Property Value

string

sourceSubscriptionID

SubscriptionId corresponding to the DataSource

sourceSubscriptionID: string

Property Value

string

startTime

StartTime of the job(in UTC)

startTime: Date

Property Value

Date

status

Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused

status: string

Property Value

string

subscriptionId

Subscription Id of the corresponding backup vault

subscriptionId: string

Property Value

string

supportedActions

List of supported actions

supportedActions: string[]

Property Value

string[]

vaultName

Name of the vault

vaultName: string

Property Value

string