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/defender-for-cloud/defender-for-apis-deploy.md
+53-8Lines changed: 53 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: dcurwin
5
5
ms.author: dacurwin
6
6
ms.service: defender-for-cloud
7
7
ms.topic: conceptual
8
-
ms.date: 12/03/2023
8
+
ms.date: 02/26/2024
9
9
---
10
10
11
11
# Protect your APIs with Defender for APIs
@@ -14,6 +14,8 @@ Defender for APIs in Microsoft Defender for Cloud offers full lifecycle protecti
14
14
15
15
Defender for APIs helps you to gain visibility into business-critical APIs. You can investigate and improve your API security posture, prioritize vulnerability fixes, and quickly detect active real-time threats.
16
16
17
+
This article describes how to enable and onboard the Defender for APIs plan in the Defender for Cloud portal. Alternately, you can [enable Defender for APIs within an API Management instance](../api-management/protect-with-defender-for-apis.md) in the Azure portal.
18
+
17
19
Learn more about the [Microsoft Defender for APIs](defender-for-apis-introduction.md) plan in the Microsoft Defender for Cloud.
18
20
19
21
## Prerequisites
@@ -28,20 +30,35 @@ Learn more about the [Microsoft Defender for APIs](defender-for-apis-introductio
28
30
29
31
- Ensure that APIs you want to secure are published in [Azure API management](/azure/api-management/api-management-key-concepts). Follow [these instructions](/azure/api-management/get-started-create-service-instance) to set up Azure API Management.
30
32
31
-
> [!NOTE]
32
-
> This article describes how to enable and onboard the Defender for APIs plan in the Defender for Cloud portal. Alternately, you can [enable Defender for APIs within an API Management instance](../api-management/protect-with-defender-for-apis.md) in the Azure portal.
33
+
- You must select a plan that grants entitlement appropriate for the API traffic volume in your subscription to receive the most optimal pricing. By default, subscriptions are opted into "Plan 1", which can lead to unexpected overages if your subscription has API traffic higher than the [one million API calls entitlement](https://ms.portal.azure.com/#view/Microsoft_Azure_Security/SecurityMenuBlade/~/18).
33
34
34
35
## Enable the Defender for APIs plan
35
36
37
+
When selecting a plan, consider these points:
38
+
39
+
- Defender for APIs protects only those APIs that are onboarded to Defender for APIs. This means you can activate the plan at the subscription level, and complete the second step of onboarding by fixing the onboarding recommendation. (For more information about onboarding, see the [onboarding guide](defender-for-apis-deploy.md#enable-the-defender-for-apis-plan)).
40
+
- Defender for APIs has five pricing plans, each with a different entitlement limit and monthly fee. The billing is done at the subscription level.
41
+
- Billing is applied to the entire subscription based on the total amount of API traffic monitored over the month for the subscription.
42
+
- The API traffic counted towards the billing is reset to 0 at the start of each month (every billing cycle).
43
+
- The overages are computed on API traffic exceeding the entitlement limit per plan selection during the month for your entire subscription.
44
+
45
+
To select the best plan for your subscription from the Microsoft Defender for Cloud [pricing page](https://azure.microsoft.com/pricing/details/defender-for-cloud/), follow these steps and choose the plan that matches your subscriptions’ API traffic requirements:
46
+
47
+
> [!NOTE]
48
+
> The Defender for Cloud pricing page will be updated with the pricing information and pricing calculators by end of March 2024. In the meantime, use this document to select the correct Defender for APIs entitlements and enable the plan.
49
+
36
50
1. Sign into the [portal](https://portal.azure.com/), and in Defender for Cloud, select **Environment settings**.
37
51
38
52
1. Select the subscription that contains the managed APIs that you want to protect.
39
53
40
-
1. In the **APIs** plan, select **On**. Then select **Save**:
54
+
:::image type="content" source="media/defender-for-apis-entitlement-plans/select-environment-settings.png" alt-text="Screenshot that shows where to select Environment settings." lightbox="media/defender-for-apis-entitlement-plans/select-environment-settings.png":::
55
+
56
+
1. Select **Details** under the pricing column for the APIs plan.
41
57
42
-
:::image type="content" source="media/defender-for-apis-deploy/enable-plan.png" alt-text="Screenshot that shows how to turn on the Defender for APIs plan in the portal." lightbox="media/defender-for-apis-deploy/enable-plan.png":::
43
-
44
-
1. Select **Save**.
58
+
:::image type="content" source="media/defender-for-apis-entitlement-plans/select-api-details.png" alt-text="Screenshot that shows where to select API details." lightbox="media/defender-for-apis-entitlement-plans/select-api-details.png":::
59
+
60
+
1. Select the plan that is suitable for your subscription.
61
+
1. Select **Save**.
45
62
46
63
> [!NOTE]
47
64
> After enabling Defender for APIs, onboarded APIs take up to 50 minutes to appear in the **Recommendations** tab. Security insights are available in the **Workload protections** > **API security** dashboard within 40 minutes of onboarding.
@@ -73,6 +90,33 @@ Learn more about the [Microsoft Defender for APIs](defender-for-apis-introductio
73
90
74
91
:::image type="content" source="media/defender-for-apis-deploy/fix-resources-confirm.png" alt-text="Screenshot that confirms that remediation was successful." lightbox="media/defender-for-apis-deploy/fix-resources-confirm.png":::
75
92
93
+
## Selecting the optimal plan based on historical Azure API Management API traffic usage
94
+
95
+
You must select a plan that grants entitlement appropriate for the API traffic volume in your subscription to receive the most optimal pricing. By default, subscriptions are opted into **Plan 1**, which can lead to unexpected overages if your subscription has API traffic higher than the [one million API calls entitlement](https://ms.portal.azure.com/#view/Microsoft_Azure_Security/SecurityMenuBlade/~/18).
96
+
97
+
**To estimate the monthly API traffic in Azure API Management:**
98
+
99
+
1. Navigate to the Azure API Management portal and select **Metrics** under the Monitoring menu bar item.
100
+
101
+
:::image type="content" source="media/defender-for-apis-entitlement-plans/select-metrics.png" alt-text="Screenshot that shows where to select metrics." lightbox="media/defender-for-apis-entitlement-plans/select-metrics.png":::
102
+
103
+
1. Select the time range as **Last 30 days**.
104
+
1. Select and set the following parameters:
105
+
106
+
1. Scope: **Azure API Management Service Name**
107
+
1. Metric Namespace: **API Management service standard metrics**
108
+
1. Metric = **Requests**
109
+
1. Aggregation = **Sum**
110
+
111
+
1. After setting the above parameters, the query will automatically run, and the total number of requests for the past 30 days appears at the bottom of the screen. Iin the screenshot example, the query results in 414 total number of requests.
112
+
113
+
:::image type="content" source="media/defender-for-apis-entitlement-plans/metrics-results.png" alt-text="Screenshot that shows metrics results." lightbox="media/defender-for-apis-entitlement-plans/metrics-results.png":::
114
+
115
+
> [!NOTE]
116
+
> These instructions are for calculating the usage per Azure API management service. To calculate the estimated traffic usage for *all* API management services within the Azure subscription, change the **Scope** parameter to each Azure API management service within the Azure subscription, re-run the query, and sum the query results.
117
+
118
+
If you don't have access to run the metrics query, reach out to your internal Azure API Management administrator or your Microsoft account manager.
119
+
76
120
## Track onboarded API resources
77
121
78
122
After onboarding the API resources, you can track their status in the Defender for Cloud portal > **Workload protections** > **API security**:
@@ -85,4 +129,5 @@ You can also navigate to other collections to learn about what types of insights
85
129
86
130
## Next steps
87
131
88
-
[Review](defender-for-apis-posture.md) API threats and security posture.
132
+
-[Review](defender-for-apis-posture.md) API threats and security posture.
133
+
-[Investigate API findings, recommendations, and alerts](defender-for-apis-posture.md).
Copy file name to clipboardExpand all lines: articles/defender-for-cloud/faq-defender-for-apis.yml
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,10 @@ sections:
29
29
30
30
- question: Does Defender for APIs collect API traffic logs from Azure API Management?
31
31
answer: Defender for APIs receives a copy of all of the HTTP request and response traffic sent to the API management service for all onboarded APIs. This includes the request URL, the response status code, and a subset of HTTP headers for the requests and responses. Also, Defender for APIs receives a copy of some of the HTTP request and response bodies. The request and response bodies received by Defender for APIs are capped at a size of 64 KB.
32
-
32
+
33
+
- question: Why can't I select multiple resources?
34
+
answer: API Management service resources don't enable multi-selection with metrics. You can let the API Management service team know this capability is important and upvote this request.
35
+
33
36
- name: Questions related to region/geo
34
37
questions:
35
38
- question: I just moved my APIs within my Azure API Management service to a new region. Why are these not updated?
0 commit comments