IndexDocumentsBatch.Delete Method

  • Reference

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1

Overloads

Delete(String, IEnumerable<String>)

Create an IndexDocumentsBatch<T> to delete.
Delete<T>(IEnumerable<T>)

Create an IndexDocumentsBatch<T> to delete.

Delete(String, IEnumerable<String>)

Source:
IndexDocumentsBatch.cs
Source:
IndexDocumentsBatch.cs

Create an IndexDocumentsBatch<T> to delete.

public static Azure.Search.Documents.Models.IndexDocumentsBatch<Azure.Search.Documents.Models.SearchDocument> Delete (string keyName, System.Collections.Generic.IEnumerable<string> keyValues);
static member Delete : string * seq<string> -> Azure.Search.Documents.Models.IndexDocumentsBatch<Azure.Search.Documents.Models.SearchDocument>
Public Shared Function Delete (keyName As String, keyValues As IEnumerable(Of String)) As IndexDocumentsBatch(Of SearchDocument)

Parameters

keyName
String

The name of the key field that uniquely identifies documents in the index.

keyValues
IEnumerable<String>

The keys of the documents to delete.

Returns

IndexDocumentsBatch<SearchDocument>

An IndexDocumentsBatch<T> to delete.

Applies to

Delete<T>(IEnumerable<T>)

Source:
IndexDocumentsBatch.cs
Source:
IndexDocumentsBatch.cs

Create an IndexDocumentsBatch<T> to delete.

public static Azure.Search.Documents.Models.IndexDocumentsBatch<T> Delete<T> (System.Collections.Generic.IEnumerable<T> documents);
static member Delete : seq<'T> -> Azure.Search.Documents.Models.IndexDocumentsBatch<'T>
Public Shared Function Delete(Of T) (documents As IEnumerable(Of T)) As IndexDocumentsBatch(Of T)

Type Parameters

T

The .NET type that maps to the index schema. Instances of this type can be retrieved as documents from the index.

Parameters

documents
IEnumerable<T>

The documents to delete.

Returns

IndexDocumentsBatch<T>

An IndexDocumentsBatch<T> to delete.

Applies to