1. Packages
  2. Azure Classic
  3. API Docs
  4. batch
  5. Pool

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.batch.Pool

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages an Azure Batch pool.

    Example Usage

    using System;
using System.IO;
using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
	private static string ReadFileBase64(string path) {
		return Convert.ToBase64String(Encoding.UTF8.GetBytes(File.ReadAllText(path)))
	}

    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var exampleBatch_accountAccount = new Azure.Batch.Account("exampleBatch/accountAccount", new Azure.Batch.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            PoolAllocationMode = "BatchService",
            StorageAccountId = exampleAccount.Id,
            Tags = 
            {
                { "env", "test" },
            },
        });
        var exampleCertificate = new Azure.Batch.Certificate("exampleCertificate", new Azure.Batch.CertificateArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            AccountName = exampleBatch / accountAccount.Name,
            Certificate = ReadFileBase64("certificate.cer"),
            Format = "Cer",
            Thumbprint = "312d31a79fa0cef49c00f769afc2b73e9f4edf34",
            ThumbprintAlgorithm = "SHA1",
        });
        var examplePool = new Azure.Batch.Pool("examplePool", new Azure.Batch.PoolArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            AccountName = exampleBatch / accountAccount.Name,
            DisplayName = "Test Acc Pool Auto",
            VmSize = "Standard_A1",
            NodeAgentSkuId = "batch.node.ubuntu 20.04",
            AutoScale = new Azure.Batch.Inputs.PoolAutoScaleArgs
            {
                EvaluationInterval = "PT15M",
                Formula = @"      startingNumberOfVMs = 1;
      maxNumberofVMs = 25;
      pendingTaskSamplePercent = $PendingTasks.GetSamplePercent(180 * TimeInterval_Second);
      pendingTaskSamples = pendingTaskSamplePercent < 70 ? startingNumberOfVMs : avg($PendingTasks.GetSample(180 *   TimeInterval_Second));
      $TargetDedicatedNodes=min(maxNumberofVMs, pendingTaskSamples);
",
            },
            StorageImageReference = new Azure.Batch.Inputs.PoolStorageImageReferenceArgs
            {
                Publisher = "microsoft-azure-batch",
                Offer = "ubuntu-server-container",
                Sku = "20-04-lts",
                Version = "latest",
            },
            ContainerConfiguration = new Azure.Batch.Inputs.PoolContainerConfigurationArgs
            {
                Type = "DockerCompatible",
                ContainerRegistries = 
                {
                    new Azure.Batch.Inputs.PoolContainerConfigurationContainerRegistryArgs
                    {
                        RegistryServer = "docker.io",
                        UserName = "login",
                        Password = "apassword",
                    },
                },
            },
            StartTask = new Azure.Batch.Inputs.PoolStartTaskArgs
            {
                CommandLine = "echo 'Hello World from $env'",
                TaskRetryMaximum = 1,
                WaitForSuccess = true,
                CommonEnvironmentProperties = 
                {
                    { "env", "TEST" },
                },
                UserIdentity = new Azure.Batch.Inputs.PoolStartTaskUserIdentityArgs
                {
                    AutoUser = new Azure.Batch.Inputs.PoolStartTaskUserIdentityAutoUserArgs
                    {
                        ElevationLevel = "NonAdmin",
                        Scope = "Task",
                    },
                },
            },
            Certificates = 
            {
                new Azure.Batch.Inputs.PoolCertificateArgs
                {
                    Id = exampleCertificate.Id,
                    Visibilities = 
                    {
                        "StartTask",
                    },
                },
            },
        });
    }

}

    package main

