CosmosDBKeyWrapMetadata Class

Definition

Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.

public class CosmosDBKeyWrapMetadata : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBKeyWrapMetadata>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBKeyWrapMetadata>
type CosmosDBKeyWrapMetadata = class
    interface IJsonModel<CosmosDBKeyWrapMetadata>
    interface IPersistableModel<CosmosDBKeyWrapMetadata>
Public Class CosmosDBKeyWrapMetadata
Implements IJsonModel(Of CosmosDBKeyWrapMetadata), IPersistableModel(Of CosmosDBKeyWrapMetadata)
Inheritance
CosmosDBKeyWrapMetadata
Implements

Constructors

CosmosDBKeyWrapMetadata()

Initializes a new instance of CosmosDBKeyWrapMetadata.

Properties

Algorithm

Algorithm used in wrapping and unwrapping of the data encryption key.

CosmosDBKeyWrapMetadataType

ProviderName of KeyStoreProvider.

Name

The name of associated KeyEncryptionKey (aka CustomerManagedKey).

Value

Reference / link to the KeyEncryptionKey.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CosmosDBKeyWrapMetadata>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CosmosDBKeyWrapMetadata>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CosmosDBKeyWrapMetadata>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CosmosDBKeyWrapMetadata>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CosmosDBKeyWrapMetadata>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to