Class EncryptionSetProperties


  • public final class EncryptionSetProperties
    extends Object
    The EncryptionSetProperties model.
    • Constructor Detail

      • EncryptionSetProperties

        public EncryptionSetProperties()
    • Method Detail

      • encryptionType

        public DiskEncryptionSetType encryptionType()
        Get the encryptionType property: The type of key used to encrypt the data of the disk.
        Returns:
        the encryptionType value.
      • withEncryptionType

        public EncryptionSetProperties withEncryptionType​(DiskEncryptionSetType encryptionType)
        Set the encryptionType property: The type of key used to encrypt the data of the disk.
        Parameters:
        encryptionType - the encryptionType value to set.
        Returns:
        the EncryptionSetProperties object itself.
      • activeKey

        public KeyForDiskEncryptionSet activeKey()
        Get the activeKey property: The key vault key which is currently used by this disk encryption set.
        Returns:
        the activeKey value.
      • withActiveKey

        public EncryptionSetProperties withActiveKey​(KeyForDiskEncryptionSet activeKey)
        Set the activeKey property: The key vault key which is currently used by this disk encryption set.
        Parameters:
        activeKey - the activeKey value to set.
        Returns:
        the EncryptionSetProperties object itself.
      • previousKeys

        public List<KeyForDiskEncryptionSet> previousKeys()
        Get the previousKeys property: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
        Returns:
        the previousKeys value.
      • provisioningState

        public String provisioningState()
        Get the provisioningState property: The disk encryption set provisioning state.
        Returns:
        the provisioningState value.
      • rotationToLatestKeyVersionEnabled

        public Boolean rotationToLatestKeyVersionEnabled()
        Get the rotationToLatestKeyVersionEnabled property: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
        Returns:
        the rotationToLatestKeyVersionEnabled value.
      • withRotationToLatestKeyVersionEnabled

        public EncryptionSetProperties withRotationToLatestKeyVersionEnabled​(Boolean rotationToLatestKeyVersionEnabled)
        Set the rotationToLatestKeyVersionEnabled property: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
        Parameters:
        rotationToLatestKeyVersionEnabled - the rotationToLatestKeyVersionEnabled value to set.
        Returns:
        the EncryptionSetProperties object itself.
      • lastKeyRotationTimestamp

        public OffsetDateTime lastKeyRotationTimestamp()
        Get the lastKeyRotationTimestamp property: The time when the active key of this disk encryption set was updated.
        Returns:
        the lastKeyRotationTimestamp value.
      • autoKeyRotationError

        public ApiError autoKeyRotationError()
        Get the autoKeyRotationError property: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
        Returns:
        the autoKeyRotationError value.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.