GetPool

Use this data source to access information about an existing Batch pool

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Batch.GetPool.InvokeAsync(new Azure.Batch.GetPoolArgs
        {
            AccountName = "testbatchaccount",
            Name = "testbatchpool",
            ResourceGroupName = "test",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/batch"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := batch.LookupPool(ctx, &batch.LookupPoolArgs{
            AccountName:       "testbatchaccount",
            Name:              "testbatchpool",
            ResourceGroupName: "test",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.batch.get_pool(account_name="testbatchaccount",
    name="testbatchpool",
    resource_group_name="test")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.batch.getPool({
    accountName: "testbatchaccount",
    name: "testbatchpool",
    resourceGroupName: "test",
}, { async: true }));

Using GetPool

function getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>

function  get_pool(account_name=None, certificates=None, name=None, network_configuration=None, resource_group_name=None, start_task=None, opts=None)

func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)

public static class GetPool {
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

AccountName string: The name of the Batch account.
Name string: The name of the endpoint.
ResourceGroupName string
Certificates List<GetPoolCertificateArgs>: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
NetworkConfiguration GetPoolNetworkConfigurationArgs
StartTask GetPoolStartTaskArgs: A start_task block that describes the start task settings for the Batch pool.

AccountName string: The name of the Batch account.
Name string: The name of the endpoint.
ResourceGroupName string
Certificates []GetPoolCertificate: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
NetworkConfiguration GetPoolNetworkConfiguration
StartTask GetPoolStartTask: A start_task block that describes the start task settings for the Batch pool.

accountName string: The name of the Batch account.
name string: The name of the endpoint.
resourceGroupName string
certificates GetPoolCertificate[]: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
networkConfiguration GetPoolNetworkConfiguration
startTask GetPoolStartTask: A start_task block that describes the start task settings for the Batch pool.

account_name str: The name of the Batch account.
name str: The name of the endpoint.
resource_group_name str
certificates List[GetPoolCertificate]: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
network_configuration Dict[GetPoolNetworkConfiguration]
start_task Dict[GetPoolStartTask]: A start_task block that describes the start task settings for the Batch pool.

GetPool Result

The following output properties are available:

AccountName string: The name of the Batch account.
AutoScales List<GetPoolAutoScale>: A auto_scale block that describes the scale settings when using auto scale.
ContainerConfigurations List<GetPoolContainerConfiguration>: The container configuration used in the pool’s VMs.
DisplayName string
FixedScales List<GetPoolFixedScale>: A fixed_scale block that describes the scale settings when using fixed scale.
Id string: The provider-assigned unique ID for this managed resource.
MaxTasksPerNode int: The maximum number of tasks that can run concurrently on a single compute node in the pool.
Metadata Dictionary<string, string>
Name string: The name of the endpoint.
NetworkConfiguration GetPoolNetworkConfiguration
NodeAgentSkuId string: The Sku of the node agents in the Batch pool.
ResourceGroupName string
StorageImageReferences List<GetPoolStorageImageReference>: The reference of the storage image used by the nodes in the Batch pool.
VmSize string: The size of the VM created in the Batch pool.
Certificates List<GetPoolCertificate>: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
StartTask GetPoolStartTask: A start_task block that describes the start task settings for the Batch pool.

AccountName string: The name of the Batch account.
AutoScales []GetPoolAutoScale: A auto_scale block that describes the scale settings when using auto scale.
ContainerConfigurations []GetPoolContainerConfiguration: The container configuration used in the pool’s VMs.
DisplayName string
FixedScales []GetPoolFixedScale: A fixed_scale block that describes the scale settings when using fixed scale.
Id string: The provider-assigned unique ID for this managed resource.
MaxTasksPerNode int: The maximum number of tasks that can run concurrently on a single compute node in the pool.
Metadata map[string]string
Name string: The name of the endpoint.
NetworkConfiguration GetPoolNetworkConfiguration
NodeAgentSkuId string: The Sku of the node agents in the Batch pool.
ResourceGroupName string
StorageImageReferences []GetPoolStorageImageReference: The reference of the storage image used by the nodes in the Batch pool.
VmSize string: The size of the VM created in the Batch pool.
Certificates []GetPoolCertificate: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
StartTask GetPoolStartTask: A start_task block that describes the start task settings for the Batch pool.

accountName string: The name of the Batch account.
autoScales GetPoolAutoScale[]: A auto_scale block that describes the scale settings when using auto scale.
containerConfigurations GetPoolContainerConfiguration[]: The container configuration used in the pool’s VMs.
displayName string
fixedScales GetPoolFixedScale[]: A fixed_scale block that describes the scale settings when using fixed scale.
id string: The provider-assigned unique ID for this managed resource.
maxTasksPerNode number: The maximum number of tasks that can run concurrently on a single compute node in the pool.
metadata {[key: string]: string}
name string: The name of the endpoint.
networkConfiguration GetPoolNetworkConfiguration
nodeAgentSkuId string: The Sku of the node agents in the Batch pool.
resourceGroupName string
storageImageReferences GetPoolStorageImageReference[]: The reference of the storage image used by the nodes in the Batch pool.
vmSize string: The size of the VM created in the Batch pool.
certificates GetPoolCertificate[]: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
startTask GetPoolStartTask: A start_task block that describes the start task settings for the Batch pool.

account_name str: The name of the Batch account.
auto_scales List[GetPoolAutoScale]: A auto_scale block that describes the scale settings when using auto scale.
container_configurations List[GetPoolContainerConfiguration]: The container configuration used in the pool’s VMs.
display_name str
fixed_scales List[GetPoolFixedScale]: A fixed_scale block that describes the scale settings when using fixed scale.
id str: The provider-assigned unique ID for this managed resource.
max_tasks_per_node float: The maximum number of tasks that can run concurrently on a single compute node in the pool.
metadata Dict[str, str]
name str: The name of the endpoint.
network_configuration Dict[GetPoolNetworkConfiguration]
node_agent_sku_id str: The Sku of the node agents in the Batch pool.
resource_group_name str
storage_image_references List[GetPoolStorageImageReference]: The reference of the storage image used by the nodes in the Batch pool.
vm_size str: The size of the VM created in the Batch pool.
certificates List[GetPoolCertificate]: One or more certificate blocks that describe the certificates installed on each compute node in the pool.
start_task Dict[GetPoolStartTask]: A start_task block that describes the start task settings for the Batch pool.

Supporting Types

GetPoolAutoScale

EvaluationInterval string: The interval to wait before evaluating if the pool needs to be scaled.
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.
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.
formula string: 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.
formula str: The autoscale formula that needs to be used for scaling the Batch pool.

GetPoolCertificate

Id string: The fully qualified ID of the certificate installed on the pool.
StoreLocation string: The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.
StoreName string: The name of the certificate store on the compute node into which the certificate is installed.
Visibilities List<string>: Which user accounts on the compute node have access to the private data of the certificate.

Id string: The fully qualified ID of the certificate installed on the pool.
StoreLocation string: The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.
StoreName string: The name of the certificate store on the compute node into which the certificate is installed.
Visibilities []string: Which user accounts on the compute node have access to the private data of the certificate.

id string: The fully qualified ID of the certificate installed on the pool.
storeLocation string: The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.
storeName string: The name of the certificate store on the compute node into which the certificate is installed.
visibilities string[]: Which user accounts on the compute node have access to the private data of the certificate.

id str: The fully qualified ID of the certificate installed on the pool.
storeLocation str: The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.
storeName str: The name of the certificate store on the compute node into which the certificate is installed.
visibilities List[str]: Which user accounts on the compute node have access to the private data of the certificate.

GetPoolContainerConfiguration

ContainerRegistries List<GetPoolContainerConfigurationContainerRegistryArgs>: Additional container registries from which container images can be pulled by the pool’s VMs.
Type string: The type of container configuration.

ContainerRegistries []GetPoolContainerConfigurationContainerRegistry: Additional container registries from which container images can be pulled by the pool’s VMs.
Type string: The type of container configuration.

containerRegistries GetPoolContainerConfigurationContainerRegistry[]: Additional container registries from which container images can be pulled by the pool’s VMs.
type string: The type of container configuration.

containerRegistries List[GetPoolContainerConfigurationContainerRegistry]: Additional container registries from which container images can be pulled by the pool’s VMs.
type str: The type of container configuration.

GetPoolContainerConfigurationContainerRegistry

Password string: The password to log into the registry server.
RegistryServer string: The container registry URL. The default is “docker.io”.
UserName string: The user name to log into the registry server.

Password string: The password to log into the registry server.
RegistryServer string: The container registry URL. The default is “docker.io”.
UserName string: The user name to log into the registry server.

password string: The password to log into the registry server.
registryServer string: The container registry URL. The default is “docker.io”.
userName string: The user name to log into the registry server.

password str: The password to log into the registry server.
registryServer str: The container registry URL. The default is “docker.io”.
userName str: The user name to log into the registry server.

GetPoolFixedScale

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

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

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

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

GetPoolNetworkConfiguration

EndpointConfiguration GetPoolNetworkConfigurationEndpointConfigurationArgs: The inbound NAT pools that are used to address specific ports on the individual compute node externally.
SubnetId string: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

EndpointConfiguration GetPoolNetworkConfigurationEndpointConfiguration: The inbound NAT pools that are used to address specific ports on the individual compute node externally.
SubnetId string: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

endpointConfiguration GetPoolNetworkConfigurationEndpointConfiguration: The inbound NAT pools that are used to address specific ports on the individual compute node externally.
subnetId string: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

endpointConfiguration Dict[GetPoolNetworkConfigurationEndpointConfiguration]: The inbound NAT pools that are used to address specific ports on the individual compute node externally.
subnet_id str: The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

GetPoolNetworkConfigurationEndpointConfiguration

BackendPort int: The port number on the compute node.
FrontendPortRange string: The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.
Name string: The name of the endpoint.
NetworkSecurityGroupRules List<GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRuleArgs>: The list of network security group rules that are applied to the endpoint.
Protocol string: The protocol of the endpoint.

BackendPort int: The port number on the compute node.
FrontendPortRange string: The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.
Name string: The name of the endpoint.
NetworkSecurityGroupRules []GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule: The list of network security group rules that are applied to the endpoint.
Protocol string: The protocol of the endpoint.

backendPort number: The port number on the compute node.
frontendPortRange string: The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.
name string: The name of the endpoint.
networkSecurityGroupRules GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule[]: The list of network security group rules that are applied to the endpoint.
protocol string: The protocol of the endpoint.

backend_port float: The port number on the compute node.
frontendPortRange str: The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.
name str: The name of the endpoint.
networkSecurityGroupRules List[GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule]: The list of network security group rules that are applied to the endpoint.
protocol str: The protocol of the endpoint.

GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

Access string: The action that should be taken for a specified IP address, subnet range or tag.
Priority int: The priority for this rule.
SourceAddressPrefix string: The source address prefix or tag to match for the rule.

Access string: The action that should be taken for a specified IP address, subnet range or tag.
Priority int: The priority for this rule.
SourceAddressPrefix string: The source address prefix or tag to match for the rule.

access string: The action that should be taken for a specified IP address, subnet range or tag.
priority number: The priority for this rule.
sourceAddressPrefix string: The source address prefix or tag to match for the rule.

access str: The action that should be taken for a specified IP address, subnet range or tag.
priority float: The priority for this rule.
source_address_prefix str: The source address prefix or tag to match for the rule.

GetPoolStartTask

CommandLine string: The command line executed by the start task.
ResourceFiles List<GetPoolStartTaskResourceFileArgs>: One or more resource_file blocks that describe the files to be downloaded to a compute node.
UserIdentities List<GetPoolStartTaskUserIdentityArgs>: 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.
WaitForSuccess bool: A flag that indicates if the Batch pool should wait for the start task to be completed.

CommandLine string: The command line executed by the start task.
ResourceFiles []GetPoolStartTaskResourceFile: One or more resource_file blocks that describe the files to be downloaded to a compute node.
UserIdentities []GetPoolStartTaskUserIdentity: 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.
WaitForSuccess bool: A flag that indicates if the Batch pool should wait for the start task to be completed.

commandLine string: The command line executed by the start task.
resourceFiles GetPoolStartTaskResourceFile[]: One or more resource_file blocks that describe the files to be downloaded to a compute node.
userIdentities GetPoolStartTaskUserIdentity[]: 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.
waitForSuccess boolean: A flag that indicates if the Batch pool should wait for the start task to be completed.

commandLine str: The command line executed by the start task.
resourceFiles List[GetPoolStartTaskResourceFile]: One or more resource_file blocks that describe the files to be downloaded to a compute node.
userIdentities List[GetPoolStartTaskUserIdentity]: 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.
waitForSuccess bool: A flag that indicates if the Batch pool should wait for the start task to be completed.

GetPoolStartTaskResourceFile

AutoStorageContainerName string: The storage container name in the auto storage account.
BlobPrefix string: The blob prefix used when downloading blobs from an Azure Storage container.
FileMode string: The file permission mode attribute represented as a string in octal format (e.g. "0644").
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.
HttpUrl string: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
StorageContainerUrl string: The URL of the blob container within Azure Blob Storage.

AutoStorageContainerName string: The storage container name in the auto storage account.
BlobPrefix string: The blob prefix used when downloading blobs from an Azure Storage container.
FileMode string: The file permission mode attribute represented as a string in octal format (e.g. "0644").
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.
HttpUrl string: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
StorageContainerUrl string: The URL of the blob container within Azure Blob Storage.

autoStorageContainerName string: The storage container name in the auto storage account.
blobPrefix string: The blob prefix used when downloading blobs from an Azure Storage container.
fileMode string: The file permission mode attribute represented as a string in octal format (e.g. "0644").
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.
httpUrl string: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
storageContainerUrl string: The URL of the blob container within Azure Blob Storage.

autoStorageContainerName str: The storage container name in the auto storage account.
blobPrefix str: The blob prefix used when downloading blobs from an Azure Storage container.
fileMode str: The file permission mode attribute represented as a string in octal format (e.g. "0644").
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.
httpUrl str: The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.
storageContainerUrl str: The URL of the blob container within Azure Blob Storage.

GetPoolStartTaskUserIdentity

AutoUsers List<GetPoolStartTaskUserIdentityAutoUserArgs>: A auto_user block that describes the user identity under which the start task runs.
UserName string: The user name to log into the registry server.

AutoUsers []GetPoolStartTaskUserIdentityAutoUser: A auto_user block that describes the user identity under which the start task runs.
UserName string: The user name to log into the registry server.

autoUsers GetPoolStartTaskUserIdentityAutoUser[]: A auto_user block that describes the user identity under which the start task runs.
userName string: The user name to log into the registry server.

autoUsers List[GetPoolStartTaskUserIdentityAutoUser]: A auto_user block that describes the user identity under which the start task runs.
userName str: The user name to log into the registry server.

GetPoolStartTaskUserIdentityAutoUser

ElevationLevel string: The elevation level of the user identity under which the start task runs.
Scope string: The scope of the user identity under which the start task runs.

ElevationLevel string: The elevation level of the user identity under which the start task runs.
Scope string: The scope of the user identity under which the start task runs.

elevationLevel string: The elevation level of the user identity under which the start task runs.
scope string: The scope of the user identity under which the start task runs.

elevationLevel str: The elevation level of the user identity under which the start task runs.
scope str: The scope of the user identity under which the start task runs.

GetPoolStorageImageReference

Id string: The fully qualified ID of the certificate installed on the pool.
Offer string
Publisher string
Sku string
Version string

Id string: The fully qualified ID of the certificate installed on the pool.
Offer string
Publisher string
Sku string
Version string

id string: The fully qualified ID of the certificate installed on the pool.
offer string
publisher string
sku string
version string

id str: The fully qualified ID of the certificate installed on the pool.
offer str
publisher str
sku str
version str

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

GetPool

Example Usage

Using GetPool

GetPool Result

Supporting Types

GetPoolAutoScale

GetPoolCertificate

GetPoolContainerConfiguration

GetPoolContainerConfigurationContainerRegistry

GetPoolFixedScale

GetPoolNetworkConfiguration

GetPoolNetworkConfigurationEndpointConfiguration

GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

GetPoolStartTask

GetPoolStartTaskResourceFile

GetPoolStartTaskUserIdentity

GetPoolStartTaskUserIdentityAutoUser

GetPoolStorageImageReference

Package Details

On This Page