DocumentDbClient.GetDocumentsAsync Method

Definition

Namespace:

Azure.Connectors.Sdk.Documentdb

Assembly:

Azure.Connectors.Sdk.dll

Package:

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

Get all documents (V3)

public virtual System.Threading.Tasks.Task<Azure.Connectors.Sdk.Documentdb.Models.GetDocumentsResponse> GetDocumentsAsync(string azureCosmosDBAccountName, string databaseId, string collectionId, bool? extractSensitivityLabel = default, string purviewAccountName = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetDocumentsAsync (azureCosmosDBAccountName As String, databaseId As String, collectionId As String, Optional extractSensitivityLabel As Nullable(Of Boolean) = Nothing, Optional purviewAccountName As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of GetDocumentsResponse)

Parameters

azureCosmosDBAccountName

String

Azure Cosmos DB account name

databaseId

String

Database ID

collectionId

String

Collection ID

extractSensitivityLabel

Nullable<Boolean>

Extract Sensitivity Label

purviewAccountName

String

Purview Account Name

cancellationToken

CancellationToken

Cancellation token.

Returns

Task<GetDocumentsResponse>

The Get all documents (V3) response.

Remarks

Get all documents (V3).