SearchIndexClient.GetIndexAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.5.1

Package:: Azure.Search.Documents v11.6.0-beta.4

Source:: SearchIndexClient.cs

Source:: SearchIndexClient.Aliases.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<Response<SearchIndex>>

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

Exceptions

ArgumentNullException

Thrown when indexName is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to