Condividi tramite


SearchResourceEncryptionKey Class

Definition

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 : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Search.Models.SearchResourceEncryptionKey>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Search.Models.SearchResourceEncryptionKey>
type SearchResourceEncryptionKey = class
    interface IJsonModel<SearchResourceEncryptionKey>
    interface IPersistableModel<SearchResourceEncryptionKey>
Public Class SearchResourceEncryptionKey
Implements IJsonModel(Of SearchResourceEncryptionKey), IPersistableModel(Of SearchResourceEncryptionKey)
Inheritance
SearchResourceEncryptionKey
Implements

Constructors

Name Description
SearchResourceEncryptionKey()

Initializes a new instance of SearchResourceEncryptionKey.

Properties

Name Description
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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<SearchResourceEncryptionKey>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<SearchResourceEncryptionKey>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<SearchResourceEncryptionKey>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<SearchResourceEncryptionKey>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<SearchResourceEncryptionKey>.Write(ModelReaderWriterOptions)

Applies to