Database.GetClientEncryptionKeyQueryIterator Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: Database.cs

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.

Returns an iterator that can be iterated to get properties of client encryption keys. This method is not meant to be invoked directly. Please see https://aka.ms/CosmosClientEncryption in order to use client-side encryption.

public abstract Microsoft.Azure.Cosmos.FeedIterator<Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties> GetClientEncryptionKeyQueryIterator (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetClientEncryptionKeyQueryIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<Microsoft.Azure.Cosmos.ClientEncryptionKeyProperties>

Public MustOverride Function GetClientEncryptionKeyQueryIterator (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of ClientEncryptionKeyProperties)

Parameters

queryDefinition: QueryDefinition

The Cosmos SQL query definition.

continuationToken: String

(Optional) The continuation token in the Azure Cosmos DB service.

requestOptions: QueryRequestOptions

(Optional) The options for the request. Set MaxItemCount to restrict the number of results returned.

Returns

FeedIterator<ClientEncryptionKeyProperties>

An iterator over client encryption keys.

Remarks

ReadAsync(RequestOptions, CancellationToken) is recommended for single client encryption key look-up.

Applies to