Class EncryptionSetProperties

java.lang.Object
com.azure.resourcemanager.compute.fluent.models.EncryptionSetProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<EncryptionSetProperties>
public final class EncryptionSetProperties extends Object implements com.azure.json.JsonSerializable<EncryptionSetProperties>
The EncryptionSetProperties model.

  • Constructor Details

    • EncryptionSetProperties

      public EncryptionSetProperties()
      Creates an instance of EncryptionSetProperties class.

  • Method Details

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

    • federatedClientId

      public String federatedClientId()
      Get the federatedClientId property: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property.
      Returns:
      the federatedClientId value.

    • withFederatedClientId

      public EncryptionSetProperties withFederatedClientId(String federatedClientId)
      Set the federatedClientId property: Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property.
      Parameters:
      federatedClientId - the federatedClientId value to set.
      Returns:
      the EncryptionSetProperties object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<EncryptionSetProperties>
      Throws:
      IOException

    • fromJson

      public static EncryptionSetProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of EncryptionSetProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of EncryptionSetProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the EncryptionSetProperties.