PoolPatchParameter Class

Package:

com.microsoft.azure.batch.protocol.models

Maven Artifact:

com.microsoft.azure:azure-batch:11.1.1

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.PoolPatchParameter

public class PoolPatchParameter

The set of changes to be made to a Pool.

Constructor Summary

Constructor	Description
PoolPatchParameter()

Method Summary

Modifier and Type	Method and Description
List<ApplicationPackageReference>	applicationPackageReferences() Get 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.
List<CertificateReference>	certificateReferences() Get if this element is present, it replaces any existing Certificate references configured on the Pool.
List<MetadataItem>	metadata() Get if this element is present, it replaces any existing metadata configured on the Pool.
StartTask	startTask() Get if this element is present, it overwrites any existing StartTask.
NodeCommunicationMode	targetNodeCommunicationMode() Get if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool.
PoolPatchParameter	withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences) Set 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.
PoolPatchParameter	withCertificateReferences(List<CertificateReference> certificateReferences) Set if this element is present, it replaces any existing Certificate references configured on the Pool.
PoolPatchParameter	withMetadata(List<MetadataItem> metadata) Set if this element is present, it replaces any existing metadata configured on the Pool.
PoolPatchParameter	withStartTask(StartTask startTask) Set if this element is present, it overwrites any existing StartTask.
PoolPatchParameter	withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode) Set if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PoolPatchParameter

public PoolPatchParameter()

Method Details

applicationPackageReferences

public List applicationPackageReferences()

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

Returns:

the applicationPackageReferences value

certificateReferences

public List certificateReferences()

Get 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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Returns:

the certificateReferences value

metadata

public List metadata()

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

Returns:

the metadata value

startTask

public StartTask startTask()

Get if this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.

Returns:

the startTask value

targetNodeCommunicationMode

public NodeCommunicationMode targetNodeCommunicationMode()

Get if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged. Possible values include: 'default', 'classic', 'simplified'.

Returns:

the targetNodeCommunicationMode value

withApplicationPackageReferences

public PoolPatchParameter withApplicationPackageReferences(List applicationPackageReferences)

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

Parameters:

applicationPackageReferences - the applicationPackageReferences value to set

Returns:

the PoolPatchParameter object itself.

withCertificateReferences

public PoolPatchParameter withCertificateReferences(List certificateReferences)

Set 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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

certificateReferences - the certificateReferences value to set

Returns:

the PoolPatchParameter object itself.

withMetadata

public PoolPatchParameter withMetadata(List metadata)

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

Parameters:

metadata - the metadata value to set

Returns:

the PoolPatchParameter object itself.

withStartTask

public PoolPatchParameter withStartTask(StartTask startTask)

Set if this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.

Parameters:

startTask - the startTask value to set

Returns:

the PoolPatchParameter object itself.

withTargetNodeCommunicationMode

public PoolPatchParameter withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)

Set if this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged. Possible values include: 'default', 'classic', 'simplified'.

Parameters:

targetNodeCommunicationMode - the targetNodeCommunicationMode value to set

Returns:

the PoolPatchParameter object itself.