EncryptionConfiguration Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0
  • java.lang.Object
    • com.azure.resourcemanager.datafactory.models.EncryptionConfiguration

Implements

JsonSerializable<EncryptionConfiguration>

public final class EncryptionConfiguration
implements JsonSerializable<EncryptionConfiguration>

Definition of CMK for the factory.

Constructor Summary

Constructor Description
EncryptionConfiguration()

Creates an instance of EncryptionConfiguration class.

Method Summary

Modifier and Type Method and Description
static EncryptionConfiguration fromJson(JsonReader jsonReader)

Reads an instance of EncryptionConfiguration from the JsonReader.
CmkIdentityDefinition identity()

Get the identity property: User assigned identity to use to authenticate to customer's key vault.
String keyName()

Get the keyName property: The name of the key in Azure Key Vault to use as Customer Managed Key.
String keyVersion()

Get the keyVersion property: The version of the key used for CMK.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
String vaultBaseUrl()

Get the vaultBaseUrl property: The url of the Azure Key Vault used for CMK.
EncryptionConfiguration withIdentity(CmkIdentityDefinition identity)

Set the identity property: User assigned identity to use to authenticate to customer's key vault.
EncryptionConfiguration withKeyName(String keyName)

Set the keyName property: The name of the key in Azure Key Vault to use as Customer Managed Key.
EncryptionConfiguration withKeyVersion(String keyVersion)

Set the keyVersion property: The version of the key used for CMK.
EncryptionConfiguration withVaultBaseUrl(String vaultBaseUrl)

Set the vaultBaseUrl property: The url of the Azure Key Vault used for CMK.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EncryptionConfiguration

public EncryptionConfiguration()

Creates an instance of EncryptionConfiguration class.

Method Details

fromJson

public static EncryptionConfiguration fromJson(JsonReader jsonReader)

Reads an instance of EncryptionConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

identity

public CmkIdentityDefinition identity()

Get the identity property: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.

Returns:

the identity value.

keyName

public String keyName()

Get the keyName property: The name of the key in Azure Key Vault to use as Customer Managed Key.

Returns:

the keyName value.

keyVersion

public String keyVersion()

Get the keyVersion property: The version of the key used for CMK. If not provided, latest version will be used.

Returns:

the keyVersion value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

vaultBaseUrl

public String vaultBaseUrl()

Get the vaultBaseUrl property: The url of the Azure Key Vault used for CMK.

Returns:

the vaultBaseUrl value.

withIdentity

public EncryptionConfiguration withIdentity(CmkIdentityDefinition identity)

Set the identity property: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.

Parameters:

identity - the identity value to set.

Returns:

the EncryptionConfiguration object itself.

withKeyName

public EncryptionConfiguration withKeyName(String keyName)

Set the keyName property: The name of the key in Azure Key Vault to use as Customer Managed Key.

Parameters:

keyName - the keyName value to set.

Returns:

the EncryptionConfiguration object itself.

withKeyVersion

public EncryptionConfiguration withKeyVersion(String keyVersion)

Set the keyVersion property: The version of the key used for CMK. If not provided, latest version will be used.

Parameters:

keyVersion - the keyVersion value to set.

Returns:

the EncryptionConfiguration object itself.

withVaultBaseUrl

public EncryptionConfiguration withVaultBaseUrl(String vaultBaseUrl)

Set the vaultBaseUrl property: The url of the Azure Key Vault used for CMK.

Parameters:

vaultBaseUrl - the vaultBaseUrl value to set.

Returns:

the EncryptionConfiguration object itself.

Applies to