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: .github/copilot-instructions.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,6 +54,8 @@ Uniformity, clarity, and ease of use are paramount across all infrastructures an
54
54
-**Keep README structure uniform.** Infrastructure READMEs and sample READMEs each follow their own standard layout (see the guidelines below). Readers should be able to predict where to find objectives, configuration steps, and execution instructions.
55
55
-**Reuse shared utilities.** Use `NotebookHelper`, `InfrastructureNotebookHelper`, `ApimRequests`, `ApimTesting`, and shared Bicep modules rather than inventing ad-hoc alternatives. Shared code is the single best tool for enforcing uniformity.
56
56
-**Mirror tone and depth.** Similar sections across artefacts should use similar levels of detail. If one sample's README explains configuration in three sentences, another sample of comparable complexity should do the same.
57
+
-**Sort samples alphabetically.** Wherever samples are listed (README tables, landing page cards, JSON-LD structured data, diagrams, AGENTS.md), they must appear in alphabetical order by their display name. Infrastructures keep their current deliberate ordering.
58
+
-**Use consistent sample display names.** The display name used for a sample in README tables, landing page cards, JSON-LD, and compatibility diagrams must be identical. The canonical name is the one shown in the compatibility-matrix SVG diagram (e.g. "Costing", not "Costing & Showback"; "OAuth 3rd-Party", not "Credential Manager (with Spotify)"). Longer descriptions belong in the Description column or card body text, not in the name.
57
59
-**Validate against peers.** Before finalising a new infrastructure or sample, compare it side-by-side with at least one existing peer to identify structural or stylistic drift.
58
60
59
61
## General Coding Guidelines
@@ -423,6 +425,8 @@ Check `docs/README.md` for local preview instructions and styling notes. The pag
423
425
- The Draw.io diagrams were created with the [Azure Draw.io MCP Server](https://github.com/simonkurtz-MSFT/drawio-mcp-server).
424
426
- Keep diagrams simple. For Azure, include major components, not individual aspects of components. For example, there is no need for individual policies in WAFs or APIs in API Management, Smart Detector Alert Rules, etc.
425
427
- Less is more. Don't be too verbose in the diagrams.
428
+
- Sample names in compatibility-matrix diagrams are the canonical display names. README tables, landing page cards, and JSON-LD entries must use the same names. When adding or renaming a sample, update the diagram and all listings together.
429
+
- Samples in compatibility-matrix diagrams must be listed in alphabetical order by display name.
426
430
- Never include subscription IDs, resource group names, or any other sensitive information in the diagrams. That data is not relevant.
Copy file name to clipboardExpand all lines: README.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,10 +67,11 @@ It's quick and easy to get started!
67
67
|[AuthX][sample-authx]| Authentication and role-based authorization in a mock HR API. | All infrastructures |
68
68
|[AuthX Pro][sample-authx-pro]| Authentication and role-based authorization in a mock product with multiple APIs and policy fragments. | All infrastructures |
69
69
|[Azure Maps][sample-azure-maps]| Proxying calls to Azure Maps with APIM policies. | All infrastructures |
70
-
|[Costing & Showback][sample-costing]| Track and allocate API costs per business unit using APIM subscriptions, Log Analytics, and Cost Management. | All infrastructures |
71
-
|[Credential Manager (with Spotify)][sample-oauth-3rd-party]| Authenticate with APIM which then uses its Credential Manager with Spotify's REST API.| All infrastructures |
70
+
|[Costing][sample-costing]| Track and allocate API costs per business unit using APIM subscriptions, Log Analytics, and Cost Management. | All infrastructures |
71
+
|[Egress Control][sample-egress-control]| Control APIM outbound internet traffic by routing it through a Network Virtual Appliance (NVA) in a hub/spoke topology. | appgw-apim, appgw-apim-pe|
72
72
|[General][sample-general]| Basic demo of APIM sample setup and policy usage. | All infrastructures |
73
73
|[Load Balancing][sample-load-balancing]| Priority and weighted load balancing across backends. | apim-aca, afd-apim-pe |
74
+
|[OAuth 3rd-Party][sample-oauth-3rd-party]| Authenticate with APIM which then uses its Credential Manager with Spotify's REST API. | All infrastructures |
74
75
|[Secure Blob Access][sample-secure-blob-access]| Secure blob access via the [valet key pattern][valet-key-pattern]. | All infrastructures |
75
76
</details>
76
77
@@ -381,6 +382,7 @@ _For much more API Management content, please also check out [APIM Love](https:/
0 commit comments