Share via

Job interface

  • Reference
Package:
@azure/arm-batchai
Extends
ProxyResource

Properties

caffe2Settings

Specifies the settings for
caffeSettings

Specifies the settings for Caffe
chainerSettings

Specifies the settings for
cluster

Cluster. Resource ID of the cluster
cntkSettings

Specifies the settings for CNTK (aka
constraints

Constraints associated
containerSettings

If provided the job will
creationTime

Creation time. The creation time of the job.
customMpiSettings

Specifies the settings for
customToolkitSettings

Specifies the
environmentVariables

Environment
executionInfo

Information about the
executionState

Execution state. The current
executionStateTransitionTime

Execution state transition
horovodSettings

Specifies the settings for
inputDirectories

Input directories. A list of
jobOutputDirectoryPathSegment

Output directory path
jobPreparation

Specifies the actions to be
mountVolumes

Mount volumes. Collection of mount
nodeCount

Number of compute nodes to run the job on.
outputDirectories

Output directories. A list
provisioningState

Provisioning state. The
provisioningStateTransitionTime

Provisioning state
pyTorchSettings

Specifies the settings for
schedulingPriority

Scheduling priority. Scheduling
secrets

Secrets. A
stdOutErrPathPrefix

Standard output directory path
tensorFlowSettings

Specifies the settings
toolType

The toolkit type of this job. Possible

Inherited Properties

id

The ID of the resource.
name

The name of the resource.
type

The type of the resource.

Property Details

caffe2Settings

Specifies the settings for

caffe2Settings?: Caffe2Settings

Property Value

Caffe2Settings

caffeSettings

Specifies the settings for Caffe

caffeSettings?: CaffeSettings

Property Value

CaffeSettings

chainerSettings

Specifies the settings for

chainerSettings?: ChainerSettings

Property Value

ChainerSettings

cluster

Cluster. Resource ID of the cluster

cluster?: ResourceId

Property Value

ResourceId

cntkSettings

Specifies the settings for CNTK (aka

cntkSettings?: CNTKsettings

Property Value

CNTKsettings

constraints

Constraints associated

constraints?: JobPropertiesConstraints

Property Value

JobPropertiesConstraints

containerSettings

If provided the job will

containerSettings?: ContainerSettings

Property Value

ContainerSettings

creationTime

Creation time. The creation time of the job.

creationTime?: Date

Property Value

Date

customMpiSettings

Specifies the settings for

customMpiSettings?: CustomMpiSettings

Property Value

CustomMpiSettings

customToolkitSettings

Specifies the

customToolkitSettings?: CustomToolkitSettings

Property Value

CustomToolkitSettings

environmentVariables

Environment

environmentVariables?: EnvironmentVariable[]

Property Value

EnvironmentVariable[]

executionInfo

Information about the

executionInfo?: JobPropertiesExecutionInfo

Property Value

JobPropertiesExecutionInfo

executionState

Execution state. The current

executionState?: ExecutionState

Property Value

ExecutionState

executionStateTransitionTime

Execution state transition

executionStateTransitionTime?: Date

Property Value

Date

horovodSettings

Specifies the settings for

horovodSettings?: HorovodSettings

Property Value

HorovodSettings

inputDirectories

Input directories. A list of

inputDirectories?: InputDirectory[]

Property Value

InputDirectory[]

jobOutputDirectoryPathSegment

Output directory path

jobOutputDirectoryPathSegment?: string

Property Value

string

jobPreparation

Specifies the actions to be

jobPreparation?: JobPreparation

Property Value

JobPreparation

mountVolumes

Mount volumes. Collection of mount

mountVolumes?: MountVolumes

Property Value

MountVolumes

nodeCount

Number of compute nodes to run the job on.

nodeCount?: number

Property Value

number

outputDirectories

Output directories. A list

outputDirectories?: OutputDirectory[]

Property Value

OutputDirectory[]

provisioningState

Provisioning state. The

provisioningState?: ProvisioningState

Property Value

ProvisioningState

provisioningStateTransitionTime

Provisioning state

provisioningStateTransitionTime?: Date

Property Value

Date

pyTorchSettings

Specifies the settings for

pyTorchSettings?: PyTorchSettings

Property Value

PyTorchSettings

schedulingPriority

Scheduling priority. Scheduling

schedulingPriority?: JobPriority

Property Value

JobPriority

secrets

Secrets. A

secrets?: EnvironmentVariableWithSecretValue[]

Property Value

EnvironmentVariableWithSecretValue[]

stdOutErrPathPrefix

Standard output directory path

stdOutErrPathPrefix?: string

Property Value

string

tensorFlowSettings

Specifies the settings

tensorFlowSettings?: TensorFlowSettings

Property Value

TensorFlowSettings

toolType

The toolkit type of this job. Possible

toolType?: ToolType

Property Value

ToolType

Inherited Property Details

id

The ID of the resource.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource.

type?: string

Property Value

string

Inherited From ProxyResource.type