SearchResourceEncryptionKey Class
Definition
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 : 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 |