IIndexOperations.GetAsync Method (String, CancellationToken)

Applies To: Microsoft Azure

Retrieves an index definition from Azure Search. (see https://msdn.microsoft.com/library/azure/dn798939.aspx for more information)

Namespace:   Microsoft.Azure.Search
Assembly:  Microsoft.Azure.Search (in Microsoft.Azure.Search.dll)

Syntax

Task<IndexDefinitionResponse> GetAsync(
    string indexName,
    CancellationToken cancellationToken
)

Task<IndexDefinitionResponse^>^ GetAsync(
    String^ indexName,
    CancellationToken cancellationToken
)

abstract GetAsync : 
        indexName:string *
        cancellationToken:CancellationToken -> Task<IndexDefinitionResponse>

Function GetAsync (
    indexName As String,
    cancellationToken As CancellationToken
) As Task(Of IndexDefinitionResponse)

Parameters

• indexName
  Type: System.String

  The name of the index to retrieve.

• cancellationToken
  Type: System.Threading.CancellationToken

  Cancellation token.

Return Value

Type: System.Threading.Tasks.Task<IndexDefinitionResponse>

Response from a Create, Update, or Get Index request. If successful, it includes the full definition of the index that was created, updated, or retrieved.

See Also

IIndexOperations Interface
Microsoft.Azure.Search Namespace

Return to top