getPool

Azure Native v3.13.0, Jan 28 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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)
public static Output<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:batch:getPool
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountName string: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
PoolName string: The pool name. This must be unique within the account.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

AccountName string: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
PoolName string: The pool name. This must be unique within the account.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

accountName String: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
poolName String: The pool name. This must be unique within the account.
resourceGroupName String: The name of the resource group. The name is case insensitive.

accountName string: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
poolName string: The pool name. This must be unique within the account.
resourceGroupName string: The name of the resource group. The name is case insensitive.

account_name str: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
pool_name str: The pool name. This must be unique within the account.
resource_group_name str: The name of the resource group. The name is case insensitive.

accountName String: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
poolName String: The pool name. This must be unique within the account.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getPool Result

The following output properties are available:

AllocationState string

Whether the pool is resizing.

AllocationStateTransitionTime string

The time at which the pool entered its current allocation state.

AutoScaleRun Pulumi.AzureNative.Batch.Outputs.AutoScaleRunResponse

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

AzureApiVersion string

The Azure API version of the resource.

CreationTime string

The creation time of the pool.

CurrentDedicatedNodes int

The number of dedicated compute nodes currently in the pool.

CurrentLowPriorityNodes int

The number of Spot/low-priority compute nodes currently in the pool.

CurrentNodeCommunicationMode string

Determines how a pool communicates with the Batch service.

Etag string

The ETag of the resource, used for concurrency statements.

Id string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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

The current state of the pool.

ProvisioningStateTransitionTime string

The time at which the pool entered its current state.

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).

SystemData Pulumi.AzureNative.Batch.Outputs.SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

DeploymentConfiguration Pulumi.AzureNative.Batch.Outputs.DeploymentConfigurationResponse

Deployment configuration properties.

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.

ResourceTags Dictionary<string, string>

The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.

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.

Tags Dictionary<string, string>

The tags of the resource.

TargetNodeCommunicationMode string

If omitted, the default value is Default.

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.

UpgradePolicy Pulumi.AzureNative.Batch.Outputs.UpgradePolicyResponse

Describes an upgrade policy - automatic, manual, or rolling.

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

The list of user accounts to be created on each node in the pool.

VmSize string

For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

AllocationState string

Whether the pool is resizing.

AllocationStateTransitionTime string

The time at which the pool entered its current allocation state.

AutoScaleRun AutoScaleRunResponse

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

AzureApiVersion string

The Azure API version of the resource.

CreationTime string

The creation time of the pool.

CurrentDedicatedNodes int

The number of dedicated compute nodes currently in the pool.

CurrentLowPriorityNodes int

The number of Spot/low-priority compute nodes currently in the pool.

CurrentNodeCommunicationMode string

Determines how a pool communicates with the Batch service.

Etag string

The ETag of the resource, used for concurrency statements.

Id string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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

The current state of the pool.

ProvisioningStateTransitionTime string

The time at which the pool entered its current state.

ResizeOperationStatus ResizeOperationStatusResponse

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

SystemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

Certificates []CertificateReferenceResponse

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

DeploymentConfiguration DeploymentConfigurationResponse

Deployment configuration properties.

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

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.

ResourceTags map[string]string

ScaleSettings ScaleSettingsResponse

StartTask StartTaskResponse

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

Tags map[string]string

The tags of the resource.

TargetNodeCommunicationMode string

If omitted, the default value is Default.

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.

UpgradePolicy UpgradePolicyResponse

Describes an upgrade policy - automatic, manual, or rolling.

UserAccounts []UserAccountResponse

The list of user accounts to be created on each node in the pool.

VmSize string

allocationState String

Whether the pool is resizing.

allocationStateTransitionTime String

The time at which the pool entered its current allocation state.

autoScaleRun AutoScaleRunResponse

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

azureApiVersion String

The Azure API version of the resource.

creationTime String

The creation time of the pool.

currentDedicatedNodes Integer

The number of dedicated compute nodes currently in the pool.

currentLowPriorityNodes Integer

The number of Spot/low-priority compute nodes currently in the pool.

currentNodeCommunicationMode String

Determines how a pool communicates with the Batch service.

etag String

The ETag of the resource, used for concurrency statements.

id String

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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

The current state of the pool.

provisioningStateTransitionTime String

The time at which the pool entered its current state.

resizeOperationStatus ResizeOperationStatusResponse

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

systemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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>

certificates List<CertificateReferenceResponse>

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

deploymentConfiguration DeploymentConfigurationResponse

Deployment configuration properties.

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

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.

resourceTags Map<String,String>

scaleSettings ScaleSettingsResponse

startTask StartTaskResponse

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

tags Map<String,String>

The tags of the resource.

targetNodeCommunicationMode String

If omitted, the default value is Default.

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.

upgradePolicy UpgradePolicyResponse

Describes an upgrade policy - automatic, manual, or rolling.

userAccounts List<UserAccountResponse>

The list of user accounts to be created on each node in the pool.

vmSize String

allocationState string

Whether the pool is resizing.

allocationStateTransitionTime string

The time at which the pool entered its current allocation state.

autoScaleRun AutoScaleRunResponse

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

azureApiVersion string

The Azure API version of the resource.

creationTime string

The creation time of the pool.

currentDedicatedNodes number

The number of dedicated compute nodes currently in the pool.

currentLowPriorityNodes number

The number of Spot/low-priority compute nodes currently in the pool.

currentNodeCommunicationMode string

Determines how a pool communicates with the Batch service.

etag string

The ETag of the resource, used for concurrency statements.

id string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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

The current state of the pool.

provisioningStateTransitionTime string

The time at which the pool entered its current state.

resizeOperationStatus ResizeOperationStatusResponse

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

systemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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[]

certificates CertificateReferenceResponse[]

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

deploymentConfiguration DeploymentConfigurationResponse

Deployment configuration properties.

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

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.

resourceTags {[key: string]: string}

