SearchIndexClient.GetAliasAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0-beta.3

Source:

SearchIndexClient.Aliases.cs

Retrieves an alias definition.

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

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

Public Overridable Function GetAliasAsync (aliasName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchAlias))

Parameters

aliasName

String

The name of the alias to retrieve.

cancellationToken

CancellationToken

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

Returns

Task<Response<SearchAlias>>

SearchAlias defined by aliasName.