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

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

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

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    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" },
            },
        });
    }

}

    package main

import (
	"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 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
		}
		return nil
	})
}

    Example coming soon!

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

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",
    },
});

    import pulumi
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 coming soon!

    Create Account Resource

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

    Constructor syntax

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

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            encryption: Optional[AccountEncryptionArgs] = None,
            identity: Optional[AccountIdentityArgs] = None,
            key_vault_reference: Optional[AccountKeyVaultReferenceArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            pool_allocation_mode: Optional[str] = None,
            public_network_access_enabled: Optional[bool] = None,
            storage_account_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
    public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
    public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)

    type: azure:batch:Account
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 AccountArgs
    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 AccountArgs
    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 AccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountArgs
    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 azureAccountResource = new Azure.Batch.Account("azureAccountResource", new()
{
    ResourceGroupName = "string",
    Encryption = new Azure.Batch.Inputs.AccountEncryptionArgs
    {
        KeyVaultKeyId = "string",
    },
    Identity = new Azure.Batch.Inputs.AccountIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    KeyVaultReference = new Azure.Batch.Inputs.AccountKeyVaultReferenceArgs
    {
        Id = "string",
        Url = "string",
    },
    Location = "string",
    Name = "string",
    PoolAllocationMode = "string",
    PublicNetworkAccessEnabled = false,
    StorageAccountId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := batch.NewAccount(ctx, "azureAccountResource", &batch.AccountArgs{
	ResourceGroupName: pulumi.String("string"),
	Encryption: &batch.AccountEncryptionArgs{
		KeyVaultKeyId: pulumi.String("string"),
	},
	Identity: &batch.AccountIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	KeyVaultReference: &batch.AccountKeyVaultReferenceArgs{
		Id:  pulumi.String("string"),
		Url: pulumi.String("string"),
	},
	Location:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PoolAllocationMode:         pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	StorageAccountId:           pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var azureAccountResource = new com.pulumi.azure.batch.Account("azureAccountResource", com.pulumi.azure.batch.AccountArgs.builder()
    .resourceGroupName("string")
    .encryption(AccountEncryptionArgs.builder()
        .keyVaultKeyId("string")
        .build())
    .identity(AccountIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .keyVaultReference(AccountKeyVaultReferenceArgs.builder()
        .id("string")
        .url("string")
        .build())
    .location("string")
    .name("string")
    .poolAllocationMode("string")
    .publicNetworkAccessEnabled(false)
    .storageAccountId("string")
    .tags(Map.of("string", "string"))
    .build());

    azure_account_resource = azure.batch.Account("azureAccountResource",
    resource_group_name="string",
    encryption={
        "key_vault_key_id": "string",
    },
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    key_vault_reference={
        "id": "string",
        "url": "string",
    },
    location="string",
    name="string",
    pool_allocation_mode="string",
    public_network_access_enabled=False,
    storage_account_id="string",
    tags={
        "string": "string",
    })

    const azureAccountResource = new azure.batch.Account("azureAccountResource", {
    resourceGroupName: "string",
    encryption: {
        keyVaultKeyId: "string",
    },
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    keyVaultReference: {
        id: "string",
        url: "string",
    },
    location: "string",
    name: "string",
    poolAllocationMode: "string",
    publicNetworkAccessEnabled: false,
    storageAccountId: "string",
    tags: {
        string: "string",
    },
});

    type: azure:batch:Account
properties:
    encryption:
        keyVaultKeyId: string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    keyVaultReference:
        id: string
        url: string
    location: string
    name: string
    poolAllocationMode: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    storageAccountId: string
    tags:
        string: string

    Account 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 Account resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    Encryption AccountEncryption
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    Identity AccountIdentity
    An identity block as defined below.
    KeyVaultReference AccountKeyVaultReference
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    PoolAllocationMode string
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this server. Defaults to true.
    StorageAccountId string
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    Encryption AccountEncryptionArgs
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    Identity AccountIdentityArgs
    An identity block as defined below.
    KeyVaultReference AccountKeyVaultReferenceArgs
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    PoolAllocationMode string
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this server. Defaults to true.
    StorageAccountId string
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    encryption AccountEncryption
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity AccountIdentity
    An identity block as defined below.
    keyVaultReference AccountKeyVaultReference
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    poolAllocationMode String
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this server. Defaults to true.
    storageAccountId String
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    resourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    encryption AccountEncryption
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity AccountIdentity
    An identity block as defined below.
    keyVaultReference AccountKeyVaultReference
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    poolAllocationMode string
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    publicNetworkAccessEnabled boolean
    Whether public network access is allowed for this server. Defaults to true.
    storageAccountId string
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    resource_group_name str
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    encryption AccountEncryptionArgs
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity AccountIdentityArgs
    An identity block as defined below.
    key_vault_reference AccountKeyVaultReferenceArgs
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    pool_allocation_mode str
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    public_network_access_enabled bool
    Whether public network access is allowed for this server. Defaults to true.
    storage_account_id str
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    encryption Property Map
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity Property Map
    An identity block as defined below.
    keyVaultReference Property Map
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    poolAllocationMode String
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this server. Defaults to true.
    storageAccountId String
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    AccountEndpoint string
    The account endpoint used to interact with the Batch service.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    The Batch account primary access key.
    SecondaryAccessKey string
    The Batch account secondary access key.
    AccountEndpoint string
    The account endpoint used to interact with the Batch service.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    The Batch account primary access key.
    SecondaryAccessKey string
    The Batch account secondary access key.
    accountEndpoint String
    The account endpoint used to interact with the Batch service.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    The Batch account primary access key.
    secondaryAccessKey String
    The Batch account secondary access key.
    accountEndpoint string
    The account endpoint used to interact with the Batch service.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey string
    The Batch account primary access key.
    secondaryAccessKey string
    The Batch account secondary access key.
    account_endpoint str
    The account endpoint used to interact with the Batch service.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_access_key str
    The Batch account primary access key.
    secondary_access_key str
    The Batch account secondary access key.
    accountEndpoint String
    The account endpoint used to interact with the Batch service.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    The Batch account primary access key.
    secondaryAccessKey String
    The Batch account secondary access key.

    Look up Existing Account Resource

    Get an existing Account 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?: AccountState, opts?: CustomResourceOptions): Account
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_endpoint: Optional[str] = None,
        encryption: Optional[AccountEncryptionArgs] = None,
        identity: Optional[AccountIdentityArgs] = None,
        key_vault_reference: Optional[AccountKeyVaultReferenceArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        pool_allocation_mode: Optional[str] = None,
        primary_access_key: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None,
        storage_account_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Account
    func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
    public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
    public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
    resources:  _:    type: azure:batch:Account    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:
    AccountEndpoint string
    The account endpoint used to interact with the Batch service.
    Encryption AccountEncryption
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    Identity AccountIdentity
    An identity block as defined below.
    KeyVaultReference AccountKeyVaultReference
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    PoolAllocationMode string
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    PrimaryAccessKey string
    The Batch account primary access key.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this server. Defaults to true.
    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The Batch account secondary access key.
    StorageAccountId string
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    AccountEndpoint string
    The account endpoint used to interact with the Batch service.
    Encryption AccountEncryptionArgs
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    Identity AccountIdentityArgs
    An identity block as defined below.
    KeyVaultReference AccountKeyVaultReferenceArgs
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    PoolAllocationMode string
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    PrimaryAccessKey string
    The Batch account primary access key.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for this server. Defaults to true.
    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The Batch account secondary access key.
    StorageAccountId string
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    accountEndpoint String
    The account endpoint used to interact with the Batch service.
    encryption AccountEncryption
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity AccountIdentity
    An identity block as defined below.
    keyVaultReference AccountKeyVaultReference
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    poolAllocationMode String
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    primaryAccessKey String
    The Batch account primary access key.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this server. Defaults to true.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The Batch account secondary access key.
    storageAccountId String
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    accountEndpoint string
    The account endpoint used to interact with the Batch service.
    encryption AccountEncryption
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity AccountIdentity
    An identity block as defined below.
    keyVaultReference AccountKeyVaultReference
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    poolAllocationMode string
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    primaryAccessKey string
    The Batch account primary access key.
    publicNetworkAccessEnabled boolean
    Whether public network access is allowed for this server. Defaults to true.
    resourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    secondaryAccessKey string
    The Batch account secondary access key.
    storageAccountId string
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    account_endpoint str
    The account endpoint used to interact with the Batch service.
    encryption AccountEncryptionArgs
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity AccountIdentityArgs
    An identity block as defined below.
    key_vault_reference AccountKeyVaultReferenceArgs
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    pool_allocation_mode str
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    primary_access_key str
    The Batch account primary access key.
    public_network_access_enabled bool
    Whether public network access is allowed for this server. Defaults to true.
    resource_group_name str
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    secondary_access_key str
    The Batch account secondary access key.
    storage_account_id str
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    accountEndpoint String
    The account endpoint used to interact with the Batch service.
    encryption Property Map
    Specifies if customer managed key encryption should be used to encrypt batch account data.
    identity Property Map
    An identity block as defined below.
    keyVaultReference Property Map
    A key_vault_reference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    poolAllocationMode String
    Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.
    primaryAccessKey String
    The Batch account primary access key.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for this server. Defaults to true.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The Batch account secondary access key.
    storageAccountId String
    Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Supporting Types

    AccountEncryption, AccountEncryptionArgs

    KeyVaultKeyId string
    The Azure key vault reference id with version that should be used to encrypt data, as documented here. Key rotation is not yet supported.
    KeyVaultKeyId string
    The Azure key vault reference id with version that should be used to encrypt data, as documented here. Key rotation is not yet supported.
    keyVaultKeyId String
    The Azure key vault reference id with version that should be used to encrypt data, as documented here. Key rotation is not yet supported.
    keyVaultKeyId string
    The Azure key vault reference id with version that should be used to encrypt data, as documented here. Key rotation is not yet supported.
    key_vault_key_id str
    The Azure key vault reference id with version that should be used to encrypt data, as documented here. Key rotation is not yet supported.
    keyVaultKeyId String
    The Azure key vault reference id with version that should be used to encrypt data, as documented here. Key rotation is not yet supported.

    AccountIdentity, AccountIdentityArgs

    Type string
    The identity type of the Batch Account. Possible values are SystemAssigned and UserAssigned.
    IdentityIds List<string>
    Specifies a list of user assigned identity ids. Required if type is UserAssigned.
    PrincipalId string
    The Principal ID for the Service Principal associated with the system assigned identity of this Batch Account.
    TenantId string
    The Tenant ID for the Service Principal associated with the system assigned identity of this Batch Account.
    Type string
    The identity type of the Batch Account. Possible values are SystemAssigned and UserAssigned.
    IdentityIds []string
    Specifies a list of user assigned identity ids. Required if type is UserAssigned.
    PrincipalId string
    The Principal ID for the Service Principal associated with the system assigned identity of this Batch Account.
    TenantId string
    The Tenant ID for the Service Principal associated with the system assigned identity of this Batch Account.
    type String
    The identity type of the Batch Account. Possible values are SystemAssigned and UserAssigned.
    identityIds List<String>
    Specifies a list of user assigned identity ids. Required if type is UserAssigned.
    principalId String
    The Principal ID for the Service Principal associated with the system assigned identity of this Batch Account.
    tenantId String
    The Tenant ID for the Service Principal associated with the system assigned identity of this Batch Account.
    type string
    The identity type of the Batch Account. Possible values are SystemAssigned and UserAssigned.
    identityIds string[]
    Specifies a list of user assigned identity ids. Required if type is UserAssigned.
    principalId string
    The Principal ID for the Service Principal associated with the system assigned identity of this Batch Account.
    tenantId string
    The Tenant ID for the Service Principal associated with the system assigned identity of this Batch Account.
    type str
    The identity type of the Batch Account. Possible values are SystemAssigned and UserAssigned.
    identity_ids Sequence[str]
    Specifies a list of user assigned identity ids. Required if type is UserAssigned.
    principal_id str
    The Principal ID for the Service Principal associated with the system assigned identity of this Batch Account.
    tenant_id str
    The Tenant ID for the Service Principal associated with the system assigned identity of this Batch Account.
    type String
    The identity type of the Batch Account. Possible values are SystemAssigned and UserAssigned.
    identityIds List<String>
    Specifies a list of user assigned identity ids. Required if type is UserAssigned.
    principalId String
    The Principal ID for the Service Principal associated with the system assigned identity of this Batch Account.
    tenantId String
    The Tenant ID for the Service Principal associated with the system assigned identity of this Batch Account.

    AccountKeyVaultReference, AccountKeyVaultReferenceArgs

    Id string
    The Azure identifier of the Azure KeyVault to use.
    Url string
    The HTTPS URL of the Azure KeyVault to use.
    Id string
    The Azure identifier of the Azure KeyVault to use.
    Url string
    The HTTPS URL of the Azure KeyVault to use.
    id String
    The Azure identifier of the Azure KeyVault to use.
    url String
    The HTTPS URL of the Azure KeyVault to use.
    id string
    The Azure identifier of the Azure KeyVault to use.
    url string
    The HTTPS URL of the Azure KeyVault to use.
    id str
    The Azure identifier of the Azure KeyVault to use.
    url str
    The HTTPS URL of the Azure KeyVault to use.
    id String
    The Azure identifier of the Azure KeyVault to use.
    url String
    The HTTPS URL of the Azure KeyVault to use.

    Import

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

     $ pulumi import azure:batch/account:Account example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Batch/batchAccounts/account1

    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.