SearchIndexClient.GetIndex(String, CancellationToken) メソッド

定義

名前空間:

Azure.Search.Documents.Indexes

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

ソース:

SearchIndexClient.cs

特定 SearchIndexの を取得します。

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex> GetIndex (string indexName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndex : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>
override this.GetIndex : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>

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

パラメーター

indexName

String

必須。 取得するインデックスの名前。

cancellationToken

CancellationToken

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

戻り値

Response<SearchIndex>

Response<T>要求された SearchIndexを含むサーバーからの 。

例外

ArgumentNullException

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

RequestFailedException

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