BatchAccountPoolData Class

Definition

Namespace:

Azure.ResourceManager.Batch

Assembly:

Azure.ResourceManager.Batch.dll

Package:

Azure.ResourceManager.Batch v1.5.0

Source:

BatchAccountPoolData.cs

A class representing the BatchAccountPool data model. Contains information about a pool.

public class BatchAccountPoolData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Batch.BatchAccountPoolData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Batch.BatchAccountPoolData>

type BatchAccountPoolData = class
    inherit ResourceData
    interface IJsonModel<BatchAccountPoolData>
    interface IPersistableModel<BatchAccountPoolData>

Public Class BatchAccountPoolData
Inherits ResourceData
Implements IJsonModel(Of BatchAccountPoolData), IPersistableModel(Of BatchAccountPoolData)

Inheritance

Object

ResourceData

BatchAccountPoolData

Implements

IJsonModel<BatchAccountPoolData> IPersistableModel<BatchAccountPoolData> IPersistableModel<T>

Constructors

BatchAccountPoolData()

Initializes a new instance of BatchAccountPoolData.

Properties

AllocationState	Whether the pool is resizing.
AllocationStateTransitionOn	The time at which the pool entered its current allocation state.
ApplicationLicenses	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	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.
AutoScaleRun	This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
Certificates	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.
CreatedOn	The creation time of the pool.
CurrentDedicatedNodes	The number of dedicated compute nodes currently in the pool.
CurrentLowPriorityNodes	The number of Spot/low-priority compute nodes currently in the pool.
CurrentNodeCommunicationMode	Determines how a pool communicates with the Batch service.
DeploymentConfiguration	The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.
DeploymentVmConfiguration	The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.
DisplayName	The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
ETag	The ETag of the resource, used for concurrency statements.
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData)
Identity	The type of identity used for the Batch Pool. Current supported identity types: UserAssigned, None.
InterNodeCommunication	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'.
LastModifiedOn	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.
Metadata	The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
MountConfiguration	This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
Name	The name of the resource. (Inherited from ResourceData)
NetworkConfiguration	The network configuration for a pool.
ProvisioningState	The current state of the pool.
ProvisioningStateTransitOn	The time at which the pool entered its current state.
ResizeOperationStatus	Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
ResourceTags	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'.
ResourceType	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData)
ScaleSettings	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	In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData)
Tags	The tags of the resource.
TargetNodeCommunicationMode	If omitted, the default value is Default.
TaskSchedulingNodeFillType	How tasks should be distributed across compute nodes.
TaskSlotsPerNode	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	Describes an upgrade policy - automatic, manual, or rolling.
UserAccounts	The list of user accounts to be created on each node in the pool.
VmSize	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).

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

(Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<BatchAccountPoolData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchAccountPoolData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchAccountPoolData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BatchAccountPoolData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchAccountPoolData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.