JobResource interface

Package:

@azure/arm-databox

Job Resource.

Extends

Resource

Properties

cancellationReason	Reason for cancellation. NOTE: This property will not be serialized. It can only be populated by the server.
deliveryInfo	Delivery Info of Job.
deliveryType	Delivery type of Job.
details	Details of a job run. This field will only be sent for expand details filter.
error	Top level error for the job. NOTE: This property will not be serialized. It can only be populated by the server.
id	Id of the object. NOTE: This property will not be serialized. It can only be populated by the server.
isCancellable	Describes whether the job is cancellable or not. NOTE: This property will not be serialized. It can only be populated by the server.
isCancellableWithoutFee	Flag to indicate cancellation of scheduled job. NOTE: This property will not be serialized. It can only be populated by the server.
isDeletable	Describes whether the job is deletable or not. NOTE: This property will not be serialized. It can only be populated by the server.
isPrepareToShipEnabled	Is Prepare To Ship Enabled on this job NOTE: This property will not be serialized. It can only be populated by the server.
isShippingAddressEditable	Describes whether the shipping address is editable or not. NOTE: This property will not be serialized. It can only be populated by the server.
name	Name of the object. NOTE: This property will not be serialized. It can only be populated by the server.
reverseShippingDetailsUpdate	The Editable status for Reverse Shipping Address and Contact Info NOTE: This property will not be serialized. It can only be populated by the server.
reverseTransportPreferenceUpdate	The Editable status for Reverse Transport preferences NOTE: This property will not be serialized. It can only be populated by the server.
startTime	Time at which the job was started in UTC ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
status	Name of the stage which is in progress. NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
transferType	Type of the data transfer.
type	Type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

identity	Msi identity of the resource
location	The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.
sku	The sku type.
tags	The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).

Property Details

cancellationReason

Reason for cancellation. NOTE: This property will not be serialized. It can only be populated by the server.

cancellationReason?: string

Property Value

string

deliveryInfo

Delivery Info of Job.

deliveryInfo?: JobDeliveryInfo

Property Value

JobDeliveryInfo

deliveryType

Delivery type of Job.

deliveryType?: JobDeliveryType

Property Value

JobDeliveryType

details

Details of a job run. This field will only be sent for expand details filter.

details?: JobDetailsUnion

Property Value

JobDetailsUnion

error

Top level error for the job. NOTE: This property will not be serialized. It can only be populated by the server.

error?: CloudError

Property Value

CloudError

id

Id of the object. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

isCancellable

Describes whether the job is cancellable or not. NOTE: This property will not be serialized. It can only be populated by the server.

isCancellable?: boolean

Property Value

boolean

isCancellableWithoutFee

Flag to indicate cancellation of scheduled job. NOTE: This property will not be serialized. It can only be populated by the server.

isCancellableWithoutFee?: boolean

Property Value

boolean

isDeletable

Describes whether the job is deletable or not. NOTE: This property will not be serialized. It can only be populated by the server.

isDeletable?: boolean

Property Value

boolean

isPrepareToShipEnabled

Is Prepare To Ship Enabled on this job NOTE: This property will not be serialized. It can only be populated by the server.

isPrepareToShipEnabled?: boolean

Property Value

boolean

isShippingAddressEditable

Describes whether the shipping address is editable or not. NOTE: This property will not be serialized. It can only be populated by the server.

isShippingAddressEditable?: boolean

Property Value

boolean

name

Name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

reverseShippingDetailsUpdate

The Editable status for Reverse Shipping Address and Contact Info NOTE: This property will not be serialized. It can only be populated by the server.

reverseShippingDetailsUpdate?: ReverseShippingDetailsEditStatus

Property Value

ReverseShippingDetailsEditStatus

reverseTransportPreferenceUpdate

The Editable status for Reverse Transport preferences NOTE: This property will not be serialized. It can only be populated by the server.

reverseTransportPreferenceUpdate?: ReverseTransportPreferenceEditStatus

Property Value

ReverseTransportPreferenceEditStatus

startTime

Time at which the job was started in UTC ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: Date

Property Value

Date

status

Name of the stage which is in progress. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

transferType

Type of the data transfer.

transferType: TransferType

Property Value

TransferType

type

Type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited Property Details

identity

Msi identity of the resource

identity?: ResourceIdentity

Property Value

ResourceIdentity

Inherited From Resource.identity

location

The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.

location: string

Property Value

string

Inherited From Resource.location

sku

The sku type.

sku: Sku

Property Value

Sku

Inherited From Resource.sku

tags

The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags