SpecializedBlobExtensions.UpdateClientSideKeyEncryptionKeyAsync Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assemblies:

Azure.Storage.Blobs.dll, Azure.Storage.Blobs.Batch.dll

Packages:

Azure.Storage.Blobs v12.23.0, Azure.Storage.Blobs.Batch v12.20.0

Source:

AppendBlobClient.cs

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

public static System.Threading.Tasks.Task UpdateClientSideKeyEncryptionKeyAsync (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 UpdateClientSideKeyEncryptionKeyAsync : Azure.Storage.Blobs.BlobClient * Azure.Storage.ClientSideEncryptionOptions * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function UpdateClientSideKeyEncryptionKeyAsync (client As BlobClient, Optional encryptionOptionsOverride As ClientSideEncryptionOptions = Nothing, Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

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.