SpecializedBlobExtensions.UpdateClientSideKeyEncryptionKey Method

  • Reference

Definition

Namespace:
Azure.Storage.Blobs.Specialized
Assemblies:
Azure.Storage.Blobs.dll, Azure.Storage.Blobs.Batch.dll
Packages:
Azure.Storage.Blobs v12.22.2, Azure.Storage.Blobs.Batch v12.19.1
Packages:
Azure.Storage.Blobs v12.23.0-beta.2, Azure.Storage.Blobs.Batch v12.20.0-beta.2
Source:
SpecializedBlobExtensions.ClientSideEncryption.cs
Source:
SpecializedBlobExtensions.ClientSideEncryption.cs

Rotates the Key Encryption Key (KEK) for a client-side encrypted blob without needing to reupload the entire blob.

public static void UpdateClientSideKeyEncryptionKey (this Azure.Storage.Blobs.BlobClient client, Azure.Storage.ClientSideEncryptionOptions encryptionOptionsOverride = default, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);
static member UpdateClientSideKeyEncryptionKey : Azure.Storage.Blobs.BlobClient * Azure.Storage.ClientSideEncryptionOptions * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> unit
<Extension()>
Public Sub UpdateClientSideKeyEncryptionKey (client As BlobClient, Optional encryptionOptionsOverride As ClientSideEncryptionOptions = Nothing, Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing)

Parameters

client
BlobClient

Client to the blob.

encryptionOptionsOverride
ClientSideEncryptionOptions

Optional override for client-side encryption options to use when updating the key encryption key. Defaults to the ClientSideEncryptionOptions configured on the client when this is not populated. New key encryption key for the blob will be the KeyEncryptionKey on whichever encryption options are used for the operation. Options must have a resolver that can resolve the old key on the blob.

conditions
BlobRequestConditions

Optional request conditions for the operation.

cancellationToken
CancellationToken

Cancellation token for the operation.

Applies to