SearchIndexClient.DeleteAliasAsync(String, CancellationToken) Method

  • Reference

Definition

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

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAliasAsync (string aliasName, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAliasAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteAliasAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteAliasAsync (aliasName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

aliasName
String

The name of the alias to delete.

cancellationToken
CancellationToken

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

Returns

Task<Response>

Response from the service.

Applies to