SearchIndexClient.DeleteIndex メソッド

定義

名前空間:

Azure.Search.Documents.Indexes

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

オーバーロード

DeleteIndex(String, CancellationToken)	検索インデックスとそのインデックスに含まれるすべてのドキュメントを削除します。
DeleteIndex(SearchIndex, Boolean, CancellationToken)	検索インデックスとそのインデックスに含まれるすべてのドキュメントを削除します。

DeleteIndex(String, CancellationToken)

ソース:

SearchIndexClient.cs

検索インデックスとそのインデックスに含まれるすべてのドキュメントを削除します。

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

パラメーター

indexName

String

必須。 削除する SearchIndex の名前。

cancellationToken

CancellationToken

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

戻り値

Response

Responseサーバーからの 。

例外

ArgumentNullException

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

RequestFailedException

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

DeleteIndex(SearchIndex, Boolean, CancellationToken)

ソース:

SearchIndexClient.cs

検索インデックスとそのインデックスに含まれるすべてのドキュメントを削除します。

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

パラメーター

index

SearchIndex

必須。 SearchIndex削除する 。

onlyIfUnchanged

Boolean

True を指定すると、 RequestFailedException が現在の ETag サービス バージョンと一致しない場合は がスローされます。それ以外の場合は、現在のサービス バージョンが上書きされます。

cancellationToken

CancellationToken

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

戻り値

Response

Responseサーバーからの 。

例外

ArgumentNullException

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

RequestFailedException

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