你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchIndexClient.DeleteIndexAsync 方法

定义

命名空间:

Azure.Search.Documents.Indexes

程序集:

Azure.Search.Documents.dll

包:

Azure.Search.Documents v11.5.1

重载

DeleteIndexAsync(String, CancellationToken)	删除搜索索引及其包含的所有文档。
DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)	删除搜索索引及其包含的所有文档。

DeleteIndexAsync(String, CancellationToken)

Source:

SearchIndexClient.cs

删除搜索索引及其包含的所有文档。

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)

参数

indexName

String

必需。 要删除的 SearchIndex 的名称。

cancellationToken

CancellationToken

可选 CancellationToken ，用于传播应取消操作的通知。

返回

Task<Response>

Response来自服务器的 。

例外

ArgumentNullException

当 indexName 为 null 时引发。

RequestFailedException

当搜索服务返回失败时引发。

DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)

Source:

SearchIndexClient.cs

删除搜索索引及其包含的所有文档。

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)

参数

index

SearchIndex

必需。 要 SearchIndex 删除的 。

onlyIfUnchanged

Boolean

如果 ETag 与当前服务版本不匹配，则为 True，则引发 RequestFailedException ;否则，将覆盖当前服务版本。

cancellationToken

CancellationToken

可选 CancellationToken ，用于传播应取消操作的通知。

返回

Task<Response>

Response来自服务器的 。

例外

ArgumentNullException

当 index 为 null 时引发。

RequestFailedException

当搜索服务返回失败时引发。