DocumentDbClient.QueryDocumentsAsync Method

Definition

Namespace:

Azure.Connectors.Sdk.Documentdb

Assembly:

Azure.Connectors.Sdk.dll

Package:

Azure.Connectors.Sdk v0.13.0-preview.1

Query documents V5

public virtual System.Threading.Tasks.Task<Azure.Connectors.Sdk.Documentdb.Models.QueryDocumentsResponse> QueryDocumentsAsync(string azureCosmosDBAccountName, string databaseId, string containerId, string sQLSyntaxQuery = default, string partitionKeyValue = default, int? maxItemCount = default, string continuationToken = default, string consistencyLevel = default, string sessionToken = default, bool? extractSensitivityLabel = default, string purviewAccountName = default, System.Threading.CancellationToken cancellationToken = default);

abstract member QueryDocumentsAsync : string * string * string * string * string * Nullable<int> * string * string * string * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.Documentdb.Models.QueryDocumentsResponse>
override this.QueryDocumentsAsync : string * string * string * string * string * Nullable<int> * string * string * string * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.Documentdb.Models.QueryDocumentsResponse>

Public Overridable Function QueryDocumentsAsync (azureCosmosDBAccountName As String, databaseId As String, containerId As String, Optional sQLSyntaxQuery As String = Nothing, Optional partitionKeyValue As String = Nothing, Optional maxItemCount As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional consistencyLevel As String = Nothing, Optional sessionToken As String = Nothing, Optional extractSensitivityLabel As Nullable(Of Boolean) = Nothing, Optional purviewAccountName As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of QueryDocumentsResponse)

Parameters

azureCosmosDBAccountName

String

Azure Cosmos DB account name

databaseId

String

Database ID

containerId

String

Container ID

sQLSyntaxQuery

String

SQL Syntax Query

partitionKeyValue

String

Partition key value

maxItemCount

Nullable<Int32>

Max Item Count

continuationToken

String

Continuation Token

consistencyLevel

String

Consistency Level

sessionToken

String

Session Token

extractSensitivityLabel

Nullable<Boolean>

Extract Sensitivity Label

purviewAccountName

String

Purview Account Name

cancellationToken

CancellationToken

Cancellation token.

Returns

Task<QueryDocumentsResponse>

The Query documents V5 response.

Remarks

Query documents (V5).