IndexBatch.Delete Method

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Overloads

Delete(String, IEnumerable<String>)	Creates a new IndexBatch for deleting a batch of documents.
Delete<T>(IEnumerable<T>)	Creates a new IndexBatch for deleting a batch of documents.

Delete(String, IEnumerable<String>)

Source:

IndexBatch.Customization.cs

Creates a new IndexBatch for deleting a batch of documents.

public static Microsoft.Azure.Search.Models.IndexBatch<Microsoft.Azure.Search.Models.Document> Delete (string keyName, System.Collections.Generic.IEnumerable<string> keyValues);

static member Delete : string * seq<string> -> Microsoft.Azure.Search.Models.IndexBatch<Microsoft.Azure.Search.Models.Document>

Public Shared Function Delete (keyName As String, keyValues As IEnumerable(Of String)) As IndexBatch(Of Document)

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

IndexBatch<Document>

A new IndexBatch.

Delete<T>(IEnumerable<T>)

Source:

IndexBatch.Customization.cs

Creates a new IndexBatch for deleting a batch of documents.

public static Microsoft.Azure.Search.Models.IndexBatch<T> Delete<T> (System.Collections.Generic.IEnumerable<T> documents);

static member Delete : seq<'T> -> Microsoft.Azure.Search.Models.IndexBatch<'T>

Public Shared Function Delete(Of T) (documents As IEnumerable(Of T)) As IndexBatch(Of T)

Type Parameters

T

The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index.

Parameters

documents

IEnumerable<T>

The documents to delete; Fields other than the key are ignored.

Returns

IndexBatch<T>

A new IndexBatch.