Share via


SearchIndexingBufferedSenderExtensions.DeleteDocuments Method

Definition

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

public static void DeleteDocuments (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 DeleteDocuments : Azure.Search.Documents.SearchIndexingBufferedSender<Azure.Search.Documents.Models.SearchDocument> * string * seq<string> * System.Threading.CancellationToken -> unit
<Extension()>
Public Sub DeleteDocuments (indexer As SearchIndexingBufferedSender(Of SearchDocument), keyFieldName As String, documentKeys As IEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing)

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.

Applies to