Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. batch
  5. Job

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.batch.Job

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Batch Job.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "west europe",
});
const exampleAccount = new azure.batch.Account("example", {
    name: "exampleaccount",
    resourceGroupName: example.name,
    location: example.location,
});
const examplePool = new azure.batch.Pool("example", {
    name: "examplepool",
    resourceGroupName: example.name,
    accountName: exampleAccount.name,
    nodeAgentSkuId: "batch.node.ubuntu 16.04",
    vmSize: "Standard_A1",
    fixedScale: {
        targetDedicatedNodes: 1,
    },
    storageImageReference: {
        publisher: "Canonical",
        offer: "0001-com-ubuntu-server-jammy",
        sku: "22_04-lts",
        version: "latest",
    },
});
const exampleJob = new azure.batch.Job("example", {
    name: "examplejob",
    batchPoolId: examplePool.id,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="west europe")
example_account = azure.batch.Account("example",
    name="exampleaccount",
    resource_group_name=example.name,
    location=example.location)
example_pool = azure.batch.Pool("example",
    name="examplepool",
    resource_group_name=example.name,
    account_name=example_account.name,
    node_agent_sku_id="batch.node.ubuntu 16.04",
    vm_size="Standard_A1",
    fixed_scale={
        "target_dedicated_nodes": 1,
    },
    storage_image_reference={
        "publisher": "Canonical",
        "offer": "0001-com-ubuntu-server-jammy",
        "sku": "22_04-lts",
        "version": "latest",
    })
example_job = azure.batch.Job("example",
    name="examplejob",
    batch_pool_id=example_pool.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("west europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := batch.NewAccount(ctx, "example", &batch.AccountArgs{
			Name:              pulumi.String("exampleaccount"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		examplePool, err := batch.NewPool(ctx, "example", &batch.PoolArgs{
			Name:              pulumi.String("examplepool"),
			ResourceGroupName: example.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("0001-com-ubuntu-server-jammy"),
				Sku:       pulumi.String("22_04-lts"),
				Version:   pulumi.String("latest"),
			},
		})
		if err != nil {
			return err
		}
		_, err = batch.NewJob(ctx, "example", &batch.JobArgs{
			Name:        pulumi.String("examplejob"),
			BatchPoolId: examplePool.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "west europe",
    });

    var exampleAccount = new Azure.Batch.Account("example", new()
    {
        Name = "exampleaccount",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

    var examplePool = new Azure.Batch.Pool("example", new()
    {
        Name = "examplepool",
        ResourceGroupName = example.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 = "0001-com-ubuntu-server-jammy",
            Sku = "22_04-lts",
            Version = "latest",
        },
    });

    var exampleJob = new Azure.Batch.Job("example", new()
    {
        Name = "examplejob",
        BatchPoolId = examplePool.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.batch.Account;
import com.pulumi.azure.batch.AccountArgs;
import com.pulumi.azure.batch.Pool;
import com.pulumi.azure.batch.PoolArgs;
import com.pulumi.azure.batch.inputs.PoolFixedScaleArgs;
import com.pulumi.azure.batch.inputs.PoolStorageImageReferenceArgs;
import com.pulumi.azure.batch.Job;
import com.pulumi.azure.batch.JobArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("west europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("exampleaccount")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

        var examplePool = new Pool("examplePool", PoolArgs.builder()
            .name("examplepool")
            .resourceGroupName(example.name())
            .accountName(exampleAccount.name())
            .nodeAgentSkuId("batch.node.ubuntu 16.04")
            .vmSize("Standard_A1")
            .fixedScale(PoolFixedScaleArgs.builder()
                .targetDedicatedNodes(1)
                .build())
            .storageImageReference(PoolStorageImageReferenceArgs.builder()
                .publisher("Canonical")
                .offer("0001-com-ubuntu-server-jammy")
                .sku("22_04-lts")
                .version("latest")
                .build())
            .build());

        var exampleJob = new Job("exampleJob", JobArgs.builder()
            .name("examplejob")
            .batchPoolId(examplePool.id())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: west europe
  exampleAccount:
    type: azure:batch:Account
    name: example
    properties:
      name: exampleaccount
      resourceGroupName: ${example.name}
      location: ${example.location}
  examplePool:
    type: azure:batch:Pool
    name: example
    properties:
      name: examplepool
      resourceGroupName: ${example.name}
      accountName: ${exampleAccount.name}
      nodeAgentSkuId: batch.node.ubuntu 16.04
      vmSize: Standard_A1
      fixedScale:
        targetDedicatedNodes: 1
      storageImageReference:
        publisher: Canonical
        offer: 0001-com-ubuntu-server-jammy
        sku: 22_04-lts
        version: latest
  exampleJob:
    type: azure:batch:Job
    name: example
    properties:
      name: examplejob
      batchPoolId: ${examplePool.id}

    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 Job("jobResource", 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.
    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.
    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.
    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.
    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.
    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.

    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)
    Resource lookup is not supported in YAML
    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.
    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.
    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.
    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.
    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.
    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.

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

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure