SearchIndexClient.CreateAliasAsync Method

Definition

Overloads

Name Description
CreateAliasAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new search alias.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateAliasAsync(SearchAlias, CancellationToken)

Creates a new search alias.

CreateAliasAsync(RequestContent, RequestContext)

Source:
SearchIndexClient.cs

[Protocol Method] Creates a new search alias.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response> CreateAliasAsync(Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member CreateAliasAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateAliasAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CreateAliasAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

content
RequestContent

The content to send as the body of the request.

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

content is null.

Service returned a non-success status code.

Applies to

CreateAliasAsync(SearchAlias, CancellationToken)

Source:
SearchIndexClient.cs
Source:
SearchIndexClient.Aliases.cs

Creates a new search alias.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>> CreateAliasAsync(Azure.Search.Documents.Indexes.Models.SearchAlias alias, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateAliasAsync : Azure.Search.Documents.Indexes.Models.SearchAlias * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>>
override this.CreateAliasAsync : Azure.Search.Documents.Indexes.Models.SearchAlias * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchAlias>>
Public Overridable Function CreateAliasAsync (alias As SearchAlias, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchAlias))

Parameters

alias
SearchAlias

The definition of the alias to create.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

SearchAlias created by the service.

Exceptions

alias is null.

Service returned a non-success status code.

Applies to