SearchIndexClient.DeleteIndexAsync Methode

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Paket:

Azure.Search.Documents v11.5.1

Überlädt

DeleteIndexAsync(String, CancellationToken)	Löscht einen Suchindex und alle darin enthaltenen Dokumente.
DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)	Löscht einen Suchindex und alle darin enthaltenen Dokumente.

DeleteIndexAsync(String, CancellationToken)

Quelle:

SearchIndexClient.cs

Löscht einen Suchindex und alle darin enthaltenen Dokumente.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteIndexAsync (string indexName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIndexAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteIndexAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteIndexAsync (indexName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameter

indexName

String

Erforderlich. Der Name der zu löschenden SearchIndex.

cancellationToken

CancellationToken

Optional CancellationToken zur Weitergabe von Benachrichtigungen, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Task<Response>

Der Response vom Server.

Ausnahmen

ArgumentNullException

Wird ausgelöst, wenn indexName NULL ist.

RequestFailedException

Wird ausgelöst, wenn ein Fehler vom Suchdienst zurückgegeben wird.

DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)

Quelle:

SearchIndexClient.cs

Löscht einen Suchindex und alle darin enthaltenen Dokumente.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteIndexAsync (Azure.Search.Documents.Indexes.Models.SearchIndex index, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIndexAsync : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteIndexAsync : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteIndexAsync (index As SearchIndex, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameter

index

SearchIndex

Erforderlich. Der SearchIndex zu löschende.

onlyIfUnchanged

Boolean

True, um ein RequestFailedException auszulösen, wenn die ETag nicht mit der aktuellen Dienstversion übereinstimmt. Andernfalls wird die aktuelle Dienstversion überschrieben.

cancellationToken

CancellationToken

Optional CancellationToken zur Weitergabe von Benachrichtigungen, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Task<Response>

Der Response vom Server.

Ausnahmen

ArgumentNullException

Wird ausgelöst, wenn index NULL ist.

RequestFailedException

Wird ausgelöst, wenn ein Fehler vom Suchdienst zurückgegeben wird.