Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getPool

Contains information about a pool. API Version: 2021-01-01.

Using getPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
def get_pool(account_name: Optional[str] = None,
             pool_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(account_name: Optional[pulumi.Input[str]] = None,
             pool_name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput

> Note: This function is named LookupPool in the Go SDK.

public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:batch:getPool
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AccountName string

The name of the Batch account.

PoolName string

The pool name. This must be unique within the account.

ResourceGroupName string

The name of the resource group that contains the Batch account.

AccountName string

The name of the Batch account.

PoolName string

The pool name. This must be unique within the account.

ResourceGroupName string

The name of the resource group that contains the Batch account.

accountName String

The name of the Batch account.

poolName String

The pool name. This must be unique within the account.

resourceGroupName String

The name of the resource group that contains the Batch account.

accountName string

The name of the Batch account.

poolName string

The pool name. This must be unique within the account.

resourceGroupName string

The name of the resource group that contains the Batch account.

account_name str

The name of the Batch account.

pool_name str

The pool name. This must be unique within the account.

resource_group_name str

The name of the resource group that contains the Batch account.

accountName String

The name of the Batch account.

poolName String

The pool name. This must be unique within the account.

resourceGroupName String

The name of the resource group that contains the Batch account.

getPool Result

The following output properties are available:

AllocationState string
AllocationStateTransitionTime string
AutoScaleRun Pulumi.AzureNative.Batch.Outputs.AutoScaleRunResponse

This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

CreationTime string
CurrentDedicatedNodes int
CurrentLowPriorityNodes int
Etag string

The ETag of the resource, used for concurrency statements.

Id string

The ID of the resource.

LastModified string

This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.

Name string

The name of the resource.

ProvisioningState string
ProvisioningStateTransitionTime string
ResizeOperationStatus Pulumi.AzureNative.Batch.Outputs.ResizeOperationStatusResponse

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

Type string

The type of the resource.

ApplicationLicenses List<string>

The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

ApplicationPackages List<Pulumi.AzureNative.Batch.Outputs.ApplicationPackageReferenceResponse>

Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

Certificates List<Pulumi.AzureNative.Batch.Outputs.CertificateReferenceResponse>

For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

DeploymentConfiguration Pulumi.AzureNative.Batch.Outputs.DeploymentConfigurationResponse

Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

DisplayName string

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Identity Pulumi.AzureNative.Batch.Outputs.BatchPoolIdentityResponse

The type of identity used for the Batch Pool.

InterNodeCommunication string

This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

Metadata List<Pulumi.AzureNative.Batch.Outputs.MetadataItemResponse>

The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

MountConfiguration List<Pulumi.AzureNative.Batch.Outputs.MountConfigurationResponse>

This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

NetworkConfiguration Pulumi.AzureNative.Batch.Outputs.NetworkConfigurationResponse

The network configuration for a pool.

ScaleSettings Pulumi.AzureNative.Batch.Outputs.ScaleSettingsResponse

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

StartTask Pulumi.AzureNative.Batch.Outputs.StartTaskResponse

In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

TaskSchedulingPolicy Pulumi.AzureNative.Batch.Outputs.TaskSchedulingPolicyResponse

If not specified, the default is spread.

TaskSlotsPerNode int

The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

UserAccounts List<Pulumi.AzureNative.Batch.Outputs.UserAccountResponse>
VmSize string

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

AllocationState string
AllocationStateTransitionTime string
AutoScaleRun AutoScaleRunResponse

This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

CreationTime string
CurrentDedicatedNodes int
CurrentLowPriorityNodes int
Etag string

The ETag of the resource, used for concurrency statements.

Id string

The ID of the resource.

LastModified string

This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.

Name string

The name of the resource.

ProvisioningState string
ProvisioningStateTransitionTime string
ResizeOperationStatus ResizeOperationStatusResponse

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

Type string

The type of the resource.

ApplicationLicenses []string

The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

ApplicationPackages []ApplicationPackageReferenceResponse

Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

Certificates []CertificateReferenceResponse

For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

DeploymentConfiguration DeploymentConfigurationResponse

Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

DisplayName string

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Identity BatchPoolIdentityResponse

The type of identity used for the Batch Pool.

InterNodeCommunication string

This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

Metadata []MetadataItemResponse

The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

MountConfiguration []MountConfigurationResponse

This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

NetworkConfiguration NetworkConfigurationResponse

The network configuration for a pool.

ScaleSettings ScaleSettingsResponse

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

StartTask StartTaskResponse

In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

TaskSchedulingPolicy TaskSchedulingPolicyResponse

If not specified, the default is spread.

TaskSlotsPerNode int

The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

UserAccounts []UserAccountResponse
VmSize string

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

allocationState String
allocationStateTransitionTime String
autoScaleRun AutoScaleRunResponse

This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

creationTime String
currentDedicatedNodes Integer
currentLowPriorityNodes Integer
etag String

The ETag of the resource, used for concurrency statements.

id String

The ID of the resource.

lastModified String

This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.

name String

The name of the resource.

provisioningState String
provisioningStateTransitionTime String
resizeOperationStatus ResizeOperationStatusResponse

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

type String

The type of the resource.

applicationLicenses List<String>

The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

applicationPackages List<ApplicationPackageReferenceResponse>

Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

certificates List<CertificateReferenceResponse>

For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

deploymentConfiguration DeploymentConfigurationResponse

Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

displayName String

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

identity BatchPoolIdentityResponse

The type of identity used for the Batch Pool.

interNodeCommunication String

This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

metadata List<MetadataItemResponse>

The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

mountConfiguration List<MountConfigurationResponse>

This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

networkConfiguration NetworkConfigurationResponse

The network configuration for a pool.

scaleSettings ScaleSettingsResponse

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

startTask StartTaskResponse

In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

taskSchedulingPolicy TaskSchedulingPolicyResponse

If not specified, the default is spread.

taskSlotsPerNode Integer

The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

userAccounts List<UserAccountResponse>
vmSize String

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

allocationState string
allocationStateTransitionTime string
autoScaleRun AutoScaleRunResponse

This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

creationTime string
currentDedicatedNodes number
currentLowPriorityNodes number
etag string

The ETag of the resource, used for concurrency statements.

id string

The ID of the resource.

lastModified string

This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.

name string

The name of the resource.

provisioningState string
provisioningStateTransitionTime string
resizeOperationStatus ResizeOperationStatusResponse

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

type string

The type of the resource.

applicationLicenses string[]

The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

applicationPackages ApplicationPackageReferenceResponse[]

Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

certificates CertificateReferenceResponse[]

For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

deploymentConfiguration DeploymentConfigurationResponse

Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

displayName string

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

identity BatchPoolIdentityResponse

The type of identity used for the Batch Pool.

interNodeCommunication string

This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

metadata MetadataItemResponse[]

The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

mountConfiguration MountConfigurationResponse[]

This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

networkConfiguration NetworkConfigurationResponse

The network configuration for a pool.

scaleSettings ScaleSettingsResponse

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

startTask StartTaskResponse

In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

taskSchedulingPolicy TaskSchedulingPolicyResponse

If not specified, the default is spread.

taskSlotsPerNode number

The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

userAccounts UserAccountResponse[]
vmSize string

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

allocation_state str
allocation_state_transition_time str
auto_scale_run AutoScaleRunResponse

This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

creation_time str
current_dedicated_nodes int
current_low_priority_nodes int
etag str

The ETag of the resource, used for concurrency statements.

id str

The ID of the resource.

last_modified str

This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.

name str

The name of the resource.

provisioning_state str
provisioning_state_transition_time str
resize_operation_status ResizeOperationStatusResponse

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

type str

The type of the resource.

application_licenses Sequence[str]

The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

application_packages Sequence[ApplicationPackageReferenceResponse]

Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

certificates Sequence[CertificateReferenceResponse]

For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

deployment_configuration DeploymentConfigurationResponse

Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

display_name str

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

identity BatchPoolIdentityResponse

The type of identity used for the Batch Pool.

inter_node_communication str

This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

metadata Sequence[MetadataItemResponse]

The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

mount_configuration Sequence[MountConfigurationResponse]

This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

network_configuration NetworkConfigurationResponse

The network configuration for a pool.

scale_settings ScaleSettingsResponse

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

start_task StartTaskResponse

In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

task_scheduling_policy TaskSchedulingPolicyResponse

If not specified, the default is spread.

task_slots_per_node int

The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

user_accounts Sequence[UserAccountResponse]
vm_size str

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

allocationState String
allocationStateTransitionTime String
autoScaleRun Property Map

This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

creationTime String
currentDedicatedNodes Number
currentLowPriorityNodes Number
etag String

The ETag of the resource, used for concurrency statements.

id String

The ID of the resource.

lastModified String

This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.

name String

The name of the resource.

provisioningState String
provisioningStateTransitionTime String
resizeOperationStatus Property Map

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

type String

The type of the resource.

applicationLicenses List<String>

The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

applicationPackages List<Property Map>

Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

certificates List<Property Map>

For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

deploymentConfiguration Property Map

Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

displayName String

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

identity Property Map

The type of identity used for the Batch Pool.

interNodeCommunication String

This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

metadata List<Property Map>

The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

mountConfiguration List<Property Map>

This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

networkConfiguration Property Map

The network configuration for a pool.

scaleSettings Property Map

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

startTask Property Map

In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

taskSchedulingPolicy Property Map

If not specified, the default is spread.

taskSlotsPerNode Number

The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

userAccounts List<Property Map>
vmSize String

For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

Supporting Types

ApplicationPackageReferenceResponse

Id string
Version string

If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.

Id string
Version string

If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.

id String
version String

If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.

id string
version string

If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.

id str
version str

If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.

id String
version String

If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.

AutoScaleRunErrorResponse

Code string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

Message string

A message describing the error, intended to be suitable for display in a user interface.

Details List<Pulumi.AzureNative.Batch.Inputs.AutoScaleRunErrorResponse>
Code string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

Message string

A message describing the error, intended to be suitable for display in a user interface.

Details []AutoScaleRunErrorResponse
code String

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message String

A message describing the error, intended to be suitable for display in a user interface.

details List<AutoScaleRunErrorResponse>
code string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message string

A message describing the error, intended to be suitable for display in a user interface.

details AutoScaleRunErrorResponse[]
code str

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message str

A message describing the error, intended to be suitable for display in a user interface.

details Sequence[AutoScaleRunErrorResponse]
code String

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message String

A message describing the error, intended to be suitable for display in a user interface.

details List<Property Map>

AutoScaleRunResponse

EvaluationTime string
Error Pulumi.AzureNative.Batch.Inputs.AutoScaleRunErrorResponse
Results string

Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

EvaluationTime string
Error AutoScaleRunErrorResponse
Results string

Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluationTime String
error AutoScaleRunErrorResponse
results String

Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluationTime string
error AutoScaleRunErrorResponse
results string

Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluation_time str
error AutoScaleRunErrorResponse
results str

Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluationTime String
error Property Map
results String

Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

AutoScaleSettingsResponse

Formula string
EvaluationInterval string

If omitted, the default value is 15 minutes (PT15M).

Formula string
EvaluationInterval string

If omitted, the default value is 15 minutes (PT15M).

formula String
evaluationInterval String

If omitted, the default value is 15 minutes (PT15M).

formula string
evaluationInterval string

If omitted, the default value is 15 minutes (PT15M).

formula str
evaluation_interval str

If omitted, the default value is 15 minutes (PT15M).

formula String
evaluationInterval String

If omitted, the default value is 15 minutes (PT15M).

AutoUserSpecificationResponse

ElevationLevel string

The default value is nonAdmin.

Scope string

The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.

ElevationLevel string

The default value is nonAdmin.

Scope string

The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.

elevationLevel String

The default value is nonAdmin.

scope String

The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.

elevationLevel string

The default value is nonAdmin.

scope string

The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.

elevation_level str

The default value is nonAdmin.

scope str

The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.

elevationLevel String

The default value is nonAdmin.

scope String

The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.

AzureBlobFileSystemConfigurationResponse

AccountName string
ContainerName string
RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

AccountKey string

This property is mutually exclusive with sasKey and one must be specified.

BlobfuseOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

SasKey string

This property is mutually exclusive with accountKey and one must be specified.

AccountName string
ContainerName string
RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

AccountKey string

This property is mutually exclusive with sasKey and one must be specified.

BlobfuseOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

SasKey string

This property is mutually exclusive with accountKey and one must be specified.

accountName String
containerName String
relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

accountKey String

This property is mutually exclusive with sasKey and one must be specified.

blobfuseOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

sasKey String

This property is mutually exclusive with accountKey and one must be specified.

accountName string
containerName string
relativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

accountKey string

This property is mutually exclusive with sasKey and one must be specified.

blobfuseOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

sasKey string

This property is mutually exclusive with accountKey and one must be specified.

account_name str
container_name str
relative_mount_path str

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

account_key str

This property is mutually exclusive with sasKey and one must be specified.

blobfuse_options str

These are 'net use' options in Windows and 'mount' options in Linux.

sas_key str

This property is mutually exclusive with accountKey and one must be specified.

accountName String
containerName String
relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

accountKey String

This property is mutually exclusive with sasKey and one must be specified.

blobfuseOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

sasKey String

This property is mutually exclusive with accountKey and one must be specified.

AzureFileShareConfigurationResponse

AccountKey string
AccountName string
AzureFileUrl string

This is of the form 'https://{account}.file.core.windows.net/'.

RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

MountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

AccountKey string
AccountName string
AzureFileUrl string

This is of the form 'https://{account}.file.core.windows.net/'.

RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

MountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

accountKey String
accountName String
azureFileUrl String

This is of the form 'https://{account}.file.core.windows.net/'.

relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

mountOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

accountKey string
accountName string
azureFileUrl string

This is of the form 'https://{account}.file.core.windows.net/'.

relativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

mountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

account_key str
account_name str
azure_file_url str

This is of the form 'https://{account}.file.core.windows.net/'.

relative_mount_path str

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

mount_options str

These are 'net use' options in Windows and 'mount' options in Linux.

accountKey String
accountName String
azureFileUrl String

This is of the form 'https://{account}.file.core.windows.net/'.

relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

mountOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

BatchPoolIdentityResponse

Type string

The type of identity used for the Batch Pool.

UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Batch.Inputs.BatchPoolIdentityResponseUserAssignedIdentities>

The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Type string

The type of identity used for the Batch Pool.

UserAssignedIdentities map[string]BatchPoolIdentityResponseUserAssignedIdentities

The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

type String

The type of identity used for the Batch Pool.

userAssignedIdentities Map<String,BatchPoolIdentityResponseUserAssignedIdentities>

The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

type string

The type of identity used for the Batch Pool.

userAssignedIdentities {[key: string]: BatchPoolIdentityResponseUserAssignedIdentities}

The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

type str

The type of identity used for the Batch Pool.

user_assigned_identities Mapping[str, BatchPoolIdentityResponseUserAssignedIdentities]

The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

type String

The type of identity used for the Batch Pool.

userAssignedIdentities Map<Property Map>

The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

BatchPoolIdentityResponseUserAssignedIdentities

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

principalId string

The principal id of user assigned identity.

client_id str

The client id of user assigned identity.

principal_id str

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

CIFSMountConfigurationResponse

Password string
RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

Source string
Username string
MountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

Password string
RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

Source string
Username string
MountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

password String
relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source String
username String
mountOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

password string
relativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source string
username string
mountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

password str
relative_mount_path str

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source str
username str
mount_options str

These are 'net use' options in Windows and 'mount' options in Linux.

password String
relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source String
username String
mountOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

CertificateReferenceResponse

Id string
StoreLocation string

The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

StoreName string

This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

Visibility List<string>
Id string
StoreLocation string

The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

StoreName string

This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

Visibility []string
id String
storeLocation String

The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

storeName String

This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

visibility List<String>
id string
storeLocation string

The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

storeName string

This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

visibility string[]
id str
store_location str

The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

store_name str

This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

visibility Sequence[str]
id String
storeLocation String

The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

storeName String

This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

visibility List<String>

CloudServiceConfigurationResponse

OsFamily string

Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

OsVersion string

The default value is * which specifies the latest operating system version for the specified OS family.

OsFamily string

Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

OsVersion string

The default value is * which specifies the latest operating system version for the specified OS family.

osFamily String

Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

osVersion String

The default value is * which specifies the latest operating system version for the specified OS family.

osFamily string

Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

osVersion string

The default value is * which specifies the latest operating system version for the specified OS family.

os_family str

Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

os_version str

The default value is * which specifies the latest operating system version for the specified OS family.

osFamily String

Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

osVersion String

The default value is * which specifies the latest operating system version for the specified OS family.

ContainerConfigurationResponse

Type string
ContainerImageNames List<string>

This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.

ContainerRegistries List<Pulumi.AzureNative.Batch.Inputs.ContainerRegistryResponse>

If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

Type string
ContainerImageNames []string

This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.

ContainerRegistries []ContainerRegistryResponse

If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

type String
containerImageNames List<String>

This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.

containerRegistries List<ContainerRegistryResponse>

If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

type string
containerImageNames string[]

This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.

containerRegistries ContainerRegistryResponse[]

If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

type str
container_image_names Sequence[str]

This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.

container_registries Sequence[ContainerRegistryResponse]

If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

type String
containerImageNames List<String>

This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.

containerRegistries List<Property Map>

If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

ContainerRegistryResponse

Password string
UserName string
RegistryServer string

If omitted, the default is "docker.io".

Password string
UserName string
RegistryServer string

If omitted, the default is "docker.io".

password String
userName String
registryServer String

If omitted, the default is "docker.io".

password string
userName string
registryServer string

If omitted, the default is "docker.io".

password str
user_name str
registry_server str

If omitted, the default is "docker.io".

password String
userName String
registryServer String

If omitted, the default is "docker.io".

DataDiskResponse

DiskSizeGB int
Lun int

The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive.

Caching string

Values are:

none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write.

The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

StorageAccountType string

If omitted, the default is "Standard_LRS". Values are:

Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.

DiskSizeGB int
Lun int

The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive.

Caching string

Values are:

none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write.

The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

StorageAccountType string

If omitted, the default is "Standard_LRS". Values are:

Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.

diskSizeGB Integer
lun Integer

The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive.

caching String

Values are:

none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write.

The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

storageAccountType String

If omitted, the default is "Standard_LRS". Values are:

Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.

diskSizeGB number
lun number

The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive.

caching string

Values are:

none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write.

The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

storageAccountType string

If omitted, the default is "Standard_LRS". Values are:

Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.

disk_size_gb int
lun int

The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive.

caching str

Values are:

none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write.

The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

storage_account_type str

If omitted, the default is "Standard_LRS". Values are:

Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.

diskSizeGB Number
lun Number

The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive.

caching String

Values are:

none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write.

The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

storageAccountType String

If omitted, the default is "Standard_LRS". Values are:

Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.

DeploymentConfigurationResponse

CloudServiceConfiguration Pulumi.AzureNative.Batch.Inputs.CloudServiceConfigurationResponse

This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

VirtualMachineConfiguration Pulumi.AzureNative.Batch.Inputs.VirtualMachineConfigurationResponse

This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

CloudServiceConfiguration CloudServiceConfigurationResponse

This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

VirtualMachineConfiguration VirtualMachineConfigurationResponse

This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

cloudServiceConfiguration CloudServiceConfigurationResponse

This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

virtualMachineConfiguration VirtualMachineConfigurationResponse

This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

cloudServiceConfiguration CloudServiceConfigurationResponse

This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

virtualMachineConfiguration VirtualMachineConfigurationResponse

This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

cloud_service_configuration CloudServiceConfigurationResponse

This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

virtual_machine_configuration VirtualMachineConfigurationResponse

This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

cloudServiceConfiguration Property Map

This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

virtualMachineConfiguration Property Map

This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

DiskEncryptionConfigurationResponse

Targets List<string>

On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.

Targets []string

On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.

targets List<String>

On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.

targets string[]

On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.

targets Sequence[str]

On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.

targets List<String>

On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.

EnvironmentSettingResponse

Name string
Value string
Name string
Value string
name String
value String
name string
value string
name str
value str
name String
value String

FixedScaleSettingsResponse

NodeDeallocationOption string

If omitted, the default value is Requeue.

ResizeTimeout string

The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

TargetDedicatedNodes int

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

TargetLowPriorityNodes int

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

NodeDeallocationOption string

If omitted, the default value is Requeue.

ResizeTimeout string

The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

TargetDedicatedNodes int

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

TargetLowPriorityNodes int

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

nodeDeallocationOption String

If omitted, the default value is Requeue.

resizeTimeout String

The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

targetDedicatedNodes Integer

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

targetLowPriorityNodes Integer

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

nodeDeallocationOption string

If omitted, the default value is Requeue.

resizeTimeout string

The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

targetDedicatedNodes number

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

targetLowPriorityNodes number

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

node_deallocation_option str

If omitted, the default value is Requeue.

resize_timeout str

The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

target_dedicated_nodes int

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

target_low_priority_nodes int

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

nodeDeallocationOption String

If omitted, the default value is Requeue.

resizeTimeout String

The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

targetDedicatedNodes Number

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

targetLowPriorityNodes Number

At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

ImageReferenceResponse

Id string

This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

Offer string

For example, UbuntuServer or WindowsServer.

Publisher string

For example, Canonical or MicrosoftWindowsServer.

Sku string

For example, 18.04-LTS or 2019-Datacenter.

Version string

A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

Id string

This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

Offer string

For example, UbuntuServer or WindowsServer.

Publisher string

For example, Canonical or MicrosoftWindowsServer.

Sku string

For example, 18.04-LTS or 2019-Datacenter.

Version string

A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

id String

This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

offer String

For example, UbuntuServer or WindowsServer.

publisher String

For example, Canonical or MicrosoftWindowsServer.

sku String

For example, 18.04-LTS or 2019-Datacenter.

version String

A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

id string

This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

offer string

For example, UbuntuServer or WindowsServer.

publisher string

For example, Canonical or MicrosoftWindowsServer.

sku string

For example, 18.04-LTS or 2019-Datacenter.

version string

A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

id str

This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

offer str

For example, UbuntuServer or WindowsServer.

publisher str

For example, Canonical or MicrosoftWindowsServer.

sku str

For example, 18.04-LTS or 2019-Datacenter.

version str

A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

id String

This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

offer String

For example, UbuntuServer or WindowsServer.

publisher String

For example, Canonical or MicrosoftWindowsServer.

sku String

For example, 18.04-LTS or 2019-Datacenter.

version String

A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

InboundNatPoolResponse

BackendPort int

This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

FrontendPortRangeEnd int

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

FrontendPortRangeStart int

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

Name string

The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

Protocol string
NetworkSecurityGroupRules List<Pulumi.AzureNative.Batch.Inputs.NetworkSecurityGroupRuleResponse>

The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

BackendPort int

This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

FrontendPortRangeEnd int

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

FrontendPortRangeStart int

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

Name string

The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

Protocol string
NetworkSecurityGroupRules []NetworkSecurityGroupRuleResponse

The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

backendPort Integer

This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

frontendPortRangeEnd Integer

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

frontendPortRangeStart Integer

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

name String

The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

protocol String
networkSecurityGroupRules List<NetworkSecurityGroupRuleResponse>

The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

backendPort number

This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

frontendPortRangeEnd number

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

frontendPortRangeStart number

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

name string

The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

protocol string
networkSecurityGroupRules NetworkSecurityGroupRuleResponse[]

The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

backend_port int

This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

frontend_port_range_end int

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

frontend_port_range_start int

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

name str

The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

protocol str
network_security_group_rules Sequence[NetworkSecurityGroupRuleResponse]

The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

backendPort Number

This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

frontendPortRangeEnd Number

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

frontendPortRangeStart Number

Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

name String

The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

protocol String
networkSecurityGroupRules List<Property Map>

The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

LinuxUserConfigurationResponse

Gid int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

SshPrivateKey string

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

Uid int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

Gid int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

SshPrivateKey string

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

Uid int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

gid Integer

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

sshPrivateKey String

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

uid Integer

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

gid number

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

sshPrivateKey string

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

uid number

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

gid int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

ssh_private_key str

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

uid int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

gid Number

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

sshPrivateKey String

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

uid Number

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

MetadataItemResponse

Name string
Value string
Name string
Value string
name String
value String
name string
value string
name str
value str
name String
value String

MountConfigurationResponse

AzureBlobFileSystemConfiguration Pulumi.AzureNative.Batch.Inputs.AzureBlobFileSystemConfigurationResponse

This property is mutually exclusive with all other properties.

AzureFileShareConfiguration Pulumi.AzureNative.Batch.Inputs.AzureFileShareConfigurationResponse

This property is mutually exclusive with all other properties.

CifsMountConfiguration Pulumi.AzureNative.Batch.Inputs.CIFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

NfsMountConfiguration Pulumi.AzureNative.Batch.Inputs.NFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

AzureBlobFileSystemConfiguration AzureBlobFileSystemConfigurationResponse

This property is mutually exclusive with all other properties.

AzureFileShareConfiguration AzureFileShareConfigurationResponse

This property is mutually exclusive with all other properties.

CifsMountConfiguration CIFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

NfsMountConfiguration NFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

azureBlobFileSystemConfiguration AzureBlobFileSystemConfigurationResponse

This property is mutually exclusive with all other properties.

azureFileShareConfiguration AzureFileShareConfigurationResponse

This property is mutually exclusive with all other properties.

cifsMountConfiguration CIFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

nfsMountConfiguration NFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

azureBlobFileSystemConfiguration AzureBlobFileSystemConfigurationResponse

This property is mutually exclusive with all other properties.

azureFileShareConfiguration AzureFileShareConfigurationResponse

This property is mutually exclusive with all other properties.

cifsMountConfiguration CIFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

nfsMountConfiguration NFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

azure_blob_file_system_configuration AzureBlobFileSystemConfigurationResponse

This property is mutually exclusive with all other properties.

azure_file_share_configuration AzureFileShareConfigurationResponse

This property is mutually exclusive with all other properties.

cifs_mount_configuration CIFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

nfs_mount_configuration NFSMountConfigurationResponse

This property is mutually exclusive with all other properties.

azureBlobFileSystemConfiguration Property Map

This property is mutually exclusive with all other properties.

azureFileShareConfiguration Property Map

This property is mutually exclusive with all other properties.

cifsMountConfiguration Property Map

This property is mutually exclusive with all other properties.

nfsMountConfiguration Property Map

This property is mutually exclusive with all other properties.

NFSMountConfigurationResponse

RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

Source string
MountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

RelativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

Source string
MountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source String
mountOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

relativeMountPath string

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source string
mountOptions string

These are 'net use' options in Windows and 'mount' options in Linux.

relative_mount_path str

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source str
mount_options str

These are 'net use' options in Windows and 'mount' options in Linux.

relativeMountPath String

All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source String
mountOptions String

These are 'net use' options in Windows and 'mount' options in Linux.

NetworkConfigurationResponse

EndpointConfiguration Pulumi.AzureNative.Batch.Inputs.PoolEndpointConfigurationResponse

Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

PublicIPAddressConfiguration Pulumi.AzureNative.Batch.Inputs.PublicIPAddressConfigurationResponse

This property is only supported on Pools with the virtualMachineConfiguration property.

SubnetId string

The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

EndpointConfiguration PoolEndpointConfigurationResponse

Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

PublicIPAddressConfiguration PublicIPAddressConfigurationResponse

This property is only supported on Pools with the virtualMachineConfiguration property.

SubnetId string

The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

endpointConfiguration PoolEndpointConfigurationResponse

Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

publicIPAddressConfiguration PublicIPAddressConfigurationResponse

This property is only supported on Pools with the virtualMachineConfiguration property.

subnetId String

The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

endpointConfiguration PoolEndpointConfigurationResponse

Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

publicIPAddressConfiguration PublicIPAddressConfigurationResponse

This property is only supported on Pools with the virtualMachineConfiguration property.

subnetId string

The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

endpoint_configuration PoolEndpointConfigurationResponse

Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

public_ip_address_configuration PublicIPAddressConfigurationResponse

This property is only supported on Pools with the virtualMachineConfiguration property.

subnet_id str

The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

endpointConfiguration Property Map

Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

publicIPAddressConfiguration Property Map

This property is only supported on Pools with the virtualMachineConfiguration property.

subnetId String

The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRuleResponse

Access string
Priority int

Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.

SourceAddressPrefix string

Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.

SourcePortRanges List<string>

Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.

Access string
Priority int

Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.

SourceAddressPrefix string

Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.

SourcePortRanges []string

Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.

access String
priority Integer

Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.

sourceAddressPrefix String

Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.

sourcePortRanges List<String>

Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.

access string
priority number

Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.

sourceAddressPrefix string

Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.

sourcePortRanges string[]

Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.

access str
priority int

Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.

source_address_prefix str

Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.

source_port_ranges Sequence[str]

Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.

access String
priority Number

Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.

sourceAddressPrefix String

Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.

sourcePortRanges List<String>

Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.

NodePlacementConfigurationResponse

Policy string

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

Policy string

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

policy String

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

policy string

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

policy str

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

policy String

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

PoolEndpointConfigurationResponse

InboundNatPools List<Pulumi.AzureNative.Batch.Inputs.InboundNatPoolResponse>

The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.

InboundNatPools []InboundNatPoolResponse

The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.

inboundNatPools List<InboundNatPoolResponse>

The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.

inboundNatPools InboundNatPoolResponse[]

The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.

inbound_nat_pools Sequence[InboundNatPoolResponse]

The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.

inboundNatPools List<Property Map>

The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.

PublicIPAddressConfigurationResponse

IpAddressIds List<string>

The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

Provision string

The default value is BatchManaged

IpAddressIds []string

The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

Provision string

The default value is BatchManaged

ipAddressIds List<String>

The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision String

The default value is BatchManaged

ipAddressIds string[]

The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision string

The default value is BatchManaged

ip_address_ids Sequence[str]

The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision str

The default value is BatchManaged

ipAddressIds List<String>

The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision String

The default value is BatchManaged

ResizeErrorResponse

Code string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

Message string

A message describing the error, intended to be suitable for display in a user interface.

Details List<Pulumi.AzureNative.Batch.Inputs.ResizeErrorResponse>
Code string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

Message string

A message describing the error, intended to be suitable for display in a user interface.

Details []ResizeErrorResponse
code String

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message String

A message describing the error, intended to be suitable for display in a user interface.

details List<ResizeErrorResponse>
code string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message string

A message describing the error, intended to be suitable for display in a user interface.

details ResizeErrorResponse[]
code str

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message str

A message describing the error, intended to be suitable for display in a user interface.

details Sequence[ResizeErrorResponse]
code String

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message String

A message describing the error, intended to be suitable for display in a user interface.

details List<Property Map>

ResizeOperationStatusResponse

Errors List<Pulumi.AzureNative.Batch.Inputs.ResizeErrorResponse>

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

NodeDeallocationOption string

The default value is requeue.

ResizeTimeout string

The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

StartTime string
TargetDedicatedNodes int
TargetLowPriorityNodes int
Errors []ResizeErrorResponse

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

NodeDeallocationOption string

The default value is requeue.

ResizeTimeout string

The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

StartTime string
TargetDedicatedNodes int
TargetLowPriorityNodes int
errors List<ResizeErrorResponse>

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

nodeDeallocationOption String

The default value is requeue.

resizeTimeout String

The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

startTime String
targetDedicatedNodes Integer
targetLowPriorityNodes Integer
errors ResizeErrorResponse[]

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

nodeDeallocationOption string

The default value is requeue.

resizeTimeout string

The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

startTime string
targetDedicatedNodes number
targetLowPriorityNodes number
errors Sequence[ResizeErrorResponse]

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

node_deallocation_option str

The default value is requeue.

resize_timeout str

The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

start_time str
target_dedicated_nodes int
target_low_priority_nodes int
errors List<Property Map>

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

nodeDeallocationOption String

The default value is requeue.

resizeTimeout String

The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

startTime String
targetDedicatedNodes Number
targetLowPriorityNodes Number

ResourceFileResponse

AutoStorageContainerName string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

BlobPrefix string

The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

FileMode string

This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

FilePath string

If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

HttpUrl string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

StorageContainerUrl string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

AutoStorageContainerName string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

BlobPrefix string

The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

FileMode string

This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

FilePath string

If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

HttpUrl string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

StorageContainerUrl string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

autoStorageContainerName String

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

blobPrefix String

The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

fileMode String

This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

filePath String

If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

httpUrl String

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

storageContainerUrl String

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

autoStorageContainerName string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

blobPrefix string

The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

fileMode string

This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

filePath string

If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

httpUrl string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

storageContainerUrl string

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

auto_storage_container_name str

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

blob_prefix str

The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

file_mode str

This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

file_path str

If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

http_url str

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

storage_container_url str

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

autoStorageContainerName String

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

blobPrefix String

The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

fileMode String

This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

filePath String

If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

httpUrl String

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

storageContainerUrl String

The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

ScaleSettingsResponse

AutoScale Pulumi.AzureNative.Batch.Inputs.AutoScaleSettingsResponse

This property and fixedScale are mutually exclusive and one of the properties must be specified.

FixedScale Pulumi.AzureNative.Batch.Inputs.FixedScaleSettingsResponse

This property and autoScale are mutually exclusive and one of the properties must be specified.

AutoScale AutoScaleSettingsResponse

This property and fixedScale are mutually exclusive and one of the properties must be specified.

FixedScale FixedScaleSettingsResponse

This property and autoScale are mutually exclusive and one of the properties must be specified.

autoScale AutoScaleSettingsResponse

This property and fixedScale are mutually exclusive and one of the properties must be specified.

fixedScale FixedScaleSettingsResponse

This property and autoScale are mutually exclusive and one of the properties must be specified.

autoScale AutoScaleSettingsResponse

This property and fixedScale are mutually exclusive and one of the properties must be specified.

fixedScale FixedScaleSettingsResponse

This property and autoScale are mutually exclusive and one of the properties must be specified.

auto_scale AutoScaleSettingsResponse

This property and fixedScale are mutually exclusive and one of the properties must be specified.

fixed_scale FixedScaleSettingsResponse

This property and autoScale are mutually exclusive and one of the properties must be specified.

autoScale Property Map

This property and fixedScale are mutually exclusive and one of the properties must be specified.

fixedScale Property Map

This property and autoScale are mutually exclusive and one of the properties must be specified.

StartTaskResponse

CommandLine string

The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.

ContainerSettings Pulumi.AzureNative.Batch.Inputs.TaskContainerSettingsResponse

When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

EnvironmentSettings List<Pulumi.AzureNative.Batch.Inputs.EnvironmentSettingResponse>
MaxTaskRetryCount int

The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.

ResourceFiles List<Pulumi.AzureNative.Batch.Inputs.ResourceFileResponse>
UserIdentity Pulumi.AzureNative.Batch.Inputs.UserIdentityResponse

If omitted, the task runs as a non-administrative user unique to the task.

WaitForSuccess bool

If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

CommandLine string

The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.

ContainerSettings TaskContainerSettingsResponse

When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

EnvironmentSettings []EnvironmentSettingResponse
MaxTaskRetryCount int

The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.

ResourceFiles []ResourceFileResponse
UserIdentity UserIdentityResponse

If omitted, the task runs as a non-administrative user unique to the task.

WaitForSuccess bool

If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

commandLine String

The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.

containerSettings TaskContainerSettingsResponse

When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

environmentSettings List<EnvironmentSettingResponse>
maxTaskRetryCount Integer

The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.

resourceFiles List<ResourceFileResponse>
userIdentity UserIdentityResponse

If omitted, the task runs as a non-administrative user unique to the task.

waitForSuccess Boolean

If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

commandLine string

The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.

containerSettings TaskContainerSettingsResponse

When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

environmentSettings EnvironmentSettingResponse[]
maxTaskRetryCount number

The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.

resourceFiles ResourceFileResponse[]
userIdentity UserIdentityResponse

If omitted, the task runs as a non-administrative user unique to the task.

waitForSuccess boolean

If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

command_line str

The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.

container_settings TaskContainerSettingsResponse

When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

environment_settings Sequence[EnvironmentSettingResponse]
max_task_retry_count int

The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.

resource_files Sequence[ResourceFileResponse]
user_identity UserIdentityResponse

If omitted, the task runs as a non-administrative user unique to the task.

wait_for_success bool

If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

commandLine String

The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.

containerSettings Property Map

When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

environmentSettings List<Property Map>
maxTaskRetryCount Number

The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.

resourceFiles List<Property Map>
userIdentity Property Map

If omitted, the task runs as a non-administrative user unique to the task.

waitForSuccess Boolean

If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

TaskContainerSettingsResponse

ImageName string

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.

ContainerRunOptions string

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

Registry Pulumi.AzureNative.Batch.Inputs.ContainerRegistryResponse

This setting can be omitted if was already provided at pool creation.

WorkingDirectory string
ImageName string

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.

ContainerRunOptions string

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

Registry ContainerRegistryResponse

This setting can be omitted if was already provided at pool creation.

WorkingDirectory string
imageName String

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.

containerRunOptions String

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

registry ContainerRegistryResponse

This setting can be omitted if was already provided at pool creation.

workingDirectory String
imageName string

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.

containerRunOptions string

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

registry ContainerRegistryResponse

This setting can be omitted if was already provided at pool creation.

workingDirectory string
image_name str

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.

container_run_options str

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

registry ContainerRegistryResponse

This setting can be omitted if was already provided at pool creation.

working_directory str
imageName String

This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.

containerRunOptions String

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

registry Property Map

This setting can be omitted if was already provided at pool creation.

workingDirectory String

TaskSchedulingPolicyResponse

UserAccountResponse

Name string
Password string
ElevationLevel string

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

LinuxUserConfiguration Pulumi.AzureNative.Batch.Inputs.LinuxUserConfigurationResponse

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

WindowsUserConfiguration Pulumi.AzureNative.Batch.Inputs.WindowsUserConfigurationResponse

This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.

Name string
Password string
ElevationLevel string

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

LinuxUserConfiguration LinuxUserConfigurationResponse

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

WindowsUserConfiguration WindowsUserConfigurationResponse

This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.

name String
password String
elevationLevel String

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

linuxUserConfiguration LinuxUserConfigurationResponse

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

windowsUserConfiguration WindowsUserConfigurationResponse

This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.

name string
password string
elevationLevel string

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

linuxUserConfiguration LinuxUserConfigurationResponse

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

windowsUserConfiguration WindowsUserConfigurationResponse

This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.

name str
password str
elevation_level str

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

linux_user_configuration LinuxUserConfigurationResponse

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

windows_user_configuration WindowsUserConfigurationResponse

This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.

name String
password String
elevationLevel String

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

linuxUserConfiguration Property Map

This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

windowsUserConfiguration Property Map

This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.

UserIdentityResponse

AutoUser Pulumi.AzureNative.Batch.Inputs.AutoUserSpecificationResponse

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

UserName string

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

AutoUser AutoUserSpecificationResponse

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

UserName string

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

autoUser AutoUserSpecificationResponse

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

userName String

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

autoUser AutoUserSpecificationResponse

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

userName string

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

auto_user AutoUserSpecificationResponse

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

user_name str

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

autoUser Property Map

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

userName String

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

VMExtensionResponse

Name string
Publisher string
Type string
AutoUpgradeMinorVersion bool

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

ProtectedSettings object

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

ProvisionAfterExtensions List<string>

Collection of extension names after which this extension needs to be provisioned.

Settings object
TypeHandlerVersion string
Name string
Publisher string
Type string
AutoUpgradeMinorVersion bool

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

ProtectedSettings interface{}

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

ProvisionAfterExtensions []string

Collection of extension names after which this extension needs to be provisioned.

Settings interface{}
TypeHandlerVersion string
name String
publisher String
type String
autoUpgradeMinorVersion Boolean

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

protectedSettings Object

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

provisionAfterExtensions List<String>

Collection of extension names after which this extension needs to be provisioned.

settings Object
typeHandlerVersion String
name string
publisher string
type string
autoUpgradeMinorVersion boolean

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

protectedSettings any

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

provisionAfterExtensions string[]

Collection of extension names after which this extension needs to be provisioned.

settings any
typeHandlerVersion string
name str
publisher str
type str
auto_upgrade_minor_version bool

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

protected_settings Any

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

provision_after_extensions Sequence[str]

Collection of extension names after which this extension needs to be provisioned.

settings Any
type_handler_version str
name String
publisher String
type String
autoUpgradeMinorVersion Boolean

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

protectedSettings Any

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

provisionAfterExtensions List<String>

Collection of extension names after which this extension needs to be provisioned.

settings Any
typeHandlerVersion String

VirtualMachineConfigurationResponse

ImageReference Pulumi.AzureNative.Batch.Inputs.ImageReferenceResponse
NodeAgentSkuId string

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

ContainerConfiguration Pulumi.AzureNative.Batch.Inputs.ContainerConfigurationResponse

If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

DataDisks List<Pulumi.AzureNative.Batch.Inputs.DataDiskResponse>

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

DiskEncryptionConfiguration Pulumi.AzureNative.Batch.Inputs.DiskEncryptionConfigurationResponse

If specified, encryption is performed on each node in the pool during node provisioning.

Extensions List<Pulumi.AzureNative.Batch.Inputs.VMExtensionResponse>

If specified, the extensions mentioned in this configuration will be installed on each node.

LicenseType string

This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

NodePlacementConfiguration Pulumi.AzureNative.Batch.Inputs.NodePlacementConfigurationResponse

This configuration will specify rules on how nodes in the pool will be physically allocated.

WindowsConfiguration Pulumi.AzureNative.Batch.Inputs.WindowsConfigurationResponse

This property must not be specified if the imageReference specifies a Linux OS image.

ImageReference ImageReferenceResponse
NodeAgentSkuId string

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

ContainerConfiguration ContainerConfigurationResponse

If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

DataDisks []DataDiskResponse

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

DiskEncryptionConfiguration DiskEncryptionConfigurationResponse

If specified, encryption is performed on each node in the pool during node provisioning.

Extensions []VMExtensionResponse

If specified, the extensions mentioned in this configuration will be installed on each node.

LicenseType string

This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

NodePlacementConfiguration NodePlacementConfigurationResponse

This configuration will specify rules on how nodes in the pool will be physically allocated.

WindowsConfiguration WindowsConfigurationResponse

This property must not be specified if the imageReference specifies a Linux OS image.

imageReference ImageReferenceResponse
nodeAgentSkuId String

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

containerConfiguration ContainerConfigurationResponse

If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

dataDisks List<DataDiskResponse>

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

diskEncryptionConfiguration DiskEncryptionConfigurationResponse

If specified, encryption is performed on each node in the pool during node provisioning.

extensions List<VMExtensionResponse>

If specified, the extensions mentioned in this configuration will be installed on each node.

licenseType String

This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

nodePlacementConfiguration NodePlacementConfigurationResponse

This configuration will specify rules on how nodes in the pool will be physically allocated.

windowsConfiguration WindowsConfigurationResponse

This property must not be specified if the imageReference specifies a Linux OS image.

imageReference ImageReferenceResponse
nodeAgentSkuId string

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

containerConfiguration ContainerConfigurationResponse

If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

dataDisks DataDiskResponse[]

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

diskEncryptionConfiguration DiskEncryptionConfigurationResponse

If specified, encryption is performed on each node in the pool during node provisioning.

extensions VMExtensionResponse[]

If specified, the extensions mentioned in this configuration will be installed on each node.

licenseType string

This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

nodePlacementConfiguration NodePlacementConfigurationResponse

This configuration will specify rules on how nodes in the pool will be physically allocated.

windowsConfiguration WindowsConfigurationResponse

This property must not be specified if the imageReference specifies a Linux OS image.

image_reference ImageReferenceResponse
node_agent_sku_id str

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

container_configuration ContainerConfigurationResponse

If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

data_disks Sequence[DataDiskResponse]

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

disk_encryption_configuration DiskEncryptionConfigurationResponse

If specified, encryption is performed on each node in the pool during node provisioning.

extensions Sequence[VMExtensionResponse]

If specified, the extensions mentioned in this configuration will be installed on each node.

license_type str

This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

node_placement_configuration NodePlacementConfigurationResponse

This configuration will specify rules on how nodes in the pool will be physically allocated.

windows_configuration WindowsConfigurationResponse

This property must not be specified if the imageReference specifies a Linux OS image.

imageReference Property Map
nodeAgentSkuId String

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

containerConfiguration Property Map

If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

dataDisks List<Property Map>

This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.

diskEncryptionConfiguration Property Map

If specified, encryption is performed on each node in the pool during node provisioning.

extensions List<Property Map>

If specified, the extensions mentioned in this configuration will be installed on each node.

licenseType String

This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

nodePlacementConfiguration Property Map

This configuration will specify rules on how nodes in the pool will be physically allocated.

windowsConfiguration Property Map

This property must not be specified if the imageReference specifies a Linux OS image.

WindowsConfigurationResponse

EnableAutomaticUpdates bool

If omitted, the default value is true.

EnableAutomaticUpdates bool

If omitted, the default value is true.

enableAutomaticUpdates Boolean

If omitted, the default value is true.

enableAutomaticUpdates boolean

If omitted, the default value is true.

enable_automatic_updates bool

If omitted, the default value is true.

enableAutomaticUpdates Boolean

If omitted, the default value is true.

WindowsUserConfigurationResponse

LoginMode string

Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.

LoginMode string

Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.

loginMode String

Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.

loginMode string

Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.

login_mode str

Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.

loginMode String

Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0