Batch Batch Accounts Pool

This table represents the batch_batch_accounts_pool resource from Microsoft Azure.

azure.batch_batch_accounts_pool

Fields

TitleIDTypeData TypeDescription
_keycorestring
allocation_statecorestringWhether the pool is resizing.
allocation_state_transition_timecorestringThe time at which the pool entered its current allocation state.
application_licensescorearray<string>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.
application_packagescorejsonChanges 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.
auto_scale_runcorejsonThis property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
certificatescorejsonFor 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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
creation_timecorestringThe creation time of the pool.
current_dedicated_nodescoreint64The number of dedicated compute nodes currently in the pool.
current_low_priority_nodescoreint64The number of Spot/low-priority compute nodes currently in the pool.
current_node_communication_modecorestringDetermines how a pool communicates with the Batch service.
deployment_configurationcorejsonDeployment configuration properties.
etagcorestringThe ETag of the resource, used for concurrency statements.
idcorestringFully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identitycorejsonThe type of identity used for the Batch Pool.
inter_node_communicationcorestringThis 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'.
last_modifiedcorestringThis 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.
locationcorestring
metadatacorejsonThe Batch service does not assign any meaning to metadata; it is solely for the use of user code.
mount_configurationcorejsonThis supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
namecorestringThe name of the resource
network_configurationcorejsonThe network configuration for a pool.
provisioning_statecorestringThe current state of the pool.
provisioning_state_transition_timecorestringThe time at which the pool entered its current state.
resize_operation_statuscorejsonDescribes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
resource_groupcorestring
scale_settingscorejsonDefines 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.
start_taskcorejsonIn an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
subscription_idcorestring
subscription_namecorestring
system_datacorejsonAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagscorehstore_csv
target_node_communication_modecorestringIf omitted, the default value is Default.
task_scheduling_policycorejsonIf not specified, the default is spread.
task_slots_per_nodecoreint64The 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.
typecorestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
upgrade_policycorejsonDescribes an upgrade policy - automatic, manual, or rolling.
user_accountscorejsonThe list of user accounts to be created on each node in the pool.
vm_sizecorestringFor information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).