Module batch

@pulumi/azure > batch

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class Account

extends CustomResource

Manages an Azure Batch account.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "westeurope",
    name: "testbatch",
});
const testStorageAccount = new azure.storage.Account("test", {
    accountReplicationType: "LRS",
    accountTier: "Standard",
    location: testResourceGroup.location,
    name: "teststorage",
    resourceGroupName: testResourceGroup.name,
});
const testAccount = new azure.batch.Account("test", {
    location: testResourceGroup.location,
    name: "testbatchaccount",
    poolAllocationMode: "BatchService",
    resourceGroupName: testResourceGroup.name,
    storageAccountId: testStorageAccount.id,
    tags: {
        env: "test",
    },
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/batch_account.html.markdown.

constructor

new Account(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): Account

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Account. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountEndpoint

public accountEndpoint: pulumi.Output<string>;

The account endpoint used to interact with the Batch service.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Batch account. Changing this forces a new resource to be created.

property poolAllocationMode

public poolAllocationMode: pulumi.Output<string | undefined>;

Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.

property primaryAccessKey

public primaryAccessKey: pulumi.Output<string>;

The Batch account primary access key.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

property secondaryAccessKey

public secondaryAccessKey: pulumi.Output<string>;

The Batch account secondary access key.

property storageAccountId

public storageAccountId: pulumi.Output<string>;

Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.

property tags

public tags: pulumi.Output<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Certificate

extends CustomResource

Manages a certificate in an Azure Batch account.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "westeurope",
    name: "testbatch",
});
const testStorageAccount = new azure.storage.Account("test", {
    accountReplicationType: "LRS",
    accountTier: "Standard",
    location: testResourceGroup.location,
    name: "teststorage",
    resourceGroupName: testResourceGroup.name,
});
const testAccount = new azure.batch.Account("test", {
    location: testResourceGroup.location,
    name: "testbatchaccount",
    poolAllocationMode: "BatchService",
    resourceGroupName: testResourceGroup.name,
    storageAccountId: testStorageAccount.id,
    tags: {
        env: "test",
    },
});
const testCertificate = new azure.batch.Certificate("test", {
    accountName: testAccount.name,
    certificate: (() => {
        throw "tf2pulumi error: NYI: call to filebase64";
        return (() => { throw "NYI: call to filebase64"; })();
    })(),
    format: "Pfx",
    password: "password",
    resourceGroupName: testResourceGroup.name,
    thumbprint: "42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
    thumbprintAlgorithm: "SHA1",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/batch_certificate.html.markdown.

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a Certificate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Certificate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountName

public accountName: pulumi.Output<string>;

Specifies the name of the Batch account. Changing this forces a new resource to be created.

property certificate

public certificate: pulumi.Output<string>;

The base64-encoded contents of the certificate.

property format

public format: pulumi.Output<string>;

The format of the certificate. Possible values are Cer or Pfx.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The generated name of the certificate.

property password

public password: pulumi.Output<string | undefined>;

The password to access the certificate’s private key. This must and can only be specified when format is Pfx.

property publicData

public publicData: pulumi.Output<string>;

The public key of the certificate.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

property thumbprint

public thumbprint: pulumi.Output<string>;

The thumbprint of the certificate. At this time the only supported value is ‘SHA1’.

property thumbprintAlgorithm

public thumbprintAlgorithm: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Pool

extends CustomResource

Manages an Azure Batch pool.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "testaccbatch",
});
const testStorageAccount = new azure.storage.Account("test", {
    accountReplicationType: "LRS",
    accountTier: "Standard",
    location: testResourceGroup.location,
    name: "testaccsa",
    resourceGroupName: testResourceGroup.name,
});
const testAccount = new azure.batch.Account("test", {
    location: testResourceGroup.location,
    name: "testaccbatch",
    poolAllocationMode: "BatchService",
    resourceGroupName: testResourceGroup.name,
    storageAccountId: testStorageAccount.id,
    tags: {
        env: "test",
    },
});
const testcer = new azure.batch.Certificate("testcer", {
    accountName: testAccount.name,
    certificate: (() => {
        throw "tf2pulumi error: NYI: call to filebase64";
        return (() => { throw "NYI: call to filebase64"; })();
    })(),
    format: "Cer",
    resourceGroupName: testResourceGroup.name,
    thumbprint: "312d31a79fa0cef49c00f769afc2b73e9f4edf34",
    thumbprintAlgorithm: "SHA1",
});
const testPool = new azure.batch.Pool("test", {
    accountName: testAccount.name,
    autoScale: {
        evaluationInterval: "PT15M",
        formula: `      startingNumberOfVMs = 1;
      maxNumberofVMs = 25;
      pendingTaskSamplePercent = $PendingTasks.GetSamplePercent(180 * TimeInterval_Second);
      pendingTaskSamples = pendingTaskSamplePercent < 70 ? startingNumberOfVMs : avg($PendingTasks.GetSample(180 *   TimeInterval_Second));
      $TargetDedicatedNodes=min(maxNumberofVMs, pendingTaskSamples);
`,
    },
    certificates: [{
        id: testcer.id,
        visibilities: ["StartTask"],
    }],
    containerConfiguration: {
        type: "DockerCompatible",
    },
    displayName: "Test Acc Pool Auto",
    name: "testaccpool",
    nodeAgentSkuId: "batch.node.ubuntu 16.04",
    resourceGroupName: testResourceGroup.name,
    startTask: {
        commandLine: "echo 'Hello World from $env'",
        environment: {
            env: "TEST",
        },
        maxTaskRetryCount: 1,
        userIdentity: {
            autoUser: {
                elevationLevel: "NonAdmin",
                scope: "Task",
            },
        },
        waitForSuccess: true,
    },
    storageImageReference: {
        offer: "ubuntu-server-container",
        publisher: "microsoft-azure-batch",
        sku: "16-04-lts",
        version: "latest",
    },
    vmSize: "Standard_A1",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/batch_pool.html.markdown.

constructor

new Pool(name: string, args: PoolArgs, opts?: pulumi.CustomResourceOptions)

Create a Pool resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PoolState, opts?: pulumi.CustomResourceOptions): Pool

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Pool. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountName

public accountName: pulumi.Output<string>;

Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.

property autoScale

public autoScale: pulumi.Output<{
    evaluationInterval: undefined | string;
    formula: string;
} | undefined>;

A autoScale block that describes the scale settings when using auto scale.

property certificates

public certificates: pulumi.Output<{
    id: string;
    storeLocation: string;
    storeName: undefined | string;
    visibilities: string[];
}[] | undefined>;

One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.

property containerConfiguration

public containerConfiguration: pulumi.Output<{
    type: undefined | string;
} | undefined>;

The container configuration used in the pool’s VMs.

property displayName

public displayName: pulumi.Output<string | undefined>;

Specifies the display name of the Batch pool.

property fixedScale

public fixedScale: pulumi.Output<{
    resizeTimeout: undefined | string;
    targetDedicatedNodes: undefined | number;
    targetLowPriorityNodes: undefined | number;
} | undefined>;

A fixedScale block that describes the scale settings when using fixed scale.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxTasksPerNode

public maxTasksPerNode: pulumi.Output<number | undefined>;

Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Batch pool. Changing this forces a new resource to be created.

property nodeAgentSkuId

public nodeAgentSkuId: pulumi.Output<string>;

Specifies the Sku of the node agents that will be created in the Batch pool.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.

property startTask

public startTask: pulumi.Output<{
    commandLine: string;
    environment: undefined | {[key: string]: any};
    maxTaskRetryCount: undefined | number;
    resourceFiles: {
        autoStorageContainerName: undefined | string;
        blobPrefix: undefined | string;
        fileMode: undefined | string;
        filePath: undefined | string;
        httpUrl: undefined | string;
        storageContainerUrl: undefined | string;
    }[];
    userIdentity: {
        autoUser: undefined | {
            elevationLevel: undefined | string;
            scope: undefined | string;
        };
        userName: undefined | string;
    };
    waitForSuccess: undefined | false | true;
} | undefined>;

A startTask block that describes the start task settings for the Batch pool.

property stopPendingResizeOperation

public stopPendingResizeOperation: pulumi.Output<boolean | undefined>;

property storageImageReference

public storageImageReference: pulumi.Output<{
    id: undefined | string;
    offer: string;
    publisher: string;
    sku: string;
    version: string;
}>;

A storageImageReference for the virtual machines that will compose the Batch pool.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vmSize

public vmSize: pulumi.Output<string>;

Specifies the size of the VM created in the Batch pool.

function getAccount

getAccount(args: GetAccountArgs, opts?: pulumi.InvokeOptions): Promise<GetAccountResult> & GetAccountResult

Use this data source to access information about an existing Batch Account.

Example Usage

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

const test = pulumi.output(azure.batch.getAccount({
    name: "testbatchaccount",
    resourceGroupName: "test",
}));

export const poolAllocationMode = test.poolAllocationMode;

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/batch_account.html.markdown.

function getCertificate

getCertificate(args: GetCertificateArgs, opts?: pulumi.InvokeOptions): Promise<GetCertificateResult> & GetCertificateResult

Use this data source to access information about an existing certificate in a Batch Account.

Example Usage

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

const example = pulumi.output(azure.batch.getCertificate({
    accountName: "examplebatchaccount",
    name: "SHA1-42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
    resourceGroupName: "example",
}));

export const thumbprint = example.thumbprint;

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/batch_certificate.html.markdown.

function getPool

getPool(args: GetPoolArgs, opts?: pulumi.InvokeOptions): Promise<GetPoolResult> & GetPoolResult

Use this data source to access information about an existing Batch pool

Example Usage

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

const test = pulumi.output(azure.batch.getPool({
    accountName: "testbatchaccount",
    name: "testbatchpool",
    resourceGroupName: "test",
}));

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/batch_pool.html.markdown.

interface AccountArgs

The set of arguments for constructing a Account resource.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Batch account. Changing this forces a new resource to be created.

property poolAllocationMode

poolAllocationMode?: pulumi.Input<string>;

Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

property storageAccountId

storageAccountId?: pulumi.Input<string>;

Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface AccountState

Input properties used for looking up and filtering Account resources.

property accountEndpoint

accountEndpoint?: pulumi.Input<string>;

The account endpoint used to interact with the Batch service.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Batch account. Changing this forces a new resource to be created.

property poolAllocationMode

poolAllocationMode?: pulumi.Input<string>;

Specifies the mode to use for pool allocation. Possible values are BatchService or UserSubscription. Defaults to BatchService.

property primaryAccessKey

primaryAccessKey?: pulumi.Input<string>;

The Batch account primary access key.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

property secondaryAccessKey

secondaryAccessKey?: pulumi.Input<string>;

The Batch account secondary access key.

property storageAccountId

storageAccountId?: pulumi.Input<string>;

Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface CertificateArgs

The set of arguments for constructing a Certificate resource.

property accountName

accountName: pulumi.Input<string>;

Specifies the name of the Batch account. Changing this forces a new resource to be created.

property certificate

certificate: pulumi.Input<string>;

The base64-encoded contents of the certificate.

property format

format: pulumi.Input<string>;

The format of the certificate. Possible values are Cer or Pfx.

property password

password?: pulumi.Input<string>;

The password to access the certificate’s private key. This must and can only be specified when format is Pfx.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

property thumbprint

thumbprint: pulumi.Input<string>;

The thumbprint of the certificate. At this time the only supported value is ‘SHA1’.

property thumbprintAlgorithm

thumbprintAlgorithm: pulumi.Input<string>;

interface CertificateState

Input properties used for looking up and filtering Certificate resources.

property accountName

accountName?: pulumi.Input<string>;

Specifies the name of the Batch account. Changing this forces a new resource to be created.

property certificate

certificate?: pulumi.Input<string>;

The base64-encoded contents of the certificate.

property format

format?: pulumi.Input<string>;

The format of the certificate. Possible values are Cer or Pfx.

property name

name?: pulumi.Input<string>;

The generated name of the certificate.

property password

password?: pulumi.Input<string>;

The password to access the certificate’s private key. This must and can only be specified when format is Pfx.

property publicData

publicData?: pulumi.Input<string>;

The public key of the certificate.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.

property thumbprint

thumbprint?: pulumi.Input<string>;

The thumbprint of the certificate. At this time the only supported value is ‘SHA1’.

property thumbprintAlgorithm

thumbprintAlgorithm?: pulumi.Input<string>;

interface GetAccountArgs

A collection of arguments for invoking getAccount.

property name

name: string;

The name of the Batch account.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where this Batch account exists.

interface GetAccountResult

A collection of values returned by getAccount.

property accountEndpoint

accountEndpoint: string;

The account endpoint used to interact with the Batch service.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure Region in which this Batch account exists.

property name

name: string;

The Batch account name.

property poolAllocationMode

poolAllocationMode: string;

The pool allocation mode configured for this Batch account.

property primaryAccessKey

primaryAccessKey: string;

The Batch account primary access key.

property resourceGroupName

resourceGroupName: string;

property secondaryAccessKey

secondaryAccessKey: string;

The Batch account secondary access key.

property storageAccountId

storageAccountId: string;

The ID of the Storage Account used for this Batch account.

property tags

tags: {[key: string]: any};

A map of tags assigned to the Batch account.

interface GetCertificateArgs

A collection of arguments for invoking getCertificate.

property accountName

accountName: string;

The name of the Batch account.

property name

name: string;

The name of the Batch certificate.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where this Batch account exists.

interface GetCertificateResult

A collection of values returned by getCertificate.

property accountName

accountName: string;

property format

format: string;

The format of the certificate, such as Cer or Pfx.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property name

name: string;

property publicData

publicData: string;

The public key of the certificate.

property resourceGroupName

resourceGroupName: string;

property thumbprint

thumbprint: string;

The thumbprint of the certificate.

property thumbprintAlgorithm

thumbprintAlgorithm: string;

The algorithm of the certificate thumbprint.

interface GetPoolArgs

A collection of arguments for invoking getPool.

property accountName

accountName: string;

property certificates

certificates?: {
    id: string;
    storeLocation: string;
    storeName: undefined | string;
    visibilities: string[];
}[];

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property startTask

startTask?: undefined | {
    commandLine: string;
    environment: undefined | {[key: string]: any};
    maxTaskRetryCount: undefined | number;
    resourceFiles: {
        autoStorageContainerName: undefined | string;
        blobPrefix: undefined | string;
        fileMode: undefined | string;
        filePath: undefined | string;
        httpUrl: undefined | string;
        storageContainerUrl: undefined | string;
    }[];
    userIdentities: {
        autoUsers: {
            elevationLevel: undefined | string;
            scope: undefined | string;
        }[];
        userName: undefined | string;
    }[];
    waitForSuccess: undefined | false | true;
};

interface GetPoolResult

A collection of values returned by getPool.

property accountName

accountName: string;

The name of the Batch account.

property autoScales

autoScales: {
    evaluationInterval: string;
    formula: string;
}[];

A autoScale block that describes the scale settings when using auto scale.

property certificates

certificates?: {
    id: string;
    storeLocation: string;
    storeName: undefined | string;
    visibilities: string[];
}[];

One or more certificate blocks that describe the certificates installed on each compute node in the pool.

property containerConfigurations

containerConfigurations: {
    type: string;
}[];

The container configuration used in the pool’s VMs.

property displayName

displayName: string;

property fixedScales

fixedScales: {
    resizeTimeout: string;
    targetDedicatedNodes: number;
    targetLowPriorityNodes: number;
}[];

A fixedScale block that describes the scale settings when using fixed scale.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property maxTasksPerNode

maxTasksPerNode: number;

The maximum number of tasks that can run concurrently on a single compute node in the pool.

property name

name: string;

The name of the Batch pool.

property nodeAgentSkuId

nodeAgentSkuId: string;

The Sku of the node agents in the Batch pool.

property resourceGroupName

resourceGroupName: string;

property startTask

startTask?: undefined | {
    commandLine: string;
    environment: undefined | {[key: string]: any};
    maxTaskRetryCount: undefined | number;
    resourceFiles: {
        autoStorageContainerName: string;
        blobPrefix: string;
        fileMode: string;
        filePath: string;
        httpUrl: string;
        storageContainerUrl: string;
    }[];
    userIdentities: {
        autoUsers: {
            elevationLevel: string;
            scope: string;
        }[];
        userName: string;
    }[];
    waitForSuccess: undefined | false | true;
};

A startTask block that describes the start task settings for the Batch pool.

property storageImageReferences

storageImageReferences: {
    id: string;
    offer: string;
    publisher: string;
    sku: string;
    version: string;
}[];

The reference of the storage image used by the nodes in the Batch pool.

property vmSize

vmSize: string;

The size of the VM created in the Batch pool.

interface PoolArgs

The set of arguments for constructing a Pool resource.

property accountName

accountName: pulumi.Input<string>;

Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.

property autoScale

autoScale?: pulumi.Input<{
    evaluationInterval: pulumi.Input<string>;
    formula: pulumi.Input<string>;
}>;

A autoScale block that describes the scale settings when using auto scale.

property certificates

certificates?: pulumi.Input<pulumi.Input<{
    id: pulumi.Input<string>;
    storeLocation: pulumi.Input<string>;
    storeName: pulumi.Input<string>;
    visibilities: pulumi.Input<pulumi.Input<string>[]>;
}>[]>;

One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.

property containerConfiguration

containerConfiguration?: pulumi.Input<{
    type: pulumi.Input<string>;
}>;

The container configuration used in the pool’s VMs.

property displayName

displayName?: pulumi.Input<string>;

Specifies the display name of the Batch pool.

property fixedScale

fixedScale?: pulumi.Input<{
    resizeTimeout: pulumi.Input<string>;
    targetDedicatedNodes: pulumi.Input<number>;
    targetLowPriorityNodes: pulumi.Input<number>;
}>;

A fixedScale block that describes the scale settings when using fixed scale.

property maxTasksPerNode

maxTasksPerNode?: pulumi.Input<number>;

Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Batch pool. Changing this forces a new resource to be created.

property nodeAgentSkuId

nodeAgentSkuId: pulumi.Input<string>;

Specifies the Sku of the node agents that will be created in the Batch pool.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.

property startTask

startTask?: pulumi.Input<{
    commandLine: pulumi.Input<string>;
    environment: pulumi.Input<{[key: string]: any}>;
    maxTaskRetryCount: pulumi.Input<number>;
    resourceFiles: pulumi.Input<pulumi.Input<{
        autoStorageContainerName: pulumi.Input<string>;
        blobPrefix: pulumi.Input<string>;
        fileMode: pulumi.Input<string>;
        filePath: pulumi.Input<string>;
        httpUrl: pulumi.Input<string>;
        storageContainerUrl: pulumi.Input<string>;
    }>[]>;
    userIdentity: pulumi.Input<{
        autoUser: pulumi.Input<{
            elevationLevel: pulumi.Input<string>;
            scope: pulumi.Input<string>;
        }>;
        userName: pulumi.Input<string>;
    }>;
    waitForSuccess: pulumi.Input<boolean>;
}>;

A startTask block that describes the start task settings for the Batch pool.

property stopPendingResizeOperation

stopPendingResizeOperation?: pulumi.Input<boolean>;

property storageImageReference

storageImageReference: pulumi.Input<{
    id: pulumi.Input<string>;
    offer: pulumi.Input<string>;
    publisher: pulumi.Input<string>;
    sku: pulumi.Input<string>;
    version: pulumi.Input<string>;
}>;

A storageImageReference for the virtual machines that will compose the Batch pool.

property vmSize

vmSize: pulumi.Input<string>;

Specifies the size of the VM created in the Batch pool.

interface PoolState

Input properties used for looking up and filtering Pool resources.

property accountName

accountName?: pulumi.Input<string>;

Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.

property autoScale

autoScale?: pulumi.Input<{
    evaluationInterval: pulumi.Input<string>;
    formula: pulumi.Input<string>;
}>;

A autoScale block that describes the scale settings when using auto scale.

property certificates

certificates?: pulumi.Input<pulumi.Input<{
    id: pulumi.Input<string>;
    storeLocation: pulumi.Input<string>;
    storeName: pulumi.Input<string>;
    visibilities: pulumi.Input<pulumi.Input<string>[]>;
}>[]>;

One or more certificate blocks that describe the certificates to be installed on each compute node in the pool.

property containerConfiguration

containerConfiguration?: pulumi.Input<{
    type: pulumi.Input<string>;
}>;

The container configuration used in the pool’s VMs.

property displayName

displayName?: pulumi.Input<string>;

Specifies the display name of the Batch pool.

property fixedScale

fixedScale?: pulumi.Input<{
    resizeTimeout: pulumi.Input<string>;
    targetDedicatedNodes: pulumi.Input<number>;
    targetLowPriorityNodes: pulumi.Input<number>;
}>;

A fixedScale block that describes the scale settings when using fixed scale.

property maxTasksPerNode

maxTasksPerNode?: pulumi.Input<number>;

Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to 1. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Batch pool. Changing this forces a new resource to be created.

property nodeAgentSkuId

nodeAgentSkuId?: pulumi.Input<string>;

Specifies the Sku of the node agents that will be created in the Batch pool.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.

property startTask

startTask?: pulumi.Input<{
    commandLine: pulumi.Input<string>;
    environment: pulumi.Input<{[key: string]: any}>;
    maxTaskRetryCount: pulumi.Input<number>;
    resourceFiles: pulumi.Input<pulumi.Input<{
        autoStorageContainerName: pulumi.Input<string>;
        blobPrefix: pulumi.Input<string>;
        fileMode: pulumi.Input<string>;
        filePath: pulumi.Input<string>;
        httpUrl: pulumi.Input<string>;
        storageContainerUrl: pulumi.Input<string>;
    }>[]>;
    userIdentity: pulumi.Input<{
        autoUser: pulumi.Input<{
            elevationLevel: pulumi.Input<string>;
            scope: pulumi.Input<string>;
        }>;
        userName: pulumi.Input<string>;
    }>;
    waitForSuccess: pulumi.Input<boolean>;
}>;

A startTask block that describes the start task settings for the Batch pool.

property stopPendingResizeOperation

stopPendingResizeOperation?: pulumi.Input<boolean>;

property storageImageReference

storageImageReference?: pulumi.Input<{
    id: pulumi.Input<string>;
    offer: pulumi.Input<string>;
    publisher: pulumi.Input<string>;
    sku: pulumi.Input<string>;
    version: pulumi.Input<string>;
}>;

A storageImageReference for the virtual machines that will compose the Batch pool.

property vmSize

vmSize?: pulumi.Input<string>;

Specifies the size of the VM created in the Batch pool.