SearchResourceEncryptionKey Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchResourceEncryptionKey

Implements

JsonSerializable<SearchResourceEncryptionKey>

public final class SearchResourceEncryptionKey
implements JsonSerializable<SearchResourceEncryptionKey>

A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps.

Constructor Summary

Constructor Description
SearchResourceEncryptionKey(String keyName, String vaultUrl)

Creates an instance of SearchResourceEncryptionKey class.

Method Summary

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

Reads an instance of SearchResourceEncryptionKey from the JsonReader.
AzureActiveDirectoryApplicationCredentials getAccessCredentials()

Get the accessCredentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault.
SearchIndexerDataIdentity getIdentity()

Get the identity property: An explicit managed identity to use for this encryption key.
String getKeyName()

Get the keyName property: The name of your Azure Key Vault key to be used to encrypt your data at rest.
String getKeyVersion()

Get the keyVersion property: The version of your Azure Key Vault key to be used to encrypt your data at rest.
String getVaultUrl()

Get the vaultUrl property: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest.
SearchResourceEncryptionKey setAccessCredentials(AzureActiveDirectoryApplicationCredentials accessCredentials)

Set the accessCredentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault.
SearchResourceEncryptionKey setIdentity(SearchIndexerDataIdentity identity)

Set the identity property: An explicit managed identity to use for this encryption key.
SearchResourceEncryptionKey setKeyVersion(String keyVersion)

Set the keyVersion property: The version of your Azure Key Vault key to be used to encrypt your data at rest.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchResourceEncryptionKey

public SearchResourceEncryptionKey(String keyName, String vaultUrl)

Creates an instance of SearchResourceEncryptionKey class.

Parameters:

keyName - the keyName value to set.
vaultUrl - the vaultUrl value to set.

Method Details

fromJson

public static SearchResourceEncryptionKey fromJson(JsonReader jsonReader)

Reads an instance of SearchResourceEncryptionKey from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAccessCredentials

public AzureActiveDirectoryApplicationCredentials getAccessCredentials()

Get the accessCredentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.

Returns:

the accessCredentials value.

getIdentity

public SearchIndexerDataIdentity getIdentity()

Get the identity property: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared.

Returns:

the identity value.

getKeyName

public String getKeyName()

Get the keyName property: The name of your Azure Key Vault key to be used to encrypt your data at rest.

Returns:

the keyName value.

getKeyVersion

public String getKeyVersion()

Get the keyVersion property: The version of your Azure Key Vault key to be used to encrypt your data at rest.

Returns:

the keyVersion value.

getVaultUrl

public String getVaultUrl()

Get the vaultUrl property: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`.

Returns:

the vaultUrl value.

setAccessCredentials

public SearchResourceEncryptionKey setAccessCredentials(AzureActiveDirectoryApplicationCredentials accessCredentials)

Set the accessCredentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.

Parameters:

accessCredentials - the accessCredentials value to set.

Returns:

the SearchResourceEncryptionKey object itself.

setIdentity

public SearchResourceEncryptionKey setIdentity(SearchIndexerDataIdentity identity)

Set the identity property: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared.

Parameters:

identity - the identity value to set.

Returns:

the SearchResourceEncryptionKey object itself.

setKeyVersion

public SearchResourceEncryptionKey setKeyVersion(String keyVersion)

Set the keyVersion property: The version of your Azure Key Vault key to be used to encrypt your data at rest.

Parameters:

keyVersion - the keyVersion value to set.

Returns:

the SearchResourceEncryptionKey object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to