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

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey"
fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey"
name: "SearchResourceEncryptionKey"
nameWithType: "SearchResourceEncryptionKey"
summary: "A customer-managed encryption key in Azure Key Vault."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SearchResourceEncryptionKey**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.SearchResourceEncryptionKey?alt=com.azure.search.documents.indexes.models.SearchResourceEncryptionKey&text=SearchResourceEncryptionKey\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.SearchResourceEncryptionKey(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.SearchResourceEncryptionKey(String keyName, String keyVersion, String vaultUrl)"
  name: "SearchResourceEncryptionKey(String keyName, String keyVersion, String vaultUrl)"
  nameWithType: "SearchResourceEncryptionKey.SearchResourceEncryptionKey(String keyName, String keyVersion, String vaultUrl)"
  summary: "Creates an instance of Search<wbr>Resource<wbr>Encryption<wbr>Key class."
  parameters:
  - description: "the keyName value to set."
    name: "keyName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the keyVersion value to set."
    name: "keyVersion"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the vaultUrl value to set."
    name: "vaultUrl"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchResourceEncryptionKey(String keyName, String keyVersion, String vaultUrl)"
  desc: "Creates an instance of SearchResourceEncryptionKey class."
methods:
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "SearchResourceEncryptionKey.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Search<wbr>Resource<wbr>Encryption<wbr>Key from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static SearchResourceEncryptionKey fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of SearchResourceEncryptionKey from the JsonReader."
  returns:
    description: "An instance of SearchResourceEncryptionKey if the JsonReader was pointing to an instance of it, or null\n     if it was pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchResourceEncryptionKey?alt=com.azure.search.documents.indexes.models.SearchResourceEncryptionKey&text=SearchResourceEncryptionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getApplicationId()"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getApplicationId()"
  name: "getApplicationId()"
  nameWithType: "SearchResourceEncryptionKey.getApplicationId()"
  summary: "Get the application<wbr>Id 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."
  syntax: "public String getApplicationId()"
  desc: "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:
    description: "the applicationId value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getApplicationSecret()"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getApplicationSecret()"
  name: "getApplicationSecret()"
  nameWithType: "SearchResourceEncryptionKey.getApplicationSecret()"
  summary: "Get the application<wbr>Secret property: The authentication key of the specified AAD application."
  syntax: "public String getApplicationSecret()"
  desc: "Get the applicationSecret property: The authentication key of the specified AAD application."
  returns:
    description: "the applicationSecret value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getKeyName()"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getKeyName()"
  name: "getKeyName()"
  nameWithType: "SearchResourceEncryptionKey.getKeyName()"
  summary: "Get the key<wbr>Name property: The name of your Azure Key Vault key to be used to encrypt your data at rest."
  syntax: "public String getKeyName()"
  desc: "Get the keyName property: The name of your Azure Key Vault key to be used to encrypt your data at rest."
  returns:
    description: "the keyName value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getKeyVersion()"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getKeyVersion()"
  name: "getKeyVersion()"
  nameWithType: "SearchResourceEncryptionKey.getKeyVersion()"
  summary: "Get the key<wbr>Version property: The version of your Azure Key Vault key to be used to encrypt your data at rest."
  syntax: "public String getKeyVersion()"
  desc: "Get the keyVersion property: The version of your Azure Key Vault key to be used to encrypt your data at rest."
  returns:
    description: "the keyVersion value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getVaultUrl()"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.getVaultUrl()"
  name: "getVaultUrl()"
  nameWithType: "SearchResourceEncryptionKey.getVaultUrl()"
  summary: "Get the vault<wbr>Url 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."
  syntax: "public String getVaultUrl()"
  desc: "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:
    description: "the vaultUrl value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.setApplicationId(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.setApplicationId(String applicationId)"
  name: "setApplicationId(String applicationId)"
  nameWithType: "SearchResourceEncryptionKey.setApplicationId(String applicationId)"
  summary: "Set the application<wbr>Id 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."
  parameters:
  - description: "the applicationId value to set."
    name: "applicationId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchResourceEncryptionKey setApplicationId(String applicationId)"
  desc: "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."
  returns:
    description: "the SearchResourceEncryptionKey object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchResourceEncryptionKey?alt=com.azure.search.documents.indexes.models.SearchResourceEncryptionKey&text=SearchResourceEncryptionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.setApplicationSecret(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.setApplicationSecret(String applicationSecret)"
  name: "setApplicationSecret(String applicationSecret)"
  nameWithType: "SearchResourceEncryptionKey.setApplicationSecret(String applicationSecret)"
  summary: "Set the application<wbr>Secret property: The authentication key of the specified AAD application."
  parameters:
  - description: "the applicationSecret value to set."
    name: "applicationSecret"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchResourceEncryptionKey setApplicationSecret(String applicationSecret)"
  desc: "Set the applicationSecret property: The authentication key of the specified AAD application."
  returns:
    description: "the SearchResourceEncryptionKey object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchResourceEncryptionKey?alt=com.azure.search.documents.indexes.models.SearchResourceEncryptionKey&text=SearchResourceEncryptionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.SearchResourceEncryptionKey.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "SearchResourceEncryptionKey.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "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."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.SearchResourceEncryptionKey?alt=com.azure.search.documents.indexes.models.SearchResourceEncryptionKey&text=SearchResourceEncryptionKey\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.6.5