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

定義

名前空間:

Azure.Search.Documents.Indexes

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

ソース:

SearchIndexClient.cs

特定の を取得します SearchIndex。

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

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

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

パラメーター

indexName

String

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

cancellationToken

CancellationToken

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

戻り値

Task<Response<SearchIndex>>

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

例外

ArgumentNullException

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

RequestFailedException

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