scaleSettings ScaleSettingsResponse

startTask StartTaskResponse

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

tags {[key: string]: string}

The tags of the resource.

targetNodeCommunicationMode string

If omitted, the default value is Default.

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.

upgradePolicy UpgradePolicyResponse

Describes an upgrade policy - automatic, manual, or rolling.

userAccounts UserAccountResponse[]

The list of user accounts to be created on each node in the pool.

vmSize string

allocation_state str

Whether the pool is resizing.

allocation_state_transition_time str

The time at which the pool entered its current allocation state.

auto_scale_run AutoScaleRunResponse

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

azure_api_version str

The Azure API version of the resource.

creation_time str

The creation time of the pool.

current_dedicated_nodes int

The number of dedicated compute nodes currently in the pool.

current_low_priority_nodes int

The number of Spot/low-priority compute nodes currently in the pool.

current_node_communication_mode str

Determines how a pool communicates with the Batch service.

etag str

The ETag of the resource, used for concurrency statements.

id str

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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

The current state of the pool.

provisioning_state_transition_time str

The time at which the pool entered its current state.

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).

system_data SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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]

certificates Sequence[CertificateReferenceResponse]

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

deployment_configuration DeploymentConfigurationResponse

Deployment configuration properties.

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

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.

resource_tags Mapping[str, str]

scale_settings ScaleSettingsResponse

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.

tags Mapping[str, str]

The tags of the resource.

target_node_communication_mode str

If omitted, the default value is Default.

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.

upgrade_policy UpgradePolicyResponse

Describes an upgrade policy - automatic, manual, or rolling.

user_accounts Sequence[UserAccountResponse]

The list of user accounts to be created on each node in the pool.

vm_size str

allocationState String

Whether the pool is resizing.

allocationStateTransitionTime String

The time at which the pool entered its current allocation state.

autoScaleRun Property Map

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

azureApiVersion String

The Azure API version of the resource.

creationTime String

The creation time of the pool.

currentDedicatedNodes Number

The number of dedicated compute nodes currently in the pool.

currentLowPriorityNodes Number

The number of Spot/low-priority compute nodes currently in the pool.

currentNodeCommunicationMode String

Determines how a pool communicates with the Batch service.

etag String

The ETag of the resource, used for concurrency statements.

id String

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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

The current state of the pool.

provisioningStateTransitionTime String

The time at which the pool entered its current state.

resizeOperationStatus Property Map

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

systemData Property Map

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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>

certificates List<Property Map>

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

deploymentConfiguration Property Map

Deployment configuration properties.

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

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.

resourceTags Map<String>

scaleSettings Property Map

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.

tags Map<String>

The tags of the resource.

targetNodeCommunicationMode String

If omitted, the default value is Default.

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.

upgradePolicy Property Map

Describes an upgrade policy - automatic, manual, or rolling.

userAccounts List<Property Map>

The list of user accounts to be created on each node in the pool.

vmSize String

Supporting Types

ApplicationPackageReferenceResponse

Id string: The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists.
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: The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists.
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: The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists.
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: The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists.
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: The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists.
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: The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists.
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>: Additional details about the error.

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: Additional details about the error.

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>: Additional details about the error.

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[]: Additional details about the error.

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]: Additional details about the error.

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>: Additional details about the error.

AutoScaleRunResponse

EvaluationTime string: The time at which the autoscale formula was last evaluated.
Error Pulumi.AzureNative.Batch.Inputs.AutoScaleRunErrorResponse: An error that occurred when autoscaling a pool.
Results string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

EvaluationTime string: The time at which the autoscale formula was last evaluated.
Error AutoScaleRunErrorResponse: An error that occurred when autoscaling a pool.
Results string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluationTime String: The time at which the autoscale formula was last evaluated.
error AutoScaleRunErrorResponse: An error that occurred when autoscaling a pool.
results String: Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluationTime string: The time at which the autoscale formula was last evaluated.
error AutoScaleRunErrorResponse: An error that occurred when autoscaling a pool.
results string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluation_time str: The time at which the autoscale formula was last evaluated.
error AutoScaleRunErrorResponse: An error that occurred when autoscaling a pool.
results str: Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

evaluationTime String: The time at which the autoscale formula was last evaluated.
error Property Map: An error that occurred when autoscaling a pool.
results String: Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

AutoScaleSettingsResponse

Formula string: A formula for the desired number of compute nodes in the pool.
EvaluationInterval string: If omitted, the default value is 15 minutes (PT15M).

Formula string: A formula for the desired number of compute nodes in the pool.
EvaluationInterval string: If omitted, the default value is 15 minutes (PT15M).

formula String: A formula for the desired number of compute nodes in the pool.
evaluationInterval String: If omitted, the default value is 15 minutes (PT15M).

formula string: A formula for the desired number of compute nodes in the pool.
evaluationInterval string: If omitted, the default value is 15 minutes (PT15M).

formula str: A formula for the desired number of compute nodes in the pool.
evaluation_interval str: If omitted, the default value is 15 minutes (PT15M).

formula String: A formula for the desired number of compute nodes in the pool.
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.

AutomaticOSUpgradePolicyResponse

DisableAutomaticRollback bool: Whether OS image rollback feature should be disabled.
EnableAutomaticOSUpgrade bool: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
OsRollingUpgradeDeferral bool: Defer OS upgrades on the TVMs if they are running tasks.
UseRollingUpgradePolicy bool: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

DisableAutomaticRollback bool: Whether OS image rollback feature should be disabled.
EnableAutomaticOSUpgrade bool: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
OsRollingUpgradeDeferral bool: Defer OS upgrades on the TVMs if they are running tasks.
UseRollingUpgradePolicy bool: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

disableAutomaticRollback Boolean: Whether OS image rollback feature should be disabled.
enableAutomaticOSUpgrade Boolean: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
osRollingUpgradeDeferral Boolean: Defer OS upgrades on the TVMs if they are running tasks.
useRollingUpgradePolicy Boolean: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

