Share via


SearchIndexClient.GetIndexAsync(String, CancellationToken) Method

Definition

Gets a specific 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))

Parameters

indexName
String

Required. The name of the index to get.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

The Response<T> from the server containing the requested SearchIndex.

Exceptions

Thrown when indexName is null.

Thrown when a failure is returned by the Search service.

Applies to