ArmBatchModelFactory.BatchAccountPoolData Method

Reference

Definition

Namespace:: Azure.ResourceManager.Batch.Models

Assembly:: Azure.ResourceManager.Batch.dll

Package:: Azure.ResourceManager.Batch v1.3.0-beta.1

Package:: Azure.ResourceManager.Batch v1.5.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

BatchAccountPoolData(ResourceIdentifier, String, ResourceType, SystemData, ManagedServiceIdentity, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolProvisioningState>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolAllocationState>, Nullable<DateTimeOffset>, String, BatchDeploymentConfiguration, Nullable<Int32>, Nullable<Int32>, BatchAccountPoolScaleSettings, BatchAccountPoolAutoScaleRun, Nullable<InterNodeCommunicationState>, BatchNetworkConfiguration, Nullable<Int32>, Nullable<BatchNodeFillType>, IEnumerable<BatchUserAccount>, IEnumerable<BatchAccountPoolMetadataItem>, BatchAccountPoolStartTask, IEnumerable<BatchCertificateReference>, IEnumerable<BatchApplicationPackageReference>, IEnumerable<String>, BatchResizeOperationStatus, IEnumerable<BatchMountConfiguration>, Nullable<NodeCommunicationMode>, Nullable<NodeCommunicationMode>, IDictionary<String,String>, Nullable<ETag>)

Initializes a new instance of BatchAccountPoolData.

BatchAccountPoolData(ResourceIdentifier, String, ResourceType, SystemData, ManagedServiceIdentity, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolProvisioningState>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolAllocationState>, Nullable<DateTimeOffset>, String, BatchVmConfiguration, Nullable<Int32>, Nullable<Int32>, BatchAccountPoolScaleSettings, BatchAccountPoolAutoScaleRun, Nullable<InterNodeCommunicationState>, BatchNetworkConfiguration, Nullable<Int32>, Nullable<BatchNodeFillType>, IEnumerable<BatchUserAccount>, IEnumerable<BatchAccountPoolMetadataItem>, BatchAccountPoolStartTask, IEnumerable<BatchCertificateReference>, IEnumerable<BatchApplicationPackageReference>, IEnumerable<String>, BatchResizeOperationStatus, IEnumerable<BatchMountConfiguration>, Nullable<NodeCommunicationMode>, Nullable<NodeCommunicationMode>, UpgradePolicy, IDictionary<String,String>, Nullable<ETag>, IDictionary<String, String>)

Initializes a new instance of BatchAccountPoolData.

BatchAccountPoolData(ResourceIdentifier, String, ResourceType, SystemData, ManagedServiceIdentity, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolProvisioningState>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolAllocationState>, Nullable<DateTimeOffset>, String, BatchDeploymentConfiguration, Nullable<Int32>, Nullable<Int32>, BatchAccountPoolScaleSettings, BatchAccountPoolAutoScaleRun, Nullable<InterNodeCommunicationState>, BatchNetworkConfiguration, Nullable<Int32>, Nullable<BatchNodeFillType>, IEnumerable<BatchUserAccount>, IEnumerable<BatchAccountPoolMetadataItem>, BatchAccountPoolStartTask, IEnumerable<BatchCertificateReference>, IEnumerable<BatchApplicationPackageReference>, IEnumerable<String>, BatchResizeOperationStatus, IEnumerable<BatchMountConfiguration>, Nullable<NodeCommunicationMode>, Nullable<NodeCommunicationMode>, IDictionary<String,String>, Nullable<ETag>)

Source:: ArmBatchModelFactory.cs

Initializes a new instance of BatchAccountPoolData.

