SearchResourceEncryptionKey Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.6

Source:: SearchResourceEncryptionKey.cs

Source:: SearchResourceEncryptionKey.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class SearchResourceEncryptionKey : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey>

type SearchResourceEncryptionKey = class

type SearchResourceEncryptionKey = class
    interface IJsonModel<SearchResourceEncryptionKey>
    interface IPersistableModel<SearchResourceEncryptionKey>

Public Class SearchResourceEncryptionKey

Public Class SearchResourceEncryptionKey
Implements IJsonModel(Of SearchResourceEncryptionKey), IPersistableModel(Of SearchResourceEncryptionKey)

Inheritance: Object
SearchResourceEncryptionKey

Implements: IJsonModel<SearchResourceEncryptionKey> IPersistableModel<SearchResourceEncryptionKey> IPersistableModel<T>

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<SearchResourceEncryptionKey>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<SearchResourceEncryptionKey>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<SearchResourceEncryptionKey>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<SearchResourceEncryptionKey>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<SearchResourceEncryptionKey>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to