CustomerManagedKeyEncryptionProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.fluidrelay.models.CustomerManagedKeyEncryptionProperties

Implements

public final class CustomerManagedKeyEncryptionProperties
implements JsonSerializable<CustomerManagedKeyEncryptionProperties>

All Customer-managed key encryption properties for the resource.

Constructor Summary

Constructor Description
CustomerManagedKeyEncryptionProperties()

Creates an instance of CustomerManagedKeyEncryptionProperties class.

Method Summary

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

Reads an instance of CustomerManagedKeyEncryptionProperties from the JsonReader.

CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity keyEncryptionKeyIdentity()

Get the keyEncryptionKeyIdentity property: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

String keyEncryptionKeyUrl()

Get the keyEncryptionKeyUrl property: key encryption key Url, with or without a version.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

CustomerManagedKeyEncryptionProperties withKeyEncryptionKeyIdentity(CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity keyEncryptionKeyIdentity)

Set the keyEncryptionKeyIdentity property: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

CustomerManagedKeyEncryptionProperties withKeyEncryptionKeyUrl(String keyEncryptionKeyUrl)

Set the keyEncryptionKeyUrl property: key encryption key Url, with or without a version.

Methods inherited from java.lang.Object

Constructor Details

CustomerManagedKeyEncryptionProperties

public CustomerManagedKeyEncryptionProperties()

Creates an instance of CustomerManagedKeyEncryptionProperties class.

Method Details

fromJson

public static CustomerManagedKeyEncryptionProperties fromJson(JsonReader jsonReader)

Reads an instance of CustomerManagedKeyEncryptionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

keyEncryptionKeyIdentity

public CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity keyEncryptionKeyIdentity()

Get the keyEncryptionKeyIdentity property: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

Returns:

the keyEncryptionKeyIdentity value.

keyEncryptionKeyUrl

public String keyEncryptionKeyUrl()

Get the keyEncryptionKeyUrl property: key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.

Returns:

the keyEncryptionKeyUrl value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withKeyEncryptionKeyIdentity

public CustomerManagedKeyEncryptionProperties withKeyEncryptionKeyIdentity(CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity keyEncryptionKeyIdentity)

Set the keyEncryptionKeyIdentity property: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

Parameters:

keyEncryptionKeyIdentity - the keyEncryptionKeyIdentity value to set.

Returns:

the CustomerManagedKeyEncryptionProperties object itself.

withKeyEncryptionKeyUrl

public CustomerManagedKeyEncryptionProperties withKeyEncryptionKeyUrl(String keyEncryptionKeyUrl)

Set the keyEncryptionKeyUrl property: key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.

Parameters:

keyEncryptionKeyUrl - the keyEncryptionKeyUrl value to set.

Returns:

the CustomerManagedKeyEncryptionProperties object itself.

Applies to