AmlComputeProperties Class

Definition

AML Compute properties.

public class AmlComputeProperties
type AmlComputeProperties = class
Public Class AmlComputeProperties
Inheritance
AmlComputeProperties

Constructors

AmlComputeProperties()

Initializes a new instance of AmlComputeProperties.

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.

AllocationStateTransitionOn

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.

Errors

Collection of errors encountered by various compute nodes during node setup.

IsolatedNetwork

Network is isolated or not.

NodeStateCounts

Counts of various node states on the compute.

OSType

Compute OS Type.

PropertyBag

A property bag containing additional properties.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
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.

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.

UserAccountCredentials

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

VirtualMachineImageId

Virtual Machine image path.

VmPriority

Virtual Machine priority.

VmSize

Virtual Machine Size.

Applies to