azure.batch.Job (v4) | Pulumi Registry

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "west europe",
        });
        var exampleAccount = new Azure.Batch.Account("exampleAccount", new Azure.Batch.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
        });
        var examplePool = new Azure.Batch.Pool("examplePool", new Azure.Batch.PoolArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            AccountName = exampleAccount.Name,
            NodeAgentSkuId = "batch.node.ubuntu 16.04",
            VmSize = "Standard_A1",
            FixedScale = new Azure.Batch.Inputs.PoolFixedScaleArgs
            {
                TargetDedicatedNodes = 1,
            },
            StorageImageReference = new Azure.Batch.Inputs.PoolStorageImageReferenceArgs
            {
                Publisher = "Canonical",
                Offer = "UbuntuServer",
                Sku = "16.04.0-LTS",
                Version = "latest",
            },
        });
        var exampleJob = new Azure.Batch.Job("exampleJob", new Azure.Batch.JobArgs
        {
            BatchPoolId = examplePool.Id,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("west europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := batch.NewAccount(ctx, "exampleAccount", &batch.AccountArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
		})
		if err != nil {
			return err
		}
		examplePool, err := batch.NewPool(ctx, "examplePool", &batch.PoolArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			AccountName:       exampleAccount.Name,
			NodeAgentSkuId:    pulumi.String("batch.node.ubuntu 16.04"),
			VmSize:            pulumi.String("Standard_A1"),
			FixedScale: &batch.PoolFixedScaleArgs{
				TargetDedicatedNodes: pulumi.Int(1),
			},
			StorageImageReference: &batch.PoolStorageImageReferenceArgs{
				Publisher: pulumi.String("Canonical"),
				Offer:     pulumi.String("UbuntuServer"),
				Sku:       pulumi.String("16.04.0-LTS"),
				Version:   pulumi.String("latest"),
			},
		})
		if err != nil {
			return err
		}
		_, err = batch.NewJob(ctx, "exampleJob", &batch.JobArgs{
			BatchPoolId: examplePool.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "west europe"});
const exampleAccount = new azure.batch.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const examplePool = new azure.batch.Pool("examplePool", {
    resourceGroupName: exampleResourceGroup.name,
    accountName: exampleAccount.name,
    nodeAgentSkuId: "batch.node.ubuntu 16.04",
    vmSize: "Standard_A1",
    fixedScale: {
        targetDedicatedNodes: 1,
    },
    storageImageReference: {
        publisher: "Canonical",
        offer: "UbuntuServer",
        sku: "16.04.0-LTS",
        version: "latest",
    },
});
const exampleJob = new azure.batch.Job("exampleJob", {batchPoolId: examplePool.id});

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="west europe")
example_account = azure.batch.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_pool = azure.batch.Pool("examplePool",
    resource_group_name=example_resource_group.name,
    account_name=example_account.name,
    node_agent_sku_id="batch.node.ubuntu 16.04",
    vm_size="Standard_A1",
    fixed_scale=azure.batch.PoolFixedScaleArgs(
        target_dedicated_nodes=1,
    ),
    storage_image_reference=azure.batch.PoolStorageImageReferenceArgs(
        publisher="Canonical",
        offer="UbuntuServer",
        sku="16.04.0-LTS",
        version="latest",
    ))
example_job = azure.batch.Job("exampleJob", batch_pool_id=example_pool.id)

Example coming soon!

Create Job Resource

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

Constructor syntax

new Job(name: string, args: JobArgs, opts?: CustomResourceOptions);

