Struct CustomerProvidedKey

Wrapper for an encryption key to be used with client provided key server-side encryption.

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Storage.Blobs.dll

Syntax

[System.Runtime.CompilerServices.IsReadOnly]
public struct CustomerProvidedKey : IEquatable<Azure.Storage.Blobs.Models.CustomerProvidedKey>

Constructors

CustomerProvidedKey(Byte[])

Creates a new CustomerProvidedKey for use in server-side encryption.

Declaration

public CustomerProvidedKey (byte[] key);

Parameters

System.Byte[] key The encryption key bytes.

CustomerProvidedKey(String)

Creates a new CustomerProvidedKey for use in server-side encryption.

Declaration

public CustomerProvidedKey (string key);

Parameters

System.String key The encryption key encoded as a base64 string.

Properties

EncryptionAlgorithm

The algorithm for Azure Blob Storage to encrypt with. Azure Blob Storage only offers AES256 encryption.

Declaration

public Azure.Storage.Blobs.Models.EncryptionAlgorithmType EncryptionAlgorithm { get; }

Property Value

EncryptionAlgorithmType

EncryptionKey

Base64 encoded string of the AES256 encryption key.

Declaration

public string EncryptionKey { get; }

Property Value

System.String

EncryptionKeyHash

Base64 encoded string of the AES256 encryption key's SHA256 hash.

Declaration

public string EncryptionKeyHash { get; }

Property Value

System.String

Methods

Equals(CustomerProvidedKey)

Checks if two CustomerProvidedKeyInfo are equal to each other.

Declaration

public bool Equals (Azure.Storage.Blobs.Models.CustomerProvidedKey other);

Parameters

CustomerProvidedKey other The other instance to compare to.

Returns

System.Boolean

Equals(Object)

Checks if two CustomerProvidedKeyInfo are equal to each other.

Declaration

public override bool Equals (object obj);

Parameters

System.Object obj The other instance to compare to.

Returns

System.Boolean

GetHashCode()

Get a hash code for the CustomerProvidedKeyInfo.

Declaration

public override int GetHashCode ();

Returns

System.Int32 Hash code for the CustomerProvidedKeyInfo.

ToString()

ToString

Declaration

public override string ToString ();

Returns

System.String string

Operators

Equality(CustomerProvidedKey, CustomerProvidedKey)

Check if two CustomerProvidedKeyInfo instances are equal.

Declaration

public static bool operator == (Azure.Storage.Blobs.Models.CustomerProvidedKey left, Azure.Storage.Blobs.Models.CustomerProvidedKey right);

Parameters

CustomerProvidedKey left The first instance to compare.

CustomerProvidedKey right The second instance to compare.

Returns

System.Boolean True if they're equal, false otherwise.

Inequality(CustomerProvidedKey, CustomerProvidedKey)

Check if two CustomerProvidedKeyInfo instances are not equal.

Declaration

public static bool operator != (Azure.Storage.Blobs.Models.CustomerProvidedKey left, Azure.Storage.Blobs.Models.CustomerProvidedKey right);

Parameters

CustomerProvidedKey left The first instance to compare.

CustomerProvidedKey right The second instance to compare.

Returns

System.Boolean True if they're not equal, false otherwise.