IAmlCompute Interface
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.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AmlComputeTypeConverter))]
public interface IAmlCompute : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IAmlComputeSchema, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ICompute[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.AmlComputeTypeConverter))>]
type IAmlCompute = interface
interface IJsonSerializable
interface ICompute
interface IAmlComputeSchemaPublic Interface IAmlCompute
Implements IAmlComputeSchema, ICompute- Derived
- Attributes
- Implements
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. (Inherited from IAmlComputeSchema) |
| AllocationStateTransitionTime |
The time at which the compute entered its current allocation state. (Inherited from IAmlComputeSchema) |
| CreatedOn |
The time at which the compute was created. (Inherited from ICompute) |
| CurrentNodeCount |
The number of compute nodes currently assigned to the compute. (Inherited from IAmlComputeSchema) |
| Description |
The description of the Machine Learning compute. (Inherited from ICompute) |
| DisableLocalAuth |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. (Inherited from ICompute) |
| 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. (Inherited from IAmlComputeSchema) |
| Error |
Collection of errors encountered by various compute nodes during node setup. (Inherited from IAmlComputeSchema) |
| IsAttachedCompute |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. (Inherited from ICompute) |
| IsolatedNetwork |
Network is isolated or not (Inherited from IAmlComputeSchema) |
| Location |
Location for the underlying compute (Inherited from ICompute) |
| ModifiedOn |
The time at which the compute was last modified. (Inherited from ICompute) |
| NodeStateCountIdleNodeCount |
Number of compute nodes in idle state. (Inherited from IAmlComputeSchema) |
| NodeStateCountLeavingNodeCount |
Number of compute nodes which are leaving the amlCompute. (Inherited from IAmlComputeSchema) |
| NodeStateCountPreemptedNodeCount |
Number of compute nodes which are in preempted state. (Inherited from IAmlComputeSchema) |
| NodeStateCountPreparingNodeCount |
Number of compute nodes which are being prepared. (Inherited from IAmlComputeSchema) |
| NodeStateCountRunningNodeCount |
Number of compute nodes which are running jobs. (Inherited from IAmlComputeSchema) |
| NodeStateCountUnusableNodeCount |
Number of compute nodes which are in unusable state. (Inherited from IAmlComputeSchema) |
| OSType |
Compute OS Type (Inherited from IAmlComputeSchema) |
| PropertyBag |
A property bag containing additional properties. (Inherited from IAmlComputeSchema) |
| ProvisioningError |
Errors during provisioning (Inherited from ICompute) |
| ProvisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. (Inherited from ICompute) |
| 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. (Inherited from IAmlComputeSchema) |
| ResourceId |
ARM resource id of the underlying compute (Inherited from ICompute) |
| ScaleSettingMaxNodeCount |
Max number of nodes to use (Inherited from IAmlComputeSchema) |
| ScaleSettingMinNodeCount |
Min number of nodes to use (Inherited from IAmlComputeSchema) |
| ScaleSettingNodeIdleTimeBeforeScaleDown |
Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. (Inherited from IAmlComputeSchema) |
| SubnetId |
The ID of the resource (Inherited from IAmlComputeSchema) |
| 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. (Inherited from IAmlComputeSchema) |
| Type |
The type of compute (Inherited from ICompute) |
| UserAccountCredentialsAdminUserName |
Name of the administrator user account which can be used to SSH to nodes. (Inherited from IAmlComputeSchema) |
| UserAccountCredentialsAdminUserPassword |
Password of the administrator user account. (Inherited from IAmlComputeSchema) |
| UserAccountCredentialsAdminUserSshPublicKey |
SSH public key of the administrator user account. (Inherited from IAmlComputeSchema) |
| VirtualMachineImageId |
Virtual Machine image path (Inherited from IAmlComputeSchema) |
| VMPriority |
Virtual Machine priority (Inherited from IAmlComputeSchema) |
| VMSize |
Virtual Machine Size (Inherited from IAmlComputeSchema) |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |