Share via

PoolPatchParameter Class

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

public class PoolPatchParameter

The set of changes to be made to a pool.

Method Summary

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

Get 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. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged.
List<CertificateReference> 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 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.
List<MetadataItem> 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.
StartTask startTask()

Get if this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged.
PoolPatchParameter withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)

Set 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. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged.
PoolPatchParameter withCertificateReferences(List<CertificateReference> 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 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.
PoolPatchParameter withMetadata(List<MetadataItem> 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.
PoolPatchParameter withStartTask(StartTask startTask)

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

Method Details

applicationPackageReferences

public List applicationPackageReferences()

Get 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. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application 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 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.

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 start task. If omitted, any existing start task is left unchanged.

Returns:

the startTask value

withApplicationPackageReferences

public PoolPatchParameter withApplicationPackageReferences(List applicationPackageReferences)

Set 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. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application 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 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.

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 start task. If omitted, any existing start task is left unchanged.

Parameters:

startTask - the startTask value to set

Returns:

the PoolPatchParameter object itself.

Applies to