disableAutomaticRollback boolean: Whether OS image rollback feature should be disabled.
enableAutomaticOSUpgrade boolean: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
osRollingUpgradeDeferral boolean: Defer OS upgrades on the TVMs if they are running tasks.
useRollingUpgradePolicy boolean: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

disable_automatic_rollback bool: Whether OS image rollback feature should be disabled.
enable_automatic_os_upgrade bool: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
os_rolling_upgrade_deferral bool: Defer OS upgrades on the TVMs if they are running tasks.
use_rolling_upgrade_policy bool: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

disableAutomaticRollback Boolean: Whether OS image rollback feature should be disabled.
enableAutomaticOSUpgrade Boolean: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
osRollingUpgradeDeferral Boolean: Defer OS upgrades on the TVMs if they are running tasks.
useRollingUpgradePolicy Boolean: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

AzureBlobFileSystemConfigurationResponse

AccountName string: The Azure Storage Account name.
ContainerName string: The Azure Blob Storage Container name.
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 both sasKey and identity; exactly one must be specified.
BlobfuseOptions string: These are 'net use' options in Windows and 'mount' options in Linux.
IdentityReference Pulumi.AzureNative.Batch.Inputs.ComputeNodeIdentityReferenceResponse: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
SasKey string: This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

AccountName string: The Azure Storage Account name.
ContainerName string: The Azure Blob Storage Container name.
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 both sasKey and identity; exactly one must be specified.
BlobfuseOptions string: These are 'net use' options in Windows and 'mount' options in Linux.
IdentityReference ComputeNodeIdentityReferenceResponse: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
SasKey string: This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

accountName String: The Azure Storage Account name.
containerName String: The Azure Blob Storage Container name.
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 both sasKey and identity; exactly one must be specified.
blobfuseOptions String: These are 'net use' options in Windows and 'mount' options in Linux.
identityReference ComputeNodeIdentityReferenceResponse: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
sasKey String: This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

accountName string: The Azure Storage Account name.
containerName string: The Azure Blob Storage Container name.
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 both sasKey and identity; exactly one must be specified.
blobfuseOptions string: These are 'net use' options in Windows and 'mount' options in Linux.
identityReference ComputeNodeIdentityReferenceResponse: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
sasKey string: This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

account_name str: The Azure Storage Account name.
container_name str: The Azure Blob Storage Container name.
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 both sasKey and identity; exactly one must be specified.
blobfuse_options str: These are 'net use' options in Windows and 'mount' options in Linux.
identity_reference ComputeNodeIdentityReferenceResponse: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
sas_key str: This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

accountName String: The Azure Storage Account name.
containerName String: The Azure Blob Storage Container name.
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 both sasKey and identity; exactly one must be specified.
blobfuseOptions String: These are 'net use' options in Windows and 'mount' options in Linux.
identityReference Property Map: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
sasKey String: This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

AzureFileShareConfigurationResponse

AccountKey string: The Azure Storage account key.
AccountName string: The Azure Storage account name.
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: The Azure Storage account key.
AccountName string: The Azure Storage account name.
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: The Azure Storage account key.
accountName String: The Azure Storage account name.
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: The Azure Storage account key.
accountName string: The Azure Storage account name.
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: The Azure Storage account key.
account_name str: The Azure Storage account name.
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: The Azure Storage account key.
accountName String: The Azure Storage account name.
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.UserAssignedIdentitiesResponse>: The list of user identities associated with the Batch pool.

Type string: The type of identity used for the Batch Pool.
UserAssignedIdentities map[string]UserAssignedIdentitiesResponse: The list of user identities associated with the Batch pool.

type String: The type of identity used for the Batch Pool.
userAssignedIdentities Map<String,UserAssignedIdentitiesResponse>: The list of user identities associated with the Batch pool.

type string: The type of identity used for the Batch Pool.
userAssignedIdentities {[key: string]: UserAssignedIdentitiesResponse}: The list of user identities associated with the Batch pool.

type str: The type of identity used for the Batch Pool.
user_assigned_identities Mapping[str, UserAssignedIdentitiesResponse]: The list of user identities associated with the Batch pool.

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.

CIFSMountConfigurationResponse

Password string: The password to use for authentication against the CIFS file system.
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: The URI of the file system to mount.
UserName string: The user to use for authentication against the CIFS file system.
MountOptions string: These are 'net use' options in Windows and 'mount' options in Linux.

Password string: The password to use for authentication against the CIFS file system.
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: The URI of the file system to mount.
UserName string: The user to use for authentication against the CIFS file system.
MountOptions string: These are 'net use' options in Windows and 'mount' options in Linux.

password String: The password to use for authentication against the CIFS file system.
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: The URI of the file system to mount.
userName String: The user to use for authentication against the CIFS file system.
mountOptions String: These are 'net use' options in Windows and 'mount' options in Linux.

password string: The password to use for authentication against the CIFS file system.
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: The URI of the file system to mount.
userName string: The user to use for authentication against the CIFS file system.
mountOptions string: These are 'net use' options in Windows and 'mount' options in Linux.

password str: The password to use for authentication against the CIFS file system.
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: The URI of the file system to mount.
user_name str: The user to use for authentication against the CIFS file system.
mount_options str: These are 'net use' options in Windows and 'mount' options in Linux.

password String: The password to use for authentication against the CIFS file system.
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: The URI of the file system to mount.
userName String: The user to use for authentication against the CIFS file system.
mountOptions String: These are 'net use' options in Windows and 'mount' options in Linux.

CertificateReferenceResponse

Id string: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
StoreLocation string: The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. 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 compute nodes. 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>: Which user accounts on the compute node should have access to the private data of the certificate.

Id string: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
StoreLocation string: The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. 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 compute nodes. 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: Which user accounts on the compute node should have access to the private data of the certificate.

