Condividi tramite


SearchIndexingBufferedSenderExtensions.DeleteDocumentsAsync Method

Definition

Adds a batch of delete actions to eventually send to the search index.

public static System.Threading.Tasks.Task DeleteDocumentsAsync (this Azure.Search.Documents.SearchIndexingBufferedSender<Azure.Search.Documents.Models.SearchDocument> indexer, string keyFieldName, System.Collections.Generic.IEnumerable<string> documentKeys, System.Threading.CancellationToken cancellationToken = default);
static member DeleteDocumentsAsync : Azure.Search.Documents.SearchIndexingBufferedSender<Azure.Search.Documents.Models.SearchDocument> * string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function DeleteDocumentsAsync (indexer As SearchIndexingBufferedSender(Of SearchDocument), keyFieldName As String, documentKeys As IEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

keyFieldName
String

The name of the key field.

documentKeys
IEnumerable<String>

The keys of the documents to delete.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

A task that completes when the indexing actions have been added but not yet sent.

Applies to