KeyEncryptionKeyIdentity Class

Package:
com.azure.resourcemanager.storage.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-storage:2.58.0
  • java.lang.Object
    • com.azure.resourcemanager.storage.models.KeyEncryptionKeyIdentity

Implements

JsonSerializable<KeyEncryptionKeyIdentity>

public final class KeyEncryptionKeyIdentity
implements JsonSerializable<KeyEncryptionKeyIdentity>

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

Constructor Summary

Constructor Description
KeyEncryptionKeyIdentity()

Creates an instance of KeyEncryptionKeyIdentity class.

Method Summary

Modifier and Type Method and Description
UUID delegatedIdentityClientId()

Get the delegatedIdentityClientId property: delegated identity to use for accessing key encryption key Url.
UUID federatedClientId()

Get the federatedClientId property: application client identity to use for accessing key encryption key Url in a different tenant.
static KeyEncryptionKeyIdentity fromJson(JsonReader jsonReader)

Reads an instance of KeyEncryptionKeyIdentity from the JsonReader.
KeyEncryptionKeyIdentityType identityType()

Get the identityType property: The type of identity to use.
JsonWriter toJson(JsonWriter jsonWriter)
String userAssignedIdentityResourceId()

Get the userAssignedIdentityResourceId property: User assigned identity to use for accessing key encryption key Url.
void validate()

Validates the instance.
KeyEncryptionKeyIdentity withDelegatedIdentityClientId(UUID delegatedIdentityClientId)

Set the delegatedIdentityClientId property: delegated identity to use for accessing key encryption key Url.
KeyEncryptionKeyIdentity withFederatedClientId(UUID federatedClientId)

Set the federatedClientId property: application client identity to use for accessing key encryption key Url in a different tenant.
KeyEncryptionKeyIdentity withIdentityType(KeyEncryptionKeyIdentityType identityType)

Set the identityType property: The type of identity to use.
KeyEncryptionKeyIdentity withUserAssignedIdentityResourceId(String userAssignedIdentityResourceId)

Set the userAssignedIdentityResourceId property: User assigned identity to use for accessing key encryption key Url.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KeyEncryptionKeyIdentity

public KeyEncryptionKeyIdentity()

Creates an instance of KeyEncryptionKeyIdentity class.

Method Details

delegatedIdentityClientId

public UUID delegatedIdentityClientId()

Get the delegatedIdentityClientId property: delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only.

Returns:

the delegatedIdentityClientId value.

federatedClientId

public UUID federatedClientId()

Get the federatedClientId property: application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540.

Returns:

the federatedClientId value.

fromJson

public static KeyEncryptionKeyIdentity fromJson(JsonReader jsonReader)

Reads an instance of KeyEncryptionKeyIdentity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KeyEncryptionKeyIdentity 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 KeyEncryptionKeyIdentity.

identityType

public KeyEncryptionKeyIdentityType identityType()

Get the identityType property: The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity.

Returns:

the identityType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

userAssignedIdentityResourceId

public String userAssignedIdentityResourceId()

Get the userAssignedIdentityResourceId property: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.

Returns:

the userAssignedIdentityResourceId value.

validate

public void validate()

Validates the instance.

withDelegatedIdentityClientId

public KeyEncryptionKeyIdentity withDelegatedIdentityClientId(UUID delegatedIdentityClientId)

Set the delegatedIdentityClientId property: delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only.

Parameters:

delegatedIdentityClientId - the delegatedIdentityClientId value to set.

Returns:

the KeyEncryptionKeyIdentity object itself.

withFederatedClientId

public KeyEncryptionKeyIdentity withFederatedClientId(UUID federatedClientId)

Set the federatedClientId property: application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540.

Parameters:

federatedClientId - the federatedClientId value to set.

Returns:

the KeyEncryptionKeyIdentity object itself.

withIdentityType

public KeyEncryptionKeyIdentity withIdentityType(KeyEncryptionKeyIdentityType identityType)

Set the identityType property: The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity.

Parameters:

identityType - the identityType value to set.

Returns:

the KeyEncryptionKeyIdentity object itself.

withUserAssignedIdentityResourceId

public KeyEncryptionKeyIdentity withUserAssignedIdentityResourceId(String userAssignedIdentityResourceId)

Set the userAssignedIdentityResourceId property: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.

Parameters:

userAssignedIdentityResourceId - the userAssignedIdentityResourceId value to set.

Returns:

the KeyEncryptionKeyIdentity object itself.

Applies to