You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/protect-with-defender-for-apis.md
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,42 +6,48 @@ author: dlepow
6
6
7
7
ms.service: api-management
8
8
ms.topic: how-to
9
-
ms.date: 04/14/2023
9
+
ms.date: 04/19/2023
10
10
ms.author: danlep
11
11
---
12
12
# Enable advanced API security features using Microsoft Defender for Cloud
13
13
<!-- Update links to D4APIs docs when available -->
14
14
15
-
[Defender for APIs](https://aka.ms/apiSecurityOverview) (preview), a capability of [Microsoft Defender for Cloud](/azure/defender-for-cloud/defender-for-cloud-introduction), offers full lifecycle protection, detection, and response coverage for APIs that are managed in Azure API Management. The service empowers security practitioners to gain visibility into their business-critical APIs, understand their security posture, prioritize vulnerability fixes, and detect active runtime threats within minutes.
15
+
Defender for APIs, a capability of [Microsoft Defender for Cloud](/azure/defender-for-cloud/defender-for-cloud-introduction), offers full lifecycle protection, detection, and response coverage for APIs that are managed in Azure API Management. The service empowers security practitioners to gain visibility into their business-critical APIs, understand their security posture, prioritize vulnerability fixes, and detect active runtime threats within minutes.
16
16
17
17
Capabilities of Defender for APIs include:
18
18
19
-
*Analyze for external, unused, or unauthenticated APIs
19
+
*Identify external, unused, or unauthenticated APIs
20
20
* Classify APIs that receive or respond with sensitive data
21
-
* Detect exploits of OWASP API top 10 vulnerabilities
21
+
* Apply configuration recommendations to strengthen the security posture of APIs and API Management services
22
+
* Detect anomalous and suspicious API traffic patterns and exploits of OWASP API top 10 vulnerabilities
23
+
* Prioritize threat remediation
22
24
* Integrate with SIEM systems and Defender Cloud Security Posture Management
23
25
24
-
This article shows how to use the Azure portal to enable Defender for APIs from your API Management instance and view a summary of security recommendations and alerts for onboarded APIs. You can also enable Defender for APIs directly in the Microsoft Defender for Cloud console, where more API security insights and inventory experiences are available.
26
+
This article shows how to use the Azure portal to enable Defender for APIs from your API Management instance and view a summary of security recommendations and alerts for onboarded APIs.
* Currently, Defender for APIs discovers and analyzes REST APIs only.
31
33
* Defender for APIs currently doesn't onboard APIs that are exposed using the API Management [self-hosted gateway](self-hosted-gateway-overview.md) or managed using API Management [workspaces](workspaces-overview.md).
32
-
* Some ML-based detections and security insights (data classification, authentication check, unused and external APIs) for API Management instances with [multi-region](api-management-howto-deploy-multi-region.md) deployments aren't supported in secondary regions. In such cases, data residency requirements are still met.
34
+
* Some ML-based detections and security insights (data classification, authentication check, unused and external APIs) aren't supported in secondary regions in [multi-region](api-management-howto-deploy-multi-region.md) deployments. Defender for APIs relies on local data pipelines to ensure regional data residency and improved performance in such deployments.
33
35
34
36
35
37
## Prerequisites
36
38
37
39
* At least one API Management instance in an Azure subscription. Defender for APIs is enabled at the level of a subscription.
38
40
* One or more supported APIs must be imported to the API Management instance.
39
-
*Permissions to [enable the Defender for APIs plan](/azure/defender-for-cloud/permissions).
40
-
* Owner or Contributor permissions on the API Management instance.
41
+
*Role to [enable the Defender for APIs plan](/azure/defender-for-cloud/permissions).
42
+
* Owner or Contributor role on the API Management instance.
41
43
42
44
## Onboard to Defender for APIs
43
45
44
-
Onboarding APIs to Defender for APIs is a two-step process: enabling the Defender for APIs plan, and onboarding unprotected APIs in your API Management instances.
46
+
Onboarding APIs to Defender for APIs is a two-step process: enabling the Defender for APIs plan for the subscription, and onboarding unprotected APIs in your API Management instances.
47
+
48
+
> [!TIP]
49
+
> You can also onboard to Defender for APIs directly in the Defender for Cloud portal, where more API security insights and inventory experiences are available.
50
+
45
51
46
52
### Enable the Defender for APIs plan for a subscription
47
53
@@ -60,7 +66,7 @@ Onboarding APIs to Defender for APIs is a two-step process: enabling the Defende
60
66
### Onboard unprotected APIs to Defender for APIs
61
67
62
68
> [!CAUTION]
63
-
> Onboarding APIs to Defender for APIs may increase compute, memory, and network utilization of your API Management instance. Do not onboard all APIs at one time if your API Management instance is running at high utilization. Use caution by gradually onboarding APIs, while monitoring the utilization of your instance (for example, using [the capacity metric](api-management-capacity.md)) and scaling out as needed.
69
+
> Onboarding APIs to Defender for APIs may increase compute, memory, and network utilization of your API Management instance, which in extreme cases may cause an outage of the API Management instance. Do not onboard all APIs at one time if your API Management instance is running at high utilization. Use caution by gradually onboarding APIs, while monitoring the utilization of your instance (for example, using [the capacity metric](api-management-capacity.md)) and scaling out as needed.
64
70
65
71
1. In the portal, go back to your API Management instance.
66
72
1. In the left menu, select **Microsoft Defender for Cloud (preview)**.
@@ -97,14 +103,11 @@ You can view a summary of all security recommendations and alerts for onboarded
97
103
98
104
For the security alerts received, Defender for APIs suggests necessary steps to perform the required analysis and validate the potential exploit or anomaly associated with the APIs. Follow the steps in the security alert to fix and return the APIs to healthy status.
99
105
100
-
To learn more about the benefits of Defender for APIs, including additional API inventory experiences within Defender for Cloud, see [Microsoft Defender for APIs – Benefits and features](https://aka.ms/apiSecurityOverview).
106
+
## Offboard protected APIs from Defender for APIs
107
+
108
+
You can offboard protected APIs from Defender for APIs by using the Defender for Cloud portal. For more information, see the Microsoft Defender for Cloud documentation.
101
109
102
110
## Next steps
103
111
104
-
* Learn more about Defender for APIs:
105
-
*[Benefits and features](https://aka.ms/apiSecurityOverview)
0 commit comments