Pool Class

Reference

Contains information about a pool.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance: azure.mgmt.batch.models._models_py3.AzureProxyResource

Pool

Constructor

Pool(*, tags: Dict[str, str] | None = None, identity: _models.BatchPoolIdentity | None = None, display_name: str | None = None, vm_size: str | None = None, deployment_configuration: _models.DeploymentConfiguration | None = None, scale_settings: _models.ScaleSettings | None = None, inter_node_communication: str | _models.InterNodeCommunicationState | None = None, network_configuration: _models.NetworkConfiguration | None = None, task_slots_per_node: int = 1, task_scheduling_policy: _models.TaskSchedulingPolicy | None = None, user_accounts: List[_models.UserAccount] | None = None, metadata: List[_models.MetadataItem] | None = None, start_task: _models.StartTask | None = None, certificates: List[_models.CertificateReference] | None = None, application_packages: List[_models.ApplicationPackageReference] | None = None, application_licenses: List[str] | None = None, mount_configuration: List[_models.MountConfiguration] | None = None, target_node_communication_mode: str | _models.NodeCommunicationMode | None = None, upgrade_policy: _models.UpgradePolicy | None = None, resource_tags: Dict[str, str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tags	dict[str, str] The tags of the resource.
identity	BatchPoolIdentity The type of identity used for the Batch Pool.
display_name	str The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
vm_size	str For information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
deployment_configuration	DeploymentConfiguration Deployment configuration properties.
scale_settings	ScaleSettings Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.
inter_node_communication	str or InterNodeCommunicationState This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. Known values are: "Enabled" and "Disabled".
network_configuration	NetworkConfiguration The network configuration for a pool.
task_slots_per_node	int The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. Default value: 1
task_scheduling_policy	TaskSchedulingPolicy If not specified, the default is spread.
user_accounts	list[UserAccount] The list of user accounts to be created on each node in the pool.
metadata	list[MetadataItem] The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
start_task	StartTask In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
certificates	list[CertificateReference] For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
application_packages	list[ApplicationPackageReference] Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
application_licenses	list[str] The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
mount_configuration	list[MountConfiguration] This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
target_node_communication_mode	str or NodeCommunicationMode If omitted, the default value is Default. Known values are: "Default", "Classic", and "Simplified".
upgrade_policy	UpgradePolicy Describes an upgrade policy - automatic, manual, or rolling.
resource_tags	dict[str, str] The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.

Variables

Name	Description
id	str The ID of the resource.
name	str The name of the resource.
type	str The type of the resource.
etag	str The ETag of the resource, used for concurrency statements.
tags	dict[str, str] The tags of the resource.
identity	BatchPoolIdentity The type of identity used for the Batch Pool.
display_name	str The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
last_modified	datetime This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.
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 For information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
deployment_configuration	DeploymentConfiguration Deployment configuration properties.
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 Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.
auto_scale_run	AutoScaleRun This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
inter_node_communication	str or InterNodeCommunicationState This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. Known values are: "Enabled" and "Disabled".
network_configuration	NetworkConfiguration The network configuration for a pool.
task_slots_per_node	int The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.
task_scheduling_policy	TaskSchedulingPolicy If not specified, the default is spread.
user_accounts	list[UserAccount] The list of user accounts to be created on each node in the pool.
metadata	list[MetadataItem] The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
start_task	StartTask In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
certificates	list[CertificateReference] For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
application_packages	list[ApplicationPackageReference] Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
application_licenses	list[str] The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
resize_operation_status	ResizeOperationStatus Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
mount_configuration	list[MountConfiguration] This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
target_node_communication_mode	str or NodeCommunicationMode If omitted, the default value is Default. Known values are: "Default", "Classic", and "Simplified".
current_node_communication_mode	str or NodeCommunicationMode Determines how a pool communicates with the Batch service. Known values are: "Default", "Classic", and "Simplified".
upgrade_policy	UpgradePolicy Describes an upgrade policy - automatic, manual, or rolling.
resource_tags	dict[str, str] The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.

Share via

Pool Class

Constructor

Keyword-Only Parameters

Variables

Additional resources