azure.azcollection.azure_rm_batchaccountpool module – Manages a Batch Account Pool on Azure
Note
This module is part of the azure.azcollection collection (version 3.1.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_batchaccountpool.
New in azure.azcollection 3.0.0
Synopsis
Create, update and delete instance of Azure Batch Account Pool.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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. |
|
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. |
|
The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. |
|
If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
The name of the Batch Account. |
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing Choices:
|
|
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 and certificates are placed in that directory. |
|
The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. |
|
The default value is This property is applicable only for pools configured with Windows nodes. 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 and certificates are placed in that directory. Choices:
|
|
This property is applicable only for pools configured with Windows nodes. This created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference. Choices:
|
|
Which user accounts on the compute node should have access to the private data of the certificate. Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS). Using VirtualMachineConfiguration uses Azure Virtual Machines (IaaS). |
|
This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to ‘UserSubscription’. |
|
os_family=2 equivalent to Windows Server 2008 R2 SP1. os_family=3 equivalent to Windows Server 2012. os_family=4 equivalent to Windows Server 2012 R2. os_family=5 equivalent to Windows Server 2016. os_family=6 equivalent to Windows Server 2019. Default: |
|
The default value is |
|
This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. |
|
If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property. All other tasks may specify it. |
|
This is the full image reference, as would be specified to “docker pull”. An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. |
|
If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. |
|
The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
|
The ARM resource id of the user assigned identity. |
|
The password to log into the registry server. |
|
If omitted, the default is Default: |
|
The user name to log into the registry server. |
|
The container technology to be used. Choices:
|
|
This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. |
|
The caching mode for the disk Choices:
|
|
The initial disk size in GB when creating new data disk. |
|
The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. |
|
The data disk type.
Choices:
|
|
If specified, encryption is performed on each node in the pool during node provisioning. |
|
On Linux pool, only on Windows pool, Choices:
|
|
If specified, the extensions mentioned in this configuration will be installed on each node. |
|
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, the extension will not upgrade minor versions unless redeployed, even with this property set to true. Choices:
|
|
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. Choices:
|
|
The name of the virtual machine extension. |
|
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
|
Collection of extension names after which this extension needs to be provisioned. |
|
The name of the extension handler publisher. |
|
JSON formatted public settings for the extension. |
|
The type of the extensions. |
|
The version of script handler. |
|
A reference to an Azure Virtual Machines Marketplace image or the zure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the ‘List supported node agent SKUs’ operation. |
|
This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. Sample as |
|
For example, |
|
For example, |
|
For example, |
|
A value of ‘latest’ can be specified to select the latest version of an image. If omitted, the default is |
|
This only applies to images that contain the Windows operating system. Should only be used when you hold valid on-premises licenses for the nodes which will be deployed.
|
|
The Batch node agent is a program that runs on each node in the pool. Provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references. |
|
This configuration will specify rules on how nodes in the pool during node provisioning. |
|
Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. Choices:
|
|
Contains configuration for ephemeral OSDisk settings. |
|
The type of caching to enable for the disk. Choices:
|
|
The initial disk size in GB when creating new OS disk. |
|
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. |
|
This property can be used by user in the request to choose which location the operating system should be in. |
|
The data disk config. |
|
The storage account type for use in creating data disks or OSdisk. Choices:
|
|
Specifies whether writeAccelerator should be enabled or disabled on the disk. Choices:
|
|
Specifies the security profile settings for the virtual machine or virtual machine scale set. |
|
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This willenable the encryption for all the disks including Resource/Temp disk at host itself. Choices:
|
|
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: |
|
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
|
Specifies whether secure boot should be enabled on the virtual machine. Choices:
|
|
Specifies whether vTPM should be enabled on the virtual machine. Choices:
|
|
The service artifact reference ID. Such as |
|
The service artifact reference ID of the vmArtifactsProfiles. |
|
This property must not be specified if the imageReference specifies a Linux OS image. |
|
If omitted, the default value is Choices:
|
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
The display name for the pool. |
|
The type of identity used for the Batch Pool. If the pool identity is updated during update an existing pool. Only the new vms which are created after the pool shrinks to 0 will have the updated identities. |
|
The type of identity used for the Batch Pool. Choices:
|
|
The list of user identities associated with the Batch pool. The key is the identity’s ID and value contains ‘principal_id’ and ‘client_id’. |
|
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 Choices:
|
|
Whether disables automatic scaling for a pool. Choices:
|
|
Whether stops an ongoing resize operation on the pool. Choices:
|
|
Parent argument. |
|
Parent argument. |
|
The Batch service does not assign any meaning to this metadata; it is solely for the use of user code. |
|
The name of the metadata item. |
|
The value of the metadata item. |
|
This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. |
|
Configuration of the azure blob file system. This property is mutually exclusive with all other properties. |
|
This property is mutually exclusive with both sasKey and identity; exactly one must be specified. |
|
The Azure Storage Account name. |
|
These are Choices:
|
|
The Azure Blob Storage Container name. |
|
This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. |
|
The ARM resource id of the user assigned identity. |
|
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. |
|
This property is mutually exclusive with both accountKey and identity; exactly one must be specified. |
|
Configuration of the azure file share. This property is mutually exclusive with all other properties. |
|
The Azure Storage account key. |
|
The Azure Storage account name. |
|
This is of the form ‘https://{account}.file.core.windows.net/’. |
|
These are Choices:
|
|
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. |
|
Configuration of the cifs mount. This property is mutually exclusive with all other properties. |
|
These are Choices:
|
|
The password to use for authentication against the CIFS file system. |
|
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. |
|
The URI of the file system to mount. |
|
The user to use for authentication against the CIFS file system. |
|
Configuration of the nfs mount. This property is mutually exclusive with all other properties. |
|
These are Choices:
|
|
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. |
|
The URI of the file system to mount. |
|
The name of the Batch Account Pool. |
|
The network configuration for a pool. |
|
The scope of dynamic vnet assignment. Choices:
|
|
Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM. Which may lead to improved networking performance. Choices:
|
|
Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property. |
|
The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. |
|
This must be unique within a Batch pool. Acceptable values are between 1 amd 65535 except for 22. |
|
Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. |
|
Acceptable values range between 1 and 65534 except ports overlap If any reserved or overlapping values are provided the request fails with HTTP status code 400. |
|
The name must be unique within a Batch pool. The name contain letters, numbers, underscores, periods, and hyphens. |
|
The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified. default rule will be created to allow inbound access to the specified backendPort. |
|
The action that should be taken for a specified IP address, subnet range or tags. Choices:
|
|
Priorities within a pool must be unique and are evaluated in order of priority |
|
Valid values are a single IP address (i.e. 10.10.10.10). Valid values are a single IP address. |
|
Valid values are ‘*’ (for all ports 0 - 65535) or arrays of orts or port ranges (i.e. 100-200). |
|
The protocol of the endpoint. Choices:
|
|
This property is only supported on Pools with the virtualMachineConfiguration property. |
|
The number of IPs specified here limits the maximum size of the Pool 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. |
|
The public IP Address configuration’s provision. Choices:
|
|
The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn’t have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group in which to create the Batch Account Pool. |
|
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’. |
|
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. |
|
This property and fixedScale are mutually exclusive and one of the properties must be specified. must be specified. |
|
If omitted, the default value is 15 minutes (PT15M). Default: |
|
A formula for the desired number of compute nodes in the pool. |
|
This property and autoScale are mutually exclusive and one of the properties must be specified. |
|
If omitted, the default value is Choices:
|
|
The default value is 15 minutes Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error. Default: |
|
At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. |
|
At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. |
|
The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line. Required if any other properties of the startTask are specified. |
|
When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. |
|
These additional options are supplied as arguments to the ‘docker create’ command, in addition to those controlled by the Batch Service. |
|
This is the full image reference, as would be specified to “docker pull”. If no tag is provided as part of the image name, the tag “:latest” is used as a default. |
|
This setting can be omitted if was already provided at pool creation. |
|
The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
|
The ARM resource id of the user assigned identity. |
|
The password to log into the registry server. |
|
If omitted, the default is “docker.io”. Default: |
|
he user name to log into the registry server. |
|
A flag to indicate where the container task working directory is. Choices:
|
|
A list of environment variable settings for the start task. |
|
The name of the environment variable. |
|
The value of the environment variable. |
|
The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. Default: |
|
A list of files that the Batch service will download to the compute node before running the command line. A single file or multiple files to be downloaded to a compute node. |
|
The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. |
|
The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. |
|
This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. |
|
If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. If the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task’s working directory. |
|
The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage. Include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. |
|
The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
|
The ARM resource id of the user assigned identity. |
|
The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage. Include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. |
|
If omitted, the task runs as a non-administrative user unique to the task. |
|
The autouser config of the task user identity. The userName and autoUser properties are mutually exclusive; you must specify one but not both. |
|
The auto user elevation level. Choices:
|
|
The scope of the auto user scope. The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. Choices:
|
|
The username of the task user identity. The userName and autoUser properties are mutually exclusive; you must specify one but not both. |
|
If true and the start task fails on a compute node. The Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complet. Choices:
|
|
Assert the state of the Batch Account Pool. Use Choices:
|
|
Your Azure subscription Id. |
|
If omitted, the default value is Choices:
|
|
Specifies how tasks should be distributed across compute nodes. |
|
How tasks should be distributed across compute nodes. Choices:
|
|
The default value is The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. Default: |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
Describes an upgrade policy. |
|
The configuration parameters used for performing automatic OS upgrade. |
|
Whether OS image rollback feature should be disabled. Choices:
|
|
Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Choices:
|
|
Defer OS upgrades on the TVMs if they are running tasks. Choices:
|
|
Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. Choices:
|
|
Specifies the mode of an upgrade to virtual machines in the scale set. Choices:
|
|
This property is only supported on Pools with the virtualMachineConfiguration property. |
|
Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. Choices:
|
|
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. |
|
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. |
|
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. |
|
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. |
|
Upgrade all unhealthy instances in a scale set before any healthy instances. Choices:
|
|
Rollback failed instances to previous model if the Rolling Upgrade policy is violated. Choices:
|
|
The list of user accounts to be created on each node in the pool. |
|
Choices:
|
|
Properties used to create a user account on a Linux node. |
|
The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. |
|
The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool’s enableInterNodeCommunication property is true. It does this by placing the key pair into the user’s .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user’s .ssh directory is done). |
|
The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. |
|
The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. |
|
The password for the user account. |
|
Properties used to create a user account on a Windows node. |
|
Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. Choices:
|
|
For information about available sizes of virtual machines for Cloud Services Pools. Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2, Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal. |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az logincommand.
Examples
- name: Create a new batch account pool
azure_rm_batchaccountpool:
resource_group: "{{ resource_group }}"
batch_account_name: "{{ batch_account_name }}"
name: "pool{{ batch_account_name }}--004"
deployment_configuration:
virtual_machine_configuration:
image_reference:
offer: ubuntu-hpc
publisher: microsoft-dsvm
sku: 2204
version: latest
node_agent_sku_id: batch.node.ubuntu 22.04
node_placement_configuration:
policy: Regional
os_disk:
caching: None
managed_disk:
storage_account_type: Premium_LRS
display_name: "fredtest01"
identity:
type: UserAssigned
user_assigned_identities:
'/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/AzSecPackAutoConfigUA-westus':
client_id: xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
principal_id: yyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
'/subscriptions/xxx-xxx/resourceGroups/yishitest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ystestidentity':
client_id: yyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
principal_id: xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
inter_node_communication: Disabled
network_configuration:
dynamic_vnet_assignment_scope: none
subnet_id: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet02/subnets/default"
endpoint_configuration:
inbound_nat_pools:
- backend_port: 33
frontend_port_range_end: 49999
frontend_port_range_start: 1
name: nat02
protocol: UDP
public_ip_address_configuration:
provision: BatchManaged
scale_settings:
fixed_scale:
resize_timeout: PT15M
target_dedicated_nodes: 0
target_low_priority_nodes: 0
target_node_communication_mode: Default
task_scheduling_policy:
node_fill_type: Pack
task_slots_per_node: 1
vm_size: STANDARD_D2S_V3
upgrade_policy:
mode: manual
rolling_upgrade_policy:
max_batch_instance_percent: 20
max_unhealthy_instance_percent: 20
max_unhealthy_upgraded_instance_percent: 20
pause_time_between_batches: P0D
rollback_failed_instances_on_policy_breach: false
automatic_os_upgrade_policy:
disable_automatic_rollback: false
enable_automatic_os_upgrade: false
os_rolling_upgrade_deferral: false
use_rolling_upgrade_policy: false
- name: Delete the Batch Account Pool
azure_rm_batchaccountpool:
resource_group: MyResGroup
name: pool01
batch_account_name: mybatchaccount
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Contains information about an pool in a Batch account. Returned: always Sample: |