Share via


Database.GetClientEncryptionKeyQueryIterator Method

Definition

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

An iterator over client encryption keys.

Remarks

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

Applies to