Skip to content

Commit 70349b8

Browse files
authored
Merge pull request #222027 from HeidiSteen/heidist-privacy
[azure search] Data privacy doc updates
2 parents 51c0dc0 + 5fcc49d commit 70349b8

File tree

3 files changed

+52
-12
lines changed

3 files changed

+52
-12
lines changed
56.8 KB
Loading

articles/search/search-manage.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: heidist
99
tags: azure-portal
1010
ms.service: cognitive-search
1111
ms.topic: conceptual
12-
ms.date: 05/23/2022
12+
ms.date: 12/21/2022
1313
---
1414
# Service administration for Azure Cognitive Search in the Azure portal
1515

@@ -34,7 +34,7 @@ Each search service is managed as a standalone resource. The following image sho
3434

3535
## Overview (home) page
3636

37-
The overview page is the "home" page of each service. Below, the areas on the screen enclosed in red boxes indicate tasks, tools, and tiles that you might use often, especially if you are new to the service.
37+
The overview page is the "home" page of each service. In the following screenshot, the areas on the screen enclosed in red boxes indicate tasks, tools, and tiles that you might use often, especially if you're new to the service.
3838

3939
:::image type="content" source="media/search-manage/search-portal-overview-page.png" alt-text="Portal pages for a search service" border="true":::
4040

@@ -43,7 +43,7 @@ The overview page is the "home" page of each service. Below, the areas on the sc
4343
| 1 | The **Essentials** section lists service properties, such as the service endpoint, service tier, and replica and partition counts. |
4444
| 2 | A command bar at the top of the page includes [Import data](search-get-started-portal.md) and [Search explorer](search-explorer.md), used for prototyping and exploration. |
4545
| 3 | Tabbed pages in the center provide quick access to usage statistics, service health metrics, and access to all of the existing indexes, indexers, data sources, and skillsets.|
46-
| 4 | Navigation links are to the left. |
46+
| 4 | Navigation links to other pages. |
4747

4848
### Read-only service properties
4949

@@ -55,7 +55,7 @@ Several aspects of a search service are determined when the service is provision
5555

5656
<sup>1</sup> Although there are ARM and bicep templates for service deployment, moving content is a manual job.
5757

58-
<sup>2</sup> Switching tiers requires creating a new service or filing a support ticket to request a tier upgrade.
58+
<sup>2</sup> Switching a tier requires creating a new service or filing a support ticket to request a tier upgrade.
5959

6060
## Management tasks
6161

@@ -68,7 +68,7 @@ Service administration includes the following tasks:
6868
* [Configure a private endpoint](service-create-private-endpoint.md) using Azure Private Link and a private virtual network
6969
* [Monitor service health and operations](monitor-azure-cognitive-search.md): storage, query volumes, and latency
7070

71-
There is feature parity across all modalities and languages except for preview management features. In general, preview management features are released through the Management REST API first. Programmatic support for service administration can be found in the following APIs and modules:
71+
There's feature parity across all modalities and languages except for preview management features. In general, preview management features are released through the Management REST API first. Programmatic support for service administration can be found in the following APIs and modules:
7272

7373
* [Management REST API reference](/rest/api/searchmanagement/)
7474
* [Az.Search PowerShell module](search-manage-powershell.md)
@@ -78,15 +78,27 @@ You can also use the management client libraries in the Azure SDKs for .NET, Pyt
7878

7979
## Data collection and retention
8080

81-
Cognitive Search uses other Azure services for deeper monitoring and management. By itself, the only persistent data stored within the search service are the structures that support indexing, enrichment, and queries. These structures include indexes, indexers, data sources, skillsets, and synonym maps. All other saved data, including debug session state and caching, is placed in Azure Storage.
81+
Because Azure Cognitive Search is a [monitored resource](/azure/azure-monitor/monitor-reference), you can review the built-in [**activity logs**](/azure/azure-monitor/essentials/activity-log) and [**platform metrics**](/azure/azure-monitor/essentials/data-platform-metrics#types-of-metrics) for insights into service operations. Activity logs and the data used to report on platform metrics are retained for the periods described in the following table.
8282

83-
Metrics reported out to portal pages are pulled from internal logs on a rolling 30-day cycle. For user-controlled log retention and more events, you will need [Azure Monitor](../azure-monitor/index.yml) and a supported approach for retaining log data. For more information about setting up resource logging for a search service, see [Collect and analyze log data](monitor-azure-cognitive-search.md).
83+
If you opt in for [**resource logging**](/azure/azure-monitor/essentials/resource-logs), you'll specify durable storage over which you'll have full control over data retention and data access through Kusto queries. For more information on how to set up resource logging in Cognitive Search, see [Collect and analyze log data](monitor-azure-cognitive-search.md).
84+
85+
Internally, Microsoft collects telemetry data about your service and the platform. It's stored internally in Microsoft data centers and made globally available to Microsoft support engineers when you open a support ticket.
86+
87+
| Monitoring data | Retention |
88+
|-----------------|-----------|
89+
| Activity logs | 90 days on a rolling schedule |
90+
| Platform metrics | 93 days on a rolling schedule, except that portal visualization is limited to a 30 day window |
91+
| Resource logs | User-managed |
92+
| Telemetry | One and a half years |
93+
94+
> [!NOTE]
95+
> This section is about monitoring data. For questions about customer data and privacy, see the ["Data residency"](search-security-overview.md#data-residency) section of the security overview article.
8496
8597
## Administrator permissions
8698

8799
When you open the search service overview page, the Azure role assigned to your account determines what portal content is available to you. The overview page at the beginning of the article shows the portal content available to an Owner or Contributor.
88100

89-
Control plane roles include the following:
101+
Control plane roles include the following items:
90102

91103
* Owner
92104
* Contributor (same as Owner, minus the ability to assign roles)

articles/search/search-security-overview.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: heidist
99
ms.service: cognitive-search
1010
ms.custom: ignite-2022
1111
ms.topic: conceptual
12-
ms.date: 12/12/2022
12+
ms.date: 12/21/2022
1313
---
1414

1515
# Security overview for Azure Cognitive Search
@@ -58,6 +58,10 @@ Outbound connections can be made using a resource's full access connection strin
5858

5959
If your Azure resource is behind a firewall, you'll need to [create rules that admit search service requests](search-indexer-howto-access-ip-restricted.md). For resources protected by Azure Private Link, you can [create a shared private link](search-indexer-howto-access-private.md) that an indexer uses to make its connection.
6060

61+
#### Exception for same-region search and storage services
62+
63+
If Storage and Search are in the same region, network traffic is routed through a private IP address and occurs over the Microsoft backbone network. Because private IP addresses are used, you can't configure IP firewalls or a private endpoint for network security. Instead, use the [trusted service exception](search-indexer-howto-access-trusted-service-exception.md) as an alternative when both services are in the same region.
64+
6165
### Internal traffic
6266

6367
Internal requests are secured and managed by Microsoft. You can't configure or control these connections. If you're locking down network access, no action on your part is required because internal traffic isn't customer-configurable.
@@ -156,11 +160,35 @@ In Azure Cognitive Search, Resource Manager is used to create or delete the serv
156160
157161
## Data residency
158162

159-
When you set up a search service, you choose a location or region that determines where data is stored and processed. Azure Cognitive Search won't store data outside of your specified region unless you configure a feature that has a dependency on another Azure resource, and that resource is provisioned in a different region.
163+
When you set up a search service, you choose a location or region that determines where customer data is stored and processed. Azure Cognitive Search won't store customer data outside of your specified region unless you configure a feature that has a dependency on another Azure resource, and that resource is provisioned in a different region.
164+
165+
Currently, the only external resource that a search service writes customer data to is Azure Storage. The storage account is one that you provide, and it could be in any region. A search service will write to Azure Storage if you use any of the following features: [enrichment cache](cognitive-search-incremental-indexing-conceptual.md), [debug session](cognitive-search-debug-session.md), [knowledge store](knowledge-store-concept-intro.md).
166+
167+
### Exceptions to data residency commitments
168+
169+
Although customer data isn't stored outside of your region, object names will appear in the telemetry logs used by Microsoft Support to troubleshoot your service issues. Object names are considered customer data. Names in telemetry logs include those of indexes, indexers, data sources, skillsets, containers, and key vault store.
170+
171+
Object names aren't obfuscated in the telemetry logs. If possible, avoid using names that convey sensitive information.
172+
173+
Telemetry logs are retained for one and a half years. During that period, support engineers might access and reference object names under these conditions:
174+
175+
+ Diagnose an issue, improve a feature, or fix a bug. In this scenario, data access is internal only, with no third-party access.
176+
177+
+ Proactively suggest to the original customer a workaround or alternative. For example, "Based on your usage of the product, consider using `<feature name>` since it would perform better." In this scenario, Microsoft might expose an object name through dashboards visible to the customer.
178+
179+
Upon request, Microsoft can shorten the retention interval or remove references to specific objects in the telemetry logs. Remember that if you request data removal, the trade off is reduced ability to troubleshoot any issues related to the object in question.
180+
181+
To remove references to specific objects, or to change the data retention period, [file a support ticket](/azure/azure-portal/supportability/how-to-create-azure-support-request) for your search service.
182+
183+
1. In **Problem details**, tag your request using the following selections:
184+
185+
+ **Issue type**: Technical
186+
+ **Problem type**: Setup and configuration
187+
+ **Problem subtype**: Issue with security configuration of the service
160188

161-
The only external resource that a search service writes to is Azure Storage. The storage account is one that you provide, and it could be in any region. A search service will write to Azure Storage if you use any of the following features: [enrichment cache](cognitive-search-incremental-indexing-conceptual.md), [debug session](cognitive-search-debug-session.md), [knowledge store](knowledge-store-concept-intro.md).
189+
1. When you get to **Additional details** (the third tab), describe the object names you would like removed, or specify the retention period that you require.
162190

163-
If both the storage account and the search service are in the same region, network traffic between search and storage uses a private IP address and occurs over the Microsoft backbone network. Because private IP addresses are used, you can't configure IP firewalls or a private endpoint for network security. Instead, use the [trusted service exception](search-indexer-howto-access-trusted-service-exception.md) as an alternative when both services are in the same region.
191+
:::image type="content" source="media/search-security-overview/support-request.png" alt-text="Screenshot of the first page of the support ticket with issue and problem types selected." border="true":::
164192

165193
<a name="encryption"></a>
166194

0 commit comments

Comments
 (0)