ArmMachineLearningModelFactory.MachineLearningJobProperties Method
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.
Overloads
MachineLearningJobProperties(String, IDictionary<String,String>, IDictionary<String,String>, ResourceIdentifier, ResourceIdentifier, String, String, MachineLearningIdentityConfiguration, Nullable<Boolean>, String, NotificationSetting, IDictionary<String,MachineLearningJobService>, Nullable<MachineLearningJobStatus>)
Base definition for a job. Please note this is the base class. The derived classes available for instantiation are: AutoMLJob, MachineLearningCommandJob, MachineLearningPipelineJob, SparkJob, and MachineLearningSweepJob.
public static Azure.ResourceManager.MachineLearning.Models.MachineLearningJobProperties MachineLearningJobProperties(string description = default, System.Collections.Generic.IDictionary<string,string> properties = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.ResourceIdentifier componentId = default, Azure.Core.ResourceIdentifier computeId = default, string displayName = default, string experimentName = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration identity = default, bool? isArchived = default, string jobType = default, Azure.ResourceManager.MachineLearning.Models.NotificationSetting notificationSetting = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> services = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus? status = default);static member MachineLearningJobProperties : string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * string * string * Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration * Nullable<bool> * string * Azure.ResourceManager.MachineLearning.Models.NotificationSetting * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus> -> Azure.ResourceManager.MachineLearning.Models.MachineLearningJobPropertiesPublic Shared Function MachineLearningJobProperties (Optional description As String = Nothing, Optional properties As IDictionary(Of String, String) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional componentId As ResourceIdentifier = Nothing, Optional computeId As ResourceIdentifier = Nothing, Optional displayName As String = Nothing, Optional experimentName As String = Nothing, Optional identity As MachineLearningIdentityConfiguration = Nothing, Optional isArchived As Nullable(Of Boolean) = Nothing, Optional jobType As String = Nothing, Optional notificationSetting As NotificationSetting = Nothing, Optional services As IDictionary(Of String, MachineLearningJobService) = Nothing, Optional status As Nullable(Of MachineLearningJobStatus) = Nothing) As MachineLearningJobPropertiesParameters
- description
- String
The asset description text.
- properties
- IDictionary<String,String>
The asset property dictionary.
- tags
- IDictionary<String,String>
Tag dictionary. Tags can be added, removed, and updated.
- componentId
- ResourceIdentifier
ARM resource ID of the component resource.
- computeId
- ResourceIdentifier
ARM resource ID of the compute resource.
- displayName
- String
Display name of job.
- experimentName
- String
The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
- identity
- MachineLearningIdentityConfiguration
Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.
- jobType
- String
[Required] Specifies the type of job.
- notificationSetting
- NotificationSetting
Notification setting for the job.
- services
- IDictionary<String,MachineLearningJobService>
List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
- status
- Nullable<MachineLearningJobStatus>
Status of the job.
Returns
A new MachineLearningJobProperties instance for mocking.
Applies to
MachineLearningJobProperties(String, IDictionary<String,String>, IDictionary<String,String>, ResourceIdentifier, ResourceIdentifier, String, String, MachineLearningIdentityConfiguration, Nullable<Boolean>, String, NotificationSetting, IDictionary<String,SecretConfiguration>, IDictionary<String,MachineLearningJobService>, Nullable<MachineLearningJobStatus>)
Initializes a new instance of MachineLearningJobProperties.
public static Azure.ResourceManager.MachineLearning.Models.MachineLearningJobProperties MachineLearningJobProperties(string description = default, System.Collections.Generic.IDictionary<string,string> properties = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.ResourceIdentifier componentId = default, Azure.Core.ResourceIdentifier computeId = default, string displayName = default, string experimentName = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration identity = default, bool? isArchived = default, string jobType = "Unknown", Azure.ResourceManager.MachineLearning.Models.NotificationSetting notificationSetting = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.SecretConfiguration> secretsConfiguration = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> services = default, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus? status = default);static member MachineLearningJobProperties : string * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * string * string * Azure.ResourceManager.MachineLearning.Models.MachineLearningIdentityConfiguration * Nullable<bool> * string * Azure.ResourceManager.MachineLearning.Models.NotificationSetting * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.SecretConfiguration> * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.MachineLearning.Models.MachineLearningJobService> * Nullable<Azure.ResourceManager.MachineLearning.Models.MachineLearningJobStatus> -> Azure.ResourceManager.MachineLearning.Models.MachineLearningJobPropertiesPublic Shared Function MachineLearningJobProperties (Optional description As String = Nothing, Optional properties As IDictionary(Of String, String) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional componentId As ResourceIdentifier = Nothing, Optional computeId As ResourceIdentifier = Nothing, Optional displayName As String = Nothing, Optional experimentName As String = Nothing, Optional identity As MachineLearningIdentityConfiguration = Nothing, Optional isArchived As Nullable(Of Boolean) = Nothing, Optional jobType As String = "Unknown", Optional notificationSetting As NotificationSetting = Nothing, Optional secretsConfiguration As IDictionary(Of String, SecretConfiguration) = Nothing, Optional services As IDictionary(Of String, MachineLearningJobService) = Nothing, Optional status As Nullable(Of MachineLearningJobStatus) = Nothing) As MachineLearningJobPropertiesParameters
- description
- String
The asset description text.
- properties
- IDictionary<String,String>
The asset property dictionary.
- tags
- IDictionary<String,String>
Tag dictionary. Tags can be added, removed, and updated.
- componentId
- ResourceIdentifier
ARM resource ID of the component resource.
- computeId
- ResourceIdentifier
ARM resource ID of the compute resource.
- displayName
- String
Display name of job.
- experimentName
- String
The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
- identity
- MachineLearningIdentityConfiguration
Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. Please note MachineLearningIdentityConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmlToken, MachineLearningManagedIdentity and MachineLearningUserIdentity.
- jobType
- String
[Required] Specifies the type of job.
- notificationSetting
- NotificationSetting
Notification setting for the job.
- secretsConfiguration
- IDictionary<String,SecretConfiguration>
Configuration for secrets to be made available during runtime.
- services
- IDictionary<String,MachineLearningJobService>
List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
- status
- Nullable<MachineLearningJobStatus>
Status of the job.
Returns
A new MachineLearningJobProperties instance for mocking.
