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: README.md
+20-16Lines changed: 20 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,6 @@
5
5
6
6
**This repository provides resources to quickly deploy high-fidelity Azure API Management (APIM) infrastructures and experiment with common APIM.**
7
7
8
-
_If you are interested in APIM & Azure OpenAI integrations, please check out the excellent [AI Gateway][ai-gateway] GitHub repository._
9
-
_For much more API Management content, please also check out [APIM Love][apim-love]._
10
-
11
8
Historically, there were two general paths to experimenting with APIM. Standing up an entire landing zone with the [APIM Landing Zone Accelerator][apim-lza] can feel overwhelming and _more than needed_. Similarly, using [APIM policy snippets][apim-snippets] is only helpful when an APIM instance and infrastructure already exists.
12
9
13
10
> ⭐ _APIM Samples_ provides common APIM **_infrastructures_** and real-world **_samples_**. Most samples can be deployed to any infrastructure, yielding an **innovative and highly powerful and flexible _à la carte_ approach!**
@@ -26,7 +23,7 @@ Historically, there were two general paths to experimenting with APIM. Standing
26
23
27
24
It's quick and easy to get started!
28
25
29
-
1. Follow one of the two [setup options](#️-infrastructure-setup).
26
+
1. Follow one of the two [setup options](#️-setup).
30
27
1. Select an [infrastructure](#-list-of-infrastructures) to deploy.
31
28
32
29
@@ -80,12 +77,9 @@ This menu-driven interface provides quick access to:
80
77
</details>
81
78
82
79
83
-
## 🏗️ Infrastructure Setup
84
-
85
-
APIM Samples supports two options:
80
+
## 🏗️ Setup
86
81
87
-
1. Option 1: GitHub Codespaces / Dev Container (recommended)
88
-
1. Full Local Setup
82
+
APIM Samples supports two setup options:
89
83
90
84
### Option 1: GitHub Codespaces / Dev Container (Recommended)
91
85
<details>
@@ -167,8 +161,6 @@ The Python helpers in this repo use standard-library `logging`, empowering you t
167
161
- When set to `DEBUG`, the Azure CLI runner in [shared/python/azure_resources.py](shared/python/azure_resources.py) will also add `--debug` to simple `az ...` commands.
168
162
-`APIM_SAMPLES_CONSOLE_WIDTH`: Optional wrap width for long lines (defaults to `120`).
169
163
170
-
📘 **For comprehensive troubleshooting including deployment errors, authentication issues, and more, see our main [Troubleshooting Guide][troubleshooting].**
171
-
172
164
173
165
## Troubleshooting
174
166
@@ -235,11 +227,6 @@ Adding a new sample is relatively straight-forward.
235
227
1. Create a pull request for merge.
236
228
237
229
238
-
## 📚 Supporting Resources
239
-
240
-
The APIM team maintains an [APIM policy snippets repo][apim-snippets] with use cases we have seen. They are not immediately executable samples and require integrations such as in this repo.
241
-
242
-
243
230
## 🙏 Acknowledgements
244
231
245
232
This project has its roots in work done by [Alex Vieira][alex-vieira] on the excellent Azure API Management [AI Gateway][ai-gateway] GitHub repository. Much of the structure is similar and its reuse resulted in significant time savings. Thank you, Alex!
@@ -251,6 +238,23 @@ Furthermore, [Houssem Dellai][houssem-dellai] was instrumental in setting up a w
251
238
The original author of this project is [Simon Kurtz][simon-kurtz].
252
239
253
240
241
+
## 🥇 Other resources
242
+
243
+
-[AI Gateway][ai-gateway]
244
+
-[Landing Zone Accelerator](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/scenarios/app-platform/api-management/landing-zone-accelerator#generative-ai-gateway-scenario)
_For much more API Management content, please also check out [APIM Love](https://aka.ms/apimlove)._
251
+
252
+
253
+
## 📜 Disclaimer
254
+
255
+
> [!IMPORTANT]
256
+
> This software is provided for demonstration purposes only. It is not intended to be relied upon for any purpose. The creators of this software make no representations or warranties of any kind, express or implied, about the completeness, accuracy, reliability, suitability or availability with respect to the software or the information, products, services, or related graphics contained in the software for any purpose. Any reliance you place on such information is therefore strictly at your own risk.
0 commit comments