Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AmlComputeProperties

Package version

AML Compute properties

Hierarchy

  • AmlComputeProperties

Index

Properties

Properties

Optional allocationState

allocationState: 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.

Optional allocationStateTransitionTime

allocationStateTransitionTime: Date

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.

Optional currentNodeCount

currentNodeCount: undefined | number

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.

Optional enableNodePublicIp

enableNodePublicIp: undefined | false | true

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.

Optional errors

errors: ErrorResponse[]

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.

Optional isolatedNetwork

isolatedNetwork: undefined | false | true

Network is isolated or not

Optional nodeStateCounts

nodeStateCounts: NodeStateCounts

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

Optional osType

osType: OsType

Compute OS Type

Optional propertyBag

propertyBag: undefined | {}

A property bag containing additional properties.

Optional remoteLoginPortPublicAccess

remoteLoginPortPublicAccess: 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.

Optional scaleSettings

scaleSettings: ScaleSettings

Scale settings for AML Compute

Optional subnet

subnet: ResourceId

Virtual network subnet resource ID the compute nodes belong to.

Optional targetNodeCount

targetNodeCount: undefined | number

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.

Optional userAccountCredentials

userAccountCredentials: UserAccountCredentials

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

Optional virtualMachineImage

virtualMachineImage: VirtualMachineImage

Virtual Machine image for AML Compute - windows only

Optional vmPriority

vmPriority: VmPriority

Virtual Machine priority

Optional vmSize

vmSize: undefined | string

Virtual Machine Size

Generated using TypeDoc