Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. batch
  5. BatchAccount
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.batch.BatchAccount

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Contains information about an Azure Batch account.

Uses Azure REST API version 2024-07-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.

Other available API versions: 2023-05-01, 2023-11-01, 2024-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native batch [ApiVersion]. See the version guide for details.

Example Usage

BatchAccountCreate_BYOS

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var batchAccount = new AzureNative.Batch.BatchAccount("batchAccount", new()
    {
        AccountName = "sampleacct",
        AutoStorage = new AzureNative.Batch.Inputs.AutoStorageBasePropertiesArgs
        {
            StorageAccountId = "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
        },
        KeyVaultReference = new AzureNative.Batch.Inputs.KeyVaultReferenceArgs
        {
            Id = "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
            Url = "http://sample.vault.azure.net/",
        },
        Location = "japaneast",
        PoolAllocationMode = AzureNative.Batch.PoolAllocationMode.UserSubscription,
        ResourceGroupName = "default-azurebatch-japaneast",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := batch.NewBatchAccount(ctx, "batchAccount", &batch.BatchAccountArgs{
			AccountName: pulumi.String("sampleacct"),
			AutoStorage: &batch.AutoStorageBasePropertiesArgs{
				StorageAccountId: pulumi.String("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
			},
			KeyVaultReference: &batch.KeyVaultReferenceArgs{
				Id:  pulumi.String("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample"),
				Url: pulumi.String("http://sample.vault.azure.net/"),
			},
			Location:           pulumi.String("japaneast"),
			PoolAllocationMode: batch.PoolAllocationModeUserSubscription,
			ResourceGroupName:  pulumi.String("default-azurebatch-japaneast"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.batch.BatchAccount;
import com.pulumi.azurenative.batch.BatchAccountArgs;
import com.pulumi.azurenative.batch.inputs.AutoStorageBasePropertiesArgs;
import com.pulumi.azurenative.batch.inputs.KeyVaultReferenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var batchAccount = new BatchAccount("batchAccount", BatchAccountArgs.builder()
            .accountName("sampleacct")
            .autoStorage(AutoStorageBasePropertiesArgs.builder()
                .storageAccountId("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage")
                .build())
            .keyVaultReference(KeyVaultReferenceArgs.builder()
                .id("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample")
                .url("http://sample.vault.azure.net/")
                .build())
            .location("japaneast")
            .poolAllocationMode("UserSubscription")
            .resourceGroupName("default-azurebatch-japaneast")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const batchAccount = new azure_native.batch.BatchAccount("batchAccount", {
    accountName: "sampleacct",
    autoStorage: {
        storageAccountId: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    keyVaultReference: {
        id: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
        url: "http://sample.vault.azure.net/",
    },
    location: "japaneast",
    poolAllocationMode: azure_native.batch.PoolAllocationMode.UserSubscription,
    resourceGroupName: "default-azurebatch-japaneast",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

batch_account = azure_native.batch.BatchAccount("batchAccount",
    account_name="sampleacct",
    auto_storage={
        "storage_account_id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    key_vault_reference={
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
        "url": "http://sample.vault.azure.net/",
    },
    location="japaneast",
    pool_allocation_mode=azure_native.batch.PoolAllocationMode.USER_SUBSCRIPTION,
    resource_group_name="default-azurebatch-japaneast")
Copy
resources:
  batchAccount:
    type: azure-native:batch:BatchAccount
    properties:
      accountName: sampleacct
      autoStorage:
        storageAccountId: /subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage
      keyVaultReference:
        id: /subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample
        url: http://sample.vault.azure.net/
      location: japaneast
      poolAllocationMode: UserSubscription
      resourceGroupName: default-azurebatch-japaneast
Copy

BatchAccountCreate_Default

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var batchAccount = new AzureNative.Batch.BatchAccount("batchAccount", new()
    {
        AccountName = "sampleacct",
        AutoStorage = new AzureNative.Batch.Inputs.AutoStorageBasePropertiesArgs
        {
            StorageAccountId = "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
        },
        Location = "japaneast",
        ResourceGroupName = "default-azurebatch-japaneast",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := batch.NewBatchAccount(ctx, "batchAccount", &batch.BatchAccountArgs{
			AccountName: pulumi.String("sampleacct"),
			AutoStorage: &batch.AutoStorageBasePropertiesArgs{
				StorageAccountId: pulumi.String("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
			},
			Location:          pulumi.String("japaneast"),
			ResourceGroupName: pulumi.String("default-azurebatch-japaneast"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.batch.BatchAccount;
import com.pulumi.azurenative.batch.BatchAccountArgs;
import com.pulumi.azurenative.batch.inputs.AutoStorageBasePropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var batchAccount = new BatchAccount("batchAccount", BatchAccountArgs.builder()
            .accountName("sampleacct")
            .autoStorage(AutoStorageBasePropertiesArgs.builder()
                .storageAccountId("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage")
                .build())
            .location("japaneast")
            .resourceGroupName("default-azurebatch-japaneast")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const batchAccount = new azure_native.batch.BatchAccount("batchAccount", {
    accountName: "sampleacct",
    autoStorage: {
        storageAccountId: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    location: "japaneast",
    resourceGroupName: "default-azurebatch-japaneast",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

batch_account = azure_native.batch.BatchAccount("batchAccount",
    account_name="sampleacct",
    auto_storage={
        "storage_account_id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    location="japaneast",
    resource_group_name="default-azurebatch-japaneast")
Copy
resources:
  batchAccount:
    type: azure-native:batch:BatchAccount
    properties:
      accountName: sampleacct
      autoStorage:
        storageAccountId: /subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage
      location: japaneast
      resourceGroupName: default-azurebatch-japaneast
Copy

BatchAccountCreate_SystemAssignedIdentity

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var batchAccount = new AzureNative.Batch.BatchAccount("batchAccount", new()
    {
        AccountName = "sampleacct",
        AutoStorage = new AzureNative.Batch.Inputs.AutoStorageBasePropertiesArgs
        {
            StorageAccountId = "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
        },
        Identity = new AzureNative.Batch.Inputs.BatchAccountIdentityArgs
        {
            Type = AzureNative.Batch.ResourceIdentityType.SystemAssigned,
        },
        Location = "japaneast",
        ResourceGroupName = "default-azurebatch-japaneast",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := batch.NewBatchAccount(ctx, "batchAccount", &batch.BatchAccountArgs{
			AccountName: pulumi.String("sampleacct"),
			AutoStorage: &batch.AutoStorageBasePropertiesArgs{
				StorageAccountId: pulumi.String("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
			},
			Identity: &batch.BatchAccountIdentityArgs{
				Type: batch.ResourceIdentityTypeSystemAssigned,
			},
			Location:          pulumi.String("japaneast"),
			ResourceGroupName: pulumi.String("default-azurebatch-japaneast"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.batch.BatchAccount;
import com.pulumi.azurenative.batch.BatchAccountArgs;
import com.pulumi.azurenative.batch.inputs.AutoStorageBasePropertiesArgs;
import com.pulumi.azurenative.batch.inputs.BatchAccountIdentityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var batchAccount = new BatchAccount("batchAccount", BatchAccountArgs.builder()
            .accountName("sampleacct")
            .autoStorage(AutoStorageBasePropertiesArgs.builder()
                .storageAccountId("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage")
                .build())
            .identity(BatchAccountIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .location("japaneast")
            .resourceGroupName("default-azurebatch-japaneast")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const batchAccount = new azure_native.batch.BatchAccount("batchAccount", {
    accountName: "sampleacct",
    autoStorage: {
        storageAccountId: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    identity: {
        type: azure_native.batch.ResourceIdentityType.SystemAssigned,
    },
    location: "japaneast",
    resourceGroupName: "default-azurebatch-japaneast",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

batch_account = azure_native.batch.BatchAccount("batchAccount",
    account_name="sampleacct",
    auto_storage={
        "storage_account_id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    identity={
        "type": azure_native.batch.ResourceIdentityType.SYSTEM_ASSIGNED,
    },
    location="japaneast",
    resource_group_name="default-azurebatch-japaneast")
Copy
resources:
  batchAccount:
    type: azure-native:batch:BatchAccount
    properties:
      accountName: sampleacct
      autoStorage:
        storageAccountId: /subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage
      identity:
        type: SystemAssigned
      location: japaneast
      resourceGroupName: default-azurebatch-japaneast
Copy

PrivateBatchAccountCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var batchAccount = new AzureNative.Batch.BatchAccount("batchAccount", new()
    {
        AccountName = "sampleacct",
        AutoStorage = new AzureNative.Batch.Inputs.AutoStorageBasePropertiesArgs
        {
            StorageAccountId = "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
        },
        KeyVaultReference = new AzureNative.Batch.Inputs.KeyVaultReferenceArgs
        {
            Id = "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
            Url = "http://sample.vault.azure.net/",
        },
        Location = "japaneast",
        PublicNetworkAccess = AzureNative.Batch.PublicNetworkAccessType.Disabled,
        ResourceGroupName = "default-azurebatch-japaneast",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := batch.NewBatchAccount(ctx, "batchAccount", &batch.BatchAccountArgs{
			AccountName: pulumi.String("sampleacct"),
			AutoStorage: &batch.AutoStorageBasePropertiesArgs{
				StorageAccountId: pulumi.String("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
			},
			KeyVaultReference: &batch.KeyVaultReferenceArgs{
				Id:  pulumi.String("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample"),
				Url: pulumi.String("http://sample.vault.azure.net/"),
			},
			Location:            pulumi.String("japaneast"),
			PublicNetworkAccess: batch.PublicNetworkAccessTypeDisabled,
			ResourceGroupName:   pulumi.String("default-azurebatch-japaneast"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.batch.BatchAccount;
import com.pulumi.azurenative.batch.BatchAccountArgs;
import com.pulumi.azurenative.batch.inputs.AutoStorageBasePropertiesArgs;
import com.pulumi.azurenative.batch.inputs.KeyVaultReferenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var batchAccount = new BatchAccount("batchAccount", BatchAccountArgs.builder()
            .accountName("sampleacct")
            .autoStorage(AutoStorageBasePropertiesArgs.builder()
                .storageAccountId("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage")
                .build())
            .keyVaultReference(KeyVaultReferenceArgs.builder()
                .id("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample")
                .url("http://sample.vault.azure.net/")
                .build())
            .location("japaneast")
            .publicNetworkAccess("Disabled")
            .resourceGroupName("default-azurebatch-japaneast")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const batchAccount = new azure_native.batch.BatchAccount("batchAccount", {
    accountName: "sampleacct",
    autoStorage: {
        storageAccountId: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    keyVaultReference: {
        id: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
        url: "http://sample.vault.azure.net/",
    },
    location: "japaneast",
    publicNetworkAccess: azure_native.batch.PublicNetworkAccessType.Disabled,
    resourceGroupName: "default-azurebatch-japaneast",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

batch_account = azure_native.batch.BatchAccount("batchAccount",
    account_name="sampleacct",
    auto_storage={
        "storage_account_id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    key_vault_reference={
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
        "url": "http://sample.vault.azure.net/",
    },
    location="japaneast",
    public_network_access=azure_native.batch.PublicNetworkAccessType.DISABLED,
    resource_group_name="default-azurebatch-japaneast")
Copy
resources:
  batchAccount:
    type: azure-native:batch:BatchAccount
    properties:
      accountName: sampleacct
      autoStorage:
        storageAccountId: /subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage
      keyVaultReference:
        id: /subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample
        url: http://sample.vault.azure.net/
      location: japaneast
      publicNetworkAccess: Disabled
      resourceGroupName: default-azurebatch-japaneast
Copy

Create BatchAccount Resource

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

Constructor syntax

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

@overload
def BatchAccount(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 resource_group_name: Optional[str] = None,
                 account_name: Optional[str] = None,
                 allowed_authentication_modes: Optional[Sequence[AuthenticationMode]] = None,
                 auto_storage: Optional[AutoStorageBasePropertiesArgs] = None,
                 encryption: Optional[EncryptionPropertiesArgs] = None,
                 identity: Optional[BatchAccountIdentityArgs] = None,
                 key_vault_reference: Optional[KeyVaultReferenceArgs] = None,
                 location: Optional[str] = None,
                 network_profile: Optional[NetworkProfileArgs] = None,
                 pool_allocation_mode: Optional[PoolAllocationMode] = None,
                 public_network_access: Optional[PublicNetworkAccessType] = None,
                 tags: Optional[Mapping[str, str]] = None)
func NewBatchAccount(ctx *Context, name string, args BatchAccountArgs, opts ...ResourceOption) (*BatchAccount, error)
public BatchAccount(string name, BatchAccountArgs args, CustomResourceOptions? opts = null)
public BatchAccount(String name, BatchAccountArgs args)
public BatchAccount(String name, BatchAccountArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BatchAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BatchAccountArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BatchAccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BatchAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BatchAccountArgs
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 batchAccountResource = new AzureNative.Batch.BatchAccount("batchAccountResource", new()
{
    ResourceGroupName = "string",
    AccountName = "string",
    AllowedAuthenticationModes = new[]
    {
        AzureNative.Batch.AuthenticationMode.SharedKey,
    },
    AutoStorage = new AzureNative.Batch.Inputs.AutoStorageBasePropertiesArgs
    {
        StorageAccountId = "string",
        AuthenticationMode = AzureNative.Batch.AutoStorageAuthenticationMode.StorageKeys,
        NodeIdentityReference = new AzureNative.Batch.Inputs.ComputeNodeIdentityReferenceArgs
        {
            ResourceId = "string",
        },
    },
    Encryption = new AzureNative.Batch.Inputs.EncryptionPropertiesArgs
    {
        KeySource = AzureNative.Batch.KeySource.Microsoft_Batch,
        KeyVaultProperties = new AzureNative.Batch.Inputs.KeyVaultPropertiesArgs
        {
            KeyIdentifier = "string",
        },
    },
    Identity = new AzureNative.Batch.Inputs.BatchAccountIdentityArgs
    {
        Type = AzureNative.Batch.ResourceIdentityType.SystemAssigned,
        UserAssignedIdentities = new[]
        {
            "string",
        },
    },
    KeyVaultReference = new AzureNative.Batch.Inputs.KeyVaultReferenceArgs
    {
        Id = "string",
        Url = "string",
    },
    Location = "string",
    NetworkProfile = new AzureNative.Batch.Inputs.NetworkProfileArgs
    {
        AccountAccess = new AzureNative.Batch.Inputs.EndpointAccessProfileArgs
        {
            DefaultAction = AzureNative.Batch.EndpointAccessDefaultAction.Allow,
            IpRules = new[]
            {
                new AzureNative.Batch.Inputs.IPRuleArgs
                {
                    Action = AzureNative.Batch.IPRuleAction.Allow,
                    Value = "string",
                },
            },
        },
        NodeManagementAccess = new AzureNative.Batch.Inputs.EndpointAccessProfileArgs
        {
            DefaultAction = AzureNative.Batch.EndpointAccessDefaultAction.Allow,
            IpRules = new[]
            {
                new AzureNative.Batch.Inputs.IPRuleArgs
                {
                    Action = AzureNative.Batch.IPRuleAction.Allow,
                    Value = "string",
                },
            },
        },
    },
    PoolAllocationMode = AzureNative.Batch.PoolAllocationMode.BatchService,
    PublicNetworkAccess = AzureNative.Batch.PublicNetworkAccessType.Enabled,
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := batch.NewBatchAccount(ctx, "batchAccountResource", &batch.BatchAccountArgs{
	ResourceGroupName: pulumi.String("string"),
	AccountName:       pulumi.String("string"),
	AllowedAuthenticationModes: batch.AuthenticationModeArray{
		batch.AuthenticationModeSharedKey,
	},
	AutoStorage: &batch.AutoStorageBasePropertiesArgs{
		StorageAccountId:   pulumi.String("string"),
		AuthenticationMode: batch.AutoStorageAuthenticationModeStorageKeys,
		NodeIdentityReference: &batch.ComputeNodeIdentityReferenceArgs{
			ResourceId: pulumi.String("string"),
		},
	},
	Encryption: &batch.EncryptionPropertiesArgs{
		KeySource: batch.KeySource_Microsoft_Batch,
		KeyVaultProperties: &batch.KeyVaultPropertiesArgs{
			KeyIdentifier: pulumi.String("string"),
		},
	},
	Identity: &batch.BatchAccountIdentityArgs{
		Type: batch.ResourceIdentityTypeSystemAssigned,
		UserAssignedIdentities: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	KeyVaultReference: &batch.KeyVaultReferenceArgs{
		Id:  pulumi.String("string"),
		Url: pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	NetworkProfile: &batch.NetworkProfileArgs{
		AccountAccess: &batch.EndpointAccessProfileArgs{
			DefaultAction: batch.EndpointAccessDefaultActionAllow,
			IpRules: batch.IPRuleArray{
				&batch.IPRuleArgs{
					Action: batch.IPRuleActionAllow,
					Value:  pulumi.String("string"),
				},
			},
		},
		NodeManagementAccess: &batch.EndpointAccessProfileArgs{
			DefaultAction: batch.EndpointAccessDefaultActionAllow,
			IpRules: batch.IPRuleArray{
				&batch.IPRuleArgs{
					Action: batch.IPRuleActionAllow,
					Value:  pulumi.String("string"),
				},
			},
		},
	},
	PoolAllocationMode:  batch.PoolAllocationModeBatchService,
	PublicNetworkAccess: batch.PublicNetworkAccessTypeEnabled,
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var batchAccountResource = new BatchAccount("batchAccountResource", BatchAccountArgs.builder()
    .resourceGroupName("string")
    .accountName("string")
    .allowedAuthenticationModes("SharedKey")
    .autoStorage(AutoStorageBasePropertiesArgs.builder()
        .storageAccountId("string")
        .authenticationMode("StorageKeys")
        .nodeIdentityReference(ComputeNodeIdentityReferenceArgs.builder()
            .resourceId("string")
            .build())
        .build())
    .encryption(EncryptionPropertiesArgs.builder()
        .keySource("Microsoft.Batch")
        .keyVaultProperties(KeyVaultPropertiesArgs.builder()
            .keyIdentifier("string")
            .build())
        .build())
    .identity(BatchAccountIdentityArgs.builder()
        .type("SystemAssigned")
        .userAssignedIdentities("string")
        .build())
    .keyVaultReference(KeyVaultReferenceArgs.builder()
        .id("string")
        .url("string")
        .build())
    .location("string")
    .networkProfile(NetworkProfileArgs.builder()
        .accountAccess(EndpointAccessProfileArgs.builder()
            .defaultAction("Allow")
            .ipRules(IPRuleArgs.builder()
                .action("Allow")
                .value("string")
                .build())
            .build())
        .nodeManagementAccess(EndpointAccessProfileArgs.builder()
            .defaultAction("Allow")
            .ipRules(IPRuleArgs.builder()
                .action("Allow")
                .value("string")
                .build())
            .build())
        .build())
    .poolAllocationMode("BatchService")
    .publicNetworkAccess("Enabled")
    .tags(Map.of("string", "string"))
    .build());
Copy
batch_account_resource = azure_native.batch.BatchAccount("batchAccountResource",
    resource_group_name="string",
    account_name="string",
    allowed_authentication_modes=[azure_native.batch.AuthenticationMode.SHARED_KEY],
    auto_storage={
        "storage_account_id": "string",
        "authentication_mode": azure_native.batch.AutoStorageAuthenticationMode.STORAGE_KEYS,
        "node_identity_reference": {
            "resource_id": "string",
        },
    },
    encryption={
        "key_source": azure_native.batch.KeySource.MICROSOFT_BATCH,
        "key_vault_properties": {
            "key_identifier": "string",
        },
    },
    identity={
        "type": azure_native.batch.ResourceIdentityType.SYSTEM_ASSIGNED,
        "user_assigned_identities": ["string"],
    },
    key_vault_reference={
        "id": "string",
        "url": "string",
    },
    location="string",
    network_profile={
        "account_access": {
            "default_action": azure_native.batch.EndpointAccessDefaultAction.ALLOW,
            "ip_rules": [{
                "action": azure_native.batch.IPRuleAction.ALLOW,
                "value": "string",
            }],
        },
        "node_management_access": {
            "default_action": azure_native.batch.EndpointAccessDefaultAction.ALLOW,
            "ip_rules": [{
                "action": azure_native.batch.IPRuleAction.ALLOW,
                "value": "string",
            }],
        },
    },
    pool_allocation_mode=azure_native.batch.PoolAllocationMode.BATCH_SERVICE,
    public_network_access=azure_native.batch.PublicNetworkAccessType.ENABLED,
    tags={
        "string": "string",
    })
Copy
const batchAccountResource = new azure_native.batch.BatchAccount("batchAccountResource", {
    resourceGroupName: "string",
    accountName: "string",
    allowedAuthenticationModes: [azure_native.batch.AuthenticationMode.SharedKey],
    autoStorage: {
        storageAccountId: "string",
        authenticationMode: azure_native.batch.AutoStorageAuthenticationMode.StorageKeys,
        nodeIdentityReference: {
            resourceId: "string",
        },
    },
    encryption: {
        keySource: azure_native.batch.KeySource.Microsoft_Batch,
        keyVaultProperties: {
            keyIdentifier: "string",
        },
    },
    identity: {
        type: azure_native.batch.ResourceIdentityType.SystemAssigned,
        userAssignedIdentities: ["string"],
    },
    keyVaultReference: {
        id: "string",
        url: "string",
    },
    location: "string",
    networkProfile: {
        accountAccess: {
            defaultAction: azure_native.batch.EndpointAccessDefaultAction.Allow,
            ipRules: [{
                action: azure_native.batch.IPRuleAction.Allow,
                value: "string",
            }],
        },
        nodeManagementAccess: {
            defaultAction: azure_native.batch.EndpointAccessDefaultAction.Allow,
            ipRules: [{
                action: azure_native.batch.IPRuleAction.Allow,
                value: "string",
            }],
        },
    },
    poolAllocationMode: azure_native.batch.PoolAllocationMode.BatchService,
    publicNetworkAccess: azure_native.batch.PublicNetworkAccessType.Enabled,
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:batch:BatchAccount
properties:
    accountName: string
    allowedAuthenticationModes:
        - SharedKey
    autoStorage:
        authenticationMode: StorageKeys
        nodeIdentityReference:
            resourceId: string
        storageAccountId: string
    encryption:
        keySource: Microsoft.Batch
        keyVaultProperties:
            keyIdentifier: string
    identity:
        type: SystemAssigned
        userAssignedIdentities:
            - string
    keyVaultReference:
        id: string
        url: string
    location: string
    networkProfile:
        accountAccess:
            defaultAction: Allow
            ipRules:
                - action: Allow
                  value: string
        nodeManagementAccess:
            defaultAction: Allow
            ipRules:
                - action: Allow
                  value: string
    poolAllocationMode: BatchService
    publicNetworkAccess: Enabled
    resourceGroupName: string
    tags:
        string: string
Copy

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the Batch account.
AccountName Changes to this property will trigger replacement. string
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
AllowedAuthenticationModes List<Pulumi.AzureNative.Batch.AuthenticationMode>
List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
AutoStorage Pulumi.AzureNative.Batch.Inputs.AutoStorageBaseProperties
The properties related to the auto-storage account.
Encryption Pulumi.AzureNative.Batch.Inputs.EncryptionProperties
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
Identity Pulumi.AzureNative.Batch.Inputs.BatchAccountIdentity
The identity of the Batch account.
KeyVaultReference Pulumi.AzureNative.Batch.Inputs.KeyVaultReference
A reference to the Azure key vault associated with the Batch account.
Location string
The region in which to create the account.
NetworkProfile Pulumi.AzureNative.Batch.Inputs.NetworkProfile
The network profile only takes effect when publicNetworkAccess is enabled.
PoolAllocationMode Pulumi.AzureNative.Batch.PoolAllocationMode
The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.
PublicNetworkAccess Pulumi.AzureNative.Batch.PublicNetworkAccessType
If not specified, the default value is 'enabled'.
Tags Dictionary<string, string>
The user-specified tags associated with the account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the Batch account.
AccountName Changes to this property will trigger replacement. string
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
AllowedAuthenticationModes []AuthenticationMode
List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
AutoStorage AutoStorageBasePropertiesArgs
The properties related to the auto-storage account.
Encryption EncryptionPropertiesArgs
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
Identity BatchAccountIdentityArgs
The identity of the Batch account.
KeyVaultReference KeyVaultReferenceArgs
A reference to the Azure key vault associated with the Batch account.
Location string
The region in which to create the account.
NetworkProfile NetworkProfileArgs
The network profile only takes effect when publicNetworkAccess is enabled.
PoolAllocationMode PoolAllocationMode
The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.
PublicNetworkAccess PublicNetworkAccessType
If not specified, the default value is 'enabled'.
Tags map[string]string
The user-specified tags associated with the account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the Batch account.
accountName Changes to this property will trigger replacement. String
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
allowedAuthenticationModes List<AuthenticationMode>
List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
autoStorage AutoStorageBaseProperties
The properties related to the auto-storage account.
encryption EncryptionProperties
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
identity BatchAccountIdentity
The identity of the Batch account.
keyVaultReference KeyVaultReference
A reference to the Azure key vault associated with the Batch account.
location String
The region in which to create the account.
networkProfile NetworkProfile
The network profile only takes effect when publicNetworkAccess is enabled.
poolAllocationMode PoolAllocationMode
The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.
publicNetworkAccess PublicNetworkAccessType
If not specified, the default value is 'enabled'.
tags Map<String,String>
The user-specified tags associated with the account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the Batch account.
accountName Changes to this property will trigger replacement. string
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
allowedAuthenticationModes AuthenticationMode[]
List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
autoStorage AutoStorageBaseProperties
The properties related to the auto-storage account.
encryption EncryptionProperties
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
identity BatchAccountIdentity
The identity of the Batch account.
keyVaultReference KeyVaultReference
A reference to the Azure key vault associated with the Batch account.
location string
The region in which to create the account.
networkProfile NetworkProfile
The network profile only takes effect when publicNetworkAccess is enabled.
poolAllocationMode PoolAllocationMode
The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.
publicNetworkAccess PublicNetworkAccessType
If not specified, the default value is 'enabled'.
tags {[key: string]: string}
The user-specified tags associated with the account.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the Batch account.
account_name Changes to this property will trigger replacement. str
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
allowed_authentication_modes Sequence[AuthenticationMode]
List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
auto_storage AutoStorageBasePropertiesArgs
The properties related to the auto-storage account.
encryption EncryptionPropertiesArgs
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
identity BatchAccountIdentityArgs
The identity of the Batch account.
key_vault_reference KeyVaultReferenceArgs
A reference to the Azure key vault associated with the Batch account.
location str
The region in which to create the account.
network_profile NetworkProfileArgs
The network profile only takes effect when publicNetworkAccess is enabled.
pool_allocation_mode PoolAllocationMode
The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.
public_network_access PublicNetworkAccessType
If not specified, the default value is 'enabled'.
tags Mapping[str, str]
The user-specified tags associated with the account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the Batch account.
accountName Changes to this property will trigger replacement. String
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
allowedAuthenticationModes List<"SharedKey" | "AAD" | "TaskAuthenticationToken">
List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
autoStorage Property Map
The properties related to the auto-storage account.
encryption Property Map
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
identity Property Map
The identity of the Batch account.
keyVaultReference Property Map
A reference to the Azure key vault associated with the Batch account.
location String
The region in which to create the account.
networkProfile Property Map
The network profile only takes effect when publicNetworkAccess is enabled.
poolAllocationMode "BatchService" | "UserSubscription"
The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.
publicNetworkAccess "Enabled" | "Disabled" | "SecuredByPerimeter"
If not specified, the default value is 'enabled'.
tags Map<String>
The user-specified tags associated with the account.

Outputs

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

AccountEndpoint string
The account endpoint used to interact with the Batch service.
ActiveJobAndJobScheduleQuota int
AzureApiVersion string
The Azure API version of the resource.
DedicatedCoreQuota int
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
DedicatedCoreQuotaPerVMFamily List<Pulumi.AzureNative.Batch.Outputs.VirtualMachineFamilyCoreQuotaResponse>
A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
DedicatedCoreQuotaPerVMFamilyEnforced bool
If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
Id string
The provider-assigned unique ID for this managed resource.
LowPriorityCoreQuota int
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
Name string
The name of the resource.
NodeManagementEndpoint string
The endpoint used by compute node to connect to the Batch node management service.
PoolQuota int
PrivateEndpointConnections List<Pulumi.AzureNative.Batch.Outputs.PrivateEndpointConnectionResponse>
List of private endpoint connections associated with the Batch account
ProvisioningState string
The provisioned state of the resource
Type string
The type of the resource.
AccountEndpoint string
The account endpoint used to interact with the Batch service.
ActiveJobAndJobScheduleQuota int
AzureApiVersion string
The Azure API version of the resource.
DedicatedCoreQuota int
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
DedicatedCoreQuotaPerVMFamily []VirtualMachineFamilyCoreQuotaResponse
A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
DedicatedCoreQuotaPerVMFamilyEnforced bool
If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
Id string
The provider-assigned unique ID for this managed resource.
LowPriorityCoreQuota int
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
Name string
The name of the resource.
NodeManagementEndpoint string
The endpoint used by compute node to connect to the Batch node management service.
PoolQuota int
PrivateEndpointConnections []PrivateEndpointConnectionResponse
List of private endpoint connections associated with the Batch account
ProvisioningState string
The provisioned state of the resource
Type string
The type of the resource.
accountEndpoint String
The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota Integer
azureApiVersion String
The Azure API version of the resource.
dedicatedCoreQuota Integer
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicatedCoreQuotaPerVMFamily List<VirtualMachineFamilyCoreQuotaResponse>
A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicatedCoreQuotaPerVMFamilyEnforced Boolean
If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
id String
The provider-assigned unique ID for this managed resource.
lowPriorityCoreQuota Integer
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
name String
The name of the resource.
nodeManagementEndpoint String
The endpoint used by compute node to connect to the Batch node management service.
poolQuota Integer
privateEndpointConnections List<PrivateEndpointConnectionResponse>
List of private endpoint connections associated with the Batch account
provisioningState String
The provisioned state of the resource
type String
The type of the resource.
accountEndpoint string
The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota number
azureApiVersion string
The Azure API version of the resource.
dedicatedCoreQuota number
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicatedCoreQuotaPerVMFamily VirtualMachineFamilyCoreQuotaResponse[]
A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicatedCoreQuotaPerVMFamilyEnforced boolean
If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
id string
The provider-assigned unique ID for this managed resource.
lowPriorityCoreQuota number
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
name string
The name of the resource.
nodeManagementEndpoint string
The endpoint used by compute node to connect to the Batch node management service.
poolQuota number
privateEndpointConnections PrivateEndpointConnectionResponse[]
List of private endpoint connections associated with the Batch account
provisioningState string
The provisioned state of the resource
type string
The type of the resource.
account_endpoint str
The account endpoint used to interact with the Batch service.
active_job_and_job_schedule_quota int
azure_api_version str
The Azure API version of the resource.
dedicated_core_quota int
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicated_core_quota_per_vm_family Sequence[VirtualMachineFamilyCoreQuotaResponse]
A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicated_core_quota_per_vm_family_enforced bool
If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
id str
The provider-assigned unique ID for this managed resource.
low_priority_core_quota int
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
name str
The name of the resource.
node_management_endpoint str
The endpoint used by compute node to connect to the Batch node management service.
pool_quota int
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
List of private endpoint connections associated with the Batch account
provisioning_state str
The provisioned state of the resource
type str
The type of the resource.
accountEndpoint String
The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota Number
azureApiVersion String
The Azure API version of the resource.
dedicatedCoreQuota Number
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicatedCoreQuotaPerVMFamily List<Property Map>
A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicatedCoreQuotaPerVMFamilyEnforced Boolean
If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
id String
The provider-assigned unique ID for this managed resource.
lowPriorityCoreQuota Number
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
name String
The name of the resource.
nodeManagementEndpoint String
The endpoint used by compute node to connect to the Batch node management service.
poolQuota Number
privateEndpointConnections List<Property Map>
List of private endpoint connections associated with the Batch account
provisioningState String
The provisioned state of the resource
type String
The type of the resource.

Supporting Types

AuthenticationMode
, AuthenticationModeArgs

SharedKey
SharedKeyThe authentication mode using shared keys.
AAD
AADThe authentication mode using Microsoft Entra ID.
TaskAuthenticationToken
TaskAuthenticationTokenThe authentication mode using task authentication tokens.
AuthenticationModeSharedKey
SharedKeyThe authentication mode using shared keys.
AuthenticationModeAAD
AADThe authentication mode using Microsoft Entra ID.
AuthenticationModeTaskAuthenticationToken
TaskAuthenticationTokenThe authentication mode using task authentication tokens.
SharedKey
SharedKeyThe authentication mode using shared keys.
AAD
AADThe authentication mode using Microsoft Entra ID.
TaskAuthenticationToken
TaskAuthenticationTokenThe authentication mode using task authentication tokens.
SharedKey
SharedKeyThe authentication mode using shared keys.
AAD
AADThe authentication mode using Microsoft Entra ID.
TaskAuthenticationToken
TaskAuthenticationTokenThe authentication mode using task authentication tokens.
SHARED_KEY
SharedKeyThe authentication mode using shared keys.
AAD
AADThe authentication mode using Microsoft Entra ID.
TASK_AUTHENTICATION_TOKEN
TaskAuthenticationTokenThe authentication mode using task authentication tokens.
"SharedKey"
SharedKeyThe authentication mode using shared keys.
"AAD"
AADThe authentication mode using Microsoft Entra ID.
"TaskAuthenticationToken"
TaskAuthenticationTokenThe authentication mode using task authentication tokens.

AutoStorageAuthenticationMode
, AutoStorageAuthenticationModeArgs

StorageKeys
StorageKeysThe Batch service will authenticate requests to auto-storage using storage account keys.
BatchAccountManagedIdentity
BatchAccountManagedIdentityThe Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account.
AutoStorageAuthenticationModeStorageKeys
StorageKeysThe Batch service will authenticate requests to auto-storage using storage account keys.
AutoStorageAuthenticationModeBatchAccountManagedIdentity
BatchAccountManagedIdentityThe Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account.
StorageKeys
StorageKeysThe Batch service will authenticate requests to auto-storage using storage account keys.
BatchAccountManagedIdentity
BatchAccountManagedIdentityThe Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account.
StorageKeys
StorageKeysThe Batch service will authenticate requests to auto-storage using storage account keys.
BatchAccountManagedIdentity
BatchAccountManagedIdentityThe Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account.
STORAGE_KEYS
StorageKeysThe Batch service will authenticate requests to auto-storage using storage account keys.
BATCH_ACCOUNT_MANAGED_IDENTITY
BatchAccountManagedIdentityThe Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account.
"StorageKeys"
StorageKeysThe Batch service will authenticate requests to auto-storage using storage account keys.
"BatchAccountManagedIdentity"
BatchAccountManagedIdentityThe Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account.

AutoStorageBaseProperties
, AutoStorageBasePropertiesArgs

StorageAccountId This property is required. string
The resource ID of the storage account to be used for auto-storage account.
AuthenticationMode Pulumi.AzureNative.Batch.AutoStorageAuthenticationMode
The authentication mode which the Batch service will use to manage the auto-storage account.
NodeIdentityReference Pulumi.AzureNative.Batch.Inputs.ComputeNodeIdentityReference
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
StorageAccountId This property is required. string
The resource ID of the storage account to be used for auto-storage account.
AuthenticationMode AutoStorageAuthenticationMode
The authentication mode which the Batch service will use to manage the auto-storage account.
NodeIdentityReference ComputeNodeIdentityReference
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
storageAccountId This property is required. String
The resource ID of the storage account to be used for auto-storage account.
authenticationMode AutoStorageAuthenticationMode
The authentication mode which the Batch service will use to manage the auto-storage account.
nodeIdentityReference ComputeNodeIdentityReference
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
storageAccountId This property is required. string
The resource ID of the storage account to be used for auto-storage account.
authenticationMode AutoStorageAuthenticationMode
The authentication mode which the Batch service will use to manage the auto-storage account.
nodeIdentityReference ComputeNodeIdentityReference
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
storage_account_id This property is required. str
The resource ID of the storage account to be used for auto-storage account.
authentication_mode AutoStorageAuthenticationMode
The authentication mode which the Batch service will use to manage the auto-storage account.
node_identity_reference ComputeNodeIdentityReference
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
storageAccountId This property is required. String
The resource ID of the storage account to be used for auto-storage account.
authenticationMode "StorageKeys" | "BatchAccountManagedIdentity"
The authentication mode which the Batch service will use to manage the auto-storage account.
nodeIdentityReference Property Map
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.

AutoStoragePropertiesResponse
, AutoStoragePropertiesResponseArgs

LastKeySync This property is required. string
The UTC time at which storage keys were last synchronized with the Batch account.
StorageAccountId This property is required. string
The resource ID of the storage account to be used for auto-storage account.
AuthenticationMode string
The authentication mode which the Batch service will use to manage the auto-storage account.
NodeIdentityReference Pulumi.AzureNative.Batch.Inputs.ComputeNodeIdentityReferenceResponse
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
LastKeySync This property is required. string
The UTC time at which storage keys were last synchronized with the Batch account.
StorageAccountId This property is required. string
The resource ID of the storage account to be used for auto-storage account.
AuthenticationMode string
The authentication mode which the Batch service will use to manage the auto-storage account.
NodeIdentityReference ComputeNodeIdentityReferenceResponse
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
lastKeySync This property is required. String
The UTC time at which storage keys were last synchronized with the Batch account.
storageAccountId This property is required. String
The resource ID of the storage account to be used for auto-storage account.
authenticationMode String
The authentication mode which the Batch service will use to manage the auto-storage account.
nodeIdentityReference ComputeNodeIdentityReferenceResponse
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
lastKeySync This property is required. string
The UTC time at which storage keys were last synchronized with the Batch account.
storageAccountId This property is required. string
The resource ID of the storage account to be used for auto-storage account.
authenticationMode string
The authentication mode which the Batch service will use to manage the auto-storage account.
nodeIdentityReference ComputeNodeIdentityReferenceResponse
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
last_key_sync This property is required. str
The UTC time at which storage keys were last synchronized with the Batch account.
storage_account_id This property is required. str
The resource ID of the storage account to be used for auto-storage account.
authentication_mode str
The authentication mode which the Batch service will use to manage the auto-storage account.
node_identity_reference ComputeNodeIdentityReferenceResponse
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
lastKeySync This property is required. String
The UTC time at which storage keys were last synchronized with the Batch account.
storageAccountId This property is required. String
The resource ID of the storage account to be used for auto-storage account.
authenticationMode String
The authentication mode which the Batch service will use to manage the auto-storage account.
nodeIdentityReference Property Map
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.

BatchAccountIdentity
, BatchAccountIdentityArgs

Type This property is required. Pulumi.AzureNative.Batch.ResourceIdentityType
The type of identity used for the Batch account.
UserAssignedIdentities List<string>
The list of user identities associated with the Batch account.
Type This property is required. ResourceIdentityType
The type of identity used for the Batch account.
UserAssignedIdentities []string
The list of user identities associated with the Batch account.
type This property is required. ResourceIdentityType
The type of identity used for the Batch account.
userAssignedIdentities List<String>
The list of user identities associated with the Batch account.
type This property is required. ResourceIdentityType
The type of identity used for the Batch account.
userAssignedIdentities string[]
The list of user identities associated with the Batch account.
type This property is required. ResourceIdentityType
The type of identity used for the Batch account.
user_assigned_identities Sequence[str]
The list of user identities associated with the Batch account.
type This property is required. "SystemAssigned" | "UserAssigned" | "None"
The type of identity used for the Batch account.
userAssignedIdentities List<String>
The list of user identities associated with the Batch account.

BatchAccountIdentityResponse
, BatchAccountIdentityResponseArgs

PrincipalId This property is required. string
The principal id of the Batch account. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
Type This property is required. string
The type of identity used for the Batch account.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Batch.Inputs.UserAssignedIdentitiesResponse>
The list of user identities associated with the Batch account.
PrincipalId This property is required. string
The principal id of the Batch account. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
Type This property is required. string
The type of identity used for the Batch account.
UserAssignedIdentities map[string]UserAssignedIdentitiesResponse
The list of user identities associated with the Batch account.
principalId This property is required. String
The principal id of the Batch account. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
type This property is required. String
The type of identity used for the Batch account.
userAssignedIdentities Map<String,UserAssignedIdentitiesResponse>
The list of user identities associated with the Batch account.
principalId This property is required. string
The principal id of the Batch account. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
type This property is required. string
The type of identity used for the Batch account.
userAssignedIdentities {[key: string]: UserAssignedIdentitiesResponse}
The list of user identities associated with the Batch account.
principal_id This property is required. str
The principal id of the Batch account. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
type This property is required. str
The type of identity used for the Batch account.
user_assigned_identities Mapping[str, UserAssignedIdentitiesResponse]
The list of user identities associated with the Batch account.
principalId This property is required. String
The principal id of the Batch account. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
type This property is required. String
The type of identity used for the Batch account.
userAssignedIdentities Map<Property Map>
The list of user identities associated with the Batch account.

ComputeNodeIdentityReference
, ComputeNodeIdentityReferenceArgs

ResourceId string
The ARM resource id of the user assigned identity.
ResourceId string
The ARM resource id of the user assigned identity.
resourceId String
The ARM resource id of the user assigned identity.
resourceId string
The ARM resource id of the user assigned identity.
resource_id str
The ARM resource id of the user assigned identity.
resourceId String
The ARM resource id of the user assigned identity.

ComputeNodeIdentityReferenceResponse
, ComputeNodeIdentityReferenceResponseArgs

ResourceId string
The ARM resource id of the user assigned identity.
ResourceId string
The ARM resource id of the user assigned identity.
resourceId String
The ARM resource id of the user assigned identity.
resourceId string
The ARM resource id of the user assigned identity.
resource_id str
The ARM resource id of the user assigned identity.
resourceId String
The ARM resource id of the user assigned identity.

EncryptionProperties
, EncryptionPropertiesArgs

KeySource KeySource
Type of the key source.
KeyVaultProperties KeyVaultProperties
Additional details when using Microsoft.KeyVault
keySource KeySource
Type of the key source.
keyVaultProperties KeyVaultProperties
Additional details when using Microsoft.KeyVault
keySource KeySource
Type of the key source.
keyVaultProperties KeyVaultProperties
Additional details when using Microsoft.KeyVault
key_source KeySource
Type of the key source.
key_vault_properties KeyVaultProperties
Additional details when using Microsoft.KeyVault
keySource "Microsoft.Batch" | "Microsoft.KeyVault"
Type of the key source.
keyVaultProperties Property Map
Additional details when using Microsoft.KeyVault

EncryptionPropertiesResponse
, EncryptionPropertiesResponseArgs

KeySource string
Type of the key source.
KeyVaultProperties Pulumi.AzureNative.Batch.Inputs.KeyVaultPropertiesResponse
Additional details when using Microsoft.KeyVault
KeySource string
Type of the key source.
KeyVaultProperties KeyVaultPropertiesResponse
Additional details when using Microsoft.KeyVault
keySource String
Type of the key source.
keyVaultProperties KeyVaultPropertiesResponse
Additional details when using Microsoft.KeyVault
keySource string
Type of the key source.
keyVaultProperties KeyVaultPropertiesResponse
Additional details when using Microsoft.KeyVault
key_source str
Type of the key source.
key_vault_properties KeyVaultPropertiesResponse
Additional details when using Microsoft.KeyVault
keySource String
Type of the key source.
keyVaultProperties Property Map
Additional details when using Microsoft.KeyVault

EndpointAccessDefaultAction
, EndpointAccessDefaultActionArgs

Allow
AllowAllow client access.
Deny
DenyDeny client access.
EndpointAccessDefaultActionAllow
AllowAllow client access.
EndpointAccessDefaultActionDeny
DenyDeny client access.
Allow
AllowAllow client access.
Deny
DenyDeny client access.
Allow
AllowAllow client access.
Deny
DenyDeny client access.
ALLOW
AllowAllow client access.
DENY
DenyDeny client access.
"Allow"
AllowAllow client access.
"Deny"
DenyDeny client access.

EndpointAccessProfile
, EndpointAccessProfileArgs

DefaultAction This property is required. Pulumi.AzureNative.Batch.EndpointAccessDefaultAction
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
IpRules List<Pulumi.AzureNative.Batch.Inputs.IPRule>
Array of IP ranges to filter client IP address.
DefaultAction This property is required. EndpointAccessDefaultAction
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
IpRules []IPRule
Array of IP ranges to filter client IP address.
defaultAction This property is required. EndpointAccessDefaultAction
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ipRules List<IPRule>
Array of IP ranges to filter client IP address.
defaultAction This property is required. EndpointAccessDefaultAction
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ipRules IPRule[]
Array of IP ranges to filter client IP address.
default_action This property is required. EndpointAccessDefaultAction
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ip_rules Sequence[IPRule]
Array of IP ranges to filter client IP address.
defaultAction This property is required. "Allow" | "Deny"
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ipRules List<Property Map>
Array of IP ranges to filter client IP address.

EndpointAccessProfileResponse
, EndpointAccessProfileResponseArgs

DefaultAction This property is required. string
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
IpRules List<Pulumi.AzureNative.Batch.Inputs.IPRuleResponse>
Array of IP ranges to filter client IP address.
DefaultAction This property is required. string
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
IpRules []IPRuleResponse
Array of IP ranges to filter client IP address.
defaultAction This property is required. String
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ipRules List<IPRuleResponse>
Array of IP ranges to filter client IP address.
defaultAction This property is required. string
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ipRules IPRuleResponse[]
Array of IP ranges to filter client IP address.
default_action This property is required. str
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ip_rules Sequence[IPRuleResponse]
Array of IP ranges to filter client IP address.
defaultAction This property is required. String
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
ipRules List<Property Map>
Array of IP ranges to filter client IP address.

IPRule
, IPRuleArgs

Action This property is required. Pulumi.AzureNative.Batch.IPRuleAction
Action when client IP address is matched.
Value This property is required. string
IPv4 address, or IPv4 address range in CIDR format.
Action This property is required. IPRuleAction
Action when client IP address is matched.
Value This property is required. string
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. IPRuleAction
Action when client IP address is matched.
value This property is required. String
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. IPRuleAction
Action when client IP address is matched.
value This property is required. string
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. IPRuleAction
Action when client IP address is matched.
value This property is required. str
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. "Allow"
Action when client IP address is matched.
value This property is required. String
IPv4 address, or IPv4 address range in CIDR format.

IPRuleAction
, IPRuleActionArgs

Allow
AllowAllow access for the matched client IP address.
IPRuleActionAllow
AllowAllow access for the matched client IP address.
Allow
AllowAllow access for the matched client IP address.
Allow
AllowAllow access for the matched client IP address.
ALLOW
AllowAllow access for the matched client IP address.
"Allow"
AllowAllow access for the matched client IP address.

IPRuleResponse
, IPRuleResponseArgs

Action This property is required. string
Action when client IP address is matched.
Value This property is required. string
IPv4 address, or IPv4 address range in CIDR format.
Action This property is required. string
Action when client IP address is matched.
Value This property is required. string
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. String
Action when client IP address is matched.
value This property is required. String
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. string
Action when client IP address is matched.
value This property is required. string
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. str
Action when client IP address is matched.
value This property is required. str
IPv4 address, or IPv4 address range in CIDR format.
action This property is required. String
Action when client IP address is matched.
value This property is required. String
IPv4 address, or IPv4 address range in CIDR format.

KeySource
, KeySourceArgs

Microsoft_Batch
Microsoft.BatchBatch creates and manages the encryption keys used to protect the account data.
Microsoft_KeyVault
Microsoft.KeyVaultThe encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to SystemAssigned and a valid Key Identifier must also be supplied under the keyVaultProperties.
KeySource_Microsoft_Batch
Microsoft.BatchBatch creates and manages the encryption keys used to protect the account data.
KeySource_Microsoft_KeyVault
Microsoft.KeyVaultThe encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to SystemAssigned and a valid Key Identifier must also be supplied under the keyVaultProperties.
Microsoft_Batch
Microsoft.BatchBatch creates and manages the encryption keys used to protect the account data.
Microsoft_KeyVault
Microsoft.KeyVaultThe encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to SystemAssigned and a valid Key Identifier must also be supplied under the keyVaultProperties.
Microsoft_Batch
Microsoft.BatchBatch creates and manages the encryption keys used to protect the account data.
Microsoft_KeyVault
Microsoft.KeyVaultThe encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to SystemAssigned and a valid Key Identifier must also be supplied under the keyVaultProperties.
MICROSOFT_BATCH
Microsoft.BatchBatch creates and manages the encryption keys used to protect the account data.
MICROSOFT_KEY_VAULT
Microsoft.KeyVaultThe encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to SystemAssigned and a valid Key Identifier must also be supplied under the keyVaultProperties.
"Microsoft.Batch"
Microsoft.BatchBatch creates and manages the encryption keys used to protect the account data.
"Microsoft.KeyVault"
Microsoft.KeyVaultThe encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to SystemAssigned and a valid Key Identifier must also be supplied under the keyVaultProperties.

KeyVaultProperties
, KeyVaultPropertiesArgs

KeyIdentifier string

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

KeyIdentifier string

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

keyIdentifier String

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

keyIdentifier string

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

key_identifier str

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

keyIdentifier String

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

KeyVaultPropertiesResponse
, KeyVaultPropertiesResponseArgs

KeyIdentifier string

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

KeyIdentifier string

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

keyIdentifier String

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

keyIdentifier string

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

key_identifier str

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

keyIdentifier String

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

KeyVaultReference
, KeyVaultReferenceArgs

Id This property is required. string
The resource ID of the Azure key vault associated with the Batch account.
Url This property is required. string
The URL of the Azure key vault associated with the Batch account.
Id This property is required. string
The resource ID of the Azure key vault associated with the Batch account.
Url This property is required. string
The URL of the Azure key vault associated with the Batch account.
id This property is required. String
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. String
The URL of the Azure key vault associated with the Batch account.
id This property is required. string
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. string
The URL of the Azure key vault associated with the Batch account.
id This property is required. str
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. str
The URL of the Azure key vault associated with the Batch account.
id This property is required. String
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. String
The URL of the Azure key vault associated with the Batch account.

KeyVaultReferenceResponse
, KeyVaultReferenceResponseArgs

Id This property is required. string
The resource ID of the Azure key vault associated with the Batch account.
Url This property is required. string
The URL of the Azure key vault associated with the Batch account.
Id This property is required. string
The resource ID of the Azure key vault associated with the Batch account.
Url This property is required. string
The URL of the Azure key vault associated with the Batch account.
id This property is required. String
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. String
The URL of the Azure key vault associated with the Batch account.
id This property is required. string
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. string
The URL of the Azure key vault associated with the Batch account.
id This property is required. str
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. str
The URL of the Azure key vault associated with the Batch account.
id This property is required. String
The resource ID of the Azure key vault associated with the Batch account.
url This property is required. String
The URL of the Azure key vault associated with the Batch account.

NetworkProfile
, NetworkProfileArgs

AccountAccess Pulumi.AzureNative.Batch.Inputs.EndpointAccessProfile
Network access profile for batchAccount endpoint (Batch account data plane API).
NodeManagementAccess Pulumi.AzureNative.Batch.Inputs.EndpointAccessProfile
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
AccountAccess EndpointAccessProfile
Network access profile for batchAccount endpoint (Batch account data plane API).
NodeManagementAccess EndpointAccessProfile
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
accountAccess EndpointAccessProfile
Network access profile for batchAccount endpoint (Batch account data plane API).
nodeManagementAccess EndpointAccessProfile
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
accountAccess EndpointAccessProfile
Network access profile for batchAccount endpoint (Batch account data plane API).
nodeManagementAccess EndpointAccessProfile
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
account_access EndpointAccessProfile
Network access profile for batchAccount endpoint (Batch account data plane API).
node_management_access EndpointAccessProfile
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
accountAccess Property Map
Network access profile for batchAccount endpoint (Batch account data plane API).
nodeManagementAccess Property Map
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).

NetworkProfileResponse
, NetworkProfileResponseArgs

AccountAccess Pulumi.AzureNative.Batch.Inputs.EndpointAccessProfileResponse
Network access profile for batchAccount endpoint (Batch account data plane API).
NodeManagementAccess Pulumi.AzureNative.Batch.Inputs.EndpointAccessProfileResponse
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
AccountAccess EndpointAccessProfileResponse
Network access profile for batchAccount endpoint (Batch account data plane API).
NodeManagementAccess EndpointAccessProfileResponse
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
accountAccess EndpointAccessProfileResponse
Network access profile for batchAccount endpoint (Batch account data plane API).
nodeManagementAccess EndpointAccessProfileResponse
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
accountAccess EndpointAccessProfileResponse
Network access profile for batchAccount endpoint (Batch account data plane API).
nodeManagementAccess EndpointAccessProfileResponse
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
account_access EndpointAccessProfileResponse
Network access profile for batchAccount endpoint (Batch account data plane API).
node_management_access EndpointAccessProfileResponse
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
accountAccess Property Map
Network access profile for batchAccount endpoint (Batch account data plane API).
nodeManagementAccess Property Map
Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).

PoolAllocationMode
, PoolAllocationModeArgs

BatchService
BatchServicePools will be allocated in subscriptions owned by the Batch service.
UserSubscription
UserSubscriptionPools will be allocated in a subscription owned by the user.
PoolAllocationModeBatchService
BatchServicePools will be allocated in subscriptions owned by the Batch service.
PoolAllocationModeUserSubscription
UserSubscriptionPools will be allocated in a subscription owned by the user.
BatchService
BatchServicePools will be allocated in subscriptions owned by the Batch service.
UserSubscription
UserSubscriptionPools will be allocated in a subscription owned by the user.
BatchService
BatchServicePools will be allocated in subscriptions owned by the Batch service.
UserSubscription
UserSubscriptionPools will be allocated in a subscription owned by the user.
BATCH_SERVICE
BatchServicePools will be allocated in subscriptions owned by the Batch service.
USER_SUBSCRIPTION
UserSubscriptionPools will be allocated in a subscription owned by the user.
"BatchService"
BatchServicePools will be allocated in subscriptions owned by the Batch service.
"UserSubscription"
UserSubscriptionPools will be allocated in a subscription owned by the user.

PrivateEndpointConnectionResponse
, PrivateEndpointConnectionResponseArgs

Etag This property is required. string
The ETag of the resource, used for concurrency statements.
GroupIds This property is required. List<string>
The value has one and only one group id.
Id This property is required. string
The ID of the resource.
Name This property is required. string
The name of the resource.
PrivateEndpoint This property is required. Pulumi.AzureNative.Batch.Inputs.PrivateEndpointResponse
The private endpoint of the private endpoint connection.
ProvisioningState This property is required. string
Type This property is required. string
The type of the resource.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Batch.Inputs.PrivateLinkServiceConnectionStateResponse
The private link service connection state of the private endpoint connection
Tags Dictionary<string, string>
The tags of the resource.
Etag This property is required. string
The ETag of the resource, used for concurrency statements.
GroupIds This property is required. []string
The value has one and only one group id.
Id This property is required. string
The ID of the resource.
Name This property is required. string
The name of the resource.
PrivateEndpoint This property is required. PrivateEndpointResponse
The private endpoint of the private endpoint connection.
ProvisioningState This property is required. string
Type This property is required. string
The type of the resource.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state of the private endpoint connection
Tags map[string]string
The tags of the resource.
etag This property is required. String
The ETag of the resource, used for concurrency statements.
groupIds This property is required. List<String>
The value has one and only one group id.
id This property is required. String
The ID of the resource.
name This property is required. String
The name of the resource.
privateEndpoint This property is required. PrivateEndpointResponse
The private endpoint of the private endpoint connection.
provisioningState This property is required. String
type This property is required. String
The type of the resource.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state of the private endpoint connection
tags Map<String,String>
The tags of the resource.
etag This property is required. string
The ETag of the resource, used for concurrency statements.
groupIds This property is required. string[]
The value has one and only one group id.
id This property is required. string
The ID of the resource.
name This property is required. string
The name of the resource.
privateEndpoint This property is required. PrivateEndpointResponse
The private endpoint of the private endpoint connection.
provisioningState This property is required. string
type This property is required. string
The type of the resource.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
The private link service connection state of the private endpoint connection
tags {[key: string]: string}
The tags of the resource.
etag This property is required. str
The ETag of the resource, used for concurrency statements.
group_ids This property is required. Sequence[str]
The value has one and only one group id.
id This property is required. str
The ID of the resource.
name This property is required. str
The name of the resource.
private_endpoint This property is required. PrivateEndpointResponse
The private endpoint of the private endpoint connection.
provisioning_state This property is required. str
type This property is required. str
The type of the resource.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
The private link service connection state of the private endpoint connection
tags Mapping[str, str]
The tags of the resource.
etag This property is required. String
The ETag of the resource, used for concurrency statements.
groupIds This property is required. List<String>
The value has one and only one group id.
id This property is required. String
The ID of the resource.
name This property is required. String
The name of the resource.
privateEndpoint This property is required. Property Map
The private endpoint of the private endpoint connection.
provisioningState This property is required. String
type This property is required. String
The type of the resource.
privateLinkServiceConnectionState Property Map
The private link service connection state of the private endpoint connection
tags Map<String>
The tags of the resource.

PrivateEndpointResponse
, PrivateEndpointResponseArgs

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

PrivateLinkServiceConnectionStateResponse
, PrivateLinkServiceConnectionStateResponseArgs

ActionsRequired This property is required. string
Status This property is required. string
Description string
ActionsRequired This property is required. string
Status This property is required. string
Description string
actionsRequired This property is required. String
status This property is required. String
description String
actionsRequired This property is required. string
status This property is required. string
description string
actions_required This property is required. str
status This property is required. str
description str
actionsRequired This property is required. String
status This property is required. String
description String

PublicNetworkAccessType
, PublicNetworkAccessTypeArgs

Enabled
EnabledEnables connectivity to Azure Batch through public DNS.
Disabled
DisabledDisables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource.
SecuredByPerimeter
SecuredByPerimeterSecures connectivity to Azure Batch through NSP configuration.
PublicNetworkAccessTypeEnabled
EnabledEnables connectivity to Azure Batch through public DNS.
PublicNetworkAccessTypeDisabled
DisabledDisables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource.
PublicNetworkAccessTypeSecuredByPerimeter
SecuredByPerimeterSecures connectivity to Azure Batch through NSP configuration.
Enabled
EnabledEnables connectivity to Azure Batch through public DNS.
Disabled
DisabledDisables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource.
SecuredByPerimeter
SecuredByPerimeterSecures connectivity to Azure Batch through NSP configuration.
Enabled
EnabledEnables connectivity to Azure Batch through public DNS.
Disabled
DisabledDisables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource.
SecuredByPerimeter
SecuredByPerimeterSecures connectivity to Azure Batch through NSP configuration.
ENABLED
EnabledEnables connectivity to Azure Batch through public DNS.
DISABLED
DisabledDisables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource.
SECURED_BY_PERIMETER
SecuredByPerimeterSecures connectivity to Azure Batch through NSP configuration.
"Enabled"
EnabledEnables connectivity to Azure Batch through public DNS.
"Disabled"
DisabledDisables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource.
"SecuredByPerimeter"
SecuredByPerimeterSecures connectivity to Azure Batch through NSP configuration.

ResourceIdentityType
, ResourceIdentityTypeArgs

SystemAssigned
SystemAssignedBatch account has a system assigned identity with it.
UserAssigned
UserAssignedBatch account has user assigned identities with it.
None
NoneBatch account has no identity associated with it. Setting None in update account will remove existing identities.
ResourceIdentityTypeSystemAssigned
SystemAssignedBatch account has a system assigned identity with it.
ResourceIdentityTypeUserAssigned
UserAssignedBatch account has user assigned identities with it.
ResourceIdentityTypeNone
NoneBatch account has no identity associated with it. Setting None in update account will remove existing identities.
SystemAssigned
SystemAssignedBatch account has a system assigned identity with it.
UserAssigned
UserAssignedBatch account has user assigned identities with it.
None
NoneBatch account has no identity associated with it. Setting None in update account will remove existing identities.
SystemAssigned
SystemAssignedBatch account has a system assigned identity with it.
UserAssigned
UserAssignedBatch account has user assigned identities with it.
None
NoneBatch account has no identity associated with it. Setting None in update account will remove existing identities.
SYSTEM_ASSIGNED
SystemAssignedBatch account has a system assigned identity with it.
USER_ASSIGNED
UserAssignedBatch account has user assigned identities with it.
NONE
NoneBatch account has no identity associated with it. Setting None in update account will remove existing identities.
"SystemAssigned"
SystemAssignedBatch account has a system assigned identity with it.
"UserAssigned"
UserAssignedBatch account has user assigned identities with it.
"None"
NoneBatch account has no identity associated with it. Setting None in update account will remove existing identities.

UserAssignedIdentitiesResponse
, UserAssignedIdentitiesResponseArgs

ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.
clientId This property is required. string
The client id of user assigned identity.
principalId This property is required. string
The principal id of user assigned identity.
client_id This property is required. str
The client id of user assigned identity.
principal_id This property is required. str
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.

VirtualMachineFamilyCoreQuotaResponse
, VirtualMachineFamilyCoreQuotaResponseArgs

CoreQuota This property is required. int
The core quota for the VM family for the Batch account.
Name This property is required. string
The Virtual Machine family name.
CoreQuota This property is required. int
The core quota for the VM family for the Batch account.
Name This property is required. string
The Virtual Machine family name.
coreQuota This property is required. Integer
The core quota for the VM family for the Batch account.
name This property is required. String
The Virtual Machine family name.
coreQuota This property is required. number
The core quota for the VM family for the Batch account.
name This property is required. string
The Virtual Machine family name.
core_quota This property is required. int
The core quota for the VM family for the Batch account.
name This property is required. str
The Virtual Machine family name.
coreQuota This property is required. Number
The core quota for the VM family for the Batch account.
name This property is required. String
The Virtual Machine family name.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:batch:BatchAccount sampleacct /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native