Skip to content

Commit 01a6d8d

Browse files
simonkurtz-MSFTsimonkurtz-MSFT
committed
Add icons and numbering to headers
1 parent 8a08304 commit 01a6d8d

File tree

9 files changed

+39
-42
lines changed

9 files changed

+39
-42
lines changed

‎infrastructure/afd-apim/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ Secure architecture that takes all traffic off the public Internet once Azure Fr
44

55
<img src="./Azure Front Door, API Management & Container Apps Architecture.svg" alt="Diagram showing Azure Front Door, API Management, and Container Apps architecture. Azure Front Door routes traffic to API Management, which then routes to Container Apps. Telemetry is sent to Azure Monitor." title="Azure Front Door, API Management & Container Apps Architecture" width="1000" />
66

7-
## Objectives
7+
## 🎯 Objectives
88

99
1. Provide a secure pathway to API Management via a private link from Front Door
1010
1. Maintain private networking by integrating API Management with a VNet to communicate with Azure Container Apps. (This can also be achieved via a private link there)
1111
1. Empower users to use Azure Container Apps, if desired
1212
1. Enable observability by sending telemetry to Azure Monitor
1313

14-
## Configuration
14+
## ⚙️ Configuration
1515

1616
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables](./create.ipynb#initialize-notebook-variables) section.
1717

18-
## Execution
18+
## ▶️ Execution
1919

2020
1. Execute this lab's [Jupyter Notebook](./create.ipynb) step-by-step or via _Run All_.

‎infrastructure/afd-apim/create.ipynb‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"cell_type": "markdown",
1616
"metadata": {},
1717
"source": [
18-
"### Initialize notebook variables\n",
18+
"### 🛠️ 1. Initialize notebook variables\n",
1919
"\n",
2020
"Configures everything that's needed for deployment. \n",
2121
"\n",
@@ -83,7 +83,7 @@
8383
"cell_type": "markdown",
8484
"metadata": {},
8585
"source": [
86-
"### Create deployment using Bicep\n",
86+
"### 🚀 2. Create deployment using Bicep\n",
8787
"\n",
8888
"Creates the bicep deployment into the previously-specified resource group. A bicep parameters file will be created prior to execution."
8989
]
@@ -124,7 +124,7 @@
124124
"cell_type": "markdown",
125125
"metadata": {},
126126
"source": [
127-
"### Approve Front Door private link connection to APIM\n",
127+
"### 🔗 3. Approve Front Door private link connection to APIM\n",
128128
"\n",
129129
"In the deployed Bicep template, Azure Front Door will establish a private link connection to the API Management service. This connection should be approved. Run the following command to approve the connection."
130130
]
@@ -170,7 +170,7 @@
170170
"cell_type": "markdown",
171171
"metadata": {},
172172
"source": [
173-
"### Verify API Request Success via API Management\n",
173+
"### ✅ 4. Verify API Request Success via API Management\n",
174174
"\n",
175175
"As we have not yet disabled public access to APIM, this request should succeed with a **200**."
176176
]
@@ -196,7 +196,7 @@
196196
"cell_type": "markdown",
197197
"metadata": {},
198198
"source": [
199-
"### Disabling API Management public network access\n",
199+
"### 🔒 5. Disabling API Management public network access\n",
200200
"\n",
201201
"The initial `APIM` service deployment above cannot disable public network access. It must be disabled subsequently below."
202202
]
@@ -231,7 +231,7 @@
231231
"cell_type": "markdown",
232232
"metadata": {},
233233
"source": [
234-
"### Verify API Request Success via Azure Front Door & Failure with API Management\n",
234+
"### ✅ 6. Verify API Request Success via Azure Front Door & Failure with API Management\n",
235235
"\n",
236236
"At this time only requests through Front Door should be successful and return a **200**. Requests to APIM that worked previously should result in a **403**."
237237
]
@@ -269,8 +269,7 @@
269269
"cell_type": "markdown",
270270
"metadata": {},
271271
"source": [
272-
"<a id='clean'></a>\n",
273-
"### Clean up resources\n",
272+
"### 🗑️ Clean up resources\n",
274273
"\n",
275274
"When you're finished experimenting, it's advisable to remove all associated resources from Azure to avoid unnecessary cost.\n",
276275
"Use the [clean-up notebook](clean-up.ipynb) for that."

‎infrastructure/apim-aca/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ This architecture secures API traffic by routing requests through Azure API Mana
44

55
<img src="./API Management & Container Apps Architecture.svg" alt="Diagram showing Azure API Management and Container Apps architecture. API Management routes traffic to Container Apps. Telemetry is sent to Azure Monitor." title="API Management & Container Apps Architecture" width="800" />
66

7-
## Objectives
7+
## 🎯 Objectives
88

99
1. Provide a secure API gateway using Azure API Management
1010
1. Integrate API Management with Azure Container Apps for backend services
1111
1. Enable observability by sending telemetry to Azure Monitor
1212

13-
## Configuration
13+
## ⚙️ Configuration
1414

1515
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables](./create.ipynb#initialize-notebook-variables) section.
1616

17-
## Execution
17+
## ▶️ Execution
1818

1919
1. Execute this lab's [Jupyter Notebook](./create.ipynb) step-by-step or via _Run All_.

‎infrastructure/apim-aca/create.ipynb‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"cell_type": "markdown",
1818
"metadata": {},
1919
"source": [
20-
"### Initialize notebook variables\n",
20+
"### 🛠️ 1. Initialize notebook variables\n",
2121
"\n",
2222
"Configures everything that's needed for deployment. \n",
2323
"\n",
@@ -76,7 +76,7 @@
7676
"cell_type": "markdown",
7777
"metadata": {},
7878
"source": [
79-
"### Create deployment using Bicep\n",
79+
"### 🚀 2. Create deployment using Bicep\n",
8080
"\n",
8181
"Creates the bicep deployment into the previously-specified resource group. A bicep parameters file will be created prior to execution."
8282
]
@@ -114,7 +114,7 @@
114114
"cell_type": "markdown",
115115
"metadata": {},
116116
"source": [
117-
"### Verify API Request Success\n",
117+
"### ✅ 3. Verify API Request Success\n",
118118
"\n",
119119
"Assert that the deployment was successful by making simple calls to APIM. "
120120
]
@@ -141,8 +141,7 @@
141141
"cell_type": "markdown",
142142
"metadata": {},
143143
"source": [
144-
"<a id='clean'></a>\n",
145-
"### Clean up resources\n",
144+
"### 🗑️ Clean up resources\n",
146145
"\n",
147146
"When you're finished experimenting, it's advisable to remove all associated resources from Azure to avoid unnecessary cost.\n",
148147
"Use the [clean-up notebook](clean-up.ipynb) for that."

‎infrastructure/simple-apim/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This architecture provides a basic API gateway using Azure API Management, suita
44

55
<img src="./Simple API Management Architecture.svg" alt="Diagram showing a simple Azure API Management architecture. API Management acts as a gateway for API consumers. Telemetry is sent to Azure Monitor." title="Simple API Management Architecture" width="800" />
66

7-
## Objectives
7+
## 🎯 Objectives
88

99
1. Provide the simplest Azure API Management infrastructure with a public ingress to allow for easy testing
1010
1. Enable observability by sending telemetry to Azure Monitor
1111

12-
## Configuration
12+
## ⚙️ Configuration
1313

1414
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables](./create.ipynb#initialize-notebook-variables) section.
1515

16-
## Execution
16+
## ▶️ Execution
1717

1818
1. Execute this lab's [Jupyter Notebook](./create.ipynb) step-by-step or via _Run All_.

‎infrastructure/simple-apim/create.ipynb‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"cell_type": "markdown",
1616
"metadata": {},
1717
"source": [
18-
"### Initialize notebook variables\n",
18+
"### 🛠️ 1. Initialize notebook variables\n",
1919
"\n",
2020
"Configures everything that's needed for deployment. \n",
2121
"\n",
@@ -59,7 +59,7 @@
5959
"cell_type": "markdown",
6060
"metadata": {},
6161
"source": [
62-
"### Create deployment using Bicep\n",
62+
"### 🚀 2. Create deployment using Bicep\n",
6363
"\n",
6464
"Creates the bicep deployment into the previously-specified resource group. A bicep parameters file will be created prior to execution."
6565
]
@@ -95,7 +95,7 @@
9595
"cell_type": "markdown",
9696
"metadata": {},
9797
"source": [
98-
"### Verify API Request Success\n",
98+
"### ✅ 3. Verify API Request Success\n",
9999
"\n",
100100
"Assert that the deployment was successful by making simple calls to APIM. "
101101
]
@@ -119,8 +119,7 @@
119119
"cell_type": "markdown",
120120
"metadata": {},
121121
"source": [
122-
"<a id='clean'></a>\n",
123-
"### Clean up resources\n",
122+
"### 🗑️ Clean up resources\n",
124123
"\n",
125124
"When you're finished experimenting, it's advisable to remove all associated resources from Azure to avoid unnecessary cost.\n",
126125
"Use the [clean-up notebook](clean-up.ipynb) for that."

‎samples/_TEMPLATE/create.ipynb‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
"\n",
1313
"⌚ **Expected *Run All* runtime (excl. infrastructure prerequisite): ~[NOTEBOOK RUNTIME] minute**\n",
1414
"\n",
15-
"## Objectives\n",
15+
"## 🎯 Objectives\n",
1616
"\n",
1717
"1. [LEARNING / EXPERIMENTATION OBJECTIVE 1]\n",
1818
"1. [LEARNING / EXPERIMENTATION OBJECTIVE 2]\n",
1919
"1. ...\n",
2020
"\n",
21-
"## Scenario\n",
21+
"## 📝 Scenario\n",
2222
"\n",
2323
"[IF THE SAMPLE IS DEMONSTRATED THROUGH A USE CASE OR SCENARIO, PLEASE DETAIL IT HERE. OTHERWISE, DELETE THIS SECTION]\n",
2424
"\n",
25-
"## Lab Components\n",
25+
"## 🧩 Lab Components\n",
2626
"\n",
2727
"[DESCRIBE IN MORE DETAIL WHAT THIS LAB SETS UP AND HOW THIS BENEFITS THE LEARNER/USER.]\n",
2828
"\n",
29-
"## Configuration\n",
29+
"## ⚙️ Configuration\n",
3030
"\n",
3131
"1. Decide which of the [Infrastructure Architectures](../../README.md#infrastructure-architectures) you wish to use.\n",
3232
" 1. If the infrastructure _does not_ yet exist, navigate to the desired [infrastructure](../../infrastructure/) folder and follow its README.md.\n",
@@ -37,7 +37,7 @@
3737
"cell_type": "markdown",
3838
"metadata": {},
3939
"source": [
40-
"### Initialize notebook variables\n",
40+
"### 🛠️ 1. Initialize notebook variables\n",
4141
"\n",
4242
"Configures everything that's needed for deployment. \n",
4343
"\n",
@@ -88,7 +88,7 @@
8888
"cell_type": "markdown",
8989
"metadata": {},
9090
"source": [
91-
"### Create deployment using Bicep\n",
91+
"### 🚀 2. Create deployment using Bicep\n",
9292
"\n",
9393
"Creates the bicep deployment into the previously-specified resource group. A bicep parameters file will be created prior to execution."
9494
]
@@ -128,7 +128,7 @@
128128
"cell_type": "markdown",
129129
"metadata": {},
130130
"source": [
131-
"### Verify API Request Success\n",
131+
"### ✅ 3. Verify API Request Success\n",
132132
"\n",
133133
"Assert that the deployment was successful by making simple calls to APIM. \n",
134134
"\n",

‎samples/general/create.ipynb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@
1212
"\n",
1313
"⌚ **Expected *Run All* runtime (excl. infrastructure prerequisite): ~1 minute**\n",
1414
"\n",
15-
"## Objectives\n",
15+
"## 🎯 Objectives\n",
1616
"\n",
1717
"1. Experience a variety of policies in any of the infrastructure architectures. You may see several examples from our [APIM policy snippets repo](https://github.com/Azure/api-management-policy-snippets).\n",
1818
"1. Become proficient with how policies operate.\n",
1919
"1. Gain confidence in setting up and configuring policies appropriately.\n",
2020
"\n",
21-
"## Configuration\n",
21+
"## ⚙️ Configuration\n",
2222
"\n",
2323
"1. Decide which of the [Infrastructure Architectures](../../README.md#infrastructure-architectures) you wish to use.\n",
2424
" 1. If the infrastructure _does not_ yet exist, navigate to the desired [infrastructure](../../infrastructure/) folder and follow its README.md.\n",

‎samples/load-balancing/create.ipynb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
"\n",
1313
"⌚ **Expected *Run All* runtime (excl. infrastructure prerequisite): ~3 minutes**\n",
1414
"\n",
15-
"## Objectives\n",
15+
"## 🎯 Objectives\n",
1616
"\n",
1717
"1. Understand how backends can be configured to balance load in a prioritized, weighted manner.\n",
1818
"1. Learn how circuit breakers aid with load balancing.\n",
1919
"1. Configure how retries in API Management policies can result in more successful requests.\n",
2020
"\n",
21-
"## Lab Components\n",
21+
"## 🧩 Lab Components\n",
2222
"\n",
2323
"This lab integrates into an existing Azure Container Apps architecture and sets up the following:\n",
2424
"\n",
2525
"- One container app that serves multiple mock Web API endpoints returning 429 error codes. \n",
2626
"- Three separate backends are set up in APIM that each point to a different endpoint on this container app (e.g. /api/0, /api/1, etc.).\n",
2727
"- Four separate backend pool with varying load balancer setups are configured using these three backends.\n",
2828
"\n",
29-
"## Configuration\n",
29+
"## ⚙️ Configuration\n",
3030
"\n",
3131
"1. Decide which of the [Infrastructure Architectures](../../README.md#infrastructure-architectures) you wish to use.\n",
3232
" 1. If the infrastructure _does not_ yet exist, navigate to the desired [infrastructure](../../infrastructure/) folder and follow its README.md.\n",
@@ -37,7 +37,7 @@
3737
"cell_type": "markdown",
3838
"metadata": {},
3939
"source": [
40-
"### Initialize notebook variables\n",
40+
"### 🛠️ 1. Initialize notebook variables\n",
4141
"\n",
4242
"Configures everything that's needed for deployment. \n",
4343
"\n",
@@ -94,7 +94,7 @@
9494
"cell_type": "markdown",
9595
"metadata": {},
9696
"source": [
97-
"### Create deployment using Bicep\n",
97+
"### 🚀 2. Create deployment using Bicep\n",
9898
"\n",
9999
"Creates the bicep deployment into the previously-specified resource group. A bicep parameters file will be created prior to execution."
100100
]
@@ -135,7 +135,7 @@
135135
"cell_type": "markdown",
136136
"metadata": {},
137137
"source": [
138-
"### Verify API Request Success\n",
138+
"### ✅ 3. Verify API Request Success\n",
139139
"\n",
140140
"Assert that the deployment was successful by making simple calls to Azure Front Door or API Management."
141141
]

0 commit comments

Comments
 (0)