id String: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
storeLocation String: The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. 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 compute nodes. 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>: Which user accounts on the compute node should have access to the private data of the certificate.

id string: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
storeLocation string: The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. 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 compute nodes. 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[]: Which user accounts on the compute node should have access to the private data of the certificate.

id str: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
store_location str: The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. 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 compute nodes. 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]: Which user accounts on the compute node should have access to the private data of the certificate.

id String: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
storeLocation String: The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. 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 compute nodes. 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>: Which user accounts on the compute node should have access to the private data of the certificate.

ComputeNodeIdentityReferenceResponse

ResourceId string: The ARM resource id of the user assigned identity.

ResourceId string: The ARM resource id of the user assigned identity.

resourceId String: The ARM resource id of the user assigned identity.

resourceId string: The ARM resource id of the user assigned identity.

resource_id str: The ARM resource id of the user assigned identity.

resourceId String: The ARM resource id of the user assigned identity.

ContainerConfigurationResponse

Type string: The container technology to be used.
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: The container technology to be used.
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: The container technology to be used.
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: The container technology to be used.
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: The container technology to be used.
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: The container technology to be used.
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.

ContainerHostBatchBindMountEntryResponse

IsReadOnly bool: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.
Source string: The paths which will be mounted to container task's container.

IsReadOnly bool: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.
Source string: The paths which will be mounted to container task's container.

isReadOnly Boolean: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.
source String: The paths which will be mounted to container task's container.

isReadOnly boolean: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.
source string: The paths which will be mounted to container task's container.

is_read_only bool: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.
source str: The paths which will be mounted to container task's container.

isReadOnly Boolean: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.
source String: The paths which will be mounted to container task's container.

ContainerRegistryResponse

IdentityReference Pulumi.AzureNative.Batch.Inputs.ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
Password string: The password to log into the registry server.
RegistryServer string: If omitted, the default is "docker.io".
UserName string: The user name to log into the registry server.

IdentityReference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
Password string: The password to log into the registry server.
RegistryServer string: If omitted, the default is "docker.io".
UserName string: The user name to log into the registry server.

identityReference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
password String: The password to log into the registry server.
registryServer String: If omitted, the default is "docker.io".
userName String: The user name to log into the registry server.

identityReference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
password string: The password to log into the registry server.
registryServer string: If omitted, the default is "docker.io".
userName string: The user name to log into the registry server.

identity_reference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
password str: The password to log into the registry server.
registry_server str: If omitted, the default is "docker.io".
user_name str: The user name to log into the registry server.

identityReference Property Map: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
password String: The password to log into the registry server.
registryServer String: If omitted, the default is "docker.io".
userName String: The user name to log into the registry server.

DataDiskResponse

DiskSizeGB int

The initial disk size in GB when creating new data disk.

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

The initial disk size in GB when creating new data disk.

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

The initial disk size in GB when creating new data disk.

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

The initial disk size in GB when creating new data disk.

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

The initial disk size in GB when creating new data disk.

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

The initial disk size in GB when creating new data disk.

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

VirtualMachineConfiguration Pulumi.AzureNative.Batch.Inputs.VirtualMachineConfigurationResponse: The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

VirtualMachineConfiguration VirtualMachineConfigurationResponse: The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

virtualMachineConfiguration VirtualMachineConfigurationResponse: The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

virtualMachineConfiguration VirtualMachineConfigurationResponse: The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

virtual_machine_configuration VirtualMachineConfigurationResponse: The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

virtualMachineConfiguration Property Map: The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

DiffDiskSettingsResponse

Placement string: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

Placement string: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

placement String: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

placement string: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

placement str: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

placement String: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

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: The name of the environment variable.
Value string: The value of the environment variable.

Name string: The name of the environment variable.
Value string: The value of the environment variable.

name String: The name of the environment variable.
value String: The value of the environment variable.

name string: The name of the environment variable.
value string: The value of the environment variable.

name str: The name of the environment variable.
value str: The value of the environment variable.

name String: The name of the environment variable.
value String: The value of the environment variable.

FixedScaleSettingsResponse

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.

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.

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.

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.

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.

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

CommunityGalleryImageId string: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
Id string: This property is mutually exclusive with other properties. The Azure Compute 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://learn.microsoft.com/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.
SharedGalleryImageId string: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
Sku string: For example, 18.04-LTS or 2022-datacenter.
Version string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

CommunityGalleryImageId string: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
Id string: This property is mutually exclusive with other properties. The Azure Compute 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://learn.microsoft.com/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.
SharedGalleryImageId string: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
Sku string: For example, 18.04-LTS or 2022-datacenter.
Version string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

communityGalleryImageId String: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
id String: This property is mutually exclusive with other properties. The Azure Compute 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://learn.microsoft.com/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.
sharedGalleryImageId String: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
sku String: For example, 18.04-LTS or 2022-datacenter.
version String: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

communityGalleryImageId string: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
id string: This property is mutually exclusive with other properties. The Azure Compute 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://learn.microsoft.com/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.
sharedGalleryImageId string: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
sku string: For example, 18.04-LTS or 2022-datacenter.
version string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

community_gallery_image_id str: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
id str: This property is mutually exclusive with other properties. The Azure Compute 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://learn.microsoft.com/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.
shared_gallery_image_id str: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
sku str: For example, 18.04-LTS or 2022-datacenter.
version str: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

communityGalleryImageId String: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.
id String: This property is mutually exclusive with other properties. The Azure Compute 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://learn.microsoft.com/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.
sharedGalleryImageId String: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.
sku String: For example, 18.04-LTS or 2022-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 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: The protocol of the endpoint.
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 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: The protocol of the endpoint.
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 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: The protocol of the endpoint.
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 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: The protocol of the endpoint.
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 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: The protocol of the endpoint.
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 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: The protocol of the endpoint.
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.

