SearchResourceEncryptionKey.yml

### YamlMime:TSType
name: SearchResourceEncryptionKey
uid: '@azure/search-documents.SearchResourceEncryptionKey'
package: '@azure/search-documents'
summary: >-
  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.
fullName: SearchResourceEncryptionKey
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: applicationId
    uid: '@azure/search-documents.SearchResourceEncryptionKey.applicationId'
    package: '@azure/search-documents'
    summary: >-
      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.
    fullName: applicationId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'applicationId?: string'
      return:
        description: ''
        type: string
  - name: applicationSecret
    uid: '@azure/search-documents.SearchResourceEncryptionKey.applicationSecret'
    package: '@azure/search-documents'
    summary: The authentication key of the specified AAD application.
    fullName: applicationSecret
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'applicationSecret?: string'
      return:
        description: ''
        type: string
  - name: keyName
    uid: '@azure/search-documents.SearchResourceEncryptionKey.keyName'
    package: '@azure/search-documents'
    summary: >-
      The name of your Azure Key Vault key to be used to encrypt your data at
      rest.
    fullName: keyName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'keyName: string'
      return:
        description: ''
        type: string
  - name: keyVersion
    uid: '@azure/search-documents.SearchResourceEncryptionKey.keyVersion'
    package: '@azure/search-documents'
    summary: >-
      The version of your Azure Key Vault key to be used to encrypt your data at
      rest.
    fullName: keyVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'keyVersion: string'
      return:
        description: ''
        type: string
  - name: vaultUrl
    uid: '@azure/search-documents.SearchResourceEncryptionKey.vaultUrl'
    package: '@azure/search-documents'
    summary: >-
      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.
    fullName: vaultUrl
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'vaultUrl: string'
      return:
        description: ''
        type: string