Share via

AmlComputeProperties interface

  • Reference
Package:
@azure/arm-machinelearningservices

AML Compute properties

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. NOTE: This property will not be serialized. It can only be populated by the server.
allocationStateTransitionTime

The time at which the compute entered its current allocation state. NOTE: This property will not be serialized. It can only be populated by the server.
currentNodeCount

The number of compute nodes currently assigned to the compute. NOTE: This property will not be serialized. It can only be populated by the server.
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.
errors

Collection of errors encountered by various compute nodes during node setup. NOTE: This property will not be serialized. It can only be populated by the server.
isolatedNetwork

Network is isolated or not
nodeStateCounts

Counts of various node states on the compute. NOTE: This property will not be serialized. It can only be populated by the server.
osType

Compute OS Type
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.
scaleSettings

Scale settings for AML Compute
subnet

Virtual network subnet resource ID the compute nodes belong to.
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. NOTE: This property will not be serialized. It can only be populated by the server.
userAccountCredentials

Credentials for an administrator user account that will be created on each compute node.
virtualMachineImage

Virtual Machine image for AML Compute - windows only
vmPriority

Virtual Machine priority
vmSize

Virtual Machine Size

Property Details

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. NOTE: This property will not be serialized. It can only be populated by the server.

allocationState?: string

Property Value

string

allocationStateTransitionTime

The time at which the compute entered its current allocation state. NOTE: This property will not be serialized. It can only be populated by the server.

allocationStateTransitionTime?: Date

Property Value

Date

currentNodeCount

The number of compute nodes currently assigned to the compute. NOTE: This property will not be serialized. It can only be populated by the server.

currentNodeCount?: number

Property Value

number

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.

enableNodePublicIp?: boolean

Property Value

boolean

errors

Collection of errors encountered by various compute nodes during node setup. NOTE: This property will not be serialized. It can only be populated by the server.

errors?: ErrorResponse[]

Property Value

ErrorResponse[]

isolatedNetwork

Network is isolated or not

isolatedNetwork?: boolean

Property Value

boolean

nodeStateCounts

Counts of various node states on the compute. NOTE: This property will not be serialized. It can only be populated by the server.

nodeStateCounts?: NodeStateCounts

Property Value

NodeStateCounts

osType

Compute OS Type

osType?: string

Property Value

string

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.

remoteLoginPortPublicAccess?: string

Property Value

string

scaleSettings

Scale settings for AML Compute

scaleSettings?: ScaleSettings

Property Value

ScaleSettings

subnet

Virtual network subnet resource ID the compute nodes belong to.

subnet?: ResourceId

Property Value

ResourceId

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. NOTE: This property will not be serialized. It can only be populated by the server.

targetNodeCount?: number

Property Value

number

userAccountCredentials

Credentials for an administrator user account that will be created on each compute node.

userAccountCredentials?: UserAccountCredentials

Property Value

UserAccountCredentials

virtualMachineImage

Virtual Machine image for AML Compute - windows only

virtualMachineImage?: VirtualMachineImage

Property Value

VirtualMachineImage

vmPriority

Virtual Machine priority

vmPriority?: string

Property Value

string

vmSize

Virtual Machine Size

vmSize?: string

Property Value

string