ClientEncryptionKey.ReplaceAsync Method

Definition

Replace a ClientEncryptionKeyProperties from the Azure Cosmos service as an asynchronous operation. This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse> ReplaceAsync (Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties clientEncryptionKeyProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReplaceAsync : Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse>
Public MustOverride Function ReplaceAsync (clientEncryptionKeyProperties As ClientEncryptionKeyProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientEncryptionKeyResponse)

Parameters

clientEncryptionKeyProperties
ClientEncryptionKeyProperties

The ClientEncryptionKeyProperties object.

requestOptions
RequestOptions

(Optional) The options for the request.

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

A Task containing a ClientEncryptionKeyResponse which wraps a ClientEncryptionKeyProperties containing the replace resource record.

Applies to