Database.CreateClientEncryptionKeyAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Saves the client encryption key as an asynchronous operation in the Azure Cosmos service. 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> CreateClientEncryptionKeyAsync (Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties clientEncryptionKeyProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member CreateClientEncryptionKeyAsync : Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse>Public MustOverride Function CreateClientEncryptionKeyAsync (clientEncryptionKeyProperties As ClientEncryptionKeyProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientEncryptionKeyResponse)Parameters
- clientEncryptionKeyProperties
- ClientEncryptionKeyProperties
Client encryption key properties.
- requestOptions
- RequestOptions
(Optional) The options for the request.
- cancellationToken
- CancellationToken
(Optional) Token representing request cancellation.
Returns
An awaitable response which wraps a ClientEncryptionKeyProperties containing the read resource record.
