SearchResourceEncryptionKey Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.5.1
Package:
Azure.Search.Documents v11.6.0-beta.3
Source:
SearchResourceEncryptionKey.cs
Source:
SearchResourceEncryptionKey.cs

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.

public class SearchResourceEncryptionKey
type SearchResourceEncryptionKey = class
Public Class SearchResourceEncryptionKey
Inheritance
Object
SearchResourceEncryptionKey

Constructors

SearchResourceEncryptionKey(Uri, String, String)

Creates a new instance of the SearchResourceEncryptionKey class.

Properties

ApplicationId

Gets or sets the application ID to access the Azure Key Vault specified in the VaultUri. The Azure Key Vault must be in the same tenant as the Azure Search service.
ApplicationSecret

Gets or sets the application secret to access the Azure Key Vault specified in the VaultUri. The Azure Key Vault must be in the same tenant as the Azure Search service.
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. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity.
KeyName

Gets the name of the Azure Key Vault key to encrypt resources at rest.
KeyVersion

Gets the version of the Azure Key Vault key to encrypt resources at rest.
VaultUri

Gets the Azure Key Vault Uri.

Applies to