Skip to content

Commit 75aff2d

Browse files
authored
Merge pull request #225056 from HeidiSteen/heidist-rbac
[azure search] Update create service page for auth options
2 parents d0e40b3 + e6bc4dd commit 75aff2d

File tree

5 files changed

+21
-17
lines changed

5 files changed

+21
-17
lines changed
48.2 KB
Loading
Binary file not shown.
49.4 KB
Loading

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

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Paid (or billable) search occurs when you choose a billable tier (Basic or above
4545

4646
1. Use the search bar to find "Azure Cognitive Search" or navigate to the resource through **Web** > **Azure Cognitive Search**.
4747

48-
:::image type="content" source="media/search-create-service-portal/find-search3.png" alt-text="Create a resource in the portal" border="true":::
48+
:::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":::
4949

5050
## Choose a subscription
5151

@@ -57,11 +57,11 @@ A resource group is a container that holds related resources for your Azure solu
5757

5858
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 Cognitive Search resource.
5959

60-
:::image type="content" source="media/search-create-service-portal/new-resource-group.png" alt-text="Create a new resource group" border="true":::
60+
:::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":::
6161

6262
Over time, you can track current and projected costs all-up or you can view charges for individual resources. The following screenshot shows the kind of cost information you can expect to see when you combine multiple resources into one group.
6363

64-
:::image type="content" source="media/search-create-service-portal/resource-group-cost-management.png" alt-text="Manage costs at the resource group level" border="true":::
64+
:::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":::
6565

6666
> [!TIP]
6767
> 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.
@@ -91,13 +91,13 @@ Two notable exceptions might lead to provisioning one or more search services in
9191

9292
+ [Outbound connections from Cognitive Search to Azure Storage](search-indexer-securing-resources.md). You might want storage in a different region if you're enabling a firewall.
9393

94-
+ Business continuity and disaster recovery (BCDR) requirements dictate creating multiple search services in [regional pairs](../availability-zones/cross-region-replication-azure.md#azure-cross-region-replication-pairings-for-all-geographies). For example, if you're operating in North America, you might choose East US and West US, or North Central US and South Centra US, for each search service.
94+
+ Business continuity and disaster recovery (BCDR) requirements dictate creating multiple search services in [regional pairs](../availability-zones/cross-region-replication-azure.md#azure-cross-region-replication-pairings-for-all-geographies). 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.
9595

9696
Some features are subject to regional availability. If you require any of following features, choose a region that provides them:
9797

9898
+ [AI enrichment](cognitive-search-concept-intro.md) requires Cognitive Services to be in the same physical region as Azure Cognitive 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.
9999

100-
:::image type="content" source="media/search-create-service-portal/region-availability.png" alt-text="Regional availability" border="true":::
100+
:::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":::
101101

102102
+ Semantic search is [currently in preview in selected regions](https://azure.microsoft.com/global-infrastructure/services/?products=search), such as "Australia East" in the above screenshot.
103103

@@ -112,29 +112,34 @@ Azure Cognitive Search is currently offered in [multiple pricing tiers](https://
112112

113113
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.
114114

115-
:::image type="content" source="media/search-create-service-portal/select-pricing-tier.png" alt-text="Screenshot of Select a pricing tier page" border="true":::
115+
:::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":::
116116

117117
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.
118118

119119
## Create your service
120120

121121
After you've provided the necessary inputs, go ahead and create the service.
122122

123-
:::image type="content" source="media/search-create-service-portal/new-service3.png" alt-text="Review and create the service" border="true":::
123+
:::image type="content" source="media/search-create-service-portal/new-service3.png" lightbox="media/search-create-service-portal/new-service3.png" alt-text="Screenshot of the Review and create the service page." border="true":::
124124

125125
Your service is deployed within minutes. You can monitor progress through Azure notifications. Consider pinning the service to your dashboard for easy access in the future.
126126

127-
:::image type="content" source="media/search-create-service-portal/monitor-notifications.png" alt-text="Monitor and pin the service" border="true":::
127+
:::image type="content" source="media/search-create-service-portal/monitor-notifications.png" lightbox="media/search-create-service-portal/monitor-notifications.png" alt-text="Screenshot of the monitor and pin the service page." border="true":::
128128

129-
## Get a key and URL endpoint
129+
## Configure authentication
130130

131-
Unless you're using the portal, programmatic access to your new service requires that you provide the URL endpoint and an authenticated connection. [Azure role-based access control with Azure Active Directory](search-security-rbac.md) is in public preview. [Key-based authentication](search-security-api-keys.md) is the default. It's also the only generally available authentication methodology for inbound connections to a search service.
131+
Unless you're using the portal, programmatic access to your new service requires that you provide the URL endpoint and an authenticated connection. You can use either or both of these options:
132132

133-
1. On the **Overview** page, locate and copy the URL endpoint on the right side of the page.
133+
+ [Connect using key-based authentication](search-security-api-keys.md)
134+
+ [Connect using Azure roles](search-security-rbac.md)
134135

135-
1. On the **Keys** page, copy either one of the admin keys (they're equivalent). Admin API keys are required for creating, updating, and deleting objects on your service. In contrast, query keys provide read-access to index content.
136+
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.
136137

137-
:::image type="content" source="media/search-create-service-portal/get-url-key.png" alt-text="Service overview page with URL endpoint" border="false":::
138+
:::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":::
139+
140+
1. To set authentication options, use the **Keys** page. Most quickstarts and tutorials use API keys for simplicity, but if you're setting up a service for production workloads, consider using Azure roles. You can copy keys from this page.
141+
142+
:::image type="content" source="media/search-create-service-portal/set-authentication-options.png" lightbox="media/search-create-service-portal/set-authentication-options.png" alt-text="Screenshot of the keys page with authentication options." border="true":::
138143

139144
An endpoint and key aren't needed for portal-based tasks. The portal is already linked to your Azure Cognitive Search resource with admin rights. For a portal walkthrough, start with [Quickstart: Create an Azure Cognitive Search index in the portal](search-get-started-portal.md).
140145

@@ -148,14 +153,14 @@ After a search service is provisioned, you can [scale it to meet your needs](sea
148153

149154
Adding resources increases your monthly bill. The [pricing calculator](https://azure.microsoft.com/pricing/calculator/) can help you understand the billing ramifications of adding resources. Remember that you can adjust resources based on load. For example, you might increase resources to create a full initial index, and then reduce resources later to a level more appropriate for incremental indexing.
150155

151-
> [!Important]
156+
> [!IMPORTANT]
152157
> A service must have [2 replicas for read-only SLA and 3 replicas for read/write SLA](https://azure.microsoft.com/support/legal/sla/search/v1_0/).
153158
154159
1. Go to your search service page in the Azure portal.
155160
1. In the left-navigation pane, select **Settings** > **Scale**.
156161
1. Use the slidebar to add resources of either type.
157162

158-
:::image type="content" source="media/search-create-service-portal/settings-scale.png" alt-text="Add capacity through replicas and partitions" border="true":::
163+
:::image type="content" source="media/search-create-service-portal/settings-scale.png" lightbox="media/search-create-service-portal/settings-scale.png" alt-text="Screenshot of the add capacity page." border="true":::
159164

160165
## When to add a second service
161166

articles/search/tutorial-create-custom-analyzer.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ Source code for this tutorial is in the [custom-analyzers](https://github.com/Az
3939

4040
To complete this tutorial, you'll need an Azure Cognitive Search service, which you can [create in the portal](search-create-service-portal.md). You can use the Free tier to complete this walkthrough.
4141

42-
For the next step, you'll need to know the name of your search service and its API Key. If you're unsure how to find those items, check out this [quickstart](search-create-service-portal.md#get-a-key-and-url-endpoint).
43-
42+
For the next step, you'll need to know the name of your search service and its API Key. If you're unsure how to find those items, check out this [REST quickstart](search-get-started-rest.md).
4443

4544
## 2 - Set up Postman
4645

0 commit comments

Comments
 (0)