Pool

Manages an Azure Batch pool.

Create a Pool Resource

new Pool(name: string, args: PoolArgs, opts?: CustomResourceOptions);

def Pool(resource_name, opts=None, account_name=None, auto_scale=None, certificates=None, container_configuration=None, display_name=None, fixed_scale=None, max_tasks_per_node=None, metadata=None, name=None, network_configuration=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, stop_pending_resize_operation=None, storage_image_reference=None, vm_size=None, __props__=None);

func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)

public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args PoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PoolArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Pool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Pool resource accepts the following input properties:

AccountName string: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
NodeAgentSkuId string: Specifies the Sku of the node agents that will be created in the Batch pool.
ResourceGroupName string: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
StorageImageReference PoolStorageImageReferenceArgs: A storage_image_reference for the virtual machines that will compose the Batch pool.
VmSize string: Specifies the size of the VM created in the Batch pool.
AutoScale PoolAutoScaleArgs: A auto_scale block that describes the scale settings when using auto scale.
Certificates List<PoolCertificateArgs>: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
ContainerConfiguration PoolContainerConfigurationArgs: The container configuration used in the pool’s VMs.
DisplayName string: Specifies the display name of the Batch pool.
FixedScale PoolFixedScaleArgs: A fixed_scale block that describes the scale settings when using fixed scale.
MaxTasksPerNode int: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
Metadata Dictionary<string, string>: A map of custom batch pool metadata.
Name string: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
NetworkConfiguration PoolNetworkConfigurationArgs: A network_configuration block that describes the network configurations for the Batch pool.
StartTask PoolStartTaskArgs: A start_task block that describes the start task settings for the Batch pool.
StopPendingResizeOperation bool

AccountName string: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
NodeAgentSkuId string: Specifies the Sku of the node agents that will be created in the Batch pool.
ResourceGroupName string: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
StorageImageReference PoolStorageImageReference: A storage_image_reference for the virtual machines that will compose the Batch pool.
VmSize string: Specifies the size of the VM created in the Batch pool.
AutoScale PoolAutoScale: A auto_scale block that describes the scale settings when using auto scale.
Certificates []PoolCertificate: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
ContainerConfiguration PoolContainerConfiguration: The container configuration used in the pool’s VMs.
DisplayName string: Specifies the display name of the Batch pool.
FixedScale PoolFixedScale: A fixed_scale block that describes the scale settings when using fixed scale.
MaxTasksPerNode int: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
Metadata map[string]string: A map of custom batch pool metadata.
Name string: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
NetworkConfiguration PoolNetworkConfiguration: A network_configuration block that describes the network configurations for the Batch pool.
StartTask PoolStartTask: A start_task block that describes the start task settings for the Batch pool.
StopPendingResizeOperation bool

accountName string: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
nodeAgentSkuId string: Specifies the Sku of the node agents that will be created in the Batch pool.
resourceGroupName string: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
storageImageReference PoolStorageImageReference: A storage_image_reference for the virtual machines that will compose the Batch pool.
vmSize string: Specifies the size of the VM created in the Batch pool.
autoScale PoolAutoScale: A auto_scale block that describes the scale settings when using auto scale.
certificates PoolCertificate[]: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
containerConfiguration PoolContainerConfiguration: The container configuration used in the pool’s VMs.
displayName string: Specifies the display name of the Batch pool.
fixedScale PoolFixedScale: A fixed_scale block that describes the scale settings when using fixed scale.
maxTasksPerNode number: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
metadata {[key: string]: string}: A map of custom batch pool metadata.
name string: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
networkConfiguration PoolNetworkConfiguration: A network_configuration block that describes the network configurations for the Batch pool.
startTask PoolStartTask: A start_task block that describes the start task settings for the Batch pool.
stopPendingResizeOperation boolean

account_name str: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
node_agent_sku_id str: Specifies the Sku of the node agents that will be created in the Batch pool.
resource_group_name str: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
storage_image_reference Dict[PoolStorageImageReference]: A storage_image_reference for the virtual machines that will compose the Batch pool.
vm_size str: Specifies the size of the VM created in the Batch pool.
auto_scale Dict[PoolAutoScale]: A auto_scale block that describes the scale settings when using auto scale.
certificates List[PoolCertificate]: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
container_configuration Dict[PoolContainerConfiguration]: The container configuration used in the pool’s VMs.
display_name str: Specifies the display name of the Batch pool.
fixed_scale Dict[PoolFixedScale]: A fixed_scale block that describes the scale settings when using fixed scale.
max_tasks_per_node float: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
metadata Dict[str, str]: A map of custom batch pool metadata.
name str: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
network_configuration Dict[PoolNetworkConfiguration]: A network_configuration block that describes the network configurations for the Batch pool.
start_task Dict[PoolStartTask]: A start_task block that describes the start task settings for the Batch pool.
stop_pending_resize_operation bool

