SearchIndexClient.DeleteAlias Method

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.8.0-beta.1

Package:: Azure.Search.Documents v12.0.0

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
DeleteAlias(String, CancellationToken)	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.
DeleteAlias(SearchAlias, Boolean, CancellationToken)	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.
DeleteAlias(String, MatchConditions, RequestContext)	[Protocol Method] 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. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteAlias(String, MatchConditions, CancellationToken)	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.

DeleteAlias(String, CancellationToken)

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 Azure.Response DeleteAlias(string aliasName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAlias : string * System.Threading.CancellationToken -> Azure.Response
override this.DeleteAlias : string * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function DeleteAlias (aliasName As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Response

Response from the service.

Applies to

DeleteAlias(SearchAlias, Boolean, CancellationToken)

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 Azure.Response DeleteAlias(Azure.Search.Documents.Indexes.Models.SearchAlias alias, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAlias : Azure.Search.Documents.Indexes.Models.SearchAlias * bool * System.Threading.CancellationToken -> Azure.Response
override this.DeleteAlias : Azure.Search.Documents.Indexes.Models.SearchAlias * bool * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function DeleteAlias (alias As SearchAlias, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

alias: SearchAlias

The definition of the alias to delete.

onlyIfUnchanged: Boolean

True to throw a RequestFailedException if the ETag does not match the current alias version; otherwise, the current version will be overwritten.

cancellationToken: CancellationToken

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

Returns

Response

Response from the service.

Applies to

DeleteAlias(String, MatchConditions, RequestContext)

Source:: SearchIndexClient.cs

[Protocol Method] 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.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response DeleteAlias(string aliasName, Azure.MatchConditions matchConditions, Azure.RequestContext context);

abstract member DeleteAlias : string * Azure.MatchConditions * Azure.RequestContext -> Azure.Response
override this.DeleteAlias : string * Azure.MatchConditions * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteAlias (aliasName As String, matchConditions As MatchConditions, context As RequestContext) As Response

Parameters

aliasName: String

The name of the alias.

matchConditions: MatchConditions

The content to send as the request conditions of the request.

context: RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

aliasName is null.

ArgumentException

aliasName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Applies to

DeleteAlias(String, MatchConditions, CancellationToken)

Source:: SearchIndexClient.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 Azure.Response DeleteAlias(string aliasName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAlias : string * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response
override this.DeleteAlias : string * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function DeleteAlias (aliasName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response