Skip to content

Commit 535f91e

Browse files
authored
Merge pull request #197878 from HeidiSteen/heidist-seo
[azure search] SEO optimizations for index alias
2 parents 6a6fb6c + 76e574a commit 535f91e

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

articles/search/search-how-to-alias.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create an index alias
33
titleSuffix: Azure Cognitive Search
4-
description: Create an alias to define a secondary name that can be used to refer to an index for querying and indexing.
4+
description: Create an Azure Cognitive Search index alias to define a static secondary name that can be used for referencing a search index for querying and indexing.
55

66
author: dereklegenzoff
77
ms.author: delegenz
@@ -15,7 +15,7 @@ ms.date: 03/01/2022
1515
> [!IMPORTANT]
1616
> Index aliases are currently in public preview and available under [supplemental terms of use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
1717
18-
In Azure Cognitive Search, an alias is a secondary name that can be used to refer to an index for querying, indexing, and other operations. 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 added 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, you can just update the mapping for your alias.
18+
In Azure Cognitive Search, an index alias is a secondary name that can be used to refer to an index for querying, indexing, and other operations. 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. An alias adds flexibility if you need to change which index your application is pointing to. Instead of updating the references in your application, you can just update the mapping for your alias.
1919

2020
The main goal of index aliases is to make it easier to manage your production indexes. For example, if you need to make a change to your index definition, such as editing a field or adding a new analyzer, you'll have to create a new search index because all search indexes are immutable. This means you either need to [drop and rebuild your index](search-howto-reindex.md) or create a new index and then migrate your application over to that index.
2121

@@ -27,7 +27,7 @@ Instead of dropping and rebuilding your index, you can use index aliases. A typi
2727
1. When you need to make a change to your index that requires a rebuild, create a new search index
2828
1. When your new index is ready to go, update the alias to map to the new index and requests will automatically be routed to the new index
2929

30-
## Create an alias
30+
## Create an index alias
3131

3232
You can create an alias using the preview REST API, the preview SDKs, or through [Visual Studio Code](search-get-started-vs-code.md). An alias consists of the `name` of the alias and the name of the search index that the alias is mapped to. Only one index name can be specified in the `indexes` array.
3333

@@ -55,8 +55,7 @@ To create an alias in Visual Studio Code:
5555

5656
---
5757

58-
59-
## Send requests
58+
## Send requests to an index alias
6059

6160
Once you've created your alias, you're ready to start using it. Aliases can be used for [querying](/rest/api/searchservice/search-documents) and [indexing](/rest/api/searchservice/addupdate-or-delete-documents).
6261

@@ -92,7 +91,7 @@ PUT /aliases/my-alias?api-version=2021-04-30-preview
9291
After you make the update to the alias, requests will automatically start to be routed to the new index.
9392

9493
> [!NOTE]
95-
> An update to an alias may take up to 10 seconds to propogate through the system so you should wait at least 10 seconds before deleting the index that the alias was previously mapped to.
94+
> An update to an alias may take up to 10 seconds to propagate through the system so you should wait at least 10 seconds before deleting the index that the alias was previously mapped to.
9695
9796
## See also
9897

articles/search/search-how-to-create-search-index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,8 @@ The following properties can be set for CORS:
191191

192192
[**Create Index**](/rest/api/searchservice/create-index) creates the physical data structures (files and inverted indices) on your search service. Once the index is created, your ability to effect changes using [**Update Index**](/rest/api/searchservice/update-index) is contingent upon whether your modifications invalidate those physical structures. Most field attributes can't be changed once the field is created in your index.
193193

194+
Alternatively, you can [create an index alias](search-how-to-alias.md) that serves as a stable reference in your application code. Instead of updating your code, you can update an index alias to point to newer index versions.
195+
194196
To minimize churn in the design process, the following table describes which elements are fixed and flexible in the schema. Changing a fixed element requires an index rebuild, whereas flexible elements can be changed at any time without impacting the physical implementation.
195197

196198
| Element | Can be updated? |

articles/search/search-what-is-an-index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@ But you'll also want to become familiar with methodologies for loading an index
168168

169169
+ [Create a search index](search-how-to-create-search-index.md)
170170

171+
+ [Create an index alias](search-how-to-alias.md)
172+
171173
+ [Data import overview](search-what-is-data-import.md)
172174

173175
+ [Add, Update or Delete Documents (REST)](/rest/api/searchservice/addupdate-or-delete-documents)

0 commit comments

Comments
 (0)