BatchPoolUpdateContent Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.2

Source:

BatchPoolUpdateContent.cs

Parameters for updating an Azure Batch Pool.

public class BatchPoolUpdateContent : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.BatchPoolUpdateContent>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.BatchPoolUpdateContent>

type BatchPoolUpdateContent = class
    interface IJsonModel<BatchPoolUpdateContent>
    interface IPersistableModel<BatchPoolUpdateContent>

Public Class BatchPoolUpdateContent
Implements IJsonModel(Of BatchPoolUpdateContent), IPersistableModel(Of BatchPoolUpdateContent)

Inheritance

Object

BatchPoolUpdateContent

Implements

IJsonModel<BatchPoolUpdateContent> IPersistableModel<BatchPoolUpdateContent> IPersistableModel<T>

Constructors

BatchPoolUpdateContent()

Initializes a new instance of BatchPoolUpdateContent.

Properties

ApplicationPackageReferences	A list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged.
CertificateReferences	If this element is present, it replaces any existing Certificate references configured on the Pool. If omitted, any existing Certificate references are left unchanged. For Windows 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.
DisplayName	The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. This field can be updated only when the pool is empty.
EnableInterNodeCommunication	Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.<br /><br />This field can be updated only when the pool is empty.
Metadata	A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.
MountConfiguration	Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.<br /><br />This field can be updated only when the pool is empty.
NetworkConfiguration	The network configuration for the Pool. This field can be updated only when the pool is empty.
ResourceTags	The user-specified tags associated with the pool. 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'.<br /><br />This field can be updated only when the pool is empty.
StartTask	A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.
TargetNodeCommunicationMode	The desired node communication mode for the pool. If this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged.
TaskSchedulingPolicy	How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.<br /><br />This field can be updated only when the pool is empty.
TaskSlotsPerNode	The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. 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.<br /><br />This field can be updated only when the pool is empty.
UpgradePolicy	The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.<br /><br />This field can be updated only when the pool is empty.
UserAccounts	The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty.
VirtualMachineConfiguration	The virtual machine configuration for the Pool. This property must be specified.<br /><br />This field can be updated only when the pool is empty.
VmSize	The size of virtual machines in the Pool. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).<br /><br />This field can be updated only when the pool is empty.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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