Share via

SearchResourceEncryptionKey interface

  • Reference
Package:
@azure/search-documents

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.

Properties

applicationId

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

The authentication key of the specified AAD application.
identity

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.
keyName

The name of your Azure Key Vault key to be used to encrypt your data at rest.
keyVersion

The version of your Azure Key Vault key to be used to encrypt your data at rest.
vaultUrl

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.

Property Details

applicationId

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.

applicationId?: string

Property Value

string

applicationSecret

The authentication key of the specified AAD application.

applicationSecret?: string

Property Value

string

identity

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.

identity?: SearchIndexerDataIdentity

Property Value

SearchIndexerDataIdentity

keyName

The name of your Azure Key Vault key to be used to encrypt your data at rest.

keyName: string

Property Value

string

keyVersion

The version of your Azure Key Vault key to be used to encrypt your data at rest.

keyVersion: string

Property Value

string

vaultUrl

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.

vaultUrl: string

Property Value

string