import (
	"encoding/base64"
	"fmt"
	"io/ioutil"

	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/batch"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func filebase64OrPanic(path string) pulumi.StringPtrInput {
	if fileData, err := ioutil.ReadFile(path); err == nil {
		return pulumi.String(base64.StdEncoding.EncodeToString(fileData[:]))
	} else {
		panic(err.Error())
	}
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = batch.NewAccount(ctx, "exampleBatch/accountAccount", &batch.AccountArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			Location:           exampleResourceGroup.Location,
			PoolAllocationMode: pulumi.String("BatchService"),
			StorageAccountId:   exampleAccount.ID(),
			Tags: pulumi.StringMap{
				"env": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		exampleCertificate, err := batch.NewCertificate(ctx, "exampleCertificate", &batch.CertificateArgs{
			ResourceGroupName:   exampleResourceGroup.Name,
			AccountName:         exampleBatch / accountAccount.Name,
			Certificate:         filebase64OrPanic("certificate.cer"),
			Format:              pulumi.String("Cer"),
			Thumbprint:          pulumi.String("312d31a79fa0cef49c00f769afc2b73e9f4edf34"),
			ThumbprintAlgorithm: pulumi.String("SHA1"),
		})
		if err != nil {
			return err
		}
		_, err = batch.NewPool(ctx, "examplePool", &batch.PoolArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			AccountName:       exampleBatch / accountAccount.Name,
			DisplayName:       pulumi.String("Test Acc Pool Auto"),
			VmSize:            pulumi.String("Standard_A1"),
			NodeAgentSkuId:    pulumi.String("batch.node.ubuntu 20.04"),
			AutoScale: &batch.PoolAutoScaleArgs{
				EvaluationInterval: pulumi.String("PT15M"),
				Formula:            pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v", "      startingNumberOfVMs = 1;\n", "      maxNumberofVMs = 25;\n", "      pendingTaskSamplePercent = ", "$", "PendingTasks.GetSamplePercent(180 * TimeInterval_Second);\n", "      pendingTaskSamples = pendingTaskSamplePercent < 70 ? startingNumberOfVMs : avg(", "$", "PendingTasks.GetSample(180 *   TimeInterval_Second));\n", "      ", "$", "TargetDedicatedNodes=min(maxNumberofVMs, pendingTaskSamples);\n")),
			},
			StorageImageReference: &batch.PoolStorageImageReferenceArgs{
				Publisher: pulumi.String("microsoft-azure-batch"),
				Offer:     pulumi.String("ubuntu-server-container"),
				Sku:       pulumi.String("20-04-lts"),
				Version:   pulumi.String("latest"),
			},
			ContainerConfiguration: &batch.PoolContainerConfigurationArgs{
				Type: pulumi.String("DockerCompatible"),
				ContainerRegistries: batch.PoolContainerConfigurationContainerRegistryArray{
					&batch.PoolContainerConfigurationContainerRegistryArgs{
						RegistryServer: pulumi.String("docker.io"),
						UserName:       pulumi.String("login"),
						Password:       pulumi.String("apassword"),
					},
				},
			},
			StartTask: &batch.PoolStartTaskArgs{
				CommandLine:      pulumi.String(fmt.Sprintf("%v%v%v", "echo 'Hello World from ", "$", "env'")),
				TaskRetryMaximum: pulumi.Int(1),
				WaitForSuccess:   pulumi.Bool(true),
				CommonEnvironmentProperties: pulumi.StringMap{
					"env": pulumi.String("TEST"),
				},
				UserIdentity: &batch.PoolStartTaskUserIdentityArgs{
					AutoUser: &batch.PoolStartTaskUserIdentityAutoUserArgs{
						ElevationLevel: pulumi.String("NonAdmin"),
						Scope:          pulumi.String("Task"),
					},
				},
			},
			Certificates: batch.PoolCertificateArray{
				&batch.PoolCertificateArgs{
					Id: exampleCertificate.ID(),
					Visibilities: pulumi.StringArray{
						pulumi.String("StartTask"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleBatch_accountAccount = new azure.batch.Account("exampleBatch/accountAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    poolAllocationMode: "BatchService",
    storageAccountId: exampleAccount.id,
    tags: {
        env: "test",
    },
});
const exampleCertificate = new azure.batch.Certificate("exampleCertificate", {
    resourceGroupName: exampleResourceGroup.name,
    accountName: exampleBatch / accountAccount.name,
    certificate: Buffer.from(fs.readFileSync("certificate.cer"), 'binary').toString('base64'),
    format: "Cer",
    thumbprint: "312d31a79fa0cef49c00f769afc2b73e9f4edf34",
    thumbprintAlgorithm: "SHA1",
});
const examplePool = new azure.batch.Pool("examplePool", {
    resourceGroupName: exampleResourceGroup.name,
    accountName: exampleBatch / accountAccount.name,
    displayName: "Test Acc Pool Auto",
    vmSize: "Standard_A1",
    nodeAgentSkuId: "batch.node.ubuntu 20.04",
    autoScale: {
        evaluationInterval: "PT15M",
        formula: `      startingNumberOfVMs = 1;
      maxNumberofVMs = 25;
      pendingTaskSamplePercent = $PendingTasks.GetSamplePercent(180 * TimeInterval_Second);
      pendingTaskSamples = pendingTaskSamplePercent < 70 ? startingNumberOfVMs : avg($PendingTasks.GetSample(180 *   TimeInterval_Second));
      $TargetDedicatedNodes=min(maxNumberofVMs, pendingTaskSamples);
`,
    },
    storageImageReference: {
        publisher: "microsoft-azure-batch",
        offer: "ubuntu-server-container",
        sku: "20-04-lts",
        version: "latest",
    },
    containerConfiguration: {
        type: "DockerCompatible",
        containerRegistries: [{
            registryServer: "docker.io",
            userName: "login",
            password: "apassword",
        }],
    },
    startTask: {
        commandLine: `echo 'Hello World from $env'`,
        taskRetryMaximum: 1,
        waitForSuccess: true,
        commonEnvironmentProperties: {
            env: "TEST",
        },
        userIdentity: {
            autoUser: {
                elevationLevel: "NonAdmin",
                scope: "Task",
            },
        },
    },
    certificates: [{
        id: exampleCertificate.id,
        visibilities: ["StartTask"],
    }],
});

    import pulumi
import base64
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_batch_account_account = azure.batch.Account("exampleBatch/accountAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    pool_allocation_mode="BatchService",
    storage_account_id=example_account.id,
    tags={
        "env": "test",
    })
example_certificate = azure.batch.Certificate("exampleCertificate",
    resource_group_name=example_resource_group.name,
    account_name=example_batch / account_account["name"],
    certificate=(lambda path: base64.b64encode(open(path).read().encode()).decode())("certificate.cer"),
    format="Cer",
    thumbprint="312d31a79fa0cef49c00f769afc2b73e9f4edf34",
    thumbprint_algorithm="SHA1")
example_pool = azure.batch.Pool("examplePool",
    resource_group_name=example_resource_group.name,
    account_name=example_batch / account_account["name"],
    display_name="Test Acc Pool Auto",
    vm_size="Standard_A1",
    node_agent_sku_id="batch.node.ubuntu 20.04",
    auto_scale=azure.batch.PoolAutoScaleArgs(
        evaluation_interval="PT15M",
        formula="""      startingNumberOfVMs = 1;
      maxNumberofVMs = 25;
      pendingTaskSamplePercent = $PendingTasks.GetSamplePercent(180 * TimeInterval_Second);
      pendingTaskSamples = pendingTaskSamplePercent < 70 ? startingNumberOfVMs : avg($PendingTasks.GetSample(180 *   TimeInterval_Second));
      $TargetDedicatedNodes=min(maxNumberofVMs, pendingTaskSamples);
""",
    ),
    storage_image_reference=azure.batch.PoolStorageImageReferenceArgs(
        publisher="microsoft-azure-batch",
        offer="ubuntu-server-container",
        sku="20-04-lts",
        version="latest",
    ),
    container_configuration=azure.batch.PoolContainerConfigurationArgs(
        type="DockerCompatible",
        container_registries=[azure.batch.PoolContainerConfigurationContainerRegistryArgs(
            registry_server="docker.io",
            user_name="login",
            password="apassword",
        )],
    ),
    start_task=azure.batch.PoolStartTaskArgs(
        command_line="echo 'Hello World from $env'",
        task_retry_maximum=1,
        wait_for_success=True,
        common_environment_properties={
            "env": "TEST",
        },
        user_identity=azure.batch.PoolStartTaskUserIdentityArgs(
            auto_user=azure.batch.PoolStartTaskUserIdentityAutoUserArgs(
                elevation_level="NonAdmin",
                scope="Task",
            ),
        ),
    ),
    certificates=[azure.batch.PoolCertificateArgs(
        id=example_certificate.id,
        visibilities=["StartTask"],
    )])

    Example coming soon!

    Create Pool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Pool(name: string, args: PoolArgs, opts?: CustomResourceOptions);
    @overload
def Pool(resource_name: str,
         args: PoolArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         node_agent_sku_id: Optional[str] = None,
         vm_size: Optional[str] = None,
         storage_image_reference: Optional[PoolStorageImageReferenceArgs] = None,
         resource_group_name: Optional[str] = None,
         account_name: Optional[str] = None,
         display_name: Optional[str] = None,
         identity: Optional[PoolIdentityArgs] = None,
         max_tasks_per_node: Optional[int] = None,
         metadata: Optional[Mapping[str, str]] = None,
         name: Optional[str] = None,
         network_configuration: Optional[PoolNetworkConfigurationArgs] = None,
         fixed_scale: Optional[PoolFixedScaleArgs] = None,
         container_configuration: Optional[PoolContainerConfigurationArgs] = None,
         start_task: Optional[PoolStartTaskArgs] = None,
         stop_pending_resize_operation: Optional[bool] = None,
         certificates: Optional[Sequence[PoolCertificateArgs]] = None,
         auto_scale: Optional[PoolAutoScaleArgs] = None)
    func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)
    public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)
    public Pool(String name, PoolArgs args)
public Pool(String name, PoolArgs args, CustomResourceOptions options)

    type: azure:batch:Pool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args PoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var poolResource = new Azure.Batch.Pool("poolResource", new()
{
    NodeAgentSkuId = "string",
    VmSize = "string",
    StorageImageReference = new Azure.Batch.Inputs.PoolStorageImageReferenceArgs
    {
        Id = "string",
        Offer = "string",
        Publisher = "string",
        Sku = "string",
        Version = "string",
    },
    ResourceGroupName = "string",
    AccountName = "string",
    DisplayName = "string",
    Identity = new Azure.Batch.Inputs.PoolIdentityArgs
    {
        IdentityIds = new[]
        {
            "string",
        },
        Type = "string",
    },
    MaxTasksPerNode = 0,
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    NetworkConfiguration = new Azure.Batch.Inputs.PoolNetworkConfigurationArgs
    {
        SubnetId = "string",
        EndpointConfigurations = new[]
        {
            new Azure.Batch.Inputs.PoolNetworkConfigurationEndpointConfigurationArgs
            {
                BackendPort = 0,
                FrontendPortRange = "string",
                Name = "string",
                Protocol = "string",
                NetworkSecurityGroupRules = new[]
                {
                    new Azure.Batch.Inputs.PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRuleArgs
                    {
                        Access = "string",
                        Priority = 0,
                        SourceAddressPrefix = "string",
                    },
                },
            },
        },
        PublicAddressProvisioningType = "string",
        PublicIps = new[]
        {
            "string",
        },
    },
    FixedScale = new Azure.Batch.Inputs.PoolFixedScaleArgs
    {
        ResizeTimeout = "string",
        TargetDedicatedNodes = 0,
        TargetLowPriorityNodes = 0,
    },
    ContainerConfiguration = new Azure.Batch.Inputs.PoolContainerConfigurationArgs
    {
        ContainerImageNames = new[]
        {
            "string",
        },
        ContainerRegistries = new[]
        {
            new Azure.Batch.Inputs.PoolContainerConfigurationContainerRegistryArgs
            {
                Password = "string",
                RegistryServer = "string",
                UserName = "string",
            },
        },
        Type = "string",
    },
    StartTask = new Azure.Batch.Inputs.PoolStartTaskArgs
    {
        CommandLine = "string",
        UserIdentity = new Azure.Batch.Inputs.PoolStartTaskUserIdentityArgs
        {
            AutoUser = new Azure.Batch.Inputs.PoolStartTaskUserIdentityAutoUserArgs
            {
                ElevationLevel = "string",
                Scope = "string",
            },
            UserName = "string",
        },
        CommonEnvironmentProperties = 
        {
            { "string", "string" },
        },
        ResourceFiles = new[]
        {
            new Azure.Batch.Inputs.PoolStartTaskResourceFileArgs
            {
                AutoStorageContainerName = "string",
                BlobPrefix = "string",
                FileMode = "string",
                FilePath = "string",
                HttpUrl = "string",
                StorageContainerUrl = "string",
            },
        },
        TaskRetryMaximum = 0,
        WaitForSuccess = false,
    },
    StopPendingResizeOperation = false,
    Certificates = new[]
    {
        new Azure.Batch.Inputs.PoolCertificateArgs
        {
            Id = "string",
            StoreLocation = "string",
            StoreName = "string",
            Visibilities = new[]
            {
                "string",
            },
        },
    },
    AutoScale = new Azure.Batch.Inputs.PoolAutoScaleArgs
    {
        Formula = "string",
        EvaluationInterval = "string",
    },
});

    example, err := batch.NewPool(ctx, "poolResource", &batch.PoolArgs{
	NodeAgentSkuId: pulumi.String("string"),
	VmSize:         pulumi.String("string"),
	StorageImageReference: &batch.PoolStorageImageReferenceArgs{
		Id:        pulumi.String("string"),
		Offer:     pulumi.String("string"),
		Publisher: pulumi.String("string"),
		Sku:       pulumi.String("string"),
		Version:   pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	AccountName:       pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Identity: &batch.PoolIdentityArgs{
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Type: pulumi.String("string"),
	},
	MaxTasksPerNode: pulumi.Int(0),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	NetworkConfiguration: &batch.PoolNetworkConfigurationArgs{
		SubnetId: pulumi.String("string"),
		EndpointConfigurations: batch.PoolNetworkConfigurationEndpointConfigurationArray{
			&batch.PoolNetworkConfigurationEndpointConfigurationArgs{
				BackendPort:       pulumi.Int(0),
				FrontendPortRange: pulumi.String("string"),
				Name:              pulumi.String("string"),
				Protocol:          pulumi.String("string"),
				NetworkSecurityGroupRules: batch.PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRuleArray{
					&batch.PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRuleArgs{
						Access:              pulumi.String("string"),
						Priority:            pulumi.Int(0),
						SourceAddressPrefix: pulumi.String("string"),
					},
				},
			},
		},
		PublicAddressProvisioningType: pulumi.String("string"),
		PublicIps: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	FixedScale: &batch.PoolFixedScaleArgs{
		ResizeTimeout:          pulumi.String("string"),
		TargetDedicatedNodes:   pulumi.Int(0),
		TargetLowPriorityNodes: pulumi.Int(0),
	},
	ContainerConfiguration: &batch.PoolContainerConfigurationArgs{
		ContainerImageNames: pulumi.StringArray{
			pulumi.String("string"),
		},
		ContainerRegistries: batch.PoolContainerConfigurationContainerRegistryArray{
			&batch.PoolContainerConfigurationContainerRegistryArgs{
				Password:       pulumi.String("string"),
				RegistryServer: pulumi.String("string"),
				UserName:       pulumi.String("string"),
			},
		},
		Type: pulumi.String("string"),
	},
	StartTask: &batch.PoolStartTaskArgs{
		CommandLine: pulumi.String("string"),
		UserIdentity: &batch.PoolStartTaskUserIdentityArgs{
			AutoUser: &batch.PoolStartTaskUserIdentityAutoUserArgs{
				ElevationLevel: pulumi.String("string"),
				Scope:          pulumi.String("string"),
			},
			UserName: pulumi.String("string"),
		},
		CommonEnvironmentProperties: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ResourceFiles: batch.PoolStartTaskResourceFileArray{
			&batch.PoolStartTaskResourceFileArgs{
				AutoStorageContainerName: pulumi.String("string"),
				BlobPrefix:               pulumi.String("string"),
				FileMode:                 pulumi.String("string"),
				FilePath:                 pulumi.String("string"),
				HttpUrl:                  pulumi.String("string"),
				StorageContainerUrl:      pulumi.String("string"),
			},
		},
		TaskRetryMaximum: pulumi.Int(0),
		WaitForSuccess:   pulumi.Bool(false),
	},
	StopPendingResizeOperation: pulumi.Bool(false),
	Certificates: batch.PoolCertificateArray{
		&batch.PoolCertificateArgs{
			Id:            pulumi.String("string"),
			StoreLocation: pulumi.String("string"),
			StoreName:     pulumi.String("string"),
			Visibilities: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	AutoScale: &batch.PoolAutoScaleArgs{
		Formula:            pulumi.String("string"),
		EvaluationInterval: pulumi.String("string"),
	},
})

    var poolResource = new com.pulumi.azure.batch.Pool("poolResource", com.pulumi.azure.batch.PoolArgs.builder()
    .nodeAgentSkuId("string")
    .vmSize("string")
    .storageImageReference(PoolStorageImageReferenceArgs.builder()
        .id("string")
        .offer("string")
        .publisher("string")
        .sku("string")
        .version("string")
        .build())
    .resourceGroupName("string")
    .accountName("string")
    .displayName("string")
    .identity(PoolIdentityArgs.builder()
        .identityIds("string")
        .type("string")
        .build())
    .maxTasksPerNode(0)
    .metadata(Map.of("string", "string"))
    .name("string")
    .networkConfiguration(PoolNetworkConfigurationArgs.builder()
        .subnetId("string")
        .endpointConfigurations(PoolNetworkConfigurationEndpointConfigurationArgs.builder()
            .backendPort(0)
            .frontendPortRange("string")
            .name("string")
            .protocol("string")
            .networkSecurityGroupRules(PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRuleArgs.builder()
                .access("string")
                .priority(0)
                .sourceAddressPrefix("string")
                .build())
            .build())
        .publicAddressProvisioningType("string")
        .publicIps("string")
        .build())
    .fixedScale(PoolFixedScaleArgs.builder()
        .resizeTimeout("string")
        .targetDedicatedNodes(0)
        .targetLowPriorityNodes(0)
        .build())
    .containerConfiguration(PoolContainerConfigurationArgs.builder()
        .containerImageNames("string")
        .containerRegistries(PoolContainerConfigurationContainerRegistryArgs.builder()
            .password("string")
            .registryServer("string")
            .userName("string")
            .build())
        .type("string")
        .build())
    .startTask(PoolStartTaskArgs.builder()
        .commandLine("string")
        .userIdentity(PoolStartTaskUserIdentityArgs.builder()
            .autoUser(PoolStartTaskUserIdentityAutoUserArgs.builder()
                .elevationLevel("string")
                .scope("string")
                .build())
            .userName("string")
            .build())
        .commonEnvironmentProperties(Map.of("string", "string"))
        .resourceFiles(PoolStartTaskResourceFileArgs.builder()
            .autoStorageContainerName("string")
            .blobPrefix("string")
            .fileMode("string")
            .filePath("string")
            .httpUrl("string")
            .storageContainerUrl("string")
            .build())
        .taskRetryMaximum(0)
        .waitForSuccess(false)
        .build())
    .stopPendingResizeOperation(false)
    .certificates(PoolCertificateArgs.builder()
        .id("string")
        .storeLocation("string")
        .storeName("string")
        .visibilities("string")
        .build())
    .autoScale(PoolAutoScaleArgs.builder()
        .formula("string")
        .evaluationInterval("string")
        .build())
    .build());

    pool_resource = azure.batch.Pool("poolResource",
    node_agent_sku_id="string",
    vm_size="string",
    storage_image_reference={
        "id": "string",
        "offer": "string",
        "publisher": "string",
        "sku": "string",
        "version": "string",
    },
    resource_group_name="string",
    account_name="string",
    display_name="string",
    identity={
        "identity_ids": ["string"],
        "type": "string",
    },
    max_tasks_per_node=0,
    metadata={
        "string": "string",
    },
    name="string",
    network_configuration={
        "subnet_id": "string",
        "endpoint_configurations": [{
            "backend_port": 0,
            "frontend_port_range": "string",
            "name": "string",
            "protocol": "string",
            "network_security_group_rules": [{
                "access": "string",
                "priority": 0,
                "source_address_prefix": "string",
            }],
        }],
        "public_address_provisioning_type": "string",
        "public_ips": ["string"],
    },
    fixed_scale={
        "resize_timeout": "string",
        "target_dedicated_nodes": 0,
        "target_low_priority_nodes": 0,
    },
    container_configuration={
        "container_image_names": ["string"],
        "container_registries": [{
            "password": "string",
            "registry_server": "string",
            "user_name": "string",
        }],
        "type": "string",
    },
    start_task={
        "command_line": "string",
        "user_identity": {
            "auto_user": {
                "elevation_level": "string",
                "scope": "string",
            },
            "user_name": "string",
        },
        "common_environment_properties": {
            "string": "string",
        },
        "resource_files": [{
            "auto_storage_container_name": "string",
            "blob_prefix": "string",
            "file_mode": "string",
            "file_path": "string",
            "http_url": "string",
            "storage_container_url": "string",
        }],
        "task_retry_maximum": 0,
        "wait_for_success": False,
    },
    stop_pending_resize_operation=False,
    certificates=[{
        "id": "string",
        "store_location": "string",
        "store_name": "string",
        "visibilities": ["string"],
    }],
    auto_scale={
        "formula": "string",
        "evaluation_interval": "string",
    })

    const poolResource = new azure.batch.Pool("poolResource", {
    nodeAgentSkuId: "string",
    vmSize: "string",
    storageImageReference: {
        id: "string",
        offer: "string",
        publisher: "string",
        sku: "string",
        version: "string",
    },
    resourceGroupName: "string",
    accountName: "string",
    displayName: "string",
    identity: {
        identityIds: ["string"],
        type: "string",
    },
    maxTasksPerNode: 0,
    metadata: {
        string: "string",
    },
    name: "string",
    networkConfiguration: {
        subnetId: "string",
        endpointConfigurations: [{
            backendPort: 0,
            frontendPortRange: "string",
            name: "string",
            protocol: "string",
            networkSecurityGroupRules: [{
                access: "string",
                priority: 0,
                sourceAddressPrefix: "string",
            }],
        }],
        publicAddressProvisioningType: "string",
        publicIps: ["string"],
    },
    fixedScale: {
        resizeTimeout: "string",
        targetDedicatedNodes: 0,
        targetLowPriorityNodes: 0,
    },
    containerConfiguration: {
        containerImageNames: ["string"],
        containerRegistries: [{
            password: "string",
            registryServer: "string",
            userName: "string",
        }],
        type: "string",
    },
    startTask: {
        commandLine: "string",
        userIdentity: {
            autoUser: {
                elevationLevel: "string",
                scope: "string",
            },
            userName: "string",
        },
        commonEnvironmentProperties: {
            string: "string",
        },
        resourceFiles: [{
            autoStorageContainerName: "string",
            blobPrefix: "string",
            fileMode: "string",
            filePath: "string",
            httpUrl: "string",
            storageContainerUrl: "string",
        }],
        taskRetryMaximum: 0,
        waitForSuccess: false,
    },
    stopPendingResizeOperation: false,
    certificates: [{
        id: "string",
        storeLocation: "string",
        storeName: "string",
        visibilities: ["string"],
    }],
    autoScale: {
        formula: "string",
        evaluationInterval: "string",
    },
});

    type: azure:batch:Pool
properties:
    accountName: string
    autoScale:
        evaluationInterval: string
        formula: string
    certificates:
        - id: string
          storeLocation: string
          storeName: string
          visibilities:
            - string
    containerConfiguration:
        containerImageNames:
            - string
        containerRegistries:
            - password: string
              registryServer: string
              userName: string
        type: string
    displayName: string
    fixedScale:
        resizeTimeout: string
        targetDedicatedNodes: 0
        targetLowPriorityNodes: 0
    identity:
        identityIds:
            - string
        type: string
    maxTasksPerNode: 0
    metadata:
        string: string
    name: string
    networkConfiguration:
        endpointConfigurations:
            - backendPort: 0
              frontendPortRange: string
              name: string
              networkSecurityGroupRules:
                - access: string
                  priority: 0
                  sourceAddressPrefix: string
              protocol: string
        publicAddressProvisioningType: string
        publicIps:
            - string
        subnetId: string
    nodeAgentSkuId: string
    resourceGroupName: string
    startTask:
        commandLine: string
        commonEnvironmentProperties:
            string: string
        resourceFiles:
            - autoStorageContainerName: string
              blobPrefix: string
              fileMode: string
              filePath: string
              httpUrl: string
              storageContainerUrl: string
        taskRetryMaximum: 0
        userIdentity:
            autoUser:
                elevationLevel: string
                scope: string
            userName: string
        waitForSuccess: false
    stopPendingResizeOperation: false
    storageImageReference:
        id: string
        offer: string
        publisher: string
        sku: string
        version: string
    vmSize: string

    Pool Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 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 List<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.
    Identity PoolIdentity
    An identity block as defined below.
    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 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 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 []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.
    Identity PoolIdentityArgs
    An identity block as defined below.
    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 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 List<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.
    identity PoolIdentity
    An identity block as defined below.
    maxTasksPerNode Integer
    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 Boolean
    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.
    identity PoolIdentity
    An identity block as defined below.
    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 PoolStorageImageReferenceArgs
    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 PoolAutoScaleArgs
    A auto_scale block that describes the scale settings when using auto scale.
    certificates Sequence[PoolCertificateArgs]
    One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
    container_configuration PoolContainerConfigurationArgs
    The container configuration used in the pool's VMs.
    display_name str
    Specifies the display name of the Batch pool.
    fixed_scale PoolFixedScaleArgs
    A fixed_scale block that describes the scale settings when using fixed scale.
    identity PoolIdentityArgs
    An identity block as defined below.
    max_tasks_per_node 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 Mapping[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 PoolNetworkConfigurationArgs
    A network_configuration block that describes the network configurations for the Batch pool.
    start_task PoolStartTaskArgs
    A start_task block that describes the start task settings for the Batch pool.
    stop_pending_resize_operation 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 Property Map
    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 Property Map
    A auto_scale block that describes the scale settings when using auto scale.
    certificates List<Property Map>
    One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
    containerConfiguration Property Map
    The container configuration used in the pool's VMs.
    displayName String
    Specifies the display name of the Batch pool.
    fixedScale Property Map
    A fixed_scale block that describes the scale settings when using fixed scale.
    identity Property Map
    An identity block as defined below.
    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 Map<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 Property Map
    A network_configuration block that describes the network configurations for the Batch pool.
    startTask Property Map
    A start_task block that describes the start task settings for the Batch pool.
    stopPendingResizeOperation Boolean

    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        auto_scale: Optional[PoolAutoScaleArgs] = None,
        certificates: Optional[Sequence[PoolCertificateArgs]] = None,
        container_configuration: Optional[PoolContainerConfigurationArgs] = None,
        display_name: Optional[str] = None,
        fixed_scale: Optional[PoolFixedScaleArgs] = None,
        identity: Optional[PoolIdentityArgs] = None,
        max_tasks_per_node: Optional[int] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        network_configuration: Optional[PoolNetworkConfigurationArgs] = None,
        node_agent_sku_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        start_task: Optional[PoolStartTaskArgs] = None,
        stop_pending_resize_operation: Optional[bool] = None,
        storage_image_reference: Optional[PoolStorageImageReferenceArgs] = None,
        vm_size: Optional[str] = None) -> Pool
    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)
    public static Pool get(String name, Output<String> id, PoolState state, CustomResourceOptions options)
    resources:  _:    type: azure:batch:Pool    get:      id: ${id}
    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.
    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 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.
    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.
    Identity PoolIdentity
    An identity block as defined below.
    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 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 PoolAutoScaleArgs
    A auto_scale block that describes the scale settings when using auto scale.
    Certificates []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.
    Identity PoolIdentityArgs
    An identity block as defined below.
    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 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 List<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.
    identity PoolIdentity
    An identity block as defined below.
    maxTasksPerNode Integer
    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 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.
    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.
    identity PoolIdentity
    An identity block as defined below.
    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 PoolAutoScaleArgs
    A auto_scale block that describes the scale settings when using auto scale.
    certificates Sequence[PoolCertificateArgs]
    One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
    container_configuration PoolContainerConfigurationArgs
    The container configuration used in the pool's VMs.
    display_name str
    Specifies the display name of the Batch pool.
    fixed_scale PoolFixedScaleArgs
    A fixed_scale block that describes the scale settings when using fixed scale.
    identity PoolIdentityArgs
    An identity block as defined below.
    max_tasks_per_node 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 Mapping[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 PoolNetworkConfigurationArgs
    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 PoolStartTaskArgs
    A start_task block that describes the start task settings for the Batch pool.
    stop_pending_resize_operation bool
    storage_image_reference PoolStorageImageReferenceArgs
    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.
    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 Property Map
    A auto_scale block that describes the scale settings when using auto scale.
    certificates List<Property Map>
    One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.
    containerConfiguration Property Map
    The container configuration used in the pool's VMs.
    displayName String
    Specifies the display name of the Batch pool.
    fixedScale Property Map
    A fixed_scale block that describes the scale settings when using fixed scale.
    identity Property Map
    An identity block as defined below.
    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 Map<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 Property Map
    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 Property Map
    A start_task block that describes the start task settings for the Batch pool.
    stopPendingResizeOperation Boolean
    storageImageReference Property Map
    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.

    Supporting Types

    PoolAutoScale, PoolAutoScaleArgs

    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 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.
    evaluation_interval str
    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.

    PoolCertificate, PoolCertificateArgs

    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 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 str
    The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.
    store_location str
    The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.
    store_name 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 Sequence[str]
    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 List<String>
    Which user accounts on the compute node should have access to the private data of the certificate.

    PoolContainerConfiguration, PoolContainerConfigurationArgs

    ContainerImageNames List<string>
    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 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<String>
    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 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.
    container_image_names Sequence[str]
    A list of container image names to use, as would be specified by docker pull.
    container_registries Sequence[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.
    containerImageNames List<String>
    A list of container image names to use, as would be specified by docker pull.
    containerRegistries List<Property Map>
    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.

    PoolContainerConfigurationContainerRegistry, PoolContainerConfigurationContainerRegistryArgs

    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 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.
    registry_server str
    The container registry URL. The default is "docker.io". Changing this forces a new resource to be created.
    user_name str
    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.

    PoolFixedScale, PoolFixedScaleArgs

    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 Integer
    The number of nodes in the Batch pool. Defaults to 1.
    targetLowPriorityNodes Integer
    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.
    resize_timeout str
    The timeout for resize operations. Defaults to PT15M.
    target_dedicated_nodes int
    The number of nodes in the Batch pool. Defaults to 1.
    target_low_priority_nodes 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.

    PoolIdentity, PoolIdentityArgs

    IdentityIds List<string>
    Specifies a list of user assigned identity ids.
    Type string
    The identity type of the Batch Account. Only possible values is UserAssigned.
    IdentityIds []string
    Specifies a list of user assigned identity ids.
    Type string
    The identity type of the Batch Account. Only possible values is UserAssigned.
    identityIds List<String>
    Specifies a list of user assigned identity ids.
    type String
    The identity type of the Batch Account. Only possible values is UserAssigned.
    identityIds string[]
    Specifies a list of user assigned identity ids.
    type string
    The identity type of the Batch Account. Only possible values is UserAssigned.
    identity_ids Sequence[str]
    Specifies a list of user assigned identity ids.
    type str
    The identity type of the Batch Account. Only possible values is UserAssigned.
    identityIds List<String>
    Specifies a list of user assigned identity ids.
    type String
    The identity type of the Batch Account. Only possible values is UserAssigned.

    PoolNetworkConfiguration, PoolNetworkConfigurationArgs

    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<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.
    PublicAddressProvisioningType string
    Type of public IP address provisioning. Supported values are BatchManaged, UserManaged and NoPublicIPAddresses.
    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.
    PublicAddressProvisioningType string
    Type of public IP address provisioning. Supported values are BatchManaged, UserManaged and NoPublicIPAddresses.
    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 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.
    publicAddressProvisioningType String
    Type of public IP address provisioning. Supported values are BatchManaged, UserManaged and NoPublicIPAddresses.
    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.
    publicAddressProvisioningType string
    Type of public IP address provisioning. Supported values are BatchManaged, UserManaged and NoPublicIPAddresses.
    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.
    endpoint_configurations Sequence[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.
    public_address_provisioning_type str
    Type of public IP address provisioning. Supported values are BatchManaged, UserManaged and NoPublicIPAddresses.
    public_ips Sequence[str]
    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 List<Property Map>
    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.
    publicAddressProvisioningType String
    Type of public IP address provisioning. Supported values are BatchManaged, UserManaged and NoPublicIPAddresses.
    publicIps List<String>
    A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

    PoolNetworkConfigurationEndpointConfiguration, PoolNetworkConfigurationEndpointConfigurationArgs

    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<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 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 Integer
    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<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 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.
    frontend_port_range 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.
    network_security_group_rules Sequence[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 List<Property Map>
    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, PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRuleArgs

    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 Integer
    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 int
    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.
    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.

    PoolStartTask, PoolStartTaskArgs

    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.
    CommonEnvironmentProperties Dictionary<string, string>
    A map of strings (key,value) that represents the environment variables to set in the start task.
    Environment Dictionary<string, string>
    A map of strings (key,value) that represents the environment variables to set in the start task.

    Deprecated: Deprecated in favour of common_environment_properties

    MaxTaskRetryCount int
    The number of retry count. Defaults to 1.

    Deprecated: Deprecated in favour of task_retry_maximum

    ResourceFiles List<PoolStartTaskResourceFile>
    One or more resource_file blocks that describe the files to be downloaded to a compute node.
    TaskRetryMaximum int
    The number of retry count. Defaults to 1.
    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.
    CommonEnvironmentProperties map[string]string
    A map of strings (key,value) that represents the environment variables to set in the start task.
    Environment map[string]string
    A map of strings (key,value) that represents the environment variables to set in the start task.

    Deprecated: Deprecated in favour of common_environment_properties

    MaxTaskRetryCount int
    The number of retry count. Defaults to 1.

    Deprecated: Deprecated in favour of task_retry_maximum

    ResourceFiles []PoolStartTaskResourceFile
    One or more resource_file blocks that describe the files to be downloaded to a compute node.
    TaskRetryMaximum int
    The number of retry count. Defaults to 1.
    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.
    commonEnvironmentProperties Map<String,String>
    A map of strings (key,value) that represents the environment variables to set in the start task.
    environment Map<String,String>
    A map of strings (key,value) that represents the environment variables to set in the start task.

    Deprecated: Deprecated in favour of common_environment_properties

    maxTaskRetryCount Integer
    The number of retry count. Defaults to 1.

    Deprecated: Deprecated in favour of task_retry_maximum

    resourceFiles List<PoolStartTaskResourceFile>
    One or more resource_file blocks that describe the files to be downloaded to a compute node.
    taskRetryMaximum Integer
    The number of retry count. Defaults to 1.
    waitForSuccess Boolean
    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.
    commonEnvironmentProperties {[key: string]: string}
    A map of strings (key,value) that represents the environment variables to set in the start task.
    environment {[key: string]: string}
    A map of strings (key,value) that represents the environment variables to set in the start task.

    Deprecated: Deprecated in favour of common_environment_properties

    maxTaskRetryCount number
    The number of retry count. Defaults to 1.

    Deprecated: Deprecated in favour of task_retry_maximum

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

    Deprecated: Deprecated in favour of common_environment_properties

    max_task_retry_count int
    The number of retry count. Defaults to 1.

    Deprecated: Deprecated in favour of task_retry_maximum

    resource_files Sequence[PoolStartTaskResourceFile]
    One or more resource_file blocks that describe the files to be downloaded to a compute node.
    task_retry_maximum int
    The number of retry count. Defaults to 1.
    wait_for_success 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 Property Map
    A user_identity block that describes the user identity under which the start task runs.
    commonEnvironmentProperties Map<String>
    A map of strings (key,value) that represents the environment variables to set in the start task.
    environment Map<String>
    A map of strings (key,value) that represents the environment variables to set in the start task.

    Deprecated: Deprecated in favour of common_environment_properties

    maxTaskRetryCount Number
    The number of retry count. Defaults to 1.

    Deprecated: Deprecated in favour of task_retry_maximum

    resourceFiles List<Property Map>
    One or more resource_file blocks that describe the files to be downloaded to a compute node.
    taskRetryMaximum Number
    The number of retry count. Defaults to 1.
    waitForSuccess Boolean
    A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

    PoolStartTaskResourceFile, PoolStartTaskResourceFileArgs

    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 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.
    auto_storage_container_name str
    The storage container name in the auto storage account.
    blob_prefix 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.
    file_mode 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 '..').
    http_url 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.
    storage_container_url 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.
    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.

    PoolStartTaskUserIdentity, PoolStartTaskUserIdentityArgs

    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 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.
    auto_user PoolStartTaskUserIdentityAutoUser
    A auto_user block that describes the user identity under which the start task runs.
    user_name str
    The username to be used by the Batch pool start task.
    autoUser Property Map
    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.

    PoolStartTaskUserIdentityAutoUser, PoolStartTaskUserIdentityAutoUserArgs

    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 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.
    elevation_level 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.
    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.

    PoolStorageImageReference, PoolStorageImageReferenceArgs

    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 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.
    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.

    Import

    Batch Pools can be imported using the resource id, e.g.

     $ pulumi import azure:batch/pool:Pool example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.Batch/batchAccounts/myBatchAccount1/pools/myBatchPool1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.