Skip to content

Commit adabec8

Browse files
Merge pull request #268108 from HeidiSteen/heidist-fix
[azure search] Underscores allowed in search service names
2 parents dda0a70 + ae7bbb0 commit adabec8

File tree

2 files changed

+29
-34
lines changed

2 files changed

+29
-34
lines changed

articles/search/search-create-service-portal.md

Lines changed: 28 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- ignite-2023
1212
ms.topic: conceptual
13-
ms.date: 12/12/2023
13+
ms.date: 03/05/2024
1414
---
1515

1616
# Create an Azure AI Search service in the portal
1717

18-
[**Azure AI Search**](search-what-is-azure-search.md) is an Azure resource used for adding a full text search experience to custom apps or for providing enterprise information retrieval for chat-style search solutions.
18+
[**Azure AI Search**](search-what-is-azure-search.md) adds vector and full text search as an information retrieval solution for the enterprise, and for traditional and generative AI scenarios.
1919

2020
If you have an Azure subscription, including a [trial subscription](https://azure.microsoft.com/pricing/free-trial/?WT.mc_id=A261C142F), you can create a search service for free. Free services have limitations, but you can complete all of the quickstarts and most tutorials, except for those featuring semantic ranking (it requires a billable service).
2121

@@ -25,11 +25,11 @@ The easiest way to create a service is using the [Azure portal](https://portal.a
2525

2626
## Before you start
2727

28-
The following service properties are fixed for the lifetime of the service. Because they're fixed, consider the usage implications as you fill in each property:
28+
The following service properties are fixed for the lifetime of the service. Consider their usage implications as you fill in each property:
2929

3030
+ Service name becomes part of the URL endpoint ([review tips for helpful service names](#name-the-service)).
3131
+ [Tier](search-sku-tier.md) (Free, Basic, Standard, and so forth) determines the underlying physical hardware and billing. Some features are tier-constrained.
32-
+ [Service region](#choose-a-region) can determine the availability of certain scenarios. If you need high availability or [AI enrichment](cognitive-search-concept-intro.md), you'll need to create the resource in a region that provides the feature.
32+
+ [Service region](#choose-a-region) can determine the availability of certain scenarios. If you need high availability or [AI enrichment](cognitive-search-concept-intro.md), create the resource in a region that provides the feature.
3333

3434
## Subscribe (free or paid)
3535

@@ -43,21 +43,19 @@ Paid (or billable) search occurs when you choose a billable tier (Basic or above
4343

4444
1. Sign in to the [Azure portal](https://portal.azure.com/).
4545

46-
1. Click the plus sign (**"+ Create Resource"**) in the top-left corner.
46+
1. Select (**Create Resource"**) in the top-left corner.
4747

4848
1. Use the search bar to find "Azure AI Search".
4949

5050
:::image type="content" source="media/search-create-service-portal/find-search3.png" lightbox="media/search-create-service-portal/find-search3.png" alt-text="Screenshot of the Create Resource page in the portal." border="true":::
5151

5252
## Choose a subscription
5353

54-
If you've more than one subscription, choose one for your search service. If you're implementing [customer-managed encryption](search-security-manage-encryption-keys.md) or if you use other features that depend on managed service identities for [external data access](search-indexer-securing-resources.md), choose the same subscription as the one used for Azure Key Vault or other services for which managed identities are used.
54+
If you have more than one subscription, choose one for your search service. If you're implementing [customer-managed encryption](search-security-manage-encryption-keys.md) or if you use other features that depend on managed service identities for [external data access](search-indexer-securing-resources.md), choose the same subscription as the one used for Azure Key Vault or other services for which managed identities are used.
5555

5656
## Set a resource group
5757

58-
A resource group is a container that holds related resources for your Azure solution. It's required for the search service. It's also useful for managing resources all-up, including costs. A resource group can consist of one service, or multiple services used together. For example, if you're using Azure AI Search to index an Azure Cosmos DB database, you could make both services part of the same resource group for management purposes.
59-
60-
If you aren't combining resources into a single group, or if existing resource groups are filled with resources used in unrelated solutions, create a new resource group just for your Azure AI Search resource.
58+
A resource group is a container that holds related resources for your Azure solution. It's useful for consolidating same-solution resources, monitoring costs, and for checking the creation date of your search service.
6159

6260
:::image type="content" source="media/search-create-service-portal/new-resource-group.png" lightbox="media/search-create-service-portal/new-resource-group.png" alt-text="Screenshot of the Create Resource Group page in the portal." border="true":::
6361

@@ -66,28 +64,27 @@ Over time, you can track current and projected costs all-up or you can view char
6664
:::image type="content" source="media/search-create-service-portal/resource-group-cost-management.png" lightbox="media/search-create-service-portal/resource-group-cost-management.png" alt-text="Screenshot of the manage costs page in the portal." border="true":::
6765

6866
> [!TIP]
69-
> Resource groups simplify cleanup because deleting a group deletes all of the services within it. For prototype projects utilizing multiple services, putting all of them in the same resource group makes cleanup easier after the project is over.
67+
> Resource groups simplify cleanup because deleting a resource group deletes everything within it.
7068
7169
## Name the service
7270

73-
In Instance Details, provide a service name in the **URL** field. The name is part of the URL endpoint against which API calls are issued: `https://your-service-name.search.windows.net`. For example, if you want the endpoint to be `https://myservice.search.windows.net`, you would enter `myservice`.
71+
In Instance Details, provide a service name in the **URL** field. The name is part of the endpoint against which API calls are issued: `https://your-service-name.search.windows.net`. For example, if you want the endpoint to be `https://myservice.search.windows.net`, you would enter `myservice`.
7472

7573
Service name requirements:
7674

77-
+ It must be unique within the search.windows.net namespace
78-
+ It must be between 2 and 60 characters in length
79-
+ You must use lowercase letters, digits, or dashes ("-")
80-
+ Don't use dashes ("-") in the first 2 characters or as the last single character
81-
+ You may not use consecutive dashes ("--") anywhere
75+
+ Unique within the search.windows.net namespace
76+
+ Between 2 and 60 characters in length
77+
+ Consist of lowercase letters, digits, dashes (`-`), or underscores (`_`)
78+
+ Don't use dashes or underscores in the first 2 characters or as the last single character
79+
+ Don't use consecutive dashes or underscores anywhere
8280

8381
> [!TIP]
84-
> If you think you'll be using multiple services, we recommend including the region (or location) in the service name as a naming convention. Services within the same region can exchange data at no charge, so if Azure AI Search is in West US, and you have other services also in West US, a name like `mysearchservice-westus` can save you a trip to the properties page when deciding how to combine or attach resources.
82+
> If you have multiple search services, it helps to include the region (or location) in the service name as a naming convention. A name like `mysearchservice-westus` can save you a trip to the properties page when deciding how to combine or attach resources.
8583
8684
## Choose a region
8785

8886
> [!IMPORTANT]
89-
> Due to high demand:
90-
> + Azure AI Search is currently unavaible for new instances in West Europe. If you don't immediately need semantic ranker or skillsets, choose Sweden Central because it has the most data center capacity. Otherwise, North Europe is another option.
87+
> Due to high demand, Azure AI Search is currently unavaible for new instances in West Europe. If you don't immediately need semantic ranker or skillsets, choose Sweden Central because it has the most data center capacity. Otherwise, North Europe is another option.
9188
9289
Azure AI Search is available in most regions, as listed in the [**Products available by region**](https://azure.microsoft.com/global-infrastructure/services/?products=search) page.
9390

@@ -99,28 +96,26 @@ Two notable exceptions might lead to provisioning Azure services in separate reg
9996

10097
+ Business continuity and disaster recovery (BCDR) requirements dictate creating multiple search services in [regional pairs](../availability-zones/cross-region-replication-azure.md#azure-paired-regions). For example, if you're operating in North America, you might choose East US and West US, or North Central US and South Central US, for each search service.
10198

102-
Some features are subject to regional availability. If you require any of following features, choose a region that provides them:
103-
104-
+ [AI enrichment](cognitive-search-concept-intro.md) requires Azure AI services to be in the same physical region as Azure AI Search. There are just a few regions that *don't* provide both. The [Products available by region](https://azure.microsoft.com/global-infrastructure/services/?products=search) page indicates a common regional presence by showing two stacked check marks. An unavailable combination has a missing check mark. The time piece icon indicates future availability.
105-
106-
:::image type="content" source="media/search-create-service-portal/region-availability.png" lightbox="media/search-create-service-portal/region-availability.png" alt-text="Screenshot of the regional availability page." border="true":::
107-
108-
+ Semantic ranker is an optional premium feature. Check the [Products available by region](https://azure.microsoft.com/global-infrastructure/services/?products=search) page to confirm the feature is available in your chosen region.
109-
110-
Other features that have regional constraints:
99+
Some features are subject to [regional availability](https://azure.microsoft.com/global-infrastructure/services/?products=search):
111100

112101
+ [Availability Zones](search-reliability.md#availability-zones)
113102
+ [Azure roles for data plane operations](search-security-rbac.md) (Azure public cloud only)
103+
+ [Semantic ranker](semantic-search-overview.md), per the [**Products available by region**](https://azure.microsoft.com/global-infrastructure/services/?products=search) page.
104+
+ [AI enrichment](cognitive-search-concept-intro.md) requires Azure AI services to be in the same physical region as Azure AI Search. There are just a few regions that *don't* provide both.
105+
106+
The [Products available by region](https://azure.microsoft.com/global-infrastructure/services/?products=search) page indicates a common regional presence by showing two stacked check marks. An unavailable combination has a missing check mark. The time piece icon indicates future availability.
107+
108+
:::image type="content" source="media/search-create-service-portal/region-availability.png" lightbox="media/search-create-service-portal/region-availability.png" alt-text="Screenshot of the regional availability page." border="true":::
114109

115110
## Choose a tier
116111

117-
Azure AI Search is currently offered in [multiple pricing tiers](https://azure.microsoft.com/pricing/details/search/): Free, Basic, Standard, or Storage Optimized. Each tier has its own [capacity and limits](search-limits-quotas-capacity.md). Also the tier you select may impact the availability of certain features. See [Feature availability by tier](search-sku-tier.md#feature-availability-by-tier) for guidance.
112+
Azure AI Search is offered in [multiple pricing tiers](https://azure.microsoft.com/pricing/details/search/): Free, Basic, Standard, or Storage Optimized. Each tier has its own [capacity and limits](search-limits-quotas-capacity.md). There are also several [features that are tier-dependent](search-sku-tier.md#feature-availability-by-tier).
118113

119-
Basic and Standard are the most common choices for production workloads, but initially many customers start with the Free service for evaluation purposes. Among the billable tiers, key differences are partition size and speed, and limits on the number of objects you can create.
114+
Basic and Standard are the most common choices for production workloads, but many customers start with the Free service. Among the billable tiers, key differences are partition size and speed, and limits on the number of objects you can create.
120115

121116
:::image type="content" source="media/search-create-service-portal/select-pricing-tier.png" lightbox="media/search-create-service-portal/select-pricing-tier.png" alt-text="Screenshot of Select a pricing tier page." border="true":::
122117

123-
Remember, a pricing tier can't be changed once the service is created. If you need a higher or lower tier, you'll have to re-create the service.
118+
Remember, a pricing tier can't be changed once the service is created. If you need a higher or lower tier, you should re-create the service.
124119

125120
## Create your service
126121

@@ -139,7 +134,7 @@ Unless you're using the portal, programmatic access to your new service requires
139134
+ [Connect using key-based authentication](search-security-api-keys.md)
140135
+ [Connect using Azure roles](search-security-rbac.md)
141136

142-
1. When setting up a programmatic connection, you'll need the search service endpoint. On the **Overview** page, locate and copy the URL endpoint on the right side of the page.
137+
1. When setting up a programmatic connection, you need the search service endpoint. On the **Overview** page, locate and copy the URL endpoint on the right side of the page.
143138

144139
:::image type="content" source="media/search-create-service-portal/get-endpoint.png" lightbox="media/search-create-service-portal/get-endpoint.png" alt-text="Screenshot of the service overview page with URL endpoint." border="true":::
145140

@@ -209,7 +204,7 @@ Azure AI Search restricts the [number of resources](search-limits-quotas-capacit
209204

210205
1. Provide the additional information required to file the request, and then select **Next**.
211206

212-
1. On **Review + create**, review the details that you'll send to support, and then select **Create**.
207+
1. On **Review + create**, select **Create**.
213208

214209
## Next steps
215210

articles/search/search-get-started-bicep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The Azure resource defined in this Bicep file:
6161
---
6262
6363
> [!NOTE]
64-
> Replace **\<service-name\>** with the name of the Search service. The service name must only contain lowercase letters, digits, or dashes. You can't use a dash as the first two characters or the last character. The name has a minimum length of 2 characters and a maximum length of 60 characters.
64+
> Replace **\<service-name\>** with the name of the Search service. The service name must only contain lowercase letters, digits, dashes, or underscores. You can't use a dash as the first two characters or the last character. The name has a minimum length of 2 characters and a maximum length of 60 characters.
6565
6666
When the deployment finishes, you should see a message indicating the deployment succeeded.
6767

0 commit comments

Comments
 (0)