AmlComputeProperties 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.
AML Compute properties
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AmlComputePropertiesTypeConverter))]
public class AmlComputeProperties : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IAmlComputeProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AmlComputePropertiesTypeConverter))>]
type AmlComputeProperties = class
interface IAmlComputeProperties
interface IJsonSerializable
Public Class AmlComputeProperties
Implements IAmlComputeProperties
- Inheritance
-
AmlComputeProperties
- Attributes
- Implements
Constructors
AmlComputeProperties() |
Creates an new AmlComputeProperties 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. |
CurrentNodeCount |
The number of compute nodes currently assigned to the compute. |
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. |
IsolatedNetwork |
Network is isolated or not |
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 |
PropertyBag |
A property bag containing additional properties. |
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. |
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. |
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. |
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. |
VirtualMachineImageId |
Virtual Machine image path |
VMPriority |
Virtual Machine priority |
VMSize |
Virtual Machine Size |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of AmlComputeProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of AmlComputeProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IAmlComputeProperties. |
FromJsonString(String) |
Creates a new instance of AmlComputeProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of AmlComputeProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
ToString() |