public static Azure.ResourceManager.Batch.BatchAccountPoolData BatchAccountPoolData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, string displayName = default, DateTimeOffset? lastModifiedOn = default, DateTimeOffset? createdOn = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolProvisioningState? provisioningState = default, DateTimeOffset? provisioningStateTransitOn = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolAllocationState? allocationState = default, DateTimeOffset? allocationStateTransitionOn = default, string vmSize = default, Azure.ResourceManager.Batch.Models.BatchDeploymentConfiguration deploymentConfiguration = default, int? currentDedicatedNodes = default, int? currentLowPriorityNodes = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolScaleSettings scaleSettings = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolAutoScaleRun autoScaleRun = default, Azure.ResourceManager.Batch.Models.InterNodeCommunicationState? interNodeCommunication = default, Azure.ResourceManager.Batch.Models.BatchNetworkConfiguration networkConfiguration = default, int? taskSlotsPerNode = default, Azure.ResourceManager.Batch.Models.BatchNodeFillType? taskSchedulingNodeFillType = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchUserAccount> userAccounts = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchAccountPoolMetadataItem> metadata = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolStartTask startTask = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchCertificateReference> certificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchApplicationPackageReference> applicationPackages = default, System.Collections.Generic.IEnumerable<string> applicationLicenses = default, Azure.ResourceManager.Batch.Models.BatchResizeOperationStatus resizeOperationStatus = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchMountConfiguration> mountConfiguration = default, Azure.ResourceManager.Batch.Models.NodeCommunicationMode? targetNodeCommunicationMode = default, Azure.ResourceManager.Batch.Models.NodeCommunicationMode? currentNodeCommunicationMode = default, System.Collections.Generic.IDictionary<string,string> resourceTags = default, Azure.ETag? etag = default);

static member BatchAccountPoolData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * Azure.ResourceManager.Models.ManagedServiceIdentity * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<Azure.ResourceManager.Batch.Models.BatchAccountPoolProvisioningState> * Nullable<DateTimeOffset> * Nullable<Azure.ResourceManager.Batch.Models.BatchAccountPoolAllocationState> * Nullable<DateTimeOffset> * string * Azure.ResourceManager.Batch.Models.BatchDeploymentConfiguration * Nullable<int> * Nullable<int> * Azure.ResourceManager.Batch.Models.BatchAccountPoolScaleSettings * Azure.ResourceManager.Batch.Models.BatchAccountPoolAutoScaleRun * Nullable<Azure.ResourceManager.Batch.Models.InterNodeCommunicationState> * Azure.ResourceManager.Batch.Models.BatchNetworkConfiguration * Nullable<int> * Nullable<Azure.ResourceManager.Batch.Models.BatchNodeFillType> * seq<Azure.ResourceManager.Batch.Models.BatchUserAccount> * seq<Azure.ResourceManager.Batch.Models.BatchAccountPoolMetadataItem> * Azure.ResourceManager.Batch.Models.BatchAccountPoolStartTask * seq<Azure.ResourceManager.Batch.Models.BatchCertificateReference> * seq<Azure.ResourceManager.Batch.Models.BatchApplicationPackageReference> * seq<string> * Azure.ResourceManager.Batch.Models.BatchResizeOperationStatus * seq<Azure.ResourceManager.Batch.Models.BatchMountConfiguration> * Nullable<Azure.ResourceManager.Batch.Models.NodeCommunicationMode> * Nullable<Azure.ResourceManager.Batch.Models.NodeCommunicationMode> * System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.ETag> -> Azure.ResourceManager.Batch.BatchAccountPoolData

Public Shared Function BatchAccountPoolData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional displayName As String = Nothing, Optional lastModifiedOn As Nullable(Of DateTimeOffset) = Nothing, Optional createdOn As Nullable(Of DateTimeOffset) = Nothing, Optional provisioningState As Nullable(Of BatchAccountPoolProvisioningState) = Nothing, Optional provisioningStateTransitOn As Nullable(Of DateTimeOffset) = Nothing, Optional allocationState As Nullable(Of BatchAccountPoolAllocationState) = Nothing, Optional allocationStateTransitionOn As Nullable(Of DateTimeOffset) = Nothing, Optional vmSize As String = Nothing, Optional deploymentConfiguration As BatchDeploymentConfiguration = Nothing, Optional currentDedicatedNodes As Nullable(Of Integer) = Nothing, Optional currentLowPriorityNodes As Nullable(Of Integer) = Nothing, Optional scaleSettings As BatchAccountPoolScaleSettings = Nothing, Optional autoScaleRun As BatchAccountPoolAutoScaleRun = Nothing, Optional interNodeCommunication As Nullable(Of InterNodeCommunicationState) = Nothing, Optional networkConfiguration As BatchNetworkConfiguration = Nothing, Optional taskSlotsPerNode As Nullable(Of Integer) = Nothing, Optional taskSchedulingNodeFillType As Nullable(Of BatchNodeFillType) = Nothing, Optional userAccounts As IEnumerable(Of BatchUserAccount) = Nothing, Optional metadata As IEnumerable(Of BatchAccountPoolMetadataItem) = Nothing, Optional startTask As BatchAccountPoolStartTask = Nothing, Optional certificates As IEnumerable(Of BatchCertificateReference) = Nothing, Optional applicationPackages As IEnumerable(Of BatchApplicationPackageReference) = Nothing, Optional applicationLicenses As IEnumerable(Of String) = Nothing, Optional resizeOperationStatus As BatchResizeOperationStatus = Nothing, Optional mountConfiguration As IEnumerable(Of BatchMountConfiguration) = Nothing, Optional targetNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing, Optional currentNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing, Optional resourceTags As IDictionary(Of String, String) = Nothing, Optional etag As Nullable(Of ETag) = Nothing) As BatchAccountPoolData

