PoolUpdatePropertiesParameter Class

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

public class PoolUpdatePropertiesParameter

The set of changes to be made to a Pool.

Constructor Summary

Constructor Description
PoolUpdatePropertiesParameter()

Method Summary

Modifier and Type Method and Description
List<ApplicationPackageReference> applicationPackageReferences()

Get the list replaces any existing Application Package references on the Pool.

List<CertificateReference> certificateReferences()

Get this list replaces any existing Certificate references configured on the Pool.

List<MetadataItem> metadata()

Get this list replaces any existing metadata configured on the Pool.

StartTask startTask()

Get if this element is present, it overwrites any existing StartTask.

NodeCommunicationMode targetNodeCommunicationMode()

Get this setting replaces any existing targetNodeCommunication setting on the Pool.

PoolUpdatePropertiesParameter withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)

Set the list replaces any existing Application Package references on the Pool.

PoolUpdatePropertiesParameter withCertificateReferences(List<CertificateReference> certificateReferences)

Set this list replaces any existing Certificate references configured on the Pool.

PoolUpdatePropertiesParameter withMetadata(List<MetadataItem> metadata)

Set this list replaces any existing metadata configured on the Pool.

PoolUpdatePropertiesParameter withStartTask(StartTask startTask)

Set if this element is present, it overwrites any existing StartTask.

PoolUpdatePropertiesParameter withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)

Set this setting replaces any existing targetNodeCommunication setting on the Pool.

Methods inherited from java.lang.Object

Constructor Details

PoolUpdatePropertiesParameter

public PoolUpdatePropertiesParameter()

Method Details

applicationPackageReferences

public List applicationPackageReferences()

Get the list replaces any existing Application Package references on the Pool. 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. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool.

Returns:

the applicationPackageReferences value

certificateReferences

public List certificateReferences()

Get this list replaces any existing Certificate references configured on the Pool. If you specify an empty collection, any existing Certificate references are removed from the Pool. 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://video2.skills-academy.com/azure/batch/batch-certificate-migration-guide) instead.

Returns:

the certificateReferences value

metadata

public List metadata()

Get this list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool.

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 removed from the Pool.

Returns:

the startTask value

targetNodeCommunicationMode

public NodeCommunicationMode targetNodeCommunicationMode()

Get this setting replaces any existing targetNodeCommunication setting on the Pool. If omitted, the existing setting is default. Possible values include: 'default', 'classic', 'simplified'.

Returns:

the targetNodeCommunicationMode value

withApplicationPackageReferences

public PoolUpdatePropertiesParameter withApplicationPackageReferences(List applicationPackageReferences)

Set the list replaces any existing Application Package references on the Pool. 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. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool.

Parameters:

applicationPackageReferences - the applicationPackageReferences value to set

Returns:

the PoolUpdatePropertiesParameter object itself.

withCertificateReferences

public PoolUpdatePropertiesParameter withCertificateReferences(List certificateReferences)

Set this list replaces any existing Certificate references configured on the Pool. If you specify an empty collection, any existing Certificate references are removed from the Pool. 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://video2.skills-academy.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

certificateReferences - the certificateReferences value to set

Returns:

the PoolUpdatePropertiesParameter object itself.

withMetadata

public PoolUpdatePropertiesParameter withMetadata(List metadata)

Set this list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool.

Parameters:

metadata - the metadata value to set

Returns:

the PoolUpdatePropertiesParameter object itself.

withStartTask

public PoolUpdatePropertiesParameter withStartTask(StartTask startTask)

Set if this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool.

Parameters:

startTask - the startTask value to set

Returns:

the PoolUpdatePropertiesParameter object itself.

withTargetNodeCommunicationMode

public PoolUpdatePropertiesParameter withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)

Set this setting replaces any existing targetNodeCommunication setting on the Pool. If omitted, the existing setting is default. Possible values include: 'default', 'classic', 'simplified'.

Parameters:

targetNodeCommunicationMode - the targetNodeCommunicationMode value to set

Returns:

the PoolUpdatePropertiesParameter object itself.

Applies to