Share via


ICommandJob Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.CommandJobTypeConverter))]
public interface ICommandJob : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IJobBaseProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.CommandJobTypeConverter))>]
type ICommandJob = interface
    interface IJsonSerializable
    interface IJobBaseProperties
    interface IResourceBase
Public Interface ICommandJob
Implements IJobBaseProperties
Derived
Attributes
Implements

Properties

CodeId

ARM resource ID of the code asset.

Command

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

ComponentId

ARM resource ID of the component resource.

(Inherited from IJobBaseProperties)
ComputeId

ARM resource ID of the compute resource.

(Inherited from IJobBaseProperties)
Description

The asset description text.

(Inherited from IResourceBase)
DisplayName

Display name of job.

(Inherited from IJobBaseProperties)
DistributionType

[Required] Specifies the type of distribution framework.

EnvironmentId

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

EnvironmentVariable

Environment variables included in the job.

ExperimentName

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

(Inherited from IJobBaseProperties)
IdentityType

[Required] Specifies the type of identity framework.

(Inherited from IJobBaseProperties)
Input

Mapping of input data bindings used in the job.

IsArchived

Is the asset archived?

(Inherited from IJobBaseProperties)
JobType

[Required] Specifies the type of job.

(Inherited from IJobBaseProperties)
LimitJobLimitsType

[Required] JobLimit type.

LimitTimeout

The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.

NotificationSettingEmail

This is the email recipient list which has a limitation of 499 characters in total concat with comma separator

(Inherited from IJobBaseProperties)
NotificationSettingEmailOn

Send email notification to user on specified notification type

(Inherited from IJobBaseProperties)
NotificationSettingWebhook

Send webhook callback to a service. Key is a user-provided name for the webhook.

(Inherited from IJobBaseProperties)
Output

Mapping of output data bindings used in the job.

Parameter

Input parameters.

Property

The asset property dictionary.

(Inherited from IResourceBase)
QueueSettingJobTier

Controls the compute job tier

ResourceDockerArg

Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.

ResourceInstanceCount

Optional number of instances or nodes used by the compute target.

ResourceInstanceType

Optional type of VM used as supported by the compute target.

ResourceProperty

Additional properties bag.

ResourceShmSize

Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).

Service

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

(Inherited from IJobBaseProperties)
Status

Status of the job.

(Inherited from IJobBaseProperties)
Tag

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

(Inherited from IResourceBase)

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to