PoolProperties Class

Pool properties.

Constructor

PoolProperties(*args: Any, **kwargs: Any)

Variables

Name	Description
display_name	str The display name for the pool.
last_modified	datetime The last modified time of the pool.
creation_time	datetime The creation time of the pool.
provisioning_state	str or PoolProvisioningState The current state of the pool. Known values are: "Succeeded" and "Deleting".
provisioning_state_transition_time	datetime The time at which the pool entered its current state.
allocation_state	str or AllocationState Whether the pool is resizing. Known values are: "Steady", "Resizing", and "Stopping".
allocation_state_transition_time	datetime The time at which the pool entered its current allocation state.
vm_size	str The size of virtual machines in the pool. All VMs in a pool are the same size.
deployment_configuration	DeploymentConfiguration This property describes the virtual machines that the pool nodes will be deployed on.
current_dedicated_nodes	int The number of dedicated compute nodes currently in the pool.
current_low_priority_nodes	int The number of Spot/low-priority compute nodes currently in the pool.
scale_settings	ScaleSettings Settings which configure the number of nodes in the pool.
auto_scale_run	AutoScaleRun The results and errors from the last execution of the autoscale formula.
inter_node_communication	str or InterNodeCommunicationState Whether the pool permits direct communication between nodes. Known values are: "Enabled" and "Disabled".
network_configuration	NetworkConfiguration The network configuration for the pool.
task_slots_per_node	int The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.
task_scheduling_policy	TaskSchedulingPolicy How tasks are distributed across compute nodes in a pool.
user_accounts	list[UserAccount] The list of user accounts to be created on each node in the pool.
metadata	list[MetadataItem] A list of name-value pairs associated with the pool as metadata.
start_task	StartTask A task specified to run on each compute node as it joins the pool.
application_packages	list[ApplicationPackageReference] The list of application packages to be installed on each compute node in the pool.
resize_operation_status	ResizeOperationStatus Contains details about the current or last completed resize operation.
mount_configuration	list[MountConfiguration] A list of file systems to mount on each node in the pool.
upgrade_policy	UpgradePolicy The upgrade policy for the pool.

Attributes

allocation_state

"Steady", "Resizing", and "Stopping".

allocation_state: str | _models.AllocationState | None

allocation_state_transition_time

The time at which the pool entered its current allocation state.

allocation_state_transition_time: datetime | None

application_packages

The list of application packages to be installed on each compute node in the pool.

application_packages: list['_models.ApplicationPackageReference'] | None

auto_scale_run

The results and errors from the last execution of the autoscale formula.

auto_scale_run: _models.AutoScaleRun | None

creation_time

The creation time of the pool.

creation_time: datetime | None

current_dedicated_nodes

The number of dedicated compute nodes currently in the pool.

current_dedicated_nodes: int | None

current_low_priority_nodes

The number of Spot/low-priority compute nodes currently in the pool.

current_low_priority_nodes: int | None

deployment_configuration

This property describes the virtual machines that the pool nodes will be deployed on.

deployment_configuration: _models.DeploymentConfiguration | None

display_name

The display name for the pool.

display_name: str | None

inter_node_communication

"Enabled" and "Disabled".

inter_node_communication: str | _models.InterNodeCommunicationState | None

last_modified

The last modified time of the pool.

last_modified: datetime | None

metadata

A list of name-value pairs associated with the pool as metadata.

metadata: list['_models.MetadataItem'] | None

mount_configuration

A list of file systems to mount on each node in the pool.

mount_configuration: list['_models.MountConfiguration'] | None

network_configuration

The network configuration for the pool.

network_configuration: _models.NetworkConfiguration | None

provisioning_state

"Succeeded" and "Deleting".

provisioning_state: str | _models.PoolProvisioningState | None

provisioning_state_transition_time

The time at which the pool entered its current state.

provisioning_state_transition_time: datetime | None

resize_operation_status

Contains details about the current or last completed resize operation.

resize_operation_status: _models.ResizeOperationStatus | None

scale_settings

Settings which configure the number of nodes in the pool.

scale_settings: _models.ScaleSettings | None

start_task

A task specified to run on each compute node as it joins the pool.

start_task: _models.StartTask | None

task_scheduling_policy

How tasks are distributed across compute nodes in a pool.

task_scheduling_policy: _models.TaskSchedulingPolicy | None

task_slots_per_node

The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.

task_slots_per_node: int | None

upgrade_policy

The upgrade policy for the pool.

upgrade_policy: _models.UpgradePolicy | None

user_accounts

The list of user accounts to be created on each node in the pool.

user_accounts: list['_models.UserAccount'] | None

vm_size

The size of virtual machines in the pool. All VMs in a pool are the same size.

vm_size: str | None