Class SearchResourceEncryptionKey

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.

Inheritance

System.Object

SearchResourceEncryptionKey

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Search.Documents.dll

Syntax

public class SearchResourceEncryptionKey

Constructors

SearchResourceEncryptionKey(Uri, String, String)

Creates a new instance of the SearchResourceEncryptionKey class.

Declaration

public SearchResourceEncryptionKey (Uri vaultUri, string keyName, string keyVersion);

Parameters

System.Uri vaultUri Required. The Azure Key Vault System.Uri.

System.String keyName Required. The name of the Azure Key Vault key to encrypt resources at rest.

System.String keyVersion Required. The version of the Azure Key Vault key to encrypt resources at rest.

Exceptions

System.ArgumentNullException vaultUri, keyName, or keyVersion is null.

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.

Declaration

public string ApplicationId { get; set; }

Property Value

System.String

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.

Declaration

public string ApplicationSecret { get; set; }

Property Value

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

Declaration

public Azure.Search.Documents.Indexes.Models.SearchIndexerDataIdentity Identity { get; set; }

Property Value

SearchIndexerDataIdentity

KeyName

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

Declaration

public string KeyName { get; }

Property Value

System.String

KeyVersion

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

Declaration

public string KeyVersion { get; }

Property Value

System.String

Remarks

A version is required in case the key rotates.

VaultUri

Gets the Azure Key Vault System.Uri.

Declaration

public Uri VaultUri { get; }

Property Value

System.Uri