Class Pool

Manages an Azure Batch pool.

Inheritance

System.Object

Resource

CustomResource

Pool

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Batch

Assembly: Pulumi.Azure.dll

Syntax

public class Pool : CustomResource

Constructors

Pool(String, PoolArgs, CustomResourceOptions)

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

Declaration

public Pool(string name, PoolArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
PoolArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AccountName

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

Declaration

public Output<string> AccountName { get; }

Property Value

Type	Description
Output<System.String>

AutoScale

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

Declaration

public Output<PoolAutoScale> AutoScale { get; }

Property Value

Type	Description
Output<PoolAutoScale>

Certificates

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

Declaration

public Output<ImmutableArray<PoolCertificate>> Certificates { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<PoolCertificate>>

ContainerConfiguration

The container configuration used in the pool's VMs.

Declaration

public Output<PoolContainerConfiguration> ContainerConfiguration { get; }

Property Value

Type	Description
Output<PoolContainerConfiguration>

DisplayName

Specifies the display name of the Batch pool.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

FixedScale

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

Declaration

public Output<PoolFixedScale> FixedScale { get; }

Property Value

Type	Description
Output<PoolFixedScale>

MaxTasksPerNode

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.

Declaration

public Output<int?> MaxTasksPerNode { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Metadata

A map of custom batch pool metadata.

Declaration

public Output<ImmutableDictionary<string, string>> Metadata { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NetworkConfiguration

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

Declaration

public Output<PoolNetworkConfiguration> NetworkConfiguration { get; }

Property Value

Type	Description
Output<PoolNetworkConfiguration>

NodeAgentSkuId

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

Declaration

public Output<string> NodeAgentSkuId { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

StartTask

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

Declaration

public Output<PoolStartTask> StartTask { get; }

Property Value

Type	Description
Output<PoolStartTask>

StopPendingResizeOperation

Declaration

public Output<bool?> StopPendingResizeOperation { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

StorageImageReference

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

Declaration

public Output<PoolStorageImageReference> StorageImageReference { get; }

Property Value

Type	Description
Output<PoolStorageImageReference>

VmSize

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

Declaration

public Output<string> VmSize { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, PoolState, CustomResourceOptions)

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

Declaration

public static Pool Get(string name, Input<string> id, PoolState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
PoolState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Pool