Database.CreateClientEncryptionKeyAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.39.0
Source:
Database.cs

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

Task<ClientEncryptionKeyResponse>

An awaitable response which wraps a ClientEncryptionKeyProperties containing the read resource record.

Applies to