Aliases - Delete

Service:

Search Service

API Version:

2024-05-01-preview

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.

DELETE {endpoint}/aliases('{aliasName}')?api-version=2024-05-01-preview

URI Parameters

Name	In	Required	Type	Description
aliasName	path	True	string	The name of the alias to delete.
endpoint	path	True	string	The endpoint URL of the search service.
api-version	query	True	string	Client Api Version.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	The tracking ID sent with the request to help with debugging.
If-Match		string	Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
If-None-Match		string	Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.

Responses

Name	Type	Description
204 No Content
404 Not Found
Other Status Codes	ErrorResponse	Error response.

Examples

SearchServiceDeleteAlias

Sample request

HTTP

DELETE https://myservice.search.windows.net/aliases('staging')?api-version=2024-05-01-preview

Sample response

Status code:

204

Status code:

404

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.