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)

ソース:

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

Search Serviceによってエラーが返されたときにスローされます。

DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)

ソース:

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サービス バージョンと一致しない場合は をスローRequestFailedExceptionする場合は True、それ以外の場合は、現在のサービス バージョンが上書きされます。

cancellationToken

CancellationToken

操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Task<Response>

Responseサーバーからの 。

例外

ArgumentNullException

index が null の場合にスローされます。

RequestFailedException

Search Serviceによってエラーが返されたときにスローされます。