Share via

IndexesOperationsExtensions.GetAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Search
Assembly:
Microsoft.Azure.Search.Service.dll
Package:
Microsoft.Azure.Search.Service v10.1.0
Source:
IndexesOperationsExtensions.Customization.cs

Retrieves an index definition. https://docs.microsoft.com/rest/api/searchservice/Get-Index

public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.Index> GetAsync (this Microsoft.Azure.Search.IIndexesOperations operations, string indexName, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member GetAsync : Microsoft.Azure.Search.IIndexesOperations * string * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.Index>
<Extension()>
Public Function GetAsync (operations As IIndexesOperations, indexName As String, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Index)

Parameters

operations
IIndexesOperations

The operations group for this extension method.

indexName
String

The name of the index to retrieve.

searchRequestOptions
SearchRequestOptions

Additional parameters for the operation

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<Index>

Applies to