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: learn-pr/azure/protect-apis-on-api-management/includes/1-introduction.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
Companies that publish web APIs often need to control the behavior of those APIs without recoding them.
2
2
3
-
Suppose you are the lead developer for a government agency. The agency has created an API to make recent and historical census data available. They want to prevent any unnecessary backend information from being exposed that could be used in malicious attacks. They would also like to prevent abuse of the APIs in the form of a large volume of requests and need a mechanism to throttle requests if they exceed an allowed amount. They are serving their APIs on the Azure API Management service and would like to implement policies to address these concerns.
3
+
Suppose you're the lead developer for a government agency. The agency created an API to make recent and historical census data available. They want to prevent any unnecessary backend information from being exposed that could be used in malicious attacks. They would also like to prevent abuse of the APIs in the form of a large volume of requests. They need a mechanism to throttle requests if the requests exceed an allowed amount. They're serving their APIs on the Azure API Management service and would like to implement policies to address these concerns.
4
4
5
5
Azure API Management enables a consistent, modern, and secure gateway for all your web APIs. It offers policies to transform API requests and responses through configuration.
6
6
7
-
In this module, you'll create an API gateway to publish a RESTful API. You will remove response headers, replace URLs, and throttle requests to achieve a secure endpoint for clients to communicate with.
7
+
In this module, you create an API gateway to publish a RESTful API. Then, you remove response headers, replace URLs, and throttle requests to achieve a secure endpoint for clients to communicate with.
8
8
9
9
## Learning objectives
10
10
11
11
In this module, you will:
12
12
13
-
- Create an Azure API gateway
14
-
- Import a RESTful API into the gateway
15
-
- Implement policies to limit unintended information exposure and throttle the requests
16
-
-Call an API to test the applied policies
13
+
- Create an Azure API gateway.
14
+
- Import a RESTful API into the gateway.
15
+
- Implement policies to limit unintended information exposure and throttle the requests.
Copy file name to clipboardExpand all lines: learn-pr/azure/protect-apis-on-api-management/includes/2-remove-technical-info.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
Any organization that publishes an API needs to make sure that users can access it securely and that malicious users can't successfully attack it.
2
2
3
-
Governments store much personal data regarding citizens. Census data reveals a lot about each citizen, and their life. This data could be exploited to harm people. It is imperative that any data exposed through API endpoints are secured through modern standards.
3
+
Governments store much personal data regarding citizens. Census data reveals a lot about each citizen, and their life. This data could be exploited to harm people. It's imperative that any data exposed through API endpoints are secured through modern standards.
4
4
5
-
As the lead developer, you'll look at how to set up a secured API gateway, which will protect the census data from unauthorized access. It will also help protect the endpoints from denial-of-service attacks.
5
+
As the lead developer, you look at how to set up a secured API gateway, which protects the census data from unauthorized access. It also helps protect the endpoints from denial-of-service attacks.
6
6
7
7
## Azure API Management
8
8
@@ -24,8 +24,8 @@ In the Census API example, it's important that you remove the following header:
24
24
25
25
## API Management setup
26
26
27
-
To set up API Management, you will perform the following tasks:
27
+
To set up API Management, perform the following tasks:
28
28
29
-
-**Create an API Management gateway**. In this step, you create the API Management resource in the Azure portal. You also assign properties to the gateway, such as an FQDN and a pricing tier.
29
+
-**Create an API Management gateway**. In this step, you create the API Management resource in the Azure portal. You also assign properties to the gateway, such as a fully qualified domain name (FQDN) and a pricing tier.
30
30
-**Register an existing web API with the gateway**. In this step, you add the web API to the gateway. The API already has its own Azure app service host but you must add it to API Management in order to use policies and other API Management tools.
31
-
-**Remove a header from the response**. In this step, you will apply a policy that removes an insecure header from all responses.
31
+
-**Remove a header from the response**. In this step, you apply a policy that removes an insecure header from all responses.
Copy file name to clipboardExpand all lines: learn-pr/azure/protect-apis-on-api-management/includes/3-exercise-remove-header.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
Companies that publish web APIs often need to carefully control the HTTP headers that their APIs return, preferably without rewriting the API source code.
2
2
3
-
The government has decided to share census data with its agencies through RESTful APIs. The critical requirements are that the data is shared securely and can be easily amended to facilitate quick integration. As lead developer, you need to create an API gateway. You use the gateway to publish a RESTful Census API that exposes an OpenAPI endpoint using modern security standards.
3
+
The government decides to share census data with its agencies through RESTful APIs. The critical requirements are that the data is shared securely and can be easily amended to facilitate quick integration. As lead developer, you need to create an API gateway. You use the gateway to publish a RESTful Census API that exposes an OpenAPI endpoint using modern security standards.
4
4
5
5
Here, you will:
6
6
@@ -14,7 +14,7 @@ Here, you will:
14
14
15
15
## Deploy the Census web API
16
16
17
-
You've developed a .NET Core app that returns sensitive census information. The app includes Swashbuckle to generate OpenAPI documentation.
17
+
You developed a .NET Core app that returns sensitive census information. The app includes Swashbuckle to generate OpenAPI documentation.
18
18
19
19
To save time, let's start by running a script to host our RESTful API in Azure. The script performs the following steps:
20
20
@@ -64,11 +64,11 @@ To save time, let's start by running a script to host our RESTful API in Azure.
64
64
65
65
The next step in this exercise is to create an API gateway in the Azure portal. In the next section, you'll use this gateway to publish your API:
66
66
67
-
1. Sign in to the [Azure portal](https://portal.azure.com/)
68
-
.
67
+
1. Sign in to the [Azure portal](https://portal.azure.com/).
68
+
69
69
1. On the Azure portal menu or from the **Home** page, select **Create a resource**. The **Create a resource** pane appears.
70
70
71
-
1. In the left menu pane, select **Integration**, and then enter *API Management* in the **Search services and marketplace** search box. Select the **API Management** card in the results, and select **Create** to open the **Create API Management service** pane.
71
+
1. In the left menu pane, select **Integration**, and then enter *API Management* in the **Search services and marketplace** search box. Select the **API Management** card in the results, and select **Create**. The **Create API Management service** pane appears.
72
72
73
73
1. On the **Basics** tab, enter the following values for each setting.
74
74
@@ -79,19 +79,19 @@ The next step in this exercise is to create an API gateway in the Azure portal.
79
79
| Resource group | Select a new or existing resource group. A resource group is a logical container that holds related resources for an Azure solution. |
80
80
| **Instance details** |
81
81
| Region | Select an available region. |
82
-
|Resource name | Enter `apim-CensusData<random number>`, replacing `random number` with your own series of numbers to ensure that the name is globally unique. |
82
+
|Resource name | Enter `apim-CensusData<random number>`. Replace `<random number>` with your own series of numbers so that the name is globally unique. |
83
83
| Organization name | Enter `Government-Census`. The name of your organization for use in the developer portal and email notifications. (The developer portal and notifications aren't available in all service tiers.) |
84
84
| Administrator email | The email address to receive all system notifications. |
85
85
|**Pricing tier**|
86
86
| Pricing tier | Select `Consumption (99.95% SLA)` from the dropdown list. |
87
87
|||
88
88
89
-
:::image type="content" source="../media/3-create-apim-gateway.png" alt-text="Screenshot of the completed settings on the Basics tab of the Create API Management service screen.":::
89
+
:::image type="content" source="../media/3-create-apim-gateway.png" alt-text="Screenshot of the completed settings on the Basics tab of the 'Create API Management service' screen.":::
90
90
91
91
> [!NOTE]
92
92
> The Consumption tier provides fast deployment for testing and has a pay-for-use pricing model. The overall API management experience is similar to the other pricing tiers.
93
93
94
-
1. Select **Review + create**. After validation passes, select**Create**. Deployment may take several minutes. When the deployment has completed, you'll see the API Management instance listed in the Azure resources. Select **Go to resource** to view the pane for your API Management service.
94
+
1. Select **Review + create**. After validation passes, select**Create**. Deployment can take several minutes. When the deployment completes, the API Management instance is listed inyour Azure resources. Select **Go to resource** to view the pane for your API Management service.
95
95
96
96
## Import the API
97
97
@@ -106,13 +106,13 @@ Now, import the Census API into the API Management gateway:
106
106
:::image type="content" source="../media/3-import-api.png" alt-text="Screenshot of the Create from OpenAPI specification dialog box with the swagger JSON URL entered.":::
107
107
108
108
> [!NOTE]
109
-
> You will notice that, when you tab out of the box, some of the other fields are populated for you. This is because you have used OpenAPI which specifies most of the required connection details.
109
+
>Notice that when you tab out of the box, some of the other fields are populated foryou. The OpenAPI specification fillsin most of the required connection details.
110
110
111
111
1. Leave the other settings at their defaults, and thenselect**Create**.
112
112
113
113
## Test the API
114
114
115
-
Let's see what data is returned infrom the API by default:
115
+
Let's see what data is returned from the API by default:
116
116
117
117
1. In the [Azure portal](https://portal.azure.com/) menu or from the **Home** page, select **All Resources**, and then select your API Management instance.
0 commit comments