@overload
def Job(resource_name: str,
        args: JobArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Job(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        batch_pool_id: Optional[str] = None,
        common_environment_properties: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        task_retry_maximum: Optional[int] = None)

func NewJob(ctx *Context, name string, args JobArgs, opts ...ResourceOption) (*Job, error)

public Job(string name, JobArgs args, CustomResourceOptions? opts = null)

public Job(String name, JobArgs args)
public Job(String name, JobArgs args, CustomResourceOptions options)

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

Parameters

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

resource_name str: The unique name of the resource.
args JobArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args JobArgs: 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 jobResource = new Azure.Batch.Job("jobResource", new()
{
    BatchPoolId = "string",
    CommonEnvironmentProperties = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    Name = "string",
    Priority = 0,
    TaskRetryMaximum = 0,
});

example, err := batch.NewJob(ctx, "jobResource", &batch.JobArgs{
	BatchPoolId: pulumi.String("string"),
	CommonEnvironmentProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	Priority:         pulumi.Int(0),
	TaskRetryMaximum: pulumi.Int(0),
})

var jobResource = new com.pulumi.azure.batch.Job("jobResource", com.pulumi.azure.batch.JobArgs.builder()
    .batchPoolId("string")
    .commonEnvironmentProperties(Map.of("string", "string"))
    .displayName("string")
    .name("string")
    .priority(0)
    .taskRetryMaximum(0)
    .build());

job_resource = azure.batch.Job("jobResource",
    batch_pool_id="string",
    common_environment_properties={
        "string": "string",
    },
    display_name="string",
    name="string",
    priority=0,
    task_retry_maximum=0)

const jobResource = new azure.batch.Job("jobResource", {
    batchPoolId: "string",
    commonEnvironmentProperties: {
        string: "string",
    },
    displayName: "string",
    name: "string",
    priority: 0,
    taskRetryMaximum: 0,
});

type: azure:batch:Job
properties:
    batchPoolId: string
    commonEnvironmentProperties:
        string: string
    displayName: string
    name: string
    priority: 0
    taskRetryMaximum: 0

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

BatchPoolId string: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
CommonEnvironmentProperties Dictionary<string, string>: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
DisplayName string: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
Name string: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
Priority int: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
TaskRetryMaximum int: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

BatchPoolId string: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
CommonEnvironmentProperties map[string]string: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
DisplayName string: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
Name string: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
Priority int: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
TaskRetryMaximum int: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batchPoolId String: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
commonEnvironmentProperties Map<String,String>: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
displayName String: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name String: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority Integer: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
taskRetryMaximum Integer: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batchPoolId string: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
commonEnvironmentProperties {[key: string]: string}: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
displayName string: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name string: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority number: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
taskRetryMaximum number: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batch_pool_id str: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
common_environment_properties Mapping[str, str]: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
display_name str: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name str: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority int: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
task_retry_maximum int: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batchPoolId String: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
commonEnvironmentProperties Map<String>: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
displayName String: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name String: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority Number: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
taskRetryMaximum Number: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

Outputs

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

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

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

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

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

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

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

Look up Existing Job Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        batch_pool_id: Optional[str] = None,
        common_environment_properties: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        task_retry_maximum: Optional[int] = None) -> Job

func GetJob(ctx *Context, name string, id IDInput, state *JobState, opts ...ResourceOption) (*Job, error)

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

public static Job get(String name, Output<String> id, JobState state, CustomResourceOptions options)

resources:  _:    type: azure:batch:Job    get:      id: ${id}

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

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

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

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

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

The following state arguments are supported:

BatchPoolId string: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
CommonEnvironmentProperties Dictionary<string, string>: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
DisplayName string: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
Name string: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
Priority int: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
TaskRetryMaximum int: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

BatchPoolId string: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
CommonEnvironmentProperties map[string]string: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
DisplayName string: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
Name string: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
Priority int: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
TaskRetryMaximum int: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batchPoolId String: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
commonEnvironmentProperties Map<String,String>: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
displayName String: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name String: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority Integer: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
taskRetryMaximum Integer: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batchPoolId string: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
commonEnvironmentProperties {[key: string]: string}: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
displayName string: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name string: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority number: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
taskRetryMaximum number: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batch_pool_id str: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
common_environment_properties Mapping[str, str]: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
display_name str: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name str: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority int: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
task_retry_maximum int: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

batchPoolId String: The ID of the Batch Pool. Changing this forces a new Batch Job to be created.
commonEnvironmentProperties Map<String>: Specifies a map of common environment settings applied to this Batch Job. Changing this forces a new Batch Job to be created.
displayName String: The display name of this Batch Job. Changing this forces a new Batch Job to be created.
name String: The name which should be used for this Batch Job. Changing this forces a new Batch Job to be created.
priority Number: The priority of this Batch Job, possible values can range from -1000 (lowest) to 1000 (highest). Defaults to 0.
taskRetryMaximum Number: The number of retries to each Batch Task belongs to this Batch Job. If this is set to 0, the Batch service does not retry Tasks. If this is set to -1, the Batch service retries Batch Tasks without limit. Default value is 0.

Import

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

 $ pulumi import azure:batch/job:Job example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Batch/batchAccounts/account1/pools/pool1/jobs/job1

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

Package Details

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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.batch.Job

On this page

On this page

Example Usage

Create Job Resource

Constructor syntax

Parameters

Constructor example

Job Resource Properties

Inputs

Outputs

Look up Existing Job Resource

Import

Package Details

On this page

On this page