Share via

Cluster interface

  • Reference
Package:
@azure/arm-batchai
Extends
ProxyResource

Properties

allocationState

Allocation state. Allocation
allocationStateTransitionTime

Allocation state transition
creationTime

Creation time. The time when the cluster was
currentNodeCount

Current node count. The number of
errors

Errors. Collection of errors encountered
nodeSetup

Node setup. Setup (mount file systems,
nodeStateCounts

Node state counts. Counts of
provisioningState

Provisioning state.
provisioningStateTransitionTime

Provisioning State
scaleSettings

Scale settings. Scale settings of
subnet

Subnet. Virtual network subnet resource ID
userAccountSettings

User account settings.
virtualMachineConfiguration

VM
vmPriority

VM priority. VM priority of cluster
vmSize

VM size. The size of the virtual machines in the

Inherited Properties

id

The ID of the resource.
name

The name of the resource.
type

The type of the resource.

Property Details

allocationState

Allocation state. Allocation

allocationState?: AllocationState

Property Value

AllocationState

allocationStateTransitionTime

Allocation state transition

allocationStateTransitionTime?: Date

Property Value

Date

creationTime

Creation time. The time when the cluster was

creationTime?: Date

Property Value

Date

currentNodeCount

Current node count. The number of

currentNodeCount?: number

Property Value

number

errors

Errors. Collection of errors encountered

errors?: BatchAIError[]

Property Value

BatchAIError[]

nodeSetup

Node setup. Setup (mount file systems,

nodeSetup?: NodeSetup

Property Value

NodeSetup

nodeStateCounts

Node state counts. Counts of

nodeStateCounts?: NodeStateCounts

Property Value

NodeStateCounts

provisioningState

Provisioning state.

provisioningState?: ProvisioningState

Property Value

ProvisioningState

provisioningStateTransitionTime

Provisioning State

provisioningStateTransitionTime?: Date

Property Value

Date

scaleSettings

Scale settings. Scale settings of

scaleSettings?: ScaleSettings

Property Value

ScaleSettings

subnet

Subnet. Virtual network subnet resource ID

subnet?: ResourceId

Property Value

ResourceId

userAccountSettings

User account settings.

userAccountSettings?: UserAccountSettings

Property Value

UserAccountSettings

virtualMachineConfiguration

VM

virtualMachineConfiguration?: VirtualMachineConfiguration

Property Value

VirtualMachineConfiguration

vmPriority

VM priority. VM priority of cluster

vmPriority?: VmPriority

Property Value

VmPriority

vmSize

VM size. The size of the virtual machines in the

vmSize?: string

Property Value

string

Inherited Property Details

id

The ID of the resource.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource.

type?: string

Property Value

string

Inherited From ProxyResource.type