CommandJob interface

Package:

@azure/arm-machinelearning

Command job definition.

Extends

JobBaseProperties

Properties

codeId	ARM resource ID of the code asset.
command	[Required] The command to execute on startup of the job. eg. "python train.py"
distribution	Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.
environmentId	[Required] The ARM resource ID of the Environment specification for the job.
environmentVariables	Environment variables included in the job.
inputs	Mapping of input data bindings used in the job.
jobType	[Required] Specifies the type of job.
limits	Command Job limit.
outputs	Mapping of output data bindings used in the job.
parameters	Input parameters.
queueSettings	Queue settings for the job
resources	Compute Resource configuration for the job.

Inherited Properties

componentId	ARM resource ID of the component resource.
computeId	ARM resource ID of the compute resource.
description	The asset description text.
displayName	Display name of job.
experimentName	The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
identity	Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.
isArchived	Is the asset archived?
notificationSetting	Notification setting for the job
parentJobName	Parent job name.
properties	The asset property dictionary.
services	List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
status	Status of the job.
tags	Tag dictionary. Tags can be added, removed, and updated.

Property Details

codeId

ARM resource ID of the code asset.

codeId?: string

Property Value

string

command

[Required] The command to execute on startup of the job. eg. "python train.py"

command: string

Property Value

string

distribution

Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.

distribution?: DistributionConfigurationUnion

Property Value

DistributionConfigurationUnion

environmentId

[Required] The ARM resource ID of the Environment specification for the job.

environmentId: string

Property Value

string

environmentVariables

Environment variables included in the job.

environmentVariables?: Record<string, string>

Property Value

Record<string, string>

inputs

Mapping of input data bindings used in the job.

inputs?: Record<string, JobInputUnion>

Property Value

Record<string, JobInputUnion>

jobType

[Required] Specifies the type of job.

jobType: "Command"

Property Value

"Command"

limits

Command Job limit.

limits?: CommandJobLimits

Property Value

CommandJobLimits

outputs

Mapping of output data bindings used in the job.

outputs?: Record<string, JobOutputUnion>

Property Value

Record<string, JobOutputUnion>

parameters

Input parameters.

parameters?: any

Property Value

any

queueSettings

Queue settings for the job

queueSettings?: QueueSettings

Property Value

QueueSettings

resources

Compute Resource configuration for the job.

resources?: JobResourceConfiguration

Property Value

JobResourceConfiguration

Inherited Property Details

componentId

ARM resource ID of the component resource.

componentId?: string

Property Value

string

Inherited From JobBaseProperties.componentId

computeId

ARM resource ID of the compute resource.

computeId?: string

Property Value

string

Inherited From JobBaseProperties.computeId

description

The asset description text.

description?: string

Property Value

string

Inherited From JobBaseProperties.description

displayName

Display name of job.

displayName?: string

Property Value

string

Inherited From JobBaseProperties.displayName

experimentName

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

experimentName?: string

Property Value

string

Inherited From JobBaseProperties.experimentName

identity

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.

identity?: IdentityConfigurationUnion

Property Value

IdentityConfigurationUnion

Inherited From JobBaseProperties.identity

isArchived

Is the asset archived?

isArchived?: boolean

Property Value

boolean

Inherited From JobBaseProperties.isArchived

notificationSetting

Notification setting for the job

notificationSetting?: NotificationSetting

Property Value

NotificationSetting

Inherited From JobBaseProperties.notificationSetting

parentJobName

Parent job name.

parentJobName?: string

Property Value

string

Inherited From JobBaseProperties.parentJobName

properties

The asset property dictionary.

properties?: Record<string, string>

Property Value

Record<string, string>

Inherited From JobBaseProperties.properties

services

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

services?: Record<string, JobService>

Property Value

Record<string, JobService>

Inherited From JobBaseProperties.services

status

Status of the job.

status?: string

Property Value

string

Inherited From JobBaseProperties.status

tags

Tag dictionary. Tags can be added, removed, and updated.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From JobBaseProperties.tags