Outputs

All input properties are implicitly available as output properties. Additionally, the Pool resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Pool Resource

Get an existing Pool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PoolState, opts?: CustomResourceOptions): Pool

static get(resource_name, id, opts=None, account_name=None, auto_scale=None, certificates=None, container_configuration=None, display_name=None, fixed_scale=None, max_tasks_per_node=None, metadata=None, name=None, network_configuration=None, node_agent_sku_id=None, resource_group_name=None, start_task=None, stop_pending_resize_operation=None, storage_image_reference=None, vm_size=None, __props__=None);

func GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)

public static Pool Get(string name, Input<string> id, PoolState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountName string: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
AutoScale PoolAutoScaleArgs: A auto_scale block that describes the scale settings when using auto scale.
Certificates List<PoolCertificateArgs>: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
ContainerConfiguration PoolContainerConfigurationArgs: The container configuration used in the pool’s VMs.
DisplayName string: Specifies the display name of the Batch pool.
FixedScale PoolFixedScaleArgs: A fixed_scale block that describes the scale settings when using fixed scale.
MaxTasksPerNode int: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
Metadata Dictionary<string, string>: A map of custom batch pool metadata.
Name string: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
NetworkConfiguration PoolNetworkConfigurationArgs: A network_configuration block that describes the network configurations for the Batch pool.
NodeAgentSkuId string: Specifies the Sku of the node agents that will be created in the Batch pool.
ResourceGroupName string: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
StartTask PoolStartTaskArgs: A start_task block that describes the start task settings for the Batch pool.
StopPendingResizeOperation bool
StorageImageReference PoolStorageImageReferenceArgs: A storage_image_reference for the virtual machines that will compose the Batch pool.
VmSize string: Specifies the size of the VM created in the Batch pool.

AccountName string: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
AutoScale PoolAutoScale: A auto_scale block that describes the scale settings when using auto scale.
Certificates []PoolCertificate: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
ContainerConfiguration PoolContainerConfiguration: The container configuration used in the pool’s VMs.
DisplayName string: Specifies the display name of the Batch pool.
FixedScale PoolFixedScale: A fixed_scale block that describes the scale settings when using fixed scale.
MaxTasksPerNode int: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
Metadata map[string]string: A map of custom batch pool metadata.
Name string: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
NetworkConfiguration PoolNetworkConfiguration: A network_configuration block that describes the network configurations for the Batch pool.
NodeAgentSkuId string: Specifies the Sku of the node agents that will be created in the Batch pool.
ResourceGroupName string: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
StartTask PoolStartTask: A start_task block that describes the start task settings for the Batch pool.
StopPendingResizeOperation bool
StorageImageReference PoolStorageImageReference: A storage_image_reference for the virtual machines that will compose the Batch pool.
VmSize string: Specifies the size of the VM created in the Batch pool.

accountName string: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
autoScale PoolAutoScale: A auto_scale block that describes the scale settings when using auto scale.
certificates PoolCertificate[]: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
containerConfiguration PoolContainerConfiguration: The container configuration used in the pool’s VMs.
displayName string: Specifies the display name of the Batch pool.
fixedScale PoolFixedScale: A fixed_scale block that describes the scale settings when using fixed scale.
maxTasksPerNode number: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
metadata {[key: string]: string}: A map of custom batch pool metadata.
name string: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
networkConfiguration PoolNetworkConfiguration: A network_configuration block that describes the network configurations for the Batch pool.
nodeAgentSkuId string: Specifies the Sku of the node agents that will be created in the Batch pool.
resourceGroupName string: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
startTask PoolStartTask: A start_task block that describes the start task settings for the Batch pool.
stopPendingResizeOperation boolean
storageImageReference PoolStorageImageReference: A storage_image_reference for the virtual machines that will compose the Batch pool.
vmSize string: Specifies the size of the VM created in the Batch pool.

account_name str: Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
auto_scale Dict[PoolAutoScale]: A auto_scale block that describes the scale settings when using auto scale.
certificates List[PoolCertificate]: One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
container_configuration Dict[PoolContainerConfiguration]: The container configuration used in the pool’s VMs.
display_name str: Specifies the display name of the Batch pool.
fixed_scale Dict[PoolFixedScale]: A fixed_scale block that describes the scale settings when using fixed scale.
max_tasks_per_node float: Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.
metadata Dict[str, str]: A map of custom batch pool metadata.
name str: Specifies the name of the Batch pool. Changing this forces a new resource to be created.
network_configuration Dict[PoolNetworkConfiguration]: A network_configuration block that describes the network configurations for the Batch pool.
node_agent_sku_id str: Specifies the Sku of the node agents that will be created in the Batch pool.
resource_group_name str: The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
start_task Dict[PoolStartTask]: A start_task block that describes the start task settings for the Batch pool.
stop_pending_resize_operation bool
storage_image_reference Dict[PoolStorageImageReference]: A storage_image_reference for the virtual machines that will compose the Batch pool.
vm_size str: Specifies the size of the VM created in the Batch pool.

Supporting Types

PoolAutoScale

Formula string: The autoscale formula that needs to be used for scaling the Batch pool.
EvaluationInterval string: The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

Formula string: The autoscale formula that needs to be used for scaling the Batch pool.
EvaluationInterval string: The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

formula string: The autoscale formula that needs to be used for scaling the Batch pool.
evaluationInterval string: The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

formula str: The autoscale formula that needs to be used for scaling the Batch pool.
evaluationInterval str: The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

PoolCertificate

Id string: The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.
StoreLocation string: The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.
StoreName string: The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
Visibilities List<string>: Which user accounts on the compute node should have access to the private data of the certificate.

Id string: The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.
StoreLocation string: The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.
StoreName string: The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
Visibilities []string: Which user accounts on the compute node should have access to the private data of the certificate.

id string: The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.
storeLocation string: The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.
storeName string: The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
visibilities string[]: Which user accounts on the compute node should have access to the private data of the certificate.

id str: The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.
storeLocation str: The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.
storeName str: The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
visibilities List[str]: Which user accounts on the compute node should have access to the private data of the certificate.

PoolContainerConfiguration

ContainerImageNames List<string>: A list of container image names to use, as would be specified by docker pull.
ContainerRegistries List<PoolContainerConfigurationContainerRegistryArgs>: Additional container registries from which container images can be pulled by the pool’s VMs.
Type string: The type of container configuration. Possible value is DockerCompatible.

ContainerImageNames []string: A list of container image names to use, as would be specified by docker pull.
ContainerRegistries []PoolContainerConfigurationContainerRegistry: Additional container registries from which container images can be pulled by the pool’s VMs.
Type string: The type of container configuration. Possible value is DockerCompatible.

containerImageNames string[]: A list of container image names to use, as would be specified by docker pull.
containerRegistries PoolContainerConfigurationContainerRegistry[]: Additional container registries from which container images can be pulled by the pool’s VMs.
type string: The type of container configuration. Possible value is DockerCompatible.

containerImageNames List[str]: A list of container image names to use, as would be specified by docker pull.
containerRegistries List[PoolContainerConfigurationContainerRegistry]: Additional container registries from which container images can be pulled by the pool’s VMs.
type str: The type of container configuration. Possible value is DockerCompatible.

PoolContainerConfigurationContainerRegistry

Password string: The password to log into the registry server. Changing this forces a new resource to be created.
RegistryServer string: The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.
UserName string: The user name to log into the registry server. Changing this forces a new resource to be created.

Password string: The password to log into the registry server. Changing this forces a new resource to be created.
RegistryServer string: The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.
UserName string: The user name to log into the registry server. Changing this forces a new resource to be created.

password string: The password to log into the registry server. Changing this forces a new resource to be created.
registryServer string: The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.
userName string: The user name to log into the registry server. Changing this forces a new resource to be created.

password str: The password to log into the registry server. Changing this forces a new resource to be created.
registryServer str: The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.
userName str: The user name to log into the registry server. Changing this forces a new resource to be created.

PoolFixedScale

ResizeTimeout string: The timeout for resize operations. Defaults to PT15M.
TargetDedicatedNodes int: The number of nodes in the Batch pool. Defaults to 1.
TargetLowPriorityNodes int: The number of low priority nodes in the Batch pool. Defaults to 0.

ResizeTimeout string: The timeout for resize operations. Defaults to PT15M.
TargetDedicatedNodes int: The number of nodes in the Batch pool. Defaults to 1.
TargetLowPriorityNodes int: The number of low priority nodes in the Batch pool. Defaults to 0.

resizeTimeout string: The timeout for resize operations. Defaults to PT15M.
targetDedicatedNodes number: The number of nodes in the Batch pool. Defaults to 1.
targetLowPriorityNodes number: The number of low priority nodes in the Batch pool. Defaults to 0.

resizeTimeout str: The timeout for resize operations. Defaults to PT15M.
targetDedicatedNodes float: The number of nodes in the Batch pool. Defaults to 1.
targetLowPriorityNodes float: The number of low priority nodes in the Batch pool. Defaults to 0.

PoolNetworkConfiguration

SubnetId string: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.
EndpointConfigurations List<PoolNetworkConfigurationEndpointConfigurationArgs>: A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inbound_nat_pools block below. Changing this forces a new resource to be created.
PublicIps List<string>: A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

SubnetId string: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.
EndpointConfigurations []PoolNetworkConfigurationEndpointConfiguration: A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inbound_nat_pools block below. Changing this forces a new resource to be created.
PublicIps []string: A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

subnetId string: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.
endpointConfigurations PoolNetworkConfigurationEndpointConfiguration[]: A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inbound_nat_pools block below. Changing this forces a new resource to be created.
publicIps string[]: A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

subnet_id str: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.
endpointConfigurations List[PoolNetworkConfigurationEndpointConfiguration]: A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inbound_nat_pools block below. Changing this forces a new resource to be created.
publicIps List[str]: A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

PoolNetworkConfigurationEndpointConfiguration

BackendPort int: The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.
FrontendPortRange string: The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. 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. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.
Name string: The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.
Protocol string: The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.
NetworkSecurityGroupRules List<PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRuleArgs>: A list of network security group rules that will be applied to the endpoint. 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, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the network_security_group_rules block below. Changing this forces a new resource to be created.

BackendPort int: The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.
FrontendPortRange string: The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. 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. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.
Name string: The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.
Protocol string: The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.
NetworkSecurityGroupRules []PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule: A list of network security group rules that will be applied to the endpoint. 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, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the network_security_group_rules block below. Changing this forces a new resource to be created.

backendPort number: The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.
frontendPortRange string: The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. 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. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.
name string: The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.
protocol string: The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.
networkSecurityGroupRules PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule[]: A list of network security group rules that will be applied to the endpoint. 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, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the network_security_group_rules block below. Changing this forces a new resource to be created.

backend_port float: The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.
frontendPortRange str: The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. 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. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.
name str: The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.
protocol str: The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.
networkSecurityGroupRules List[PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule]: A list of network security group rules that will be applied to the endpoint. 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, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the network_security_group_rules block below. Changing this forces a new resource to be created.

PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

Access string: The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.
Priority int: The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.
SourceAddressPrefix string: The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

Access string: The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.
Priority int: The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.
SourceAddressPrefix string: The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

access string: The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.
priority number: The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.
sourceAddressPrefix string: The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

access str: The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.
priority float: The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.
source_address_prefix str: The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

PoolStartTask

CommandLine string: The command line executed by the start task.
UserIdentity PoolStartTaskUserIdentityArgs: A user_identity block that describes the user identity under which the start task runs.
Environment Dictionary<string, string>: A map of strings (key,value) that represents the environment variables to set in the start task.
MaxTaskRetryCount int: The number of retry count. Defaults to 1.
ResourceFiles List<PoolStartTaskResourceFileArgs>: One or more resource_file blocks that describe the files to be downloaded to a compute node.
WaitForSuccess bool: A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

CommandLine string: The command line executed by the start task.
UserIdentity PoolStartTaskUserIdentity: A user_identity block that describes the user identity under which the start task runs.
Environment map[string]string: A map of strings (key,value) that represents the environment variables to set in the start task.
MaxTaskRetryCount int: The number of retry count. Defaults to 1.
ResourceFiles []PoolStartTaskResourceFile: One or more resource_file blocks that describe the files to be downloaded to a compute node.
WaitForSuccess bool: A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

commandLine string: The command line executed by the start task.
userIdentity PoolStartTaskUserIdentity: A user_identity block that describes the user identity under which the start task runs.
environment {[key: string]: string}: A map of strings (key,value) that represents the environment variables to set in the start task.
maxTaskRetryCount number: The number of retry count. Defaults to 1.
resourceFiles PoolStartTaskResourceFile[]: One or more resource_file blocks that describe the files to be downloaded to a compute node.
waitForSuccess boolean: A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

commandLine str: The command line executed by the start task.
userIdentity Dict[PoolStartTaskUserIdentity]: A user_identity block that describes the user identity under which the start task runs.
environment Dict[str, str]: A map of strings (key,value) that represents the environment variables to set in the start task.
maxTaskRetryCount float: The number of retry count. Defaults to 1.
resourceFiles List[PoolStartTaskResourceFile]: One or more resource_file blocks that describe the files to be downloaded to a compute node.
waitForSuccess bool: A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

PoolStartTaskResourceFile

AutoStorageContainerName string: The storage container name in the auto storage account.
BlobPrefix string: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when auto_storage_container_name or storage_container_url 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.
FileMode string: The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resource_file 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.
FilePath string: The location on the compute node to which to download the file, relative to the task’s working directory. If the http_url property is specified, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified, file_path is optional and is the directory to download the files to. In the case where file_path 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 (for example by using ‘..’).
HttpUrl string: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
StorageContainerUrl string: The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

AutoStorageContainerName string: The storage container name in the auto storage account.
BlobPrefix string: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when auto_storage_container_name or storage_container_url 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.
FileMode string: The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resource_file 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.
FilePath string: The location on the compute node to which to download the file, relative to the task’s working directory. If the http_url property is specified, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified, file_path is optional and is the directory to download the files to. In the case where file_path 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 (for example by using ‘..’).
HttpUrl string: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
StorageContainerUrl string: The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

autoStorageContainerName string: The storage container name in the auto storage account.
blobPrefix string: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when auto_storage_container_name or storage_container_url 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.
fileMode string: The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resource_file 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.
filePath string: The location on the compute node to which to download the file, relative to the task’s working directory. If the http_url property is specified, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified, file_path is optional and is the directory to download the files to. In the case where file_path 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 (for example by using ‘..’).
httpUrl string: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
storageContainerUrl string: The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

autoStorageContainerName str: The storage container name in the auto storage account.
blobPrefix str: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when auto_storage_container_name or storage_container_url 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.
fileMode str: The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resource_file 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.
file_path str: The location on the compute node to which to download the file, relative to the task’s working directory. If the http_url property is specified, the file_path is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the auto_storage_container_name or storage_container_url property is specified, file_path is optional and is the directory to download the files to. In the case where file_path 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 (for example by using ‘..’).
httpUrl str: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
storageContainerUrl str: The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

PoolStartTaskUserIdentity

AutoUser PoolStartTaskUserIdentityAutoUserArgs: A auto_user block that describes the user identity under which the start task runs.
UserName string: The username to be used by the Batch pool start task.

AutoUser PoolStartTaskUserIdentityAutoUser: A auto_user block that describes the user identity under which the start task runs.
UserName string: The username to be used by the Batch pool start task.

autoUser PoolStartTaskUserIdentityAutoUser: A auto_user block that describes the user identity under which the start task runs.
userName string: The username to be used by the Batch pool start task.

autoUser Dict[PoolStartTaskUserIdentityAutoUser]: A auto_user block that describes the user identity under which the start task runs.
userName str: The username to be used by the Batch pool start task.

PoolStartTaskUserIdentityAutoUser

ElevationLevel string: The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.
Scope string: The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

ElevationLevel string: The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.
Scope string: The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

elevationLevel string: The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.
scope string: The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

elevationLevel str: The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.
scope str: The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

PoolStorageImageReference

Id string: Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.
Offer string: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
Publisher string: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
Sku string: Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
Version string: Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

Id string: Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.
Offer string: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
Publisher string: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
Sku string: Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
Version string: Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

id string: Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.
offer string: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
publisher string: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
sku string: Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
version string: Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

id str: Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.
offer str: Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
publisher str: Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
sku str: Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
version str: Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Pool

Create a Pool Resource

Pool Resource Properties

Inputs

Outputs

Look up an Existing Pool Resource

Supporting Types

PoolAutoScale

PoolCertificate

PoolContainerConfiguration

PoolContainerConfigurationContainerRegistry

PoolFixedScale

PoolNetworkConfiguration

PoolNetworkConfigurationEndpointConfiguration

PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

PoolStartTask

PoolStartTaskResourceFile

PoolStartTaskUserIdentity

PoolStartTaskUserIdentityAutoUser

PoolStorageImageReference

Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

Package Details

On This Page