SearchResourceEncryptionKey interface

Package:

@azure/arm-search

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

Properties

accessCredentials	Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.
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.
vaultUri	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

accessCredentials

Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.

accessCredentials?: AzureActiveDirectoryApplicationCredentials

Property Value

AzureActiveDirectoryApplicationCredentials

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?: DataIdentityUnion

Property Value

DataIdentityUnion

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

vaultUri

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.

vaultUri?: string

Property Value

string