Package com.microsoft.azure.batch.protocol.models

Class PoolPatchParameter

  • public class PoolPatchParameter
extends Object
    The set of changes to be made to a Pool.

    • Constructor Detail

      • PoolPatchParameter

        public PoolPatchParameter()

    • Method Detail

      • 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

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

      • certificateReferences

        public 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 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

      • withCertificateReferences

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

      • applicationPackageReferences

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

      • withApplicationPackageReferences

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

      • metadata

        public 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.
        Returns:
        the metadata value

      • withMetadata

        public 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.
        Parameters:
        metadata - the metadata value to set
        Returns:
        the PoolPatchParameter object itself.

      • 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

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