azure-api-management

name	azure-api-management
description	Expert knowledge for Azure API Management development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when managing APIM policies, self-hosted gateways, VNet/custom domains, OAuth/Entra auth, or multi-region setups, and other Azure API Management related development tasks. Not for Azure Application Gateway (use azure-application-gateway), Azure Front Door (use azure-front-door), Azure Api Center (use azure-api-center), Azure App Service (use azure-app-service).
compatibility	Requires network access. Uses mcp_microsoftdocs:microsoft_docs_fetch or fetch_webpage to retrieve documentation.
metadata	{"generated_at":"2026-04-19","generator":"docs2skills/1.0.0"}

Azure API Management Skill

This skill provides expert guidance for Azure API Management. Covers troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. It combines local quick-reference content with remote documentation fetching capabilities.

How to Use This Skill

IMPORTANT for Agent: Use the Category Index below to locate relevant sections. For categories with line ranges (e.g., L35-L120), use read_file with the specified lines. For categories with file links (e.g., [security.md](security.md)), use read_file on the linked reference file

IMPORTANT for Agent: If metadata.generated_at is more than 3 months old, suggest the user pull the latest version from the repository. If mcp_microsoftdocs tools are not available, suggest the user install it: Installation Guide

This skill requires network access to fetch documentation content:

• Preferred: Use mcp_microsoftdocs:microsoft_docs_fetch with query string from=learn-agent-skill. Returns Markdown.
• Fallback: Use fetch_webpage with query string from=learn-agent-skill&accept=text/markdown. Returns Markdown.

Category Index

Category	Lines	Description
Troubleshooting	L37-L46	Diagnosing and fixing APIM issues: policies and error handling, request tracing/debugging, custom domain/Key Vault cert failures, SNAT timeouts, portal problems, and using Diagnose and Solve.
Best Practices	L47-L56	Best practices for caching, throttling/quotas, self-hosted gateway on Kubernetes, server-sent events, and securing APIs against OWASP API Top 10 in Azure API Management
Decision Making	L57-L77	Guidance for choosing APIM tiers/networking, scaling and cost planning, DevOps/CI/CD, migrations (ARM, portals, workspaces, Amazon API Gateway), and monetization/analytics transitions.
Architecture & Design Patterns	L78-L84	Patterns for placing API Management behind App Gateway/WAF, Azure Front Door, or AKS, including routing, security, and high‑availability reference architectures.
Limits & Quotas	L85-L103	Rate, quota, and validation limits in API Management: throttling, per-key quotas, OpenAI/LLM token control, protocol format limits, WebSocket/self-hosted gateway caps, and request/response validation.
Security	L104-L141	Securing API Management and gateways: authN/Z (OAuth2, Entra ID, B2C, JWT, certs, mTLS), RBAC, managed identity, TLS/ciphers, DDoS/Defender, and secure developer portal access.
Configuration	L142-L243	Configuring Azure API Management behavior: policies, caching, networking/VNet, domains, monitoring/metrics, workspaces, self-hosted gateways, credentials, and developer portal integration.
Integrations & Coding Patterns	L244-L275	Patterns and samples for integrating API Management with AI/LLM backends, OAuth/Graph, logging/monitoring, events, Service Bus, Service Fabric, MCP, and importing/exporting APIs.
Deployment	L276-L296	Deploying and scaling APIM: multi-region, VNet and zone setups, self-hosted gateways (AKS/K8s/Docker/Arc), backup/restore, migration, automation, and portal deployment.

Troubleshooting

Topic	URL
Handle errors using Azure API Management policy features	https://learn.microsoft.com/en-us/azure/api-management/api-management-error-handling-policies
Trace and debug API requests in Azure API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-api-inspector
Fix API Management custom domain failures with Key Vault certificates	https://learn.microsoft.com/en-us/azure/api-management/api-management-troubleshoot-cannot-add-custom-domain
Developer portal FAQ and troubleshooting for API Management	https://learn.microsoft.com/en-us/azure/api-management/developer-portal-faq
Use Diagnose and Solve Problems for Azure API Management APIs	https://learn.microsoft.com/en-us/azure/api-management/diagnose-solve-problems
Troubleshoot SNAT port exhaustion and timeouts in Azure API Management	https://learn.microsoft.com/en-us/azure/api-management/troubleshoot-response-timeout-and-errors

Best Practices

Topic	URL
Configure response caching for APIs in Azure API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-cache
Implement custom key-based caching in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-sample-cache-by-key
Implement advanced throttling and quotas in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-sample-flexible-throttling
Run API Management self-hosted gateway on Kubernetes in production	https://learn.microsoft.com/en-us/azure/api-management/how-to-self-hosted-gateway-on-kubernetes-in-production
Configure server-sent events for Azure API Management APIs	https://learn.microsoft.com/en-us/azure/api-management/how-to-server-sent-events
Mitigate OWASP API Top 10 threats with API Management	https://learn.microsoft.com/en-us/azure/api-management/mitigate-owasp-api-threats

Decision Making

Topic	URL
Use API Management capacity metrics for scaling decisions	https://learn.microsoft.com/en-us/azure/api-management/api-management-capacity
Choose the right Azure API Management tier	https://learn.microsoft.com/en-us/azure/api-management/api-management-features
Transition from built-in API Management analytics dashboard to Azure Monitor	https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/analytics-dashboard-retirement-march-2027
Migrate Azure API Management ARM API versions before retirement	https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/api-version-retirement-sep-2023
Migrate from direct management API to ARM-based API in API Management	https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/direct-management-api-retirement-march-2025
Move from built-in Git configuration to APIOps for API Management	https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/git-configuration-retirement-march-2025
Migrate from legacy to new API Management developer portal	https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/legacy-portal-retirement-oct-2023
Handle breaking changes for API Management workspaces (June 2024)	https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/workspaces-breaking-changes-june-2024
Migrate preview API Management workspaces to GA workspaces	https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/workspaces-breaking-changes-march-2025

