Alias Operations (Preview REST API)
Important
This API reference is for a legacy version. See Data plane REST operations for updated reference documentation. Use the filter on the top left to select a version.
Applies to: 2023-07-01-Preview. This version is no longer supported. Upgrade immediately to a newer version.
Important
2023-07-01-Preview (no changes).
2021-04-30-Preview adds the API.
In Azure AI Search, an index alias is a secondary name for a search index. You can create an alias that maps to a search index and substitute the alias name in places where you would otherwise reference an index name. This gives you flexibility if you ever need to change which index your application is pointing to. Instead of updating the references to the index name in your application code, you can just update the mapping for your alias.
You can create and manage aliases in Azure AI Search service via HTTP requests (POST, GET, PUT, DELETE) against a given alias resource. Aliases are service level resources and maintained independently from search indexes. Once a search index is created, you can create an alias that maps to that search index.
Note
You can only use an alias with document operations or to get and update an index definition. Aliases can't be used to delete an index, can't be used with the Analyze Text API, and can't be used as the targetIndexName on an indexer.
Example
The following example shows how to create an alias that maps to an existing search index.
POST /aliases?api-version=2023-07-01-Preview
{
"name" : "my-alias",
"indexes" : ["my-index"]
}