JobDefinitionProperties interface

Job definition properties.

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.

connections

List of connections associated to this job

copyMode

Strategy to use for copy.

dataIntegrityValidation

The checksum validation mode for the job definition.

description

A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.

jobType

The type of the Job.

latestJobRunName

The name of the Job Run in a non-terminal state, if exists.

latestJobRunResourceId

The fully qualified resource ID of the Job Run in a non-terminal state, if exists.

latestJobRunStatus

The current status of the Job Run in a non-terminal state, if exists.

preservePermissions

Boolean to preserve permissions or not.

provisioningState

The provisioning state of this resource.

schedule

Schedule information for the Job Definition.

sourceName

The name of the source Endpoint.

sourceResourceId

Fully qualified resource ID of the source Endpoint.

sourceSubpath

The subpath to use when reading from the source Endpoint.

sourceTargetMap

The list of cloud endpoints to migrate.

targetName

The name of the target Endpoint.

targetResourceId

Fully qualified resource ID of the target Endpoint.

targetSubpath

The subpath to use when writing to the target Endpoint.

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.

agentResourceId?: string

Property Value

string

connections

List of connections associated to this job

connections?: string[]

Property Value

string[]

copyMode

Strategy to use for copy.

copyMode: string

Property Value

string

dataIntegrityValidation

The checksum validation mode for the job definition.

dataIntegrityValidation?: string

Property Value

string

description

A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.

description?: string

Property Value

string

jobType

The type of the Job.

jobType?: string

Property Value

string

latestJobRunName

The name of the Job Run in a non-terminal state, if exists.

latestJobRunName?: string

Property Value

string

latestJobRunResourceId

The fully qualified resource ID of the Job Run in a non-terminal state, if exists.

latestJobRunResourceId?: string

Property Value

string

latestJobRunStatus

The current status of the Job Run in a non-terminal state, if exists.

latestJobRunStatus?: string

Property Value

string

preservePermissions

Boolean to preserve permissions or not.

preservePermissions?: boolean

Property Value

boolean

provisioningState

The provisioning state of this resource.

provisioningState?: string

Property Value

string

schedule

Schedule information for the Job Definition.

schedule?: ScheduleInfo

Property Value

sourceName

The name of the source Endpoint.

sourceName: string

Property Value

string

sourceResourceId

Fully qualified resource ID of the source Endpoint.

sourceResourceId?: string

Property Value

string

sourceSubpath

The subpath to use when reading from the source Endpoint.

sourceSubpath?: string

Property Value

string

sourceTargetMap

The list of cloud endpoints to migrate.

sourceTargetMap?: { value?: SourceTargetMap[] }

Property Value

{ value?: SourceTargetMap[] }

targetName

The name of the target Endpoint.

targetName: string

Property Value

string

targetResourceId

Fully qualified resource ID of the target Endpoint.

targetResourceId?: string

Property Value

string

targetSubpath

The subpath to use when writing to the target Endpoint.

targetSubpath?: string

Property Value

string