Parameters

id: ResourceIdentifier

The id.

name: String

The name.

resourceType: ResourceType

The resourceType.

systemData: SystemData

The systemData.

identity: ManagedServiceIdentity

The type of identity used for the Batch Pool. Current supported identity types: UserAssigned, None.

displayName: String

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

lastModifiedOn: Nullable<DateTimeOffset>

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.

createdOn: Nullable<DateTimeOffset>

The creation time of the pool.

provisioningState: Nullable<BatchAccountPoolProvisioningState>

The current state of the pool.

provisioningStateTransitOn: Nullable<DateTimeOffset>

The time at which the pool entered its current state.

allocationState: Nullable<BatchAccountPoolAllocationState>

Whether the pool is resizing.

allocationStateTransitionOn: Nullable<DateTimeOffset>

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

vmSize: String

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

deploymentConfiguration: BatchDeploymentConfiguration

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

currentDedicatedNodes: Nullable<Int32>

The number of dedicated compute nodes currently in the pool.

currentLowPriorityNodes: Nullable<Int32>

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

scaleSettings: BatchAccountPoolScaleSettings

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.

autoScaleRun: BatchAccountPoolAutoScaleRun

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

interNodeCommunication: Nullable<InterNodeCommunicationState>

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

networkConfiguration: BatchNetworkConfiguration

The network configuration for a pool.

taskSlotsPerNode: Nullable<Int32>

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.

taskSchedulingNodeFillType: Nullable<BatchNodeFillType>

If not specified, the default is spread.

userAccounts: IEnumerable<BatchUserAccount>

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

metadata: IEnumerable<BatchAccountPoolMetadataItem>

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

startTask: BatchAccountPoolStartTask

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

certificates: IEnumerable<BatchCertificateReference>

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.

applicationPackages: IEnumerable<BatchApplicationPackageReference>

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.

applicationLicenses: IEnumerable<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.

resizeOperationStatus: BatchResizeOperationStatus

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

mountConfiguration: IEnumerable<BatchMountConfiguration>

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

targetNodeCommunicationMode: Nullable<NodeCommunicationMode>

If omitted, the default value is Default.

currentNodeCommunicationMode: Nullable<NodeCommunicationMode>

Determines how a pool communicates with the Batch service.

resourceTags: IDictionary<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'.

etag: Nullable<ETag>

The ETag of the resource, used for concurrency statements.

Returns

BatchAccountPoolData

A new BatchAccountPoolData instance for mocking.

Applies to

BatchAccountPoolData(ResourceIdentifier, String, ResourceType, SystemData, ManagedServiceIdentity, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolProvisioningState>, Nullable<DateTimeOffset>, Nullable<BatchAccountPoolAllocationState>, Nullable<DateTimeOffset>, String, BatchVmConfiguration, Nullable<Int32>, Nullable<Int32>, BatchAccountPoolScaleSettings, BatchAccountPoolAutoScaleRun, Nullable<InterNodeCommunicationState>, BatchNetworkConfiguration, Nullable<Int32>, Nullable<BatchNodeFillType>, IEnumerable<BatchUserAccount>, IEnumerable<BatchAccountPoolMetadataItem>, BatchAccountPoolStartTask, IEnumerable<BatchCertificateReference>, IEnumerable<BatchApplicationPackageReference>, IEnumerable<String>, BatchResizeOperationStatus, IEnumerable<BatchMountConfiguration>, Nullable<NodeCommunicationMode>, Nullable<NodeCommunicationMode>, UpgradePolicy, IDictionary<String,String>, Nullable<ETag>, IDictionary<String, String>)

