CloudBlob.RotateEncryptionKeyAsync CloudBlob.RotateEncryptionKeyAsync CloudBlob.RotateEncryptionKeyAsync Method

Definition

Overloads

RotateEncryptionKeyAsync() RotateEncryptionKeyAsync() RotateEncryptionKeyAsync()

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

RotateEncryptionKeyAsync(CancellationToken) RotateEncryptionKeyAsync(CancellationToken)

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext) RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

RotateEncryptionKeyAsync() RotateEncryptionKeyAsync() RotateEncryptionKeyAsync()

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

[Microsoft.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task RotateEncryptionKeyAsync ();
abstract member RotateEncryptionKeyAsync : unit -> System.Threading.Tasks.Task
override this.RotateEncryptionKeyAsync : unit -> System.Threading.Tasks.Task
Public Overridable Function RotateEncryptionKeyAsync () As Task
Returns

A Task object that represents the asynchronous operation.

Remarks

This method has a number of prerequisites:

  1. The blob must be encrypted on the service using client-side encryption (not service-side encryption.)

  2. The local object must have the latest attributes from the blob on the service. This can be done by calling FetchAttributes() on the blob, or by listing blobs in the container with metadata.

  3. The Encryption Policy on the default BlobRequestOptions must contain an IKeyResolver capable of resolving the old encryption key.

  4. The Encryption Policy on the default BlobRequestOptions must contain an IKey with the new encryption key.

RotateEncryptionKeyAsync(CancellationToken) RotateEncryptionKeyAsync(CancellationToken)

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

[Microsoft.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task RotateEncryptionKeyAsync (System.Threading.CancellationToken cancellationToken);
abstract member RotateEncryptionKeyAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RotateEncryptionKeyAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
Parameters
cancellationToken
CancellationToken CancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

A Task object that represents the asynchronous operation.

Remarks

This method has a number of prerequisites:

  1. The blob must be encrypted on the service using client-side encryption (not service-side encryption.)

  2. The local object must have the latest attributes from the blob on the service. This can be done by calling FetchAttributes() on the blob, or by listing blobs in the container with metadata.

  3. The Encryption Policy on the default BlobRequestOptions must contain an IKeyResolver capable of resolving the old encryption key.

  4. The Encryption Policy on the default BlobRequestOptions must contain an IKey with the new encryption key.

RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext) RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

[Microsoft.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task RotateEncryptionKeyAsync (Microsoft.WindowsAzure.Storage.AccessCondition accessCondition, Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptions options, Microsoft.WindowsAzure.Storage.OperationContext operationContext);
abstract member RotateEncryptionKeyAsync : Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext -> System.Threading.Tasks.Task
override this.RotateEncryptionKeyAsync : Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext -> System.Threading.Tasks.Task
Parameters
accessCondition
AccessCondition AccessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. For this operation, there must not be an IfMatchETag, IfNoneMatchETag, IfModifiedSinceTime, or IfNotModifiedSinceTime condition.
An IfMatchETag condition will be added internally.

options
BlobRequestOptions BlobRequestOptions BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext
OperationContext OperationContext OperationContext

An OperationContext object that represents the context for the current operation.

Returns

A Task object that represents the asynchronous operation.

Remarks

This method has a number of prerequisites:

  1. The blob must be encrypted on the service using client-side encryption (not service-side encryption.)

  2. The local object must have the latest attributes from the blob on the service. This can be done by calling FetchAttributes() on the blob, or by listing blobs in the container with metadata.

  3. The Encryption Policy on the default BlobRequestOptions must contain an IKeyResolver capable of resolving the old encryption key.

  4. The Encryption Policy on the default BlobRequestOptions must contain an IKey with the new encryption key.

RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) RotateEncryptionKeyAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to rotate the encryption key on this blob. This method rotates only the KEK, not the CEK. For more information, visit https://azure.microsoft.com/en-us/documentation/articles/storage-client-side-encryption/

[Microsoft.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task RotateEncryptionKeyAsync (Microsoft.WindowsAzure.Storage.AccessCondition accessCondition, Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptions options, Microsoft.WindowsAzure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);
abstract member RotateEncryptionKeyAsync : Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RotateEncryptionKeyAsync : Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Parameters
accessCondition
AccessCondition AccessCondition AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. For this operation, there must not be an IfMatchETag, IfNoneMatchETag, IfModifiedSinceTime, or IfNotModifiedSinceTime condition.
An IfMatchETag condition will be added internally.

options
BlobRequestOptions BlobRequestOptions BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext
OperationContext OperationContext OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken
CancellationToken CancellationToken CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

A Task object that represents the asynchronous operation.

Remarks

This method has a number of prerequisites:

  1. The blob must be encrypted on the service using client-side encryption (not service-side encryption.)

  2. The local object must have the latest attributes from the blob on the service. This can be done by calling FetchAttributes() on the blob, or by listing blobs in the container with metadata.

  3. The Encryption Policy on the default BlobRequestOptions must contain an IKeyResolver capable of resolving the old encryption key.

  4. The Encryption Policy on the default BlobRequestOptions must contain an IKey with the new encryption key.

Applies to