Module batch

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Resource Account

class Account extends CustomResource

Manages an Azure Batch account.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "westeurope"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleBatch_accountAccount = new azure.batch.Account("exampleBatch/accountAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    poolAllocationMode: "BatchService",
    storageAccountId: exampleAccount.id,
    tags: {
        env: "test",
    },
});

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): obj is Account

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 keyVaultReference

public keyVaultReference: pulumi.Output<AccountKeyVaultReference | undefined>;

A keyVaultReference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

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]: string} | undefined>;

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.

Resource Application

class Application extends CustomResource

Manages Azure Batch Application instance.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleBatch_accountAccount = new azure.batch.Account("exampleBatch/accountAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    poolAllocationMode: "BatchService",
    storageAccountId: exampleAccount.id,
});
const exampleApplication = new azure.batch.Application("exampleApplication", {
    resourceGroupName: exampleResourceGroup.name,
    accountName: exampleBatch / accountAccount.name,
});

constructor

new Application(name: string, args: ApplicationArgs, opts?: pulumi.CustomResourceOptions)

Create a Application 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?: ApplicationState, opts?: pulumi.CustomResourceOptions): Application

Get an existing Application 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): obj is Application

Returns true if the given object is an instance of Application. 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>;

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

property allowUpdates

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

A value indicating whether packages within the application may be overwritten using the same version string. Defaults to true.

property defaultVersion

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

The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.

property displayName

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

The display name for the application.

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 name of the application. This must be unique within the account. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group that contains the Batch account. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

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

Resource Certificate

class Certificate extends CustomResource

Manages a certificate in an Azure Batch account.

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): obj is Certificate

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.

Resource Pool

class Pool extends CustomResource

Manages an Azure Batch pool.

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): obj is Pool

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<PoolAutoScale | undefined>;

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

property certificates

public certificates: pulumi.Output<PoolCertificate[] | 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<PoolContainerConfiguration | 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<PoolFixedScale | 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 metadata

public metadata: pulumi.Output<{[key: string]: string} | undefined>;

A map of custom batch pool metadata.

property name

public name: pulumi.Output<string>;

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

property networkConfiguration

public networkConfiguration: pulumi.Output<PoolNetworkConfiguration | undefined>;

A networkConfiguration block that describes the network configurations for the Batch pool.

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<PoolStartTask | 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<PoolStorageImageReference>;

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.

Functions

Function getAccount

getAccount(args: GetAccountArgs, opts?: pulumi.InvokeOptions): Promise<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 example = azure.batch.getAccount({
    name: "testbatchaccount",
    resourceGroupName: "test",
});
export const poolAllocationMode = example.then(example => example.poolAllocationMode);

Function getCertificate

getCertificate(args: GetCertificateArgs, opts?: pulumi.InvokeOptions): Promise<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 = azure.batch.getCertificate({
    name: "SHA1-42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
    accountName: "examplebatchaccount",
    resourceGroupName: "example",
});
export const thumbprint = example.then(example => example.thumbprint);

Function getPool

getPool(args: GetPoolArgs, opts?: pulumi.InvokeOptions): Promise<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 example = pulumi.output(azure.batch.getPool({
    accountName: "testbatchaccount",
    name: "testbatchpool",
    resourceGroupName: "test",
}, { async: true }));

Others

interface AccountArgs

interface AccountArgs

The set of arguments for constructing a Account resource.

property keyVaultReference

keyVaultReference?: pulumi.Input<AccountKeyVaultReference>;

A keyVaultReference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

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]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface AccountState

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 keyVaultReference

keyVaultReference?: pulumi.Input<AccountKeyVaultReference>;

A keyVaultReference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

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]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ApplicationArgs

interface ApplicationArgs

The set of arguments for constructing a Application resource.

property accountName

accountName: pulumi.Input<string>;

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

property allowUpdates

allowUpdates?: pulumi.Input<boolean>;

A value indicating whether packages within the application may be overwritten using the same version string. Defaults to true.

property defaultVersion

defaultVersion?: pulumi.Input<string>;

The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.

property displayName

displayName?: pulumi.Input<string>;

The display name for the application.

property name

name?: pulumi.Input<string>;