ManagedDiskResponse

SecurityProfile Pulumi.AzureNative.Batch.Inputs.VMDiskSecurityProfileResponse: Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.
StorageAccountType string: The storage account type for use in creating data disks or OS disk.

SecurityProfile VMDiskSecurityProfileResponse: Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.
StorageAccountType string: The storage account type for use in creating data disks or OS disk.

securityProfile VMDiskSecurityProfileResponse: Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.
storageAccountType String: The storage account type for use in creating data disks or OS disk.

securityProfile VMDiskSecurityProfileResponse: Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.
storageAccountType string: The storage account type for use in creating data disks or OS disk.

security_profile VMDiskSecurityProfileResponse: Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.
storage_account_type str: The storage account type for use in creating data disks or OS disk.

securityProfile Property Map: Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.
storageAccountType String: The storage account type for use in creating data disks or OS disk.

MetadataItemResponse

Name string: The name of the metadata item.
Value string: The value of the metadata item.

Name string: The name of the metadata item.
Value string: The value of the metadata item.

name String: The name of the metadata item.
value String: The value of the metadata item.

name string: The name of the metadata item.
value string: The value of the metadata item.

name str: The name of the metadata item.
value str: The value of the metadata item.

name String: The name of the metadata item.
value String: The value of the metadata item.

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: The URI of the file system to mount.
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: The URI of the file system to mount.
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: The URI of the file system to mount.
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: The URI of the file system to mount.
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: The URI of the file system to mount.
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: The URI of the file system to mount.
mountOptions String: These are 'net use' options in Windows and 'mount' options in Linux.

NetworkConfigurationResponse

DynamicVnetAssignmentScope string: The scope of dynamic vnet assignment.
EnableAcceleratedNetworking bool: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
EndpointConfiguration Pulumi.AzureNative.Batch.Inputs.PoolEndpointConfigurationResponse: The endpoint configuration for a pool.
PublicIPAddressConfiguration Pulumi.AzureNative.Batch.Inputs.PublicIPAddressConfigurationResponse: The public IP Address configuration of the networking configuration of a Pool.
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，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

DynamicVnetAssignmentScope string: The scope of dynamic vnet assignment.
EnableAcceleratedNetworking bool: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
EndpointConfiguration PoolEndpointConfigurationResponse: The endpoint configuration for a pool.
PublicIPAddressConfiguration PublicIPAddressConfigurationResponse: The public IP Address configuration of the networking configuration of a Pool.
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，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

dynamicVnetAssignmentScope String: The scope of dynamic vnet assignment.
enableAcceleratedNetworking Boolean: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration PoolEndpointConfigurationResponse: The endpoint configuration for a pool.
publicIPAddressConfiguration PublicIPAddressConfigurationResponse: The public IP Address configuration of the networking configuration of a Pool.
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，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

dynamicVnetAssignmentScope string: The scope of dynamic vnet assignment.
enableAcceleratedNetworking boolean: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration PoolEndpointConfigurationResponse: The endpoint configuration for a pool.
publicIPAddressConfiguration PublicIPAddressConfigurationResponse: The public IP Address configuration of the networking configuration of a Pool.
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，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

dynamic_vnet_assignment_scope str: The scope of dynamic vnet assignment.
enable_accelerated_networking bool: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpoint_configuration PoolEndpointConfigurationResponse: The endpoint configuration for a pool.
public_ip_address_configuration PublicIPAddressConfigurationResponse: The public IP Address configuration of the networking configuration of a Pool.
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，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

dynamicVnetAssignmentScope String: The scope of dynamic vnet assignment.
enableAcceleratedNetworking Boolean: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration Property Map: The endpoint configuration for a pool.
publicIPAddressConfiguration Property Map: The public IP Address configuration of the networking configuration of a Pool.
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，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRuleResponse

Access string: The action that should be taken for a specified IP address, subnet range or tag.
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: The action that should be taken for a specified IP address, subnet range or tag.
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: The action that should be taken for a specified IP address, subnet range or tag.
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: The action that should be taken for a specified IP address, subnet range or tag.
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: The action that should be taken for a specified IP address, subnet range or tag.
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: The action that should be taken for a specified IP address, subnet range or tag.
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.

OSDiskResponse

Caching string: The type of caching to enable for the disk.
DiskSizeGB int: The initial disk size in GB when creating new OS disk.
EphemeralOSDiskSettings Pulumi.AzureNative.Batch.Inputs.DiffDiskSettingsResponse: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
ManagedDisk Pulumi.AzureNative.Batch.Inputs.ManagedDiskResponse
WriteAcceleratorEnabled bool: Specifies whether writeAccelerator should be enabled or disabled on the disk.

Caching string: The type of caching to enable for the disk.
DiskSizeGB int: The initial disk size in GB when creating new OS disk.
EphemeralOSDiskSettings DiffDiskSettingsResponse: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
ManagedDisk ManagedDiskResponse
WriteAcceleratorEnabled bool: Specifies whether writeAccelerator should be enabled or disabled on the disk.

caching String: The type of caching to enable for the disk.
diskSizeGB Integer: The initial disk size in GB when creating new OS disk.
ephemeralOSDiskSettings DiffDiskSettingsResponse: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
managedDisk ManagedDiskResponse
writeAcceleratorEnabled Boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

caching string: The type of caching to enable for the disk.
diskSizeGB number: The initial disk size in GB when creating new OS disk.
ephemeralOSDiskSettings DiffDiskSettingsResponse: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
managedDisk ManagedDiskResponse
writeAcceleratorEnabled boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

caching str: The type of caching to enable for the disk.
disk_size_gb int: The initial disk size in GB when creating new OS disk.
ephemeral_os_disk_settings DiffDiskSettingsResponse: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
managed_disk ManagedDiskResponse
write_accelerator_enabled bool: Specifies whether writeAccelerator should be enabled or disabled on the disk.