Source:: ArmBatchModelFactory.cs

Initializes a new instance of BatchAccountPoolData.

public static Azure.ResourceManager.Batch.BatchAccountPoolData BatchAccountPoolData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, string displayName = default, DateTimeOffset? lastModifiedOn = default, DateTimeOffset? createdOn = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolProvisioningState? provisioningState = default, DateTimeOffset? provisioningStateTransitOn = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolAllocationState? allocationState = default, DateTimeOffset? allocationStateTransitionOn = default, string vmSize = default, Azure.ResourceManager.Batch.Models.BatchVmConfiguration deploymentVmConfiguration = default, int? currentDedicatedNodes = default, int? currentLowPriorityNodes = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolScaleSettings scaleSettings = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolAutoScaleRun autoScaleRun = default, Azure.ResourceManager.Batch.Models.InterNodeCommunicationState? interNodeCommunication = default, Azure.ResourceManager.Batch.Models.BatchNetworkConfiguration networkConfiguration = default, int? taskSlotsPerNode = default, Azure.ResourceManager.Batch.Models.BatchNodeFillType? taskSchedulingNodeFillType = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchUserAccount> userAccounts = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchAccountPoolMetadataItem> metadata = default, Azure.ResourceManager.Batch.Models.BatchAccountPoolStartTask startTask = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchCertificateReference> certificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchApplicationPackageReference> applicationPackages = default, System.Collections.Generic.IEnumerable<string> applicationLicenses = default, Azure.ResourceManager.Batch.Models.BatchResizeOperationStatus resizeOperationStatus = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Batch.Models.BatchMountConfiguration> mountConfiguration = default, Azure.ResourceManager.Batch.Models.NodeCommunicationMode? targetNodeCommunicationMode = default, Azure.ResourceManager.Batch.Models.NodeCommunicationMode? currentNodeCommunicationMode = default, Azure.ResourceManager.Batch.Models.UpgradePolicy upgradePolicy = default, System.Collections.Generic.IDictionary<string,string> resourceTags = default, Azure.ETag? etag = default, System.Collections.Generic.IDictionary<string,string> tags = default);

static member BatchAccountPoolData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * Azure.ResourceManager.Models.ManagedServiceIdentity * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<Azure.ResourceManager.Batch.Models.BatchAccountPoolProvisioningState> * Nullable<DateTimeOffset> * Nullable<Azure.ResourceManager.Batch.Models.BatchAccountPoolAllocationState> * Nullable<DateTimeOffset> * string * Azure.ResourceManager.Batch.Models.BatchVmConfiguration * Nullable<int> * Nullable<int> * Azure.ResourceManager.Batch.Models.BatchAccountPoolScaleSettings * Azure.ResourceManager.Batch.Models.BatchAccountPoolAutoScaleRun * Nullable<Azure.ResourceManager.Batch.Models.InterNodeCommunicationState> * Azure.ResourceManager.Batch.Models.BatchNetworkConfiguration * Nullable<int> * Nullable<Azure.ResourceManager.Batch.Models.BatchNodeFillType> * seq<Azure.ResourceManager.Batch.Models.BatchUserAccount> * seq<Azure.ResourceManager.Batch.Models.BatchAccountPoolMetadataItem> * Azure.ResourceManager.Batch.Models.BatchAccountPoolStartTask * seq<Azure.ResourceManager.Batch.Models.BatchCertificateReference> * seq<Azure.ResourceManager.Batch.Models.BatchApplicationPackageReference> * seq<string> * Azure.ResourceManager.Batch.Models.BatchResizeOperationStatus * seq<Azure.ResourceManager.Batch.Models.BatchMountConfiguration> * Nullable<Azure.ResourceManager.Batch.Models.NodeCommunicationMode> * Nullable<Azure.ResourceManager.Batch.Models.NodeCommunicationMode> * Azure.ResourceManager.Batch.Models.UpgradePolicy * System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.ETag> * System.Collections.Generic.IDictionary<string, string> -> Azure.ResourceManager.Batch.BatchAccountPoolData

