SearchIndexClient.GetAliasesAsync Method
Definition
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.
Overloads
| Name | Description |
|---|---|
| GetAliasesAsync(CancellationToken) |
Lists all aliases available for a search service. |
| GetAliasesAsync(RequestContext) |
[Protocol Method] Lists all aliases available for a search service.
|
GetAliasesAsync(CancellationToken)
- Source:
- SearchIndexClient.cs
- Source:
- SearchIndexClient.Aliases.cs
Lists all aliases available for a search service.
public virtual Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchAlias> GetAliasesAsync(System.Threading.CancellationToken cancellationToken = default);abstract member GetAliasesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchAlias>
override this.GetAliasesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Search.Documents.Indexes.Models.SearchAlias>Public Overridable Function GetAliasesAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SearchAlias)Parameters
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
The Pageable<T> from the server containing a list of SearchAlias objects.
Exceptions
Service returned a non-success status code.
Applies to
GetAliasesAsync(RequestContext)
- Source:
- SearchIndexClient.cs
[Protocol Method] Lists all aliases available for a search service.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.AsyncPageable<BinaryData> GetAliasesAsync(Azure.RequestContext context);abstract member GetAliasesAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAliasesAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>Public Overridable Function GetAliasesAsync (context As RequestContext) As AsyncPageable(Of BinaryData)Parameters
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
Service returned a non-success status code.