caching String: The type of caching to enable for the disk.
diskSizeGB Number: The initial disk size in GB when creating new OS disk.
ephemeralOSDiskSettings Property Map: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
managedDisk Property Map
writeAcceleratorEnabled Boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

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 Spot/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 Spot/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 Spot/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 Spot/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 Spot/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 Spot/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>: Additional details about the error.

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: Additional details about the error.

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>: Additional details about the error.

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[]: Additional details about the error.

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]: Additional details about the error.

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>: Additional details about the error.

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: The time when this resize operation was started.
TargetDedicatedNodes int: The desired number of dedicated compute nodes in the pool.
TargetLowPriorityNodes int: The desired number of Spot/low-priority compute nodes in the pool.

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: The time when this resize operation was started.
TargetDedicatedNodes int: The desired number of dedicated compute nodes in the pool.
TargetLowPriorityNodes int: The desired number of Spot/low-priority compute nodes in the pool.

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: The time when this resize operation was started.
targetDedicatedNodes Integer: The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes Integer: The desired number of Spot/low-priority compute nodes in the pool.

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: The time when this resize operation was started.
targetDedicatedNodes number: The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes number: The desired number of Spot/low-priority compute nodes in the pool.

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: The time when this resize operation was started.
target_dedicated_nodes int: The desired number of dedicated compute nodes in the pool.
target_low_priority_nodes int: The desired number of Spot/low-priority compute nodes in the pool.

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: The time when this resize operation was started.
targetDedicatedNodes Number: The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes Number: The desired number of Spot/low-priority compute nodes in the pool.

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 points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.
IdentityReference Pulumi.AzureNative.Batch.Inputs.ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
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 from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the 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 points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.
IdentityReference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
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 from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the 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 points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.
identityReference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
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 from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the 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 points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.
identityReference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
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 from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the 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 points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.
identity_reference ComputeNodeIdentityReferenceResponse: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
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 from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the 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 points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.
identityReference Property Map: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
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 from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access.

RollingUpgradePolicyResponse

EnableCrossZoneUpgrade bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.
MaxBatchInstancePercent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
MaxUnhealthyInstancePercent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
MaxUnhealthyUpgradedInstancePercent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.
PauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
PrioritizeUnhealthyInstances bool: Upgrade all unhealthy instances in a scale set before any healthy instances.
RollbackFailedInstancesOnPolicyBreach bool: Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

EnableCrossZoneUpgrade bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.
MaxBatchInstancePercent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
MaxUnhealthyInstancePercent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
MaxUnhealthyUpgradedInstancePercent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.
PauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
PrioritizeUnhealthyInstances bool: Upgrade all unhealthy instances in a scale set before any healthy instances.
RollbackFailedInstancesOnPolicyBreach bool: Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

enableCrossZoneUpgrade Boolean: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.
maxBatchInstancePercent Integer: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent Integer: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent Integer: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.
pauseTimeBetweenBatches String: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
prioritizeUnhealthyInstances Boolean: Upgrade all unhealthy instances in a scale set before any healthy instances.
rollbackFailedInstancesOnPolicyBreach Boolean: Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

enableCrossZoneUpgrade boolean: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.
maxBatchInstancePercent number: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent number: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent number: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.
pauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
prioritizeUnhealthyInstances boolean: Upgrade all unhealthy instances in a scale set before any healthy instances.
rollbackFailedInstancesOnPolicyBreach boolean: Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

enable_cross_zone_upgrade bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.
max_batch_instance_percent int: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
max_unhealthy_instance_percent int: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
max_unhealthy_upgraded_instance_percent int: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.
pause_time_between_batches str: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
prioritize_unhealthy_instances bool: Upgrade all unhealthy instances in a scale set before any healthy instances.
rollback_failed_instances_on_policy_breach bool: Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

enableCrossZoneUpgrade Boolean: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.
maxBatchInstancePercent Number: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent Number: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent Number: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.
pauseTimeBetweenBatches String: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.
prioritizeUnhealthyInstances Boolean: Upgrade all unhealthy instances in a scale set before any healthy instances.
rollbackFailedInstancesOnPolicyBreach Boolean: Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

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.

SecurityProfileResponse

EncryptionAtHost bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.
SecurityType string: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
UefiSettings Pulumi.AzureNative.Batch.Inputs.UefiSettingsResponse: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

EncryptionAtHost bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.
SecurityType string: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
UefiSettings UefiSettingsResponse: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

encryptionAtHost Boolean: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.
securityType String: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
uefiSettings UefiSettingsResponse: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

encryptionAtHost boolean: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.
securityType string: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
uefiSettings UefiSettingsResponse: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

encryption_at_host bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.
security_type str: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
uefi_settings UefiSettingsResponse: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

encryptionAtHost Boolean: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.
securityType String: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
uefiSettings Property Map: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

ServiceArtifactReferenceResponse

Id string: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

Id string: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

id String: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

id string: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

id str: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

id String: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

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>: A list of environment variable settings for the start task.
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. Default is 0
ResourceFiles List<Pulumi.AzureNative.Batch.Inputs.ResourceFileResponse>: A list of files that the Batch service will download to the compute node before running the command line.
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: A list of environment variable settings for the start task.
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. Default is 0
ResourceFiles []ResourceFileResponse: A list of files that the Batch service will download to the compute node before running the command line.
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>: A list of environment variable settings for the start task.
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. Default is 0
resourceFiles List<ResourceFileResponse>: A list of files that the Batch service will download to the compute node before running the command line.
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[]: A list of environment variable settings for the start task.
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. Default is 0
resourceFiles ResourceFileResponse[]: A list of files that the Batch service will download to the compute node before running the command line.
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]: A list of environment variable settings for the start task.
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. Default is 0
resource_files Sequence[ResourceFileResponse]: A list of files that the Batch service will download to the compute node before running the command line.
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>: A list of environment variable settings for the start task.
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. Default is 0
resourceFiles List<Property Map>: A list of files that the Batch service will download to the compute node before running the command line.
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.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

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.
ContainerHostBatchBindMounts List<Pulumi.AzureNative.Batch.Inputs.ContainerHostBatchBindMountEntryResponse>: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
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: A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

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.
ContainerHostBatchBindMounts []ContainerHostBatchBindMountEntryResponse: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
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: A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

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.
containerHostBatchBindMounts List<ContainerHostBatchBindMountEntryResponse>: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
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: A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

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.
containerHostBatchBindMounts ContainerHostBatchBindMountEntryResponse[]: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
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: A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

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_host_batch_bind_mounts Sequence[ContainerHostBatchBindMountEntryResponse]: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
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: A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

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.
containerHostBatchBindMounts List<Property Map>: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
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: A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