Public Shared Function BatchAccountPoolData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional displayName As String = Nothing, Optional lastModifiedOn As Nullable(Of DateTimeOffset) = Nothing, Optional createdOn As Nullable(Of DateTimeOffset) = Nothing, Optional provisioningState As Nullable(Of BatchAccountPoolProvisioningState) = Nothing, Optional provisioningStateTransitOn As Nullable(Of DateTimeOffset) = Nothing, Optional allocationState As Nullable(Of BatchAccountPoolAllocationState) = Nothing, Optional allocationStateTransitionOn As Nullable(Of DateTimeOffset) = Nothing, Optional vmSize As String = Nothing, Optional deploymentVmConfiguration As BatchVmConfiguration = Nothing, Optional currentDedicatedNodes As Nullable(Of Integer) = Nothing, Optional currentLowPriorityNodes As Nullable(Of Integer) = Nothing, Optional scaleSettings As BatchAccountPoolScaleSettings = Nothing, Optional autoScaleRun As BatchAccountPoolAutoScaleRun = Nothing, Optional interNodeCommunication As Nullable(Of InterNodeCommunicationState) = Nothing, Optional networkConfiguration As BatchNetworkConfiguration = Nothing, Optional taskSlotsPerNode As Nullable(Of Integer) = Nothing, Optional taskSchedulingNodeFillType As Nullable(Of BatchNodeFillType) = Nothing, Optional userAccounts As IEnumerable(Of BatchUserAccount) = Nothing, Optional metadata As IEnumerable(Of BatchAccountPoolMetadataItem) = Nothing, Optional startTask As BatchAccountPoolStartTask = Nothing, Optional certificates As IEnumerable(Of BatchCertificateReference) = Nothing, Optional applicationPackages As IEnumerable(Of BatchApplicationPackageReference) = Nothing, Optional applicationLicenses As IEnumerable(Of String) = Nothing, Optional resizeOperationStatus As BatchResizeOperationStatus = Nothing, Optional mountConfiguration As IEnumerable(Of BatchMountConfiguration) = Nothing, Optional targetNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing, Optional currentNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing, Optional upgradePolicy As UpgradePolicy = Nothing, Optional resourceTags As IDictionary(Of String, String) = Nothing, Optional etag As Nullable(Of ETag) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing) As BatchAccountPoolData

Parameters

id: ResourceIdentifier

The id.

name: String

The name.

resourceType: ResourceType

The resourceType.

systemData: SystemData

The systemData.

identity: ManagedServiceIdentity

The type of identity used for the Batch Pool. Current supported identity types: UserAssigned, None.

displayName: String

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

lastModifiedOn: Nullable<DateTimeOffset>

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.

createdOn: Nullable<DateTimeOffset>

The creation time of the pool.

provisioningState: Nullable<BatchAccountPoolProvisioningState>

The current state of the pool.

provisioningStateTransitOn: Nullable<DateTimeOffset>

The time at which the pool entered its current state.

allocationState: Nullable<BatchAccountPoolAllocationState>

Whether the pool is resizing.

allocationStateTransitionOn: Nullable<DateTimeOffset>

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

vmSize: String

For information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

deploymentVmConfiguration: BatchVmConfiguration

Deployment configuration properties.

currentDedicatedNodes: Nullable<Int32>

The number of dedicated compute nodes currently in the pool.

currentLowPriorityNodes: Nullable<Int32>

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

scaleSettings: BatchAccountPoolScaleSettings

autoScaleRun: BatchAccountPoolAutoScaleRun

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

interNodeCommunication: Nullable<InterNodeCommunicationState>

networkConfiguration: BatchNetworkConfiguration

The network configuration for a pool.

taskSlotsPerNode: Nullable<Int32>

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.

taskSchedulingNodeFillType: Nullable<BatchNodeFillType>

If not specified, the default is spread.

userAccounts: IEnumerable<BatchUserAccount>

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

metadata: IEnumerable<BatchAccountPoolMetadataItem>

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

startTask: BatchAccountPoolStartTask

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

certificates: IEnumerable<BatchCertificateReference>

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

applicationPackages: IEnumerable<BatchApplicationPackageReference>

applicationLicenses: IEnumerable<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.

resizeOperationStatus: BatchResizeOperationStatus

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