Architecture & Design Patterns

Topic	URL
Front internal API Management with Application Gateway and WAF	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-integrate-internal-vnet-appgateway
Use API Management with AKS microservices architectures	https://learn.microsoft.com/en-us/azure/api-management/api-management-kubernetes
Front Azure API Management with Azure Front Door	https://learn.microsoft.com/en-us/azure/api-management/front-door-api-management

Limits & Quotas

Topic	URL
API format support restrictions for OpenAPI, WSDL, and WADL	https://learn.microsoft.com/en-us/azure/api-management/api-management-api-import-restrictions
Import SOAP APIs and handle WSDL restrictions in API Management	https://learn.microsoft.com/en-us/azure/api-management/import-soap-api
Limit concurrent request execution in API Management	https://learn.microsoft.com/en-us/azure/api-management/limit-concurrency-policy
Configure quota-by-key policy for per-key limits	https://learn.microsoft.com/en-us/azure/api-management/quota-by-key-policy
Configure quota policy for call and bandwidth limits	https://learn.microsoft.com/en-us/azure/api-management/quota-policy
Configure per-key rate limiting in API Management	https://learn.microsoft.com/en-us/azure/api-management/rate-limit-by-key-policy
Configure rate-limit policy to throttle API calls	https://learn.microsoft.com/en-us/azure/api-management/rate-limit-policy
Import and convert SOAP APIs to REST in API Management	https://learn.microsoft.com/en-us/azure/api-management/restify-soap-api
Understand support policies and limitations for self-hosted gateway	https://learn.microsoft.com/en-us/azure/api-management/self-hosted-gateway-support-policies
Understand and work within Azure API Management service limits	https://learn.microsoft.com/en-us/azure/api-management/service-limits
Validate request and response bodies with validate-content policy	https://learn.microsoft.com/en-us/azure/api-management/validate-content-policy

Security

Topic	URL
Configure authentication and authorization for LLM APIs in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-authenticate-authorize-ai-apis
Authorize API Management developer portal with Microsoft Entra ID	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-aad
Configure API Management developer portal with Azure AD B2C	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-aad-b2c
Add and manage custom CA certificates in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-ca-certificates
Manage API Management developer access using groups	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups
Configure TLS protocols and cipher suites in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-manage-protocols-ciphers
Configure mutual TLS client certificates in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates
Secure API Management front-end access with client certificate authentication	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates-for-clients
Configure OAuth 2.0 authorization in API Management test console	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2
Protect APIs in API Management using OAuth 2.0 with Microsoft Entra ID	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-protect-backend-with-aad

Configuration

Topic	URL
Configure external Redis-compatible cache for API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external
Configure custom domain names for self-hosted gateway	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-configure-custom-domain-gateway
Configure notifications and email templates in Azure API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-configure-notifications
Create and manage user accounts in Azure API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-create-or-invite-developers
Create and configure subscriptions in Azure API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-create-subscriptions
Retrieve and manage Azure API Management IP addresses	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-ip-addresses
Configure Azure Monitor logging for LLM APIs in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-llm-logs
Configure and use named values in API Management policies	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-properties
Configure delegation for user registration and subscriptions in API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-setup-delegation
Configure Azure Monitor metrics and logs for API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-use-azure-monitor

Integrations & Coding Patterns

Topic	URL
Azure PowerShell sample scripts for Azure services	https://github.com/Azure/azure-docs-powershell-samples
Import and manage Agent2Agent (A2A) agent APIs in API Management	https://learn.microsoft.com/en-us/azure/api-management/agent-to-agent-api
Import Amazon Bedrock LLM passthrough APIs into API Management	https://learn.microsoft.com/en-us/azure/api-management/amazon-bedrock-passthrough-llm-api
Integrate Azure API Management with Application Insights logging	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-app-insights
Send Azure API Management logs to Event Hubs	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs
Send messages to Azure Service Bus from API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-send-service-bus
Log API Management traffic to Event Hubs and Moesif	https://learn.microsoft.com/en-us/azure/api-management/api-management-log-to-eventhub-sample
Use policy expressions in Azure API Management policies	https://learn.microsoft.com/en-us/azure/api-management/api-management-policy-expressions
Call external HTTP services from API Management policies	https://learn.microsoft.com/en-us/azure/api-management/api-management-sample-send-request
Import Microsoft Foundry AI endpoints into API Management	https://learn.microsoft.com/en-us/azure/api-management/azure-ai-foundry-api
Import Azure OpenAI model APIs as REST in API Management

Deployment

Topic	URL
Configure autoscale rules for Azure API Management instances	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-autoscale
Deploy Azure API Management across multiple regions	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-deploy-multi-region
Backup and restore Azure API Management for disaster recovery	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-disaster-recovery-backup-restore
Migrate Azure API Management instances between regions	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-migrate
Provision gateway resources for self-hosted API Management	https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-provision-self-hosted-gateway
Check regional availability of API Management v2 tiers	https://learn.microsoft.com/en-us/azure/api-management/api-management-region-availability
Deploy Azure API Management to an internal virtual network	https://learn.microsoft.com/en-us/azure/api-management/api-management-using-with-internal-vnet
Deploy Azure API Management to an external virtual network	https://learn.microsoft.com/en-us/azure/api-management/api-management-using-with-vnet
Automate deployment of API Management developer portal content	https://learn.microsoft.com/en-us/azure/api-management/automate-portal-deployments
Automate Azure API Management operations with Azure Automation	https://learn.microsoft.com/en-us/azure/api-management/automation-manage-api-management