TaskSchedulingPolicyResponse

NodeFillType string: How tasks should be distributed across compute nodes.

NodeFillType string: How tasks should be distributed across compute nodes.

nodeFillType String: How tasks should be distributed across compute nodes.

nodeFillType string: How tasks should be distributed across compute nodes.

node_fill_type str: How tasks should be distributed across compute nodes.

nodeFillType String: How tasks should be distributed across compute nodes.

UefiSettingsResponse

SecureBootEnabled bool: Specifies whether secure boot should be enabled on the virtual machine.
VTpmEnabled bool: Specifies whether vTPM should be enabled on the virtual machine.

SecureBootEnabled bool: Specifies whether secure boot should be enabled on the virtual machine.
VTpmEnabled bool: Specifies whether vTPM should be enabled on the virtual machine.

secureBootEnabled Boolean: Specifies whether secure boot should be enabled on the virtual machine.
vTpmEnabled Boolean: Specifies whether vTPM should be enabled on the virtual machine.

secureBootEnabled boolean: Specifies whether secure boot should be enabled on the virtual machine.
vTpmEnabled boolean: Specifies whether vTPM should be enabled on the virtual machine.

secure_boot_enabled bool: Specifies whether secure boot should be enabled on the virtual machine.
v_tpm_enabled bool: Specifies whether vTPM should be enabled on the virtual machine.

secureBootEnabled Boolean: Specifies whether secure boot should be enabled on the virtual machine.
vTpmEnabled Boolean: Specifies whether vTPM should be enabled on the virtual machine.

UpgradePolicyResponse

Mode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time. Rolling - Scale set performs updates in batches with an optional pause time in between.
AutomaticOSUpgradePolicy Pulumi.AzureNative.Batch.Inputs.AutomaticOSUpgradePolicyResponse: The configuration parameters used for performing automatic OS upgrade.
RollingUpgradePolicy Pulumi.AzureNative.Batch.Inputs.RollingUpgradePolicyResponse: The configuration parameters used while performing a rolling upgrade.

Mode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time. Rolling - Scale set performs updates in batches with an optional pause time in between.
AutomaticOSUpgradePolicy AutomaticOSUpgradePolicyResponse: The configuration parameters used for performing automatic OS upgrade.
RollingUpgradePolicy RollingUpgradePolicyResponse: The configuration parameters used while performing a rolling upgrade.

mode String: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time. Rolling - Scale set performs updates in batches with an optional pause time in between.
automaticOSUpgradePolicy AutomaticOSUpgradePolicyResponse: The configuration parameters used for performing automatic OS upgrade.
rollingUpgradePolicy RollingUpgradePolicyResponse: The configuration parameters used while performing a rolling upgrade.

mode string: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time. Rolling - Scale set performs updates in batches with an optional pause time in between.
automaticOSUpgradePolicy AutomaticOSUpgradePolicyResponse: The configuration parameters used for performing automatic OS upgrade.
rollingUpgradePolicy RollingUpgradePolicyResponse: The configuration parameters used while performing a rolling upgrade.

mode str: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time. Rolling - Scale set performs updates in batches with an optional pause time in between.
automatic_os_upgrade_policy AutomaticOSUpgradePolicyResponse: The configuration parameters used for performing automatic OS upgrade.
rolling_upgrade_policy RollingUpgradePolicyResponse: The configuration parameters used while performing a rolling upgrade.

mode String: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time. Rolling - Scale set performs updates in batches with an optional pause time in between.
automaticOSUpgradePolicy Property Map: The configuration parameters used for performing automatic OS upgrade.
rollingUpgradePolicy Property Map: The configuration parameters used while performing a rolling upgrade.

UserAccountResponse

Name string: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.
Password string: The password for the user account.
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: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.
Password string: The password for the user account.
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: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.
password String: The password for the user account.
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: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.
password string: The password for the user account.
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: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.
password str: The password for the user account.
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: The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.
password String: The password for the user account.
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.

UserAssignedIdentitiesResponse

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.

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.

VMDiskSecurityProfileResponse

SecurityEncryptionType string: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.

SecurityEncryptionType string: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.

securityEncryptionType String: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.

securityEncryptionType string: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.

security_encryption_type str: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.

securityEncryptionType String: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.

VMExtensionResponse

Name string: The name of the virtual machine extension.
Publisher string: The name of the extension handler publisher.
Type string: The type of the extensions.
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.
EnableAutomaticUpgrade bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
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: JSON formatted public settings for the extension.
TypeHandlerVersion string: The version of script handler.

Name string: The name of the virtual machine extension.
Publisher string: The name of the extension handler publisher.
Type string: The type of the extensions.
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.
EnableAutomaticUpgrade bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
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{}: JSON formatted public settings for the extension.
TypeHandlerVersion string: The version of script handler.

name String: The name of the virtual machine extension.
publisher String: The name of the extension handler publisher.
type String: The type of the extensions.
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.
enableAutomaticUpgrade Boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
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: JSON formatted public settings for the extension.
typeHandlerVersion String: The version of script handler.