The name of the application. This must be unique within the account. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group that contains the Batch account. Changing this forces a new resource to be created.

interface ApplicationState

interface ApplicationState

Input properties used for looking up and filtering Application resources.

property accountName

accountName?: pulumi.Input<string>;

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

property allowUpdates

allowUpdates?: pulumi.Input<boolean>;

A value indicating whether packages within the application may be overwritten using the same version string. Defaults to true.

property defaultVersion

defaultVersion?: pulumi.Input<string>;

The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.

property displayName

displayName?: pulumi.Input<string>;

The display name for the application.

property name

name?: pulumi.Input<string>;

The name of the application. This must be unique within the account. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group that contains the Batch account. Changing this forces a new resource to be created.

interface CertificateArgs

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

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

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

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;

The provider-assigned unique ID for this managed resource.

property keyVaultReferences

keyVaultReferences: GetAccountKeyVaultReference[];

The keyVaultReference block that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the UserSubscription pool allocation mode.

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]: string};

A map of tags assigned to the Batch account.

interface GetCertificateArgs

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

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;

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

interface GetPoolArgs

A collection of arguments for invoking getPool.

property accountName

accountName: string;

The name of the Batch account.

property certificates

certificates?: GetPoolCertificate[];

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

property name

name: string;

The name of the endpoint.

property networkConfiguration

networkConfiguration?: inputs.batch.GetPoolNetworkConfiguration;

property resourceGroupName

resourceGroupName: string;

property startTask

startTask?: inputs.batch.GetPoolStartTask;

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

interface GetPoolResult

interface GetPoolResult

A collection of values returned by getPool.

property accountName

accountName: string;

The name of the Batch account.

property autoScales

autoScales: GetPoolAutoScale[];

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

property certificates

certificates?: GetPoolCertificate[];

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

property containerConfigurations

containerConfigurations: GetPoolContainerConfiguration[];

The container configuration used in the pool’s VMs.

property displayName

displayName: string;

property fixedScales

fixedScales: GetPoolFixedScale[];

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

property id

id: string;

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 metadata

metadata: {[key: string]: string};

property name

name: string;

The name of the endpoint.

property networkConfiguration

networkConfiguration: GetPoolNetworkConfiguration;

property nodeAgentSkuId

nodeAgentSkuId: string;

The Sku of the node agents in the Batch pool.

property resourceGroupName

resourceGroupName: string;

property startTask

startTask?: outputs.batch.GetPoolStartTask;

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

property storageImageReferences

storageImageReferences: GetPoolStorageImageReference[];

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

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<PoolAutoScale>;

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

property certificates

certificates?: pulumi.Input<pulumi.Input<PoolCertificate>[]>;

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

property containerConfiguration

containerConfiguration?: pulumi.Input<PoolContainerConfiguration>;

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<PoolFixedScale>;

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 metadata

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

A map of custom batch pool metadata.

property name

name?: pulumi.Input<string>;

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

property networkConfiguration

networkConfiguration?: pulumi.Input<PoolNetworkConfiguration>;

A networkConfiguration block that describes the network configurations for the Batch pool.

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<PoolStartTask>;

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

property stopPendingResizeOperation

stopPendingResizeOperation?: pulumi.Input<boolean>;

property storageImageReference

storageImageReference: pulumi.Input<PoolStorageImageReference>;

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

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<PoolAutoScale>;

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

property certificates

certificates?: pulumi.Input<pulumi.Input<PoolCertificate>[]>;

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

property containerConfiguration

containerConfiguration?: pulumi.Input<PoolContainerConfiguration>;

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<PoolFixedScale>;

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 metadata

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

A map of custom batch pool metadata.

property name

name?: pulumi.Input<string>;

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

property networkConfiguration

networkConfiguration?: pulumi.Input<PoolNetworkConfiguration>;

A networkConfiguration block that describes the network configurations for the Batch pool.

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<PoolStartTask>;

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

property stopPendingResizeOperation

stopPendingResizeOperation?: pulumi.Input<boolean>;

property storageImageReference

storageImageReference?: pulumi.Input<PoolStorageImageReference>;

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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module batch

Resources

Functions

Others

Resources

Example Usage

Example Usage

Functions

Example Usage

Example Usage

Example Usage

Others