SearchResourceEncryptionKey Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.6.2
  • 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 on your search service, such as indexes and synonym maps.

Constructor Summary

Constructor Description
SearchResourceEncryptionKey(String keyName, String keyVersion, 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.
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.
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.
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 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 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.

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.

getApplicationSecret

public String getApplicationSecret()

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

Returns:

the applicationSecret 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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to