|
1 | 1 | ---
|
2 |
| -title: Portal administration |
| 2 | +title: Service Configuration in the Azure portal |
3 | 3 | titleSuffix: Azure AI Search
|
4 |
| -description: Manage an Azure AI Search resource using the Azure portal. |
5 |
| - |
| 4 | +description: Manage your new Azure AI Search service in the Azure portal. This article provides a day-one checklist for configuring RBAC, managed identities, network security, and more. |
6 | 5 | manager: nitinme
|
7 | 6 | author: haileytap
|
8 | 7 | ms.author: haileytapia
|
9 | 8 | ms.service: azure-ai-search
|
10 |
| -ms.topic: conceptual |
11 |
| -ms.date: 12/10/2024 |
| 9 | +ms.topic: how-to |
| 10 | +ms.date: 03/04/2025 |
12 | 11 | ---
|
13 | 12 |
|
14 |
| -# Service administration for Azure AI Search in the Azure portal |
15 |
| - |
16 |
| -> [!div class="op_single_selector"] |
17 |
| -> |
18 |
| -> + [PowerShell](search-manage-powershell.md) |
19 |
| -> + [Azure CLI](search-manage-azure-cli.md) |
20 |
| -> + [REST API](search-manage-rest.md) |
| 13 | +# Configure your Azure AI Search service in the Azure portal |
21 | 14 |
|
22 |
| -In Azure AI Search, the [Azure portal](https://portal.azure.com) supports a broad range of administrative and content management operations so that you don't have to write code unless you want automation. |
| 15 | +Configuring your new Azure AI Search service involves several tasks to optimize security, access, and performance. This article provides a day-one checklist to help you set up your service in the [Azure portal](https://portal.azure.com). |
23 | 16 |
|
24 |
| -Each search service is managed as a standalone resource. Your role assignment determines what operations are exposed in the Azure portal. |
| 17 | +After you create a search service, we recommend that you: |
25 | 18 |
|
26 |
| -## Portal and administrator permissions |
| 19 | +> [!div class="checklist"] |
| 20 | +> |
| 21 | +> + [Configure role-based access](#configure-role-based-access) |
| 22 | +> + [Configure a managed identity](#configure-a-managed-identity) |
| 23 | +> + [Configure network security](#configure-network-security) |
| 24 | +> + [Check capacity and understand billing](#check-capacity-and-understand-billing) |
| 25 | +> + [Enable diagnostic logging](#enable-diagnostic-logging) |
| 26 | +> + [Provide connection information to developers](#provide-connection-information-to-developers) |
27 | 27 |
|
28 |
| -Portal access is through [role assignments](search-security-rbac.md). By default, all search services start with at least one Service Administrator or Owner. Service administrators, co-administrators, and owners have permission to create other administrators and other role assignments. They have full access to all portal pages and operations on a default search service. |
| 28 | +## Configure role-based access |
29 | 29 |
|
30 |
| -If you disable API keys on a search service and use roles only, administrators must grant themselves data plane role assignments for full access to objects and data. These role assignments include Search Service Contributor, Search Index Data Contributor, and Search Index Data Reader. |
| 30 | +Portal access is based on [role assignments](search-security-rbac.md). By default, new search services have at least one service administrator or owner. Service administrators, co-administrators, and owners have permission to create more administrators and assign other roles. They also have access to all portal pages and operations on default search services. |
31 | 31 |
|
32 | 32 | > [!TIP]
|
33 |
| -> By default, any owner or administrator can create or delete services. To prevent accidental deletions, you can [lock resources](/azure/azure-resource-manager/management/lock-resources). |
34 |
| -
|
35 |
| -## Azure portal at a glance |
36 |
| - |
37 |
| -The overview page is the home page of each service. In the following screenshot, the red boxes indicate tasks, tools, and tiles that you might use often, especially if you're new to the service. |
| 33 | +> By default, any administrator or owner can create or delete services. To prevent accidental deletions, consider [locking your resources](/azure/azure-resource-manager/management/lock-resources). |
38 | 34 |
|
39 |
| -:::image type="content" source="media/search-manage/search-portal-overview-page.png" alt-text="Portal pages for a search service" border="true"::: |
| 35 | +Each search service comes with [API keys](search-security-api-keys.md) and uses key-based authentication by default. However, we recommend using Microsoft Entra ID and role-based access control (RBAC) for improved security. RBAC eliminates the need to store and pass API keys in plain text. |
40 | 36 |
|
41 |
| -| Area | Description | |
42 |
| -|------|-------------| |
43 |
| -| 1 | A command bar at the top of the page includes [Import data wizard](search-get-started-portal.md) and [Search explorer](search-explorer.md), used for prototyping and exploration. | |
44 |
| -| 2 | The **Essentials** section lists service properties, such as the service endpoint, service tier, and replica and partition counts. | |
45 |
| -| 3 | Tabbed pages in the center provide quick access to usage statistics and service health metrics. | |
46 |
| -| 4 | Navigation links to existing indexes, indexers, data sources, and skillsets. | |
| 37 | +When you switch from key-based authentication to keyless authentication, service administrators must assign themselves data plane roles for full access to objects and data. These roles include Search Service Contributor, Search Index Data Contributor, and Search Index Data Reader. |
47 | 38 |
|
48 |
| -You can't change the search service name, subscription, resource group, region (location), or tier. Switching tiers requires creating a new service or filing a support ticket to request a tier upgrade, which is only supported for Basic and higher. |
| 39 | +To configure role-based access: |
49 | 40 |
|
50 |
| -## Day-one management checklist |
| 41 | +1. [Enable roles](search-security-enable-roles.md) on your search service. We recommend using both API keys and roles. |
51 | 42 |
|
52 |
| -On a new search service, we recommend these configuration tasks. |
| 43 | +1. [Assign data plane roles](search-security-rbac.md) to replace the functionality lost when you disable API keys. An owner only needs Search Index Data Reader, but developers need [more roles](search-security-rbac.md#assign-roles). |
53 | 44 |
|
54 |
| -### Enable role-based access |
| 45 | + Role assignments can take several minutes to take effect. Until then, portal pages used for data plane operations display the following message: |
55 | 46 |
|
56 |
| -A search service is always created with [API keys](search-security-api-keys.md) and uses key-based authentication by default. However, using Microsoft Entra ID and role assignments is a more secure option because it eliminates storing and passing keys in plain text. |
| 47 | + :::image type="content" source="media/search-security-rbac/you-do-not-have-access.png" alt-text="Screenshot of the portal message indicating insufficient permissions."::: |
57 | 48 |
|
58 |
| -1. [Enable roles](search-security-enable-roles.md) on your search service. We recommend the roles-only option. |
| 49 | +1. [Assign more roles](search-security-rbac.md) for solution developers and apps. |
59 | 50 |
|
60 |
| -1. For administration, [assign data plane roles](search-security-rbac.md) to replace the functionality lost when you disable API keys. Role assignments include Search Service Contributor, Search Index Data Contributor, and Search Index Data Reader. You need all three. |
| 51 | +## Configure a managed identity |
61 | 52 |
|
62 |
| - Sometimes it can take five to ten minutes for role assignments to take effect. Until that happens, the following message appears in the Azure portal pages used for data plane operations. |
| 53 | +If you plan to use indexers for automated indexing, applied AI, or integrated vectorization, you should [configure your search service to use a managed identity](search-howto-managed-identities-data-sources.md). You can then assign roles on other Azure services that authorize your search service to access data and operations. |
63 | 54 |
|
64 |
| - :::image type="content" source="media/search-security-rbac/you-do-not-have-access.png" alt-text="Screenshot of portal message indicating insufficient permissions."::: |
65 |
| - |
66 |
| -1. Continue to [add more role assignments](search-security-rbac.md) for solution developers and apps. |
67 |
| - |
68 |
| -### Configure a managed identity |
69 |
| - |
70 |
| -If you plan to use indexers for automated indexing, applied AI, or integrated vectorization, you should [configure the search service to use a managed identity](search-howto-managed-identities-data-sources.md). You can then add role assignments on other Azure services that authorize your search service to access data and operations. |
71 |
| - |
72 |
| -For integrated vectorization, a search service identity needs: |
| 55 | +For integrated vectorization, your search service identity needs the following roles: |
73 | 56 |
|
74 | 57 | + Storage Blob Data Reader on Azure Storage
|
75 | 58 | + Cognitive Services Data User on an Azure AI multiservice account
|
76 | 59 |
|
77 |
| -It can take several minutes for role assignments to take effect. |
78 |
| - |
79 |
| -Before moving on to network security, consider testing all points of connection to validate role assignments. Run either the [Import data wizard](search-get-started-portal.md) or the [Import and vectorize data wizard](search-get-started-portal-image-search.md) to test permissions. |
| 60 | +Role assignments can take several minutes to take effect. |
80 | 61 |
|
81 |
| -### Configure network security |
| 62 | +Before you move on to network security, consider testing all points of connection to validate role assignments. Run either the [**Import data** wizard](search-get-started-portal.md) or the [**Import and vectorize data** wizard](search-get-started-portal-image-search.md) to test permissions. |
82 | 63 |
|
83 |
| -By default, a search service accepts authenticated and authorized requests over public internet connections. Network security restricts access through firewall rules, or by disabling public connections and allowing requests only from Azure virtual networks. |
| 64 | +## Configure network security |
84 | 65 |
|
85 |
| -+ [Configure network access](service-configure-firewall.md) to restrict access by IP addresses. |
86 |
| -+ [Configure a private endpoint](service-create-private-endpoint.md) using Azure Private Link and a private virtual network. |
| 66 | +By default, a search service accepts authenticated and authorized requests over public internet connections. You have two options for enhancing network security: |
87 | 67 |
|
88 |
| -[Security in Azure AI Search](search-security-overview.md) explains inbound and outbound calls in Azure AI Search. |
| 68 | ++ [Configure firewall rules](service-configure-firewall.md) to restrict network access by IP address. |
| 69 | ++ [Configure a private endpoint](service-create-private-endpoint.md) to only allow traffic from Azure virtual networks. Note that when you turn off the public endpoint, the import wizards won't run. |
89 | 70 |
|
90 |
| -### Check capacity and understand billing |
| 71 | +To learn about inbound and outbound calls in Azure AI Search, see [Security in Azure AI Search](search-security-overview.md). |
91 | 72 |
|
92 |
| -By default, a search service is created in a minimum configuration of one replica and partition each. You can [add capacity](search-capacity-planning.md) by adding replicas and partitions, but we recommend waiting until volumes require it. Many customers run production workloads on the minimum configuration. |
| 73 | +## Check capacity and understand billing |
93 | 74 |
|
94 |
| -Some features add to the cost of running the service: |
| 75 | +By default, a search service is created with one replica and one partition. You can [add capacity](search-capacity-planning.md) by adding replicas and partitions, but we recommend waiting until volumes require it. Many customers run production workloads on the minimum configuration. |
95 | 76 |
|
96 |
| -+ [How you're charged for Azure AI Search](search-sku-manage-costs.md#how-youre-charged-for-azure-ai-search) explains which features have billing impact. |
97 |
| -+ [(Optional) disable semantic ranker](semantic-how-to-enable-disable.md) at the service level to prevent usage of the feature. |
| 77 | +Semantic ranker increases the cost of running your service. If you don't want to use this feature, you can [disable semantic ranker](semantic-how-to-enable-disable.md) at the service level. |
98 | 78 |
|
99 |
| -### Enable diagnostic logging |
| 79 | +To learn about other features that affect billing, see [How you're charged for Azure AI Search](search-sku-manage-costs.md#how-youre-charged-for-azure-ai-search). |
100 | 80 |
|
101 |
| -[Enable diagnostic logging](search-monitor-enable-logging.md) to track user activity. If you skip this step, you still get [activity logs](/azure/azure-monitor/essentials/activity-log) and [platform metrics](/azure/azure-monitor/essentials/data-platform-metrics#types-of-metrics) automatically, but if you want index and query usage information, you should enable diagnostic logging and choose a destination for logged operations. |
| 81 | +## Enable diagnostic logging |
102 | 82 |
|
103 |
| -We recommend Log Analytics Workspace for durable storage so that you can run system queries in the Azure portal. |
| 83 | +[Enable diagnostic logging](search-monitor-enable-logging.md) to track user activity. If you skip this step, you still get [activity logs](/azure/azure-monitor/essentials/activity-log) and [platform metrics](/azure/azure-monitor/essentials/data-platform-metrics#types-of-metrics) automatically. However, if you want index and query usage information, you should enable diagnostic logging and choose a destination for logged operations. We recommend Log Analytics Workspace for durable storage so that you can run system queries in the Azure portal. |
104 | 84 |
|
105 | 85 | Internally, Microsoft collects telemetry data about your service and the platform. To learn more about data retention, see [Retention of metrics](/azure/azure-monitor/essentials/data-platform-metrics#retention-of-metrics).
|
106 | 86 |
|
107 |
| -> [!NOTE] |
108 |
| -> See the ["Data residency"](search-security-overview.md#data-residency) section of the security overview article for more information about data location and privacy. |
| 87 | +To learn more about data location and privacy, see [Data residency](search-security-overview.md#data-residency). |
109 | 88 |
|
110 |
| -### Enable semantic ranker |
| 89 | +## Enable semantic ranker |
111 | 90 |
|
112 |
| -Semantic ranker is free for the first 1,000 requests per month. It's enabled by default on newer services. |
| 91 | +Semantic ranker is free for the first 1,000 requests per month. It's enabled by default on newer search services. |
113 | 92 |
|
114 |
| -In Azure portal, under **Settings** on the leftmost pane, select **Semantic ranker** and then choose the Free plan. For more information, see [Enable semantic ranker](semantic-how-to-enable-disable.md). |
| 93 | +To enable semantic ranker in the portal, select **Settings** > **Semantic ranker** from the left pane, and then select the **Free** plan. For more information, see [Enable semantic ranker](semantic-how-to-enable-disable.md). |
115 | 94 |
|
116 |
| -### Provide connection information to developers |
| 95 | +## Provide connection information to developers |
117 | 96 |
|
118 |
| -Developers need the following information to connect to Azure AI Search: |
| 97 | +To connect to Azure AI Search, developers need: |
119 | 98 |
|
120 |
| -+ An endpoint or URL, provided on the **Overview** page. |
121 |
| -+ An API key from the **Keys** page, or a role assignment (contributor is recommended). |
| 99 | ++ An endpoint or URL from the **Overview** page. |
| 100 | ++ An API key from the **Keys** page or a role assignment. We recommend Search Service Contributor, Search Index Data Contributor, and Search Index Data Reader. |
122 | 101 |
|
123 |
| -We recommend portal access for the following wizards and tools: [Import data wizard](search-get-started-portal.md), [Import and vectorize data](search-get-started-portal-import-vectors.md), [Search explorer](search-explorer.md). Recall that a user must be a contributor or above to run the import wizards. |
| 102 | +We recommend portal access for the [**Import data** wizard](search-get-started-portal.md), the [**Import and vectorize data** wizard](search-get-started-portal-import-vectors.md), and [Search explorer](search-explorer.md). You must be a contributor or higher to run the wizards. |
124 | 103 |
|
125 |
| -## Next steps |
| 104 | +## Related content |
126 | 105 |
|
127 |
| -Programmatic support for service administration can be found in the following APIs and modules: |
| 106 | +For programmatic support for service administration, see the following APIs and modules: |
128 | 107 |
|
129 |
| -* [Management REST API reference](/rest/api/searchmanagement/) |
130 |
| -* [Az.Search PowerShell module](search-manage-powershell.md) |
131 |
| -* [az search Azure CLI module](search-manage-azure-cli.md) |
| 108 | ++ [Management REST API reference](/rest/api/searchmanagement/) |
| 109 | ++ [Az.Search PowerShell module](search-manage-powershell.md) |
| 110 | ++ [az search Azure CLI module](search-manage-azure-cli.md) |
132 | 111 |
|
133 |
| -You can also use the management client libraries in the Azure SDKs for .NET, Python, Java, and JavaScript. |
| 112 | +You can also use the management client libraries in the Azure SDKs for .NET, Python, Java, and JavaScript. |
134 | 113 |
|
135 |
| -There's feature parity across all modalities and languages, except for preview management features. As a general rule, preview management features are released through the Management REST API first. |
| 114 | +There's feature parity across all modalities and languages, except for preview management features. As a general rule, preview management features are released through the Management REST API first. |
0 commit comments