name string: The name of the virtual machine extension.
publisher string: The name of the extension handler publisher.
type string: The type of the extensions.
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.
enableAutomaticUpgrade boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
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: JSON formatted public settings for the extension.
typeHandlerVersion string: The version of script handler.

name str: The name of the virtual machine extension.
publisher str: The name of the extension handler publisher.
type str: The type of the extensions.
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.
enable_automatic_upgrade bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
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: JSON formatted public settings for the extension.
type_handler_version str: The version of script handler.

name String: The name of the virtual machine extension.
publisher String: The name of the extension handler publisher.
type String: The type of the extensions.
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.
enableAutomaticUpgrade Boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
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: JSON formatted public settings for the extension.
typeHandlerVersion String: The version of script handler.

VirtualMachineConfigurationResponse

ImageReference Pulumi.AzureNative.Batch.Inputs.ImageReferenceResponse

A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.

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.

OsDisk Pulumi.AzureNative.Batch.Inputs.OSDiskResponse

Contains configuration for ephemeral OSDisk settings.

SecurityProfile Pulumi.AzureNative.Batch.Inputs.SecurityProfileResponse

Specifies the security profile settings for the virtual machine or virtual machine scale set.

ServiceArtifactReference Pulumi.AzureNative.Batch.Inputs.ServiceArtifactReferenceResponse

The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

WindowsConfiguration Pulumi.AzureNative.Batch.Inputs.WindowsConfigurationResponse

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

ImageReference ImageReferenceResponse

NodeAgentSkuId string

ContainerConfiguration ContainerConfigurationResponse

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

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.

OsDisk OSDiskResponse

Contains configuration for ephemeral OSDisk settings.

SecurityProfile SecurityProfileResponse

Specifies the security profile settings for the virtual machine or virtual machine scale set.

ServiceArtifactReference ServiceArtifactReferenceResponse

WindowsConfiguration WindowsConfigurationResponse

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

imageReference ImageReferenceResponse

nodeAgentSkuId String

containerConfiguration ContainerConfigurationResponse

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

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.

osDisk OSDiskResponse

Contains configuration for ephemeral OSDisk settings.

securityProfile SecurityProfileResponse

Specifies the security profile settings for the virtual machine or virtual machine scale set.

serviceArtifactReference ServiceArtifactReferenceResponse

windowsConfiguration WindowsConfigurationResponse

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

imageReference ImageReferenceResponse

nodeAgentSkuId string

containerConfiguration ContainerConfigurationResponse

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

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.

osDisk OSDiskResponse

Contains configuration for ephemeral OSDisk settings.

securityProfile SecurityProfileResponse

Specifies the security profile settings for the virtual machine or virtual machine scale set.

serviceArtifactReference ServiceArtifactReferenceResponse

windowsConfiguration WindowsConfigurationResponse

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

image_reference ImageReferenceResponse

node_agent_sku_id str

container_configuration ContainerConfigurationResponse

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

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.

os_disk OSDiskResponse

Contains configuration for ephemeral OSDisk settings.

security_profile SecurityProfileResponse

Specifies the security profile settings for the virtual machine or virtual machine scale set.

service_artifact_reference ServiceArtifactReferenceResponse

windows_configuration WindowsConfigurationResponse

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

imageReference Property Map

nodeAgentSkuId String

containerConfiguration Property Map

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

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.

osDisk Property Map

Contains configuration for ephemeral OSDisk settings.

securityProfile Property Map

Specifies the security profile settings for the virtual machine or virtual machine scale set.

serviceArtifactReference Property Map

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 is Interactive.

LoginMode string: Specifies login mode for the user. The default value is Interactive.

loginMode String: Specifies login mode for the user. The default value is Interactive.

loginMode string: Specifies login mode for the user. The default value is Interactive.

login_mode str: Specifies login mode for the user. The default value is Interactive.

loginMode String: Specifies login mode for the user. The default value is Interactive.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

azure-native.batch.getPool

On this page

On this page

Using getPool

getPool Result

Supporting Types

ApplicationPackageReferenceResponse

AutoScaleRunErrorResponse

AutoScaleRunResponse

AutoScaleSettingsResponse

AutoUserSpecificationResponse

AutomaticOSUpgradePolicyResponse

AzureBlobFileSystemConfigurationResponse

AzureFileShareConfigurationResponse

BatchPoolIdentityResponse

CIFSMountConfigurationResponse

CertificateReferenceResponse

ComputeNodeIdentityReferenceResponse

ContainerConfigurationResponse

ContainerHostBatchBindMountEntryResponse

ContainerRegistryResponse

DataDiskResponse

DeploymentConfigurationResponse

DiffDiskSettingsResponse

DiskEncryptionConfigurationResponse

EnvironmentSettingResponse

FixedScaleSettingsResponse

ImageReferenceResponse

InboundNatPoolResponse

LinuxUserConfigurationResponse

ManagedDiskResponse

MetadataItemResponse

MountConfigurationResponse

NFSMountConfigurationResponse

NetworkConfigurationResponse

NetworkSecurityGroupRuleResponse

NodePlacementConfigurationResponse

OSDiskResponse

PoolEndpointConfigurationResponse

PublicIPAddressConfigurationResponse

ResizeErrorResponse

ResizeOperationStatusResponse

ResourceFileResponse

RollingUpgradePolicyResponse

ScaleSettingsResponse

SecurityProfileResponse

ServiceArtifactReferenceResponse

StartTaskResponse

SystemDataResponse

TaskContainerSettingsResponse

TaskSchedulingPolicyResponse

UefiSettingsResponse

UpgradePolicyResponse

UserAccountResponse

UserAssignedIdentitiesResponse

UserIdentityResponse

VMDiskSecurityProfileResponse

VMExtensionResponse

VirtualMachineConfigurationResponse

WindowsConfigurationResponse

WindowsUserConfigurationResponse

Package Details

On this page

On this page