SearchIndexClient.DeleteIndex Methode

  • Referenz

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Paket:
Azure.Search.Documents v11.5.1
Paket:
Azure.Search.Documents v11.6.0-beta.4

Überlädt

DeleteIndex(String, CancellationToken)

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

Löscht einen Suchindex und alle darin enthaltenen Dokumente.

DeleteIndex(String, CancellationToken)

Quelle:
SearchIndexClient.cs
Quelle:
SearchIndexClient.cs

Löscht einen Suchindex und alle darin enthaltenen Dokumente.

public virtual Azure.Response DeleteIndex (string indexName, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteIndex : string * System.Threading.CancellationToken -> Azure.Response
override this.DeleteIndex : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteIndex (indexName As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Response

Die Response vom Server.

Ausnahmen

ArgumentNullException

Wird ausgelöst, wenn indexName NULL ist.

RequestFailedException

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

Gilt für:

DeleteIndex(SearchIndex, Boolean, CancellationToken)

Quelle:
SearchIndexClient.cs
Quelle:
SearchIndexClient.cs

Löscht einen Suchindex und alle darin enthaltenen Dokumente.

public virtual Azure.Response DeleteIndex (Azure.Search.Documents.Indexes.Models.SearchIndex index, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteIndex : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * System.Threading.CancellationToken -> Azure.Response
override this.DeleteIndex : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteIndex (index As SearchIndex, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameter

index
SearchIndex

Erforderlich. Die SearchIndex zu löschende.

onlyIfUnchanged
Boolean

True, um eine 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

Response

Die Response vom Server.

Ausnahmen

ArgumentNullException

Wird ausgelöst, wenn index NULL ist.

RequestFailedException

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

Gilt für: