CommandJob Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401

Assembly:: Az.MachineLearningServices.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Command job definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.CommandJobTypeConverter))]
public class CommandJob : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ICommandJob, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.CommandJobTypeConverter))>]
type CommandJob = class
    interface ICommandJob
    interface IJsonSerializable
    interface IJobBaseProperties
    interface IResourceBase
    interface IValidates

Public Class CommandJob
Implements ICommandJob, IValidates

Inheritance: Object
CommandJob

Attributes: TypeConverterAttribute

Implements: ICommandJob IJobBaseProperties IResourceBase IJsonSerializable IValidates

Constructors

CommandJob()

Creates an new CommandJob instance.

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.
ComputeId	ARM resource ID of the compute resource.
Description	The asset description text.
DisplayName	Display name of job.
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.
Identity	Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.
IdentityType	[Required] Specifies the type of identity framework.
Input	Mapping of input data bindings used in the job.
IsArchived	Is the asset archived?
JobType	[Required] Specifies the type of job.
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.
NotificationSetting	Notification setting for the job
NotificationSettingEmail	This is the email recipient list which has a limitation of 499 characters in total concat with comma separator
NotificationSettingEmailOn	Send email notification to user on specified notification type
NotificationSettingWebhook	Send webhook callback to a service. Key is a user-provided name for the webhook.
Output	Mapping of output data bindings used in the job.
Parameter	Input parameters.
Property	The asset property dictionary.
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.
Status	Status of the job.
Tag	Tag dictionary. Tags can be added, removed, and updated.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of CommandJob.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of CommandJob.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ICommandJob.
FromJsonString(String)	Creates a new instance of CommandJob, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of CommandJob into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Share via