Share via

DiskEncryptionSetInner Class

  • Reference
Package:
com.azure.resourcemanager.compute.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0

public final class DiskEncryptionSetInner
extends Resource

disk encryption set resource.

Constructor Summary

Constructor Description
DiskEncryptionSetInner()

Creates an instance of DiskEncryptionSetInner class.

Method Summary

Modifier and Type Method and Description
KeyForDiskEncryptionSet activeKey()

Get the activeKey property: The key vault key which is currently used by this disk encryption set.
ApiError autoKeyRotationError()

Get the autoKeyRotationError property: The error that was encountered during auto-key rotation.
DiskEncryptionSetType encryptionType()

Get the encryptionType property: The type of key used to encrypt the data of the disk.
String federatedClientId()

Get the federatedClientId property: Multi-tenant application client id to access key vault in a different tenant.
static DiskEncryptionSetInner fromJson(JsonReader jsonReader)

Reads an instance of DiskEncryptionSetInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
EncryptionSetIdentity identity()

Get the identity property: The managed identity for the disk encryption set.
OffsetDateTime lastKeyRotationTimestamp()

Get the lastKeyRotationTimestamp property: The time when the active key of this disk encryption set was updated.
String name()

Get the name property: The name of the resource.
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.
String provisioningState()

Get the provisioningState property: The disk encryption set provisioning state.
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.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
DiskEncryptionSetInner withActiveKey(KeyForDiskEncryptionSet activeKey)

Set the activeKey property: The key vault key which is currently used by this disk encryption set.
DiskEncryptionSetInner withEncryptionType(DiskEncryptionSetType encryptionType)

Set the encryptionType property: The type of key used to encrypt the data of the disk.
DiskEncryptionSetInner withFederatedClientId(String federatedClientId)

Set the federatedClientId property: Multi-tenant application client id to access key vault in a different tenant.
DiskEncryptionSetInner withIdentity(EncryptionSetIdentity identity)

Set the identity property: The managed identity for the disk encryption set.
DiskEncryptionSetInner withLocation(String location)
DiskEncryptionSetInner 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.
DiskEncryptionSetInner withTags(Map<String,String> tags)

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DiskEncryptionSetInner

public DiskEncryptionSetInner()

Creates an instance of DiskEncryptionSetInner class.

Method Details

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.

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.

encryptionType

public DiskEncryptionSetType encryptionType()

Get the encryptionType property: The type of key used to encrypt the data of the disk.

Returns:

the encryptionType 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.

fromJson

public static DiskEncryptionSetInner fromJson(JsonReader jsonReader)

Reads an instance of DiskEncryptionSetInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DiskEncryptionSetInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

DiskEncryptionSetInner.id()

Returns:

the id value.

identity

public EncryptionSetIdentity identity()

Get the identity property: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Returns:

the identity value.

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.

name

public String name()

Get the name property: The name of the resource.

Overrides:

DiskEncryptionSetInner.name()

Returns:

the name value.

previousKeys

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

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DiskEncryptionSetInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

DiskEncryptionSetInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withActiveKey

public DiskEncryptionSetInner 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 DiskEncryptionSetInner object itself.

withEncryptionType

public DiskEncryptionSetInner 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 DiskEncryptionSetInner object itself.

withFederatedClientId

public DiskEncryptionSetInner 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 DiskEncryptionSetInner object itself.

withIdentity

public DiskEncryptionSetInner withIdentity(EncryptionSetIdentity identity)

Set the identity property: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Parameters:

identity - the identity value to set.

Returns:

the DiskEncryptionSetInner object itself.

withLocation

public DiskEncryptionSetInner withLocation(String location)

Overrides:

DiskEncryptionSetInner.withLocation(String location)

Parameters:

location

withRotationToLatestKeyVersionEnabled

public DiskEncryptionSetInner 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 DiskEncryptionSetInner object itself.

withTags

public DiskEncryptionSetInner withTags(Map tags)

Overrides:

DiskEncryptionSetInner.withTags(Map<String,String> tags)

Parameters:

tags

Applies to