PipelineJob Class
Definition
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.
Pipeline Job definition: defines generic to MFE attributes.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.PipelineJobTypeConverter))]
public class PipelineJob : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IPipelineJob, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.PipelineJobTypeConverter))>]
type PipelineJob = class
interface IPipelineJob
interface IJsonSerializable
interface IJobBaseProperties
interface IResourceBase
interface IValidates
Public Class PipelineJob
Implements IPipelineJob, IValidates
- Inheritance
-
PipelineJob
- Attributes
- Implements
Constructors
PipelineJob() |
Creates an new PipelineJob instance. |
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. |
IdentityType |
[Required] Specifies the type of identity framework. |
Input |
Inputs for the pipeline job. |
IsArchived |
Is the asset archived? |
Job |
Jobs construct the Pipeline Job. |
JobType |
[Required] Specifies the type of job. |
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 |
Outputs for the pipeline job |
Property |
The asset property dictionary. |
Service |
List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. |
Setting |
Pipeline settings, for things like ContinueRunOnStepFailure etc. |
SourceJobId |
ARM resource ID of source job. |
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 PipelineJob. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of PipelineJob. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IPipelineJob. |
FromJsonString(String) |
Creates a new instance of PipelineJob, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of PipelineJob into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
ToString() | |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |