Skip to content

Commit fada463

Browse files
authored
Merge pull request #187438 from ThomasWeiss/thweiss-cosmosdb-atp-to-defender
Renamed ATP to Defender for Cosmos DB
2 parents 99c4029 + d6b7209 commit fada463

12 files changed

+117
-120
lines changed

articles/cosmos-db/.openpublishing.redirection.cosmos-db.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3595,6 +3595,11 @@
35953595
"source_path_from_root": "/articles/cosmos-db/sql/create-sql-api-xamarin-dotnet.md",
35963596
"redirect_url": "/azure/architecture/solution-ideas/articles/gaming-using-cosmos-db",
35973597
"redirect_document_id": false
3598+
},
3599+
{
3600+
"source_path_from_root": "/articles/cosmos-db/sql/advanced-threat-protection.md",
3601+
"redirect_url": "/azure/cosmos-db/sql/defender-for-cosmos-db",
3602+
"redirect_document_id": false
35983603
}
35993604
]
36003605
}

articles/cosmos-db/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -656,8 +656,8 @@
656656
- name: Secure access to data
657657
displayName: primary key, resource token, users, roles
658658
href: secure-access-to-data.md
659-
- name: Advanced threat protection
660-
href: sql/advanced-threat-protection.md
659+
- name: Threat protection with Microsoft Defender
660+
href: sql/defender-for-cosmos-db.md
661661
- name: Partial document update
662662
items:
663663
- name: Partial document update overview

articles/cosmos-db/sql/advanced-threat-protection.md

Lines changed: 0 additions & 118 deletions
This file was deleted.
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: 'Microsoft Defender for Azure Cosmos DB'
3+
description: Learn how Microsoft Defender provides advanced threat protection on Azure Cosmos DB.
4+
ms.service: cosmos-db
5+
ms.subservice: cosmosdb-sql
6+
ms.topic: conceptual
7+
ms.date: 02/03/2022
8+
ms.author: thweiss
9+
author: ThomasWeiss
10+
---
11+
12+
# Microsoft Defender for Cosmos DB (Preview)
13+
[!INCLUDE[appliesto-sql-api](../includes/appliesto-sql-api.md)]
14+
15+
Microsoft Defender for Cosmos DB provides an extra layer of security intelligence that detects unusual and potentially harmful attempts to access or exploit Azure Cosmos DB accounts. This layer of protection allows you to address threats, even without being a security expert, and integrate them with central security monitoring systems.
16+
17+
Security alerts are triggered when anomalies in activity occur. These security alerts show up in [Microsoft Defender for Cloud](https://azure.microsoft.com/services/security-center/). Subscription administrators also get these alerts over email, with details of the suspicious activity and recommendations on how to investigate and remediate the threats.
18+
19+
> [!NOTE]
20+
>
21+
> * Microsoft Defender for Cosmos DB is currently available only for the Core (SQL) API.
22+
> * Microsoft Defender for Cosmos DB is not currently available in Azure government and sovereign cloud regions.
23+
24+
For a full investigation experience of the security alerts, we recommended enabling [diagnostic logging in Azure Cosmos DB](../monitor-cosmos-db.md), which logs operations on the database itself, including CRUD operations on all documents, containers, and databases.
25+
26+
## Threat types
27+
28+
Microsoft Defender for Cosmos DB detects anomalous activities indicating unusual and potentially harmful attempts to access or exploit databases. It can currently trigger the following alerts:
29+
30+
- **Access from unusual locations**: This alert is triggered when there is a change in the access pattern to an Azure Cosmos DB account, where someone has connected to the Azure Cosmos DB endpoint from an unusual geographical location. In some cases, the alert detects a legitimate action, meaning a new application or developer’s maintenance operation. In other cases, the alert detects a malicious action from a former employee, external attacker, etc.
31+
32+
- **Unusual data extraction**: This alert is triggered when a client is extracting an unusual amount of data from an Azure Cosmos DB account. It can be the symptom of some data exfiltration performed to transfer all the data stored in the account to an external data store.
33+
34+
## Configure Microsoft Defender for Cosmos DB
35+
36+
You can configure Microsoft Defender protection in any of several ways, described in the following sections.
37+
38+
# [Portal](#tab/azure-portal)
39+
40+
1. Launch the Azure portal at [https://portal.azure.com](https://portal.azure.com/).
41+
42+
2. From the Azure Cosmos DB account, from the **Settings** menu, select **Microsoft Defender for Cloud**.
43+
44+
:::image type="content" source="./media/defender-for-cosmos-db/cosmos-db-atp.png" alt-text="Set up Azure Defender for Cosmos DB" border="true":::
45+
46+
3. In the **Microsoft Defender for Cloud** configuration blade:
47+
48+
* Change the option from **OFF** to **ON**.
49+
* Click **Save**.
50+
51+
# [REST API](#tab/rest-api)
52+
53+
Use Rest API commands to create, update, or get the Azure Defender setting for a specific Azure Cosmos DB account.
54+
55+
* [Advanced Threat Protection - Create](/rest/api/securitycenter/advancedthreatprotection/create)
56+
* [Advanced Threat Protection - Get](/rest/api/securitycenter/advancedthreatprotection/get)
57+
58+
# [PowerShell](#tab/azure-powershell)
59+
60+
Use the following PowerShell cmdlets:
61+
62+
* [Enable Advanced Threat Protection](/powershell/module/az.security/enable-azsecurityadvancedthreatprotection)
63+
* [Get Advanced Threat Protection](/powershell/module/az.security/get-azsecurityadvancedthreatprotection)
64+
* [Disable Advanced Threat Protection](/powershell/module/az.security/disable-azsecurityadvancedthreatprotection)
65+
66+
# [ARM template](#tab/arm-template)
67+
68+
Use an Azure Resource Manager (ARM) template to set up Azure Cosmos DB with Azure Defender protection enabled. For more information, see
69+
[Create a CosmosDB Account with Advanced Threat Protection](https://azure.microsoft.com/resources/templates/cosmosdb-advanced-threat-protection-create-account/).
70+
71+
# [Azure Policy](#tab/azure-policy)
72+
73+
Use an Azure Policy to enable Azure Defender for Cosmos DB.
74+
75+
1. Launch the Azure **Policy - Definitions** page, and search for the **Deploy Advanced Threat Protection for Cosmos DB** policy.
76+
77+
:::image type="content" source="./media/defender-for-cosmos-db/cosmos-db.png" alt-text="Search Policy":::
78+
79+
1. Click on the **Deploy Advanced Threat Protection for CosmosDB** policy, and then click **Assign**.
80+
81+
:::image type="content" source="./media/defender-for-cosmos-db/cosmos-db-atp-policy.png" alt-text="Select Subscription Or Group":::
82+
83+
1. From the **Scope** field, click the three dots, select an Azure subscription or resource group, and then click **Select**.
84+
85+
:::image type="content" source="./media/defender-for-cosmos-db/cosmos-db-atp-details.png" alt-text="Policy Definitions Page":::
86+
87+
1. Enter the other parameters, and click **Assign**.
88+
89+
---
90+
91+
## Manage security alerts
92+
93+
When Azure Cosmos DB activity anomalies occur, a security alert is triggered with information about the suspicious security event.
94+
95+
From Microsoft Defender for Cloud, you can review and manage your current [security alerts](../../security-center/security-center-alerts-overview.md). Click on a specific alert in [Defender for Cloud](https://ms.portal.azure.com/#blade/Microsoft_Azure_Security/SecurityMenuBlade/0) to view possible causes and recommended actions to investigate and mitigate the potential threat. The following image shows an example of alert details provided in Defender for Cloud.
96+
97+
:::image type="content" source="./media/defender-for-cosmos-db/cosmos-db-alert-details.png" alt-text="Threat details":::
98+
99+
An email notification is also sent with the alert details and recommended actions. The following image shows an example of an alert email.
100+
101+
:::image type="content" source="./media/defender-for-cosmos-db/cosmos-db-alert.png" alt-text="Alert details":::
102+
103+
## Azure Cosmos DB alerts
104+
105+
To see a list of the alerts generated when monitoring Azure Cosmos DB accounts, see the [Azure Cosmos DB alerts](../../security-center/alerts-reference.md#alerts-azurecosmos) section in the Microsoft Defender for Cloud documentation.
106+
107+
## Next steps
108+
109+
* Learn more about [Diagnostic logging in Azure Cosmos DB](../cosmosdb-monitor-resource-logs.md)
110+
* Learn more about [Microsoft Defender for Cloud](../../security-center/security-center-introduction.md)
Binary file not shown.

0 commit comments

Comments
 (0)