AmlCompute Class

Definition

Namespace:

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

Assembly:

Az.MachineLearningServices.private.dll

An Azure Machine Learning compute.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AmlComputeTypeConverter))]
public class AmlCompute : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IAmlCompute, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AmlComputeTypeConverter))>]
type AmlCompute = class
    interface IAmlCompute
    interface IJsonSerializable
    interface ICompute
    interface IAmlComputeSchema
    interface IValidates

Public Class AmlCompute
Implements IAmlCompute, IValidates

Inheritance

Object

AmlCompute

Attributes

TypeConverterAttribute

Implements

IAmlCompute IAmlComputeSchema ICompute IJsonSerializable IValidates

Constructors

AmlCompute()

Creates an new AmlCompute instance.

Properties

AllocationState	Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.
AllocationStateTransitionTime	The time at which the compute entered its current allocation state.
CreatedOn	The time at which the compute was created.
CurrentNodeCount	The number of compute nodes currently assigned to the compute.
Description	The description of the Machine Learning compute.
DisableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
EnableNodePublicIP	Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.
Error	Collection of errors encountered by various compute nodes during node setup.
IsAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
IsolatedNetwork	Network is isolated or not
Location	Location for the underlying compute
ModifiedOn	The time at which the compute was last modified.
NodeStateCount	Counts of various node states on the compute.
NodeStateCountIdleNodeCount	Number of compute nodes in idle state.
NodeStateCountLeavingNodeCount	Number of compute nodes which are leaving the amlCompute.
NodeStateCountPreemptedNodeCount	Number of compute nodes which are in preempted state.
NodeStateCountPreparingNodeCount	Number of compute nodes which are being prepared.
NodeStateCountRunningNodeCount	Number of compute nodes which are running jobs.
NodeStateCountUnusableNodeCount	Number of compute nodes which are in unusable state.
OSType	Compute OS Type
Property	Properties of AmlCompute
PropertyBag	A property bag containing additional properties.
ProvisioningError	Errors during provisioning
ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
RemoteLoginPortPublicAccess	State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.
ResourceId	ARM resource id of the underlying compute
ScaleSetting	Scale settings for AML Compute
ScaleSettingMaxNodeCount	Max number of nodes to use
ScaleSettingMinNodeCount	Min number of nodes to use
ScaleSettingNodeIdleTimeBeforeScaleDown	Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.
Subnet	Virtual network subnet resource ID the compute nodes belong to.
SubnetId	The ID of the resource
TargetNodeCount	The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.
Type	The type of compute
UserAccountCredentials	Credentials for an administrator user account that will be created on each compute node.
UserAccountCredentialsAdminUserName	Name of the administrator user account which can be used to SSH to nodes.
UserAccountCredentialsAdminUserPassword	Password of the administrator user account.
UserAccountCredentialsAdminUserSshPublicKey	SSH public key of the administrator user account.
VirtualMachineImage	Virtual Machine image for AML Compute - windows only
VirtualMachineImageId	Virtual Machine image path
VMPriority	Virtual Machine priority
VMSize	Virtual Machine Size

Methods

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