Package com.azure.search.documents.indexes.models

Class SearchResourceEncryptionKey

java.lang.Object

com.azure.search.documents.indexes.models.SearchResourceEncryptionKey

public final class SearchResourceEncryptionKey
extends Object

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 in Azure Cognitive Search, such as indexes and synonym maps.

Constructor Summary

Constructors

Constructor	Description
SearchResourceEncryptionKey(String keyName, String keyVersion, String vaultUrl)	Creates an instance of SearchResourceEncryptionKey class.

Method Summary

Modifier and Type	Method	Description
String	getApplicationId()	Get the applicationId property: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest.
String	getApplicationSecret()	Get the applicationSecret property: The authentication key of the specified AAD application.
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	setApplicationId(String applicationId)	Set the applicationId property: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest.
SearchResourceEncryptionKey	setApplicationSecret(String applicationSecret)	Set the applicationSecret property: The authentication key of the specified AAD application.
SearchResourceEncryptionKey	setIdentity(SearchIndexerDataIdentity identity)	Set the identity property: An explicit managed identity to use for this encryption key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResourceEncryptionKey

public SearchResourceEncryptionKey(String keyName,
                                   String keyVersion,
                                   String vaultUrl)

Creates an instance of SearchResourceEncryptionKey class.

Parameters:

keyName - the keyName value to set.

keyVersion - the keyVersion value to set.

vaultUrl - the vaultUrl value to set.

Method Detail

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.

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.

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.

getApplicationId

public String getApplicationId()

Get the applicationId property: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application.

Returns:

the applicationId value.

setApplicationId

public SearchResourceEncryptionKey setApplicationId(String applicationId)

Set the applicationId property: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application.

Parameters:

applicationId - the applicationId value to set.

Returns:

the SearchResourceEncryptionKey object itself.

getApplicationSecret

public String getApplicationSecret()

Get the applicationSecret property: The authentication key of the specified AAD application.

Returns:

the applicationSecret value.

setApplicationSecret

public SearchResourceEncryptionKey setApplicationSecret(String applicationSecret)

Set the applicationSecret property: The authentication key of the specified AAD application.

Parameters:

applicationSecret - the applicationSecret value to set.

Returns:

the SearchResourceEncryptionKey object itself.