JobRun interface

Package:

@azure/arm-storagemover

The Job Run resource.

Extends

ProxyResource

Properties

agentName	Name of the Agent assigned to this run. NOTE: This property will not be serialized. It can only be populated by the server.
agentResourceId	Fully qualified resource id of the Agent assigned to this run. NOTE: This property will not be serialized. It can only be populated by the server.
bytesExcluded	Bytes of data that will not be transferred, as they are excluded by user configuration. NOTE: This property will not be serialized. It can only be populated by the server.
bytesFailed	Bytes of data that were attempted to transfer and failed. NOTE: This property will not be serialized. It can only be populated by the server.
bytesNoTransferNeeded	Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode). NOTE: This property will not be serialized. It can only be populated by the server.
bytesScanned	Bytes of data scanned so far in source. NOTE: This property will not be serialized. It can only be populated by the server.
bytesTransferred	Bytes of data successfully transferred to target. NOTE: This property will not be serialized. It can only be populated by the server.
bytesUnsupported	Bytes of data that will not be transferred, as they are unsupported on target. NOTE: This property will not be serialized. It can only be populated by the server.
error	Error details. NOTE: This property will not be serialized. It can only be populated by the server.
executionEndTime	End time of the run. Null if Agent has not reported that the job has ended. NOTE: This property will not be serialized. It can only be populated by the server.
executionStartTime	Start time of the run. Null if no Agent reported that the job has started. NOTE: This property will not be serialized. It can only be populated by the server.
itemsExcluded	Number of items that will not be transferred, as they are excluded by user configuration. NOTE: This property will not be serialized. It can only be populated by the server.
itemsFailed	Number of items that were attempted to transfer and failed. NOTE: This property will not be serialized. It can only be populated by the server.
itemsNoTransferNeeded	Number of items that will not be transferred, as they are already found on target (e.g. mirror mode). NOTE: This property will not be serialized. It can only be populated by the server.
itemsScanned	Number of items scanned so far in source. NOTE: This property will not be serialized. It can only be populated by the server.
itemsTransferred	Number of items successfully transferred to target. NOTE: This property will not be serialized. It can only be populated by the server.
itemsUnsupported	Number of items that will not be transferred, as they are unsupported on target. NOTE: This property will not be serialized. It can only be populated by the server.
jobDefinitionProperties	Copy of parent Job Definition's properties at time of Job Run creation. NOTE: This property will not be serialized. It can only be populated by the server.
lastStatusUpdate	The last updated time of the Job Run. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The provisioning state of this resource. NOTE: This property will not be serialized. It can only be populated by the server.
scanStatus	The status of Agent's scanning of source. NOTE: This property will not be serialized. It can only be populated by the server.
sourceName	Name of source Endpoint resource. This resource may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.
sourceProperties	Copy of source Endpoint resource's properties at time of Job Run creation. NOTE: This property will not be serialized. It can only be populated by the server.
sourceResourceId	Fully qualified resource id of source Endpoint. This id may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.
status	The state of the job execution. NOTE: This property will not be serialized. It can only be populated by the server.
targetName	Name of target Endpoint resource. This resource may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.
targetProperties	Copy of Endpoint resource's properties at time of Job Run creation. NOTE: This property will not be serialized. It can only be populated by the server.
targetResourceId	Fully qualified resource id of of Endpoint. This id may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

agentName

Name of the Agent assigned to this run. NOTE: This property will not be serialized. It can only be populated by the server.

agentName?: string

Property Value

string

agentResourceId

Fully qualified resource id of the Agent assigned to this run. NOTE: This property will not be serialized. It can only be populated by the server.

agentResourceId?: string

Property Value

string

bytesExcluded

Bytes of data that will not be transferred, as they are excluded by user configuration. NOTE: This property will not be serialized. It can only be populated by the server.

bytesExcluded?: number

Property Value

number

bytesFailed

Bytes of data that were attempted to transfer and failed. NOTE: This property will not be serialized. It can only be populated by the server.

bytesFailed?: number

Property Value

number

bytesNoTransferNeeded

Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode). NOTE: This property will not be serialized. It can only be populated by the server.

bytesNoTransferNeeded?: number

Property Value

number

bytesScanned

Bytes of data scanned so far in source. NOTE: This property will not be serialized. It can only be populated by the server.

bytesScanned?: number

Property Value

number

bytesTransferred

Bytes of data successfully transferred to target. NOTE: This property will not be serialized. It can only be populated by the server.

bytesTransferred?: number

Property Value

number

bytesUnsupported

Bytes of data that will not be transferred, as they are unsupported on target. NOTE: This property will not be serialized. It can only be populated by the server.

bytesUnsupported?: number

Property Value

number

error

Error details. NOTE: This property will not be serialized. It can only be populated by the server.

error?: JobRunError

Property Value

JobRunError

executionEndTime

End time of the run. Null if Agent has not reported that the job has ended. NOTE: This property will not be serialized. It can only be populated by the server.

executionEndTime?: Date

Property Value

Date

executionStartTime

Start time of the run. Null if no Agent reported that the job has started. NOTE: This property will not be serialized. It can only be populated by the server.

executionStartTime?: Date

Property Value

Date

itemsExcluded

Number of items that will not be transferred, as they are excluded by user configuration. NOTE: This property will not be serialized. It can only be populated by the server.

itemsExcluded?: number

Property Value

number

itemsFailed

Number of items that were attempted to transfer and failed. NOTE: This property will not be serialized. It can only be populated by the server.

itemsFailed?: number

Property Value

number

itemsNoTransferNeeded

Number of items that will not be transferred, as they are already found on target (e.g. mirror mode). NOTE: This property will not be serialized. It can only be populated by the server.

itemsNoTransferNeeded?: number

Property Value

number

itemsScanned

Number of items scanned so far in source. NOTE: This property will not be serialized. It can only be populated by the server.

itemsScanned?: number

Property Value

number

itemsTransferred

Number of items successfully transferred to target. NOTE: This property will not be serialized. It can only be populated by the server.

itemsTransferred?: number

Property Value

number

itemsUnsupported

Number of items that will not be transferred, as they are unsupported on target. NOTE: This property will not be serialized. It can only be populated by the server.

itemsUnsupported?: number

Property Value

number

jobDefinitionProperties

Copy of parent Job Definition's properties at time of Job Run creation. NOTE: This property will not be serialized. It can only be populated by the server.

jobDefinitionProperties?: Record<string, unknown>

Property Value

Record<string, unknown>

lastStatusUpdate

The last updated time of the Job Run. NOTE: This property will not be serialized. It can only be populated by the server.

lastStatusUpdate?: Date

Property Value

Date

provisioningState

The provisioning state of this resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

scanStatus

The status of Agent's scanning of source. NOTE: This property will not be serialized. It can only be populated by the server.

scanStatus?: string

Property Value

string

sourceName

Name of source Endpoint resource. This resource may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.

sourceName?: string

Property Value

string

sourceProperties

Copy of source Endpoint resource's properties at time of Job Run creation. NOTE: This property will not be serialized. It can only be populated by the server.

sourceProperties?: Record<string, unknown>

Property Value

Record<string, unknown>

sourceResourceId

Fully qualified resource id of source Endpoint. This id may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.

sourceResourceId?: string

Property Value

string

status

The state of the job execution. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

targetName

Name of target Endpoint resource. This resource may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.

targetName?: string

Property Value

string

targetProperties

Copy of Endpoint resource's properties at time of Job Run creation. NOTE: This property will not be serialized. It can only be populated by the server.

targetProperties?: Record<string, unknown>

Property Value

Record<string, unknown>

targetResourceId

Fully qualified resource id of of Endpoint. This id may no longer exist. NOTE: This property will not be serialized. It can only be populated by the server.

targetResourceId?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type