Share via

JobDefinition interface

  • Reference
Package:
@azure/arm-storagemover

The Job Definition resource.

Extends
ProxyResource

Properties

agentName

Name of the Agent to assign for new Job Runs of this Job Definition.
agentResourceId

Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition. NOTE: This property will not be serialized. It can only be populated by the server.
copyMode

Strategy to use for copy.
description

A description for the Job Definition.
latestJobRunName

The name of the Job Run in a non-terminal state, if exists. NOTE: This property will not be serialized. It can only be populated by the server.
latestJobRunResourceId

The fully qualified resource ID of the Job Run in a non-terminal state, if exists. NOTE: This property will not be serialized. It can only be populated by the server.
latestJobRunStatus

The current status of the Job Run in a non-terminal state, if exists. 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.
sourceName

The name of the source Endpoint.
sourceResourceId

Fully qualified resource ID of the source Endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
sourceSubpath

The subpath to use when reading from the source Endpoint.
targetName

The name of the target Endpoint.
targetResourceId

Fully qualified resource ID of the target Endpoint. NOTE: This property will not be serialized. It can only be populated by the server.
targetSubpath

The subpath to use when writing to the target Endpoint.

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 to assign for new Job Runs of this Job Definition.

agentName?: string

Property Value

string

agentResourceId

Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition. NOTE: This property will not be serialized. It can only be populated by the server.

agentResourceId?: string

Property Value

string

copyMode

Strategy to use for copy.

copyMode: string

Property Value

string

description

A description for the Job Definition.

description?: string

Property Value

string

latestJobRunName

The name of the Job Run in a non-terminal state, if exists. NOTE: This property will not be serialized. It can only be populated by the server.

latestJobRunName?: string

Property Value

string

latestJobRunResourceId

The fully qualified resource ID of the Job Run in a non-terminal state, if exists. NOTE: This property will not be serialized. It can only be populated by the server.

latestJobRunResourceId?: string

Property Value

string

latestJobRunStatus

The current status of the Job Run in a non-terminal state, if exists. NOTE: This property will not be serialized. It can only be populated by the server.

latestJobRunStatus?: string

Property Value

string

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

sourceName

The name of the source Endpoint.

sourceName: string

Property Value

string

sourceResourceId

Fully qualified resource ID of the source Endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

sourceResourceId?: string

Property Value

string

sourceSubpath

The subpath to use when reading from the source Endpoint.

sourceSubpath?: string

Property Value

string

targetName

The name of the target Endpoint.

targetName: string

Property Value

string

targetResourceId

Fully qualified resource ID of the target Endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

targetResourceId?: string

Property Value

string

targetSubpath

The subpath to use when writing to the target Endpoint.

targetSubpath?: 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