Share via

SearchIndexClient.GetAlias(String, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchIndexClient.Aliases.cs

Retrieves an alias definition.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias> GetAlias (string aliasName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAlias : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>
override this.GetAlias : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>
Public Overridable Function GetAlias (aliasName As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<SearchAlias>

SearchAlias defined by aliasName.

Applies to