JobDetails interface

  • Reference
Package:
@azure/arm-storageimportexport

Specifies the job properties

Properties

backupDriveManifest

Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancelRequested

Indicates whether a request has been submitted to cancel the job.
deliveryPackage

Contains information about the package being shipped by the customer to the Microsoft data center.
diagnosticsPath

The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
driveList

List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.
encryptionKey

Contains information about the encryption key.
export

A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
incompleteBlobListUri

A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.
jobType

The type of job
logLevel

Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percentComplete

Overall percentage completed for the job.
provisioningState

Specifies the provisioning state of the job.
returnAddress

Specifies the return address information for the job.
returnPackage

Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
returnShipping

Specifies the return carrier and customer's account with the carrier.
shippingInformation

Contains information about the Microsoft datacenter to which the drives should be shipped.
state

Current state of the job.
storageAccountId

The resource identifier of the storage account where data will be imported to or exported from.

Property Details

backupDriveManifest

Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.

backupDriveManifest?: boolean

Property Value

boolean

cancelRequested

Indicates whether a request has been submitted to cancel the job.

cancelRequested?: boolean

Property Value

boolean

deliveryPackage

Contains information about the package being shipped by the customer to the Microsoft data center.

deliveryPackage?: DeliveryPackageInformation

Property Value

DeliveryPackageInformation

diagnosticsPath

The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.

diagnosticsPath?: string

Property Value

string

driveList

List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.

driveList?: DriveStatus[]

Property Value

DriveStatus[]

encryptionKey

Contains information about the encryption key.

encryptionKey?: EncryptionKeyDetails

Property Value

EncryptionKeyDetails

export

A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.

export?: Export

Property Value

Export

incompleteBlobListUri

A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.

incompleteBlobListUri?: string

Property Value

string

jobType

The type of job

jobType?: string

Property Value

string

logLevel

Default value is Error. Indicates whether error logging or verbose logging will be enabled.

logLevel?: string

Property Value

string

percentComplete

Overall percentage completed for the job.

percentComplete?: number

Property Value

number

provisioningState

Specifies the provisioning state of the job.

provisioningState?: string

Property Value

string

returnAddress

Specifies the return address information for the job.

returnAddress?: ReturnAddress

Property Value

ReturnAddress

returnPackage

Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.

returnPackage?: PackageInformation

Property Value

PackageInformation

returnShipping

Specifies the return carrier and customer's account with the carrier.

returnShipping?: ReturnShipping

Property Value

ReturnShipping

shippingInformation

Contains information about the Microsoft datacenter to which the drives should be shipped.

shippingInformation?: ShippingInformation

Property Value

ShippingInformation

state

Current state of the job.

state?: string

Property Value

string

storageAccountId

The resource identifier of the storage account where data will be imported to or exported from.

storageAccountId?: string

Property Value

string