EncryptionKeyWrapMetadata Class

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.45.0

Source:

EncryptionKeyWrapMetadata.cs

Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key. See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.

public class EncryptionKeyWrapMetadata : IEquatable<Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata>

type EncryptionKeyWrapMetadata = class
    interface IEquatable<EncryptionKeyWrapMetadata>

Public Class EncryptionKeyWrapMetadata
Implements IEquatable(Of EncryptionKeyWrapMetadata)

Inheritance

Object

EncryptionKeyWrapMetadata

Implements

IEquatable<EncryptionKeyWrapMetadata>

Constructors

EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata)	Creates a new instance of key wrap metadata based on an existing instance.
EncryptionKeyWrapMetadata(String, String, String, String)	Creates a new instance of key wrap metadata.

Properties

Algorithm	Serialized form of metadata. Note: This value is saved in the Cosmos DB service. Implementors of derived implementations should ensure that this does not have (private) key material or credential information.
Name	Serialized form of metadata. Note: This value is saved in the Cosmos DB service. Implementors of derived implementations should ensure that this does not have (private) key material or credential information.
Type	Serialized form of metadata. Note: This value is saved in the Cosmos DB service. Implementors of derived implementations should ensure that this does not have (private) key material or credential information.
Value	Serialized form of metadata. Note: This value is saved in the Cosmos DB service. Implementors of derived implementations should ensure that this does not have (private) key material or credential information.

Methods

Equals(EncryptionKeyWrapMetadata)	Returns whether the properties of the passed in key wrap metadata matches with those in the current instance.
Equals(Object)	Determines whether the specified object is equal to the current object.
GetHashCode()	Serves as the default hash function.