Azure API Management (APIM)
Back to Learn
FAACChapter 24

Corporate API Fundamentals and Architecture

Azure API Management (APIM)

Architecture, gateways, policies, networking, security, observability, and operation of a managed API platform on Azure

In-depth edition - study material and professional reference

Managed API platform connecting consumers, gateways, hybrid networks, backends, and observability

From publishing to Azure to distributed enforcement at the gateway

Management plan, managed gateway, developer portal, self-hosted gateway and observability in APIM
Opening figure - APIM brings together management plan, gateways and consumer experience under a single platform.

Central principle

APIM separates governance, publishing and traffic operations, but each tier and network decision changes capabilities and limits.

In-depth edition - study material and professional reference

Chapter presentation

The previous chapter studied the Axway API Gateway architecture, separating design, administrative domain, runtime instances, persistence and . Azure API Management, known as APIM, solves a similar set of problems in a managed service model in Azure. It combines a management plane exposed by portal and APIs, a gateway responsible for traffic, publishing capabilities, and a consumer portal.

The managed feature reduces installation and maintenance tasks, but does not eliminate architectural decisions. Choosing tier, network topology, , region, identity model, policies, certificates, and high availability strategy remains the organization's responsibility. The cloud abstracts part of the infrastructure; it does not replace design, governance and troubleshooting.

APIM has also evolved for hybrid and federated scenarios. In addition to the , the platform offers a to run in containers outside the managed service and workspaces to decentralize the administration of APIs on a shared infrastructure. As the availability of these resources varies depending on tier, gateway and region, decisions must be verified in the official documentation and in the current resource matrix.

This chapter builds a complete mental model: components, configuration objects, policy processing, contract import, security, networks, scalability, observability, automation and recurring failures. The goal is not to just teach portal clicks, but to allow the reader to reason about runtime behavior and design a sustainable enterprise platform.

How to study this chapter

Always separate three questions: what belongs to the management plane, what is executed by the gateway in the request path and what belongs to the consumer ecosystem. Then, identify in which tier and type of gateway the functionality is available.

Learning Objectives

  • Explain the logical architecture of Azure API Management and its main components.
  • Distinguish between management plane, , , and .
  • Understand the model of APIs, operations, backends, products, subscriptions, users and groups.
  • Explain sections, scopes, inheritance and order of execution of policies.
  • Design authentication, mTLS, certificates, managed identities and integration with Microsoft Entra ID.
  • Compare public connectivity, VNet, private endpoint and hybrid topologies.
  • Plan scale units, availability zones, multi-region and recovery.
  • Apply observability with Azure Monitor, Application Insights, logs and tracing.
  • Automate configuration with ARM, Bicep, Terraform, REST, CLI and pipelines.
  • Diagnose policy, network, certificate, , and publishing failures.

Chapter structure

  • 24.1 Positioning and logical architecture
  • 24.2 Management plane, gateway and
  • 24.3 Tiers, gateways and selection criteria
  • 24.4 APIM Resource Model
  • 24.5 Importing and publishing APIs
  • 24.6 Policies: sections, order and context
  • 24.7 Scopes, inheritance and basis
  • 24.8 Named values and policy expressions
  • 24.9 Identity, subscriptions and authorization
  • 24.10 TLS, mTLS, certificates and Key Vault
  • 24.11 Networks, VNet, Private Link and private backends
  • 24.12 High availability, zones and multi-region
  • 24.13 Backends, resilience, cache and limits
  • 24.14 Workspaces and federated governance
  • 24.15 , products and onboarding
  • 24.16 Observability and troubleshooting
  • 24.17 Automation, CI/CD and infrastructure as code
  • 24.18 Security, hardening and case studies
  • Summary, checklist, laboratories, glossary and references

24.1 Positioning and logical architecture

Azure API Management is an API management platform that receives traffic through a gateway, applies policies, and forwards the call to a . Around this runtime, the platform offers registration and import of APIs, products, subscriptions, users, groups, analytics, and administrative interfaces. The service does not necessarily host the business logic: it creates a governed facade in front of backends that can be in Azure, in data centers, in other clouds or in SaaS services.

The gateway is the data plane. It terminates connections, selects API and , executes policies, calls the and processes the response. The management plane is used to create or change configuration via Azure portal, REST, ARM, Bicep, Terraform, PowerShell, or CLI. The organizes discovery, documentation, testing, and onboarding. This separation allows configuration to be administered centrally while traffic runs through managed or distributed gateways.

The most important mental model is not to confuse the Azure resource with the traffic endpoint. An APIM instance has administrative resources, gateway endpoints and, depending on configuration, portal, management API and other hostnames. DNS, certificates, firewall, and monitoring may be different for each endpoint. A failure in the administrative portal does not automatically mean a failure in the gateway, and the reverse is also true.

Consumers, gateway, backends, management plane and developer portal in Azure API Management
Figure 1 - The gateway is in the path of traffic; management plan and portal have different responsibilities.
Table 1 - Components must be monitored and protected according to their function.
ComponentResponsibilityTypical evidence
Management planProvision and configure the service.Activity Log, deployments, administrative API.
Managed gatewayExecute policies and forward calls.Gateway logs, metrics and traces.
Self-hosted gatewayExecute data plane in a container outside the managed service.Local logs and telemetry sent to Azure.
Workspace gatewayRuntime associated with a workspace.Workspace metrics and configuration.
Developer portalDocumentation, products, registration and testing.Publication, content and identity of the portal.

24.2 Management plane, gateway and

The management plan stores and distributes the service configuration: APIs, operations, policies, backends, named values, certificates, products, subscriptions and diagnostics. Changes are made as Azure management operations and may take some time to reach all runtimes. This means that completed deploy and full propagation are not exactly the same event. Pipelines must include post-deploy validation and synthetic testing.

The is operated by Microsoft and processes traffic according to tier and topology. It should be treated as a distributed component: scale units, regions and zones affect and resilience. The gateway has a health endpoint that can be used for monitoring and availability validations. However, a platform health check does not replace a synthetic transaction that exercises DNS, TLS, policy, identity and .

The is a separate application from the API itself. It allows consumers to discover APIs grouped into products, read documentation, test operations and request subscriptions. The portal experience depends on content publishing, allowed identities, CORS configuration, and gateway availability. In regulated environments, you must carefully what is displayed, which samples contain data, and how external users are invited or removed.

Operational separation

An unavailability of the management plan can prevent changes without immediately dropping existing traffic. A gateway failure affects consumers even if the portal and Azure Resource Manager are accessible.

24.3 Tiers, gateways and selection criteria

APIM has families of tiers with different characteristics of , network, scale, high availability and governance resources. The classic family includes Developer, Basic, Standard and Premium, in addition to the Consumption model. The v2 family modernizes Basic, Standard and Premium options. As feature availability varies and changes over time, the architecture must use the official matrix as a source of truth, and not assumptions based solely on the tier name.

The Developer tier is aimed at non-productive scenarios and should not be chosen as a basis for availability. Production tiers need to be selected according to throughput, SLA, private connectivity, zones, multi-region, workspaces, and compliance requirements. Consumption uses a serverless model appropriate to specific loads, but has operational and functionality differences that need to be evaluated.

The is a container associated with an APIM instance, running on customer infrastructure, such as Kubernetes, OpenShift, on-premises or another cloud. It maintains central management in Azure and brings the data plane closer to the backends or consumers. This architecture requires outbound connectivity for configuration synchronization and, when enabled, sending telemetry. It also requires local responsibility for container , update, security and availability.

Workspaces allow you to delegate API administration and to teams, maintaining shared infrastructure. They have their own resources and gateways within the supported model. Workspaces are not just folders: they introduce administration, ownership and runtime limits that need to be incorporated into the governance design.

Table 2 - The type of gateway changes the operational and responsibility model.
OptionTypical usageCritical responsibility
Managed gatewayManaged exposure on Azure.Choose tier, scale, network and regions.
Self-hosted gatewayOn-prem, multicloud and backend proximity.Operate container, capacity and connectivity.
Workspace gatewayTeam runtime in federated governance.Define workspace ownership and limits.
ConsumptionElastic load and consumption model.Validate limitations and scaling behavior.

24.4 APIM Resource Model

An API in APIM is a managed facade. It has name, display name, path, protocols, requirements and operations. Each defines a method and URL template, and may have its own parameters, representations and policies. The identifies the actual destination and can encapsulate URL, credentials, circuit breaker, pool or other properties depending on available resources.

Products group APIs and define a consumption unit. A may require a , have terms and associate quotas or policies. Subscriptions generate access credentials, normally a primary key and a secondary key, which facilitate rotation. Users and groups control who accesses products through the portal. This model is useful for onboarding, but should not be confused with fine business authorization.

Named values store reusable parameters in policies. They can contain simple values, secret values, or references to Key Vault, depending on the configuration. Certificates represent certificates used in hostnames, client validation, or authentication. Loggers and diagnostics connect the gateway to observability targets. The design must treat these resources as code and maintain ownership, naming and lifecycle.

Table 3 - Administrative resources have different responsibilities.
ObjectFunctionCommon mistake
APIGroup operations under a facade.Mixing incompatible domains and lifecycles.
operationDefine method and logical route.Ambiguous or ungoverned templates.
BackendRepresent the target and its configuration.Duplicate URL and credentials in policies.
ProductPackage APIs for consumption.Use product as business authorization.
SubscriptionIdentify consumption and provide key.Share key between applications.
Named valueParameterize policies and secrets.Write secret directly to XML.

24.5 Importing and publishing APIs

APIM can create or import APIs from sources such as OpenAPI, WSDL, OData, Azure Compute Services, WebSocket, GraphQL, and gRPC backends, as currently supported by the service and tier. Import speeds up registration, but does not automatically transform a fragile contract into a governed API. Paths, IDs, schemas, security, servers, examples and descriptions need to be reviewed before publishing.

OpenAPI is the most common option for HTTP APIs. The import process creates operations and metadata, but certain extents, limits, and versions of the specification may have restrictions. For SOAP, a WSDL can be imported as a pass-through or used in REST conversion scenarios. GraphQL and WebSocket have their own models and policies that apply differently. The pipeline must validate the API type and test the actual behavior at the gateway.

Publishing an API involves more than importing it. It is necessary to configure the URL base, , policies, security, , , documentation, versioning, revision and observability. Revisions allow you to test changes under the same public version; versions represent distinct interfaces for consumers. The promotion must be automated and accompanied by smoke tests.

Conceptual pipeline - API publishing to APIM

# Conceptual publishing flow
Validated contract
  -> API import or update
  -> backend and named values configuration
  -> policy application by scope
  -> product association
  -> gateway tests
  -> publishing to the developer portal
  -> observability and rollout

24.6 Policies: sections, order and context

Policies are XML documents executed by the gateway. The configuration is divided into inbound, , outbound and on-error. Inbound processes the request before forwarding: authentication, rate limit, rewrite, validation and transformation are common examples. controls interaction with the destination, including forwarding and retries. Outbound processes the response. On-error is executed when failure occurs and allows you to standardize error, record telemetry or implement controlled paths.

The order of statements is semantic. A JWT validation performed after a sensitive send-request does not protect the call already made. A rewrite before the correct selection of can change the context. A return-response stops execution and produces an immediate response. If a failure occurs, remaining steps from the normal sections are skipped and execution goes to on-error.

Policy expressions use limited C# to evaluate context, headers, variables, and results. They are powerful and can introduce complex logic. The gateway must not turn into a monolithic application written in XML. Policies need to remain short, testable and focused on cross-cutting concerns. Extensive business logic belongs to the or a specific component.

APIM inbound, backend, outbound and on-error pipeline
Figure 2 - The gateway executes statements in sequence and switches to on-error when a failure occurs.
Simplified example - policy XML
<policies>
  <inbound>
    <base />
    <set-variable name="correlationId"
                  value="@(context.Request.Headers.GetValueOrDefault("x-correlation-id", Guid.NewGuid().ToString()))" />
    <validate-jwt header-name="Authorization" failed-validation-httpcode="401">
      <openid-config url="https://login.microsoftonline.com/{tenant}/v2.0/.well-known/openid-configuration" />
    </validate-jwt>
  </inbound>
  <backend>
    <base />
    <forward-request timeout="30" />
  </backend>
  <outbound><base /></outbound>
  <on-error><base /></on-error>
</policies>

24.7 Scopes, inheritance and basis

Policies can be applied to scopes such as global, , , API and , depending on the resource and type of gateway. The composition allows imposing general controls and specializing rules close to the . The base element includes policies inherited from the higher scope. Where base is placed defines when the inherited chain executes relative to statements in the current scope.

Omitting base can break inheritance and allow an API to no longer receive authentication, logging or globally defined limits. On the other hand, blindly inheriting all policies can produce duplication, incorrect order, or unexpected impact. Mature governance defines which controls are mandatory and how exceptions are approved.

The scope must be used with care because an API can be associated with multiple products or be called by in a different scope. Business authorization should not depend solely on the presence of a . Global and help implement baseline, while API and specialize behavior. Each policy must declare the expected scope and its dependencies.

Table 4 - Scope defines the reach and risk of a policy change.
ScopeTypical applicationCaution
GlobalSecurity and observability baseline.Wide blast radius.
WorkspaceCommon rules for a federated team.Coherence with central baseline.
ProductConsumption limits and rules.Multiple membership and subscription.
APIContract and backend of an API.Do not duplicate global policy.
operationException or specific semantics.Avoid excessive fragmentation.

24.8 Named values and policy expressions

Named values allow you to replace repeated literals with managed names, such as URLs, audiences, timeouts, flags and keys. Secret values can be protected and references to Azure Key Vault reduce the need to store sensitive material in APIM. Still, Key Vault access policy, , and connectivity need to be monitored. External reference does not eliminate operational dependency.

Policy expressions access context.Request, context.Response, context.API, context. , context. and variables. They can process strings, dates, JSON, certificates and claims within the allowed set. Because errors in expressions occur at runtime, pipelines must test for positive, negative paths, and missing values. Use of GetValueOrDefault is preferable when a header may not exist.

Policy fragments allow reuse, but require versioning and ownership. A change in shared shard can affect many APIs. It is recommended to maintain catalog, unit or functional tests, peer and progressive rollout. Named values must have stable names and not incorporate the environment in a confusing way.

Secret is not common configuration

Never register keys, tokens, passwords or certificates directly in policy, repository or trace. Use secret named values, Key Vault, managed identities and log masking.

24.9 Identity, subscriptions and authorization

APIM can require keys, validate JWTs, authenticate clients by certificate, use Basic in legacy integrations and obtain tokens for backends. key identifies a and enables quotas or analytics, but does not replace strong user identity or business authorization. Keys must be separated by application, rotated and protected against leakage.

validate-jwt and validate-azure-ad-token are used to validate tokens according to issuer, audience, and claims. The policy must verify the elements required by the contract, not just accept any token issued by a tenant. After validation, claims can be used for simple decisions or sent to an external PDP. Complex authorizations should avoid extensive lists encoded in XML.

allows the gateway to obtain Microsoft Entra ID access tokens to access protected backends and resources without storing client secrets. The authentication-managed-identity policy requests and keeps the token cached until expiration. You must grant permissions to the correct identity and ensure connectivity to the resource. In environments with user-assigned identities, the design must document which identity each uses.

Table 5 - Mechanisms can be combined; they solve different problems.
MechanismWhat does it proveProper use
Subscription keyPossession of a subscription key.Measurement, onboarding and basic access.
JWT/OAuthToken issued and claims validated.User or application APIs.
Client certificatePossession of the associated private key.mTLS and B2B partners.
Managed identityAPIM Azure Identity.Gateway authentication on the backend.

24.10 TLS, mTLS, certificates and Key Vault

The gateway terminates TLS on the published hostname. Custom domains allow you to use your own corporate names and certificates. Azure Key Vault is recommended for managing hostname certificates and facilitating renewal, as long as the has access and the reference remains valid. The needs to monitor expiration, chain, name, secret version, and update in APIM.

mTLS can be applied at the input to authenticate consumers by certificate and at the output to authenticate the APIM against the . Upon entry, the gateway needs to negotiate and validate the certificate according to the topology. Previous proxies may change the way the certificate is presented and need to be considered. In the output, the client certificate is associated or referenced by policy and must contain a usable private key.

Self-signed certificates or private chains require explicit installation and trust. Troubleshooting must separate TLS negotiation failure, chain failure, hostname mismatch, policy expiration and rejection. Certificate renewal without testing may cause unavailability when the new material does not contain the expected string or format.

Conceptual example - certificates in policy

<authentication-certificate thumbprint="{{backend-client-cert-thumbprint}}" />
<!-- Simplified client certificate validation -->
<choose>
  <when condition="@(context.Request.Certificate == null)">
    <return-response>
      <set-status code="401" reason="Client certificate required" />
    </return-response>
  </when>
</choose>

APIM network architecture needs to distinguish inbound access to the gateway and outbound connectivity to the . A private endpoint creates a private entry to the gateway endpoint via Azure Private Link. It does not, by itself, provide a private route from the APIM to the backends. To achieve private services, the gateway needs tier-compliant outbound connectivity, such as VNet integration or injection, peering, private DNS, and appropriate routes.

In classic tiers that support VNet, external mode keeps the gateway externally accessible while allowing it to reach network resources; internal mode publishes endpoints to the virtual network and requires a back layer or private access. In v2 tiers, integration and private endpoint models have their own characteristics. As differences are significant, the choice needs to be validated in the documentation of the adopted tier family.

DNS is a frequent dependency. The gateway needs to resolve hostnames, identity endpoints, Key Vault, and telemetry services. A private endpoint without the correct private DNS zone can resolve to a public address. UDRs, NSGs, firewalls, and TLS inspection can block control or data calls. Tests must record origin, destination, resolution and effective route.

In March 2026, Microsoft removed the gateway's trusted service connectivity mechanism for certain Azure services in the data plane. Architectures that relied on this bypass need to use explicit network connectivity. This change reinforces a general principle: implicit connectivity and firewall exceptions should be treated as versioned and monitored dependencies.

Private entry into APIM and private access to backends
Figure 3 - Private ingress and private access are different network issues.
Table 6 - Network diagnosis needs to observe the actual point of execution.
SymptomVerification
Gateway responds, backend times outBackend DNS, egress route, NSG, firewall and port.
Private endpoint exists, but access uses public IPPrivate DNS zone, VNet bond, and cache.
Works on portal, fails on gatewayNetwork origin and identity are different.
Custom domain does not updateAccess to Key Vault, managed identity and certificate version.

24.12 High availability, zones and multi-region

Scale in APIM is expressed by units, tier and, in some models, elastic behavior. Adding drives increases and can contribute to redundancy. The metric should be interpreted along with latency, requests, logical CPU, heavy policies and dependencies. Load testing is essential because throughput varies depending on payload, TLS, policy and cache.

Availability zones protect against zone failure in supported regions and tiers. The redundancy recommendation must consider a minimum number of units and automatic or configured distribution according to the service. Zones do not protect against regional failure, global configuration error, or unavailable . Multi-region adds regional gateways to an instance and can reduce latency and improve resiliency, but requires routing design, certificates, backends, and shared data.

A multi-region deployment needs to decide how the consumer chooses the region, typically with DNS or global inbound service. Policies and configuration are distributed, but backends can have different topologies. Named values and regional routes need to be explicit. Failover must be tested, including the possibility of an APIM region being healthy while the regional is unavailable.

Self-hosted gateways add another dimension: they can maintain processing close to the even when low-latency connectivity to Azure is degraded, within supported synchronization and health limits. The organization is responsible for replicas, probes, updating, and cluster resources.

Scale units, availability zones, multi-region and self-hosted gateway
Figure 4 - , zone, region and hybrid gateway resolve different classes of failure.

24.13 Backends, resilience, cache and limits

Backends should be defined as reusable resources when multiple APIs share target, credentials, or parameters. Policies like set- -service select the . Retries need to be used with discretion: repeating a non-idempotent can double the effect. APIM retry executes child policies according to condition and count; it does not automatically make safe.

Timeouts need to form an end-to-end budget. The consumer timeout must be greater than necessary for the gateway and , but not so high as to maintain resources indefinitely. Auxiliary call by send-request is also time consuming. Circuit breaker and pools, when available in the adopted model, help contain failures, but require coherent thresholds and observability.

Caching can reduce latency and load, but only appropriate responses should be stored. Custom data, tokens, sensitive headers, and per-user variations require correct keys and rules. Rate limit controls bursts or rate per window; quota controls accumulated volume. Policies can use , IP, claim or another key, but cardinality and distribution need to be evaluated.

The gateway should not compensate indefinitely for a poorly sized . Retries, caching, and throttling are resilience controls, not replacements for and correctness. An aggressive policy can amplify failures: synchronized retries increase load, payload logging consumes resources and extensive transformations increase latency.

Table 7 - Resilience needs to consider semantics and behavior in failure.
ControlBenefitRisk
RetryRecover transient failure.Duplicity and storm of retries.
CacheReduce latency and load.Leak or outdated answer.
Rate limitContain rate in short window.Incorrect key groups consumers.
QuotaControl accumulated consumption.Unexpected period blocking.
TimeoutLimit waiting and resources.Premature cuts or stuck connections.

24.14 Workspaces and federated governance

Workspaces were created to allow decentralized teams to administer and publish APIs to a shared APIM infrastructure. A contains supported APIs, products, subscriptions, and other resources, with separate administrative access and associated gateway. This allows for a federated model: the central platform operates infrastructure and baseline; Domain teams control the lifecycle of their APIs.

The benefit comes with new frontiers. Global, and local polices need to be composed without bypass. Naming, tags, ownership, diagnostics, costs and limits must be standardized. Teams should not be granted service-wide permissions when only one is needed. At the same time, the platform needs to avoid excessive centralization that turns each change into an operational queue.

Workspaces do not mean complete physical isolation. Depending on the tier and gateway, infrastructure resources and limits may be shared. The compliance assessment must check data plane, logs, identities, network and blast radius. The feature evolves quickly and its matrix needs to be reviewed before architectural commitments.

Table 8 - Federation requires explicit responsibilities.
ResponsibleSuggested functions
Central platformLanding zone, tier, network, identity, baseline, observability and guardrails.
Domain TeamContracts, backends, specific policies, products and functional support.
SecurityToken standards, certificates, logging and exception approval.
SRE/OperationCapacity, incidents, SLOs, failover tests and runbooks.

24.15 , products and onboarding

The transforms the technical catalog into a consumer experience. APIs are presented directly or within products, with documentation, examples and a test console. Consumers can create an account, request a and obtain keys according to the configured workflow. In external APIs, terms of use, contact, limits and support processes need to be visible.

Products must represent coherent offerings, not just arbitrary groupings. A can differentiate between sandbox and production, partner and internal, or service levels. policies may apply quota, but business contracts and authorization remain at appropriate layers. The portal should avoid publishing internal endpoints, sensitive headers, or actual payloads in examples.

Portal customization needs to be versioned and tested. Identity, domain, CORS, or content changes can prevent onboarding even if the gateway is healthy. API Center can complement multigateway enterprise discovery, while the APIM remains focused on consuming the APIs managed on that platform.

24.16 Observability and troubleshooting

APIM exposes metrics and resource logs through Azure Monitor and can integrate diagnostics with Application Insights. Metrics show volume, latency, , and response codes. Gateway logs allow you to investigate request, , , policy and error. Application Insights adds correlation and distributed analysis when the also participates in the trace.

Observability needs to balance detail and security. Payload logging can capture personal data, tokens and secrets. Headers must be allowlisted and masked. Sampling reduces cost, but can hide rare errors. Correlation IDs need to be propagated to the and returned to the consumer when appropriate. The policy trace can add customized events to traces and telemetry according to configuration.

The must separate the error generated by the APIM from the error returned by the . A 401 can come from validate-jwt, , mTLS or business service. A 502 can indicate DNS, TLS, or connection failure, but also invalid response transformation. The LastError context in on-error provides source, reason, message, scope, section and path, useful for classifying the failed step.

Test traces are useful, but they should be protected and not used as a substitute for continuous telemetry. Health checks validate the gateway; synthetic transactions validate the journey. Dashboards should separate total latency, time and policy time to avoid blaming the wrong component.

Table 9 - Each telemetry source responds to a different layer.
SignalQuestion answered
Gateway requests and statusWhat volume and what responses did the consumer receive?
Backend durationHow much time was spent on the target service?
CapacityDoes the gateway approach the tier/unit limit?
Application InsightsWhich dependency, trace and exception participated?
Activity LogWho changed the resource or administrative setting?

24.17 Automation, CI/CD and infrastructure as code

Manual configuration through the portal is useful for learning and diagnostics, but it should not be the main way to promote environments. APIM can be administered by ARM, Bicep, Terraform, REST, PowerShell and CLI. Contracts, policies, named values, backends, products and diagnostics must be versioned. Secrets should go in via secure references, not the repository.

Pipelines need to separate platform infrastructure and API content when ownership is different. A central team can provision instance, network, identities and logs; Domain teams publish APIs and policies within guardrails. XML Lint, OpenAPI validation, contract diff, policy tests, smoke tests and change approval reduce regressions.

Revisions allow you to test a change without immediately changing the public version. After validation, a revision becomes current. Versions allow coexistence of incompatible contracts. Rollback must consider which configuration may have been propagated and which consumers may have observed the change. Backup and restore, when applicable to the tier and model, do not replace source code and automated reconstruction.

Drift between the portal and repository is a risk. Azure Policy, RBAC, locks, and pipelines help reduce untracked changes. When
an emergency correction is made manually, it must be reconciled with the code immediately.
Conceptual example - API Management as code
# Suggested repository structure
infra/
  apim.bicep
  networking.bicep
  diagnostics.bicep
apis/
  customers/openapi.yaml
  customers/policies/
    api-policy.xml
    operations/
shared/
  policy-fragments/
  naming-and-standards.md

24.18 Security, hardening and case studies

Hardening starts by reducing exposure. Management plan must use least privilege RBAC, PIM, and audit trails. Gateway must only accept protocols, cipher suites and hostnames necessary within the service's capabilities. Public network access must be disabled when the private architecture is validated. Custom domains, certificates and DNS need ownership and automated renewal.

Global policies must enforce authentication baselines, headers, limits and logging, but exceptions must be explicit. Named values and certificates should use Key Vault when appropriate. Traces and logs cannot record credentials. Administrative APIs and portals must be secured separately from the gateway endpoint. Dependencies such as Entra ID, Key Vault, Application Insights and DNS need monitoring.

Case study 1: A public API uses Azure Front Door with WAF in front of APIM, private endpoint on the gateway and private backends. Front Door provides global entry and L7 protection; APIM performs OAuth, quotas, and transformation. The design needs to guarantee private DNS, cross-layer certificate and secure preservation of the original IP.

Case study 2: a company maintains OpenShift backends on-premises and uses a in the cluster. Azure maintains configuration and catalog, while traffic remains local. The needs to scale replicas, use mTLS, guarantee 443 output for synchronization, and monitor container versions.

Case study 3: Payments, credit and registration teams use workspaces. The central platform applies baseline and observability, while each domain manages APIs and products. The main risk is that a policy ignores inheritance or creates inconsistent behavior; Automatic tests verify mandatory bases and standards.

Next step of the course

With Axway and Azure APIM studied, the next chapter delves into API Security according to the OWASP API Security Top 10, connecting concrete threats to gateway, application, identity and controls.

Chapter summary

Azure API Management separates management plane, data plane, and consumption experience. The gateway executes policies and forwards traffic; the management plan manages the configuration; The organizes discovery and onboarding. Managed, self-hosted and gateways serve different topologies and transfer different operational responsibilities.

The resource model combines APIs, operations, backends, products, subscriptions, named values, certificates and diagnostics. Policies are executed in inbound, , outbound and on-error, with scopes and inheritance controlled on a per-base basis. The order of statements is part of the behavior and needs testing.

Network and availability depend on tier. Private endpoint protects input, while connectivity requires output design. Scale units, zones and multi-regions resolve different classes of failure. , Key Vault, TLS and mTLS reduce secrets, but depend on permissions and connectivity.

Mature requires observability, automation, drift control, contract testing, , and runbooks. APIM is managed, but the organization remains responsible for architecture, policies, identity, data, backends and customer experience.

Architecture and checklist

  • The tier and gateway type were chosen based on the current resource matrix and required SLA.
  • Input to the gateway and output to backends have a separate and documented network design.
  • DNS, certificates, custom domains and private endpoints have testing and ownership.
  • Global and policies use the basis and have a formal exception process.
  • keys are not used as a substitute for identity and business authorization.
  • Managed identities have only necessary permissions and do not rely on implicit firewall bypass.
  • Named values, secrets and certificates use appropriate storage and rotation.
  • Timeouts, retries, cache, rate limits and quotas were tested in failure scenarios.
  • Metrics, logs, Application Insights, and synthetic transactions cover the journey.
  • Configuration is versioned and published via pipeline with smoke test and rollback plan.
  • High availability includes backends, identity, DNS, global ingress, and recovery process.
  • and products expose only approved documentation and examples.

Labs and exercises

  • Import an OpenAPI and identify generated APIs, operations and .
  • Create inbound, outbound and on-error policies and observe the order of execution.
  • Apply a global and an API policy using base; test the effect of omitting foundation in the laboratory.
  • Configure a and replace a policy literal.
  • Validate a JWT and differentiate 401 from 403 in controlled responses.
  • Use to authenticate APIM to a protected .
  • Configure a custom domain with a Key Vault certificate in a test environment.
  • Design a topology with Front Door, private endpoint and private , indicating DNS and routes.
  • Create a dashboard with requests, status, duration and .
  • Simulate timeout and capture LastError in on-error.
  • Model a with platform and domain responsibilities.
  • Write a conceptual import, policy, test, and publish pipeline.

Glossary

Table 10 - Essential vocabulary of the chapter.
TermDefinition
API Management instancesAzure resource that brings together configuration, gateway, and management capabilities.
BackendResource representing the destination called by the gateway.
Base policyElement that includes policies inherited from the higher scope.
CapacityMetric that indicates relative utilization of gateway capacity.
Developer portalDiscovery, documentation, testing and onboarding portal.
DiagnosisTelemetry emission configuration for logger or destination.
Managed gatewayData plane operated by Microsoft.
Managed identityIdentity Login administered by Azure for access without static secret.
Named valueReusable parameter used in policies.
operationCombination of method and URL template within an API.
Policy expressionLimited C# expression evaluated at policy runtime.
ProductAPI package offered to consumers.
ReviewReview of an API under the same public version.
Self-hosted gatewayAPIM gateway running as a container in the customer's infrastructure.
SubscriptionConsumer entity that can have primary and secondary keys.
WorkspaceAdministrative boundary for federated API management.
Workspace gatewayGateway associated with a workspace's runtime.

Technical references

  • Microsoft Learn. Azure API Management - Overview and key concepts. Updated in 2025.
  • Microsoft Learn. API Gateway in Azure API Management. Updated May 2026.
  • Microsoft Learn. Azure API Management v2 tiers. Updated March 2026.
  • Microsoft Learn. Feature-based comparison of Azure API Management tiers. Updated in 2026.
  • Microsoft Learn. Policies in Azure API Management. Updated May 2026.
  • Microsoft Learn. Workspaces in Azure API Management. Updated June 2026.
  • Microsoft Learn. overview and support policies. Updated in 2026.
  • Microsoft Learn. Set up inbound private endpoint for Azure API Management. Updated June 2026.
  • Microsoft Learn. Reliability in Azure API Management and multi-region deployment.
  • Microsoft Learn. Use managed identities in Azure API Management. Updated April 2026.
  • Microsoft Learn. Integrate Azure API Management with Application Insights. Updated March 2026.
  • Microsoft Learn. Observability in Azure API Management. Updated June 2026.
  • Microsoft Learn. Import OpenAPI and SOAP APIs into Azure API Management.
  • Microsoft Azure Well-Architected Framework. Service guide for Azure API Management.

Update note

Azure API Management evolves frequently. Tiers, regions, limits, workspaces, gateways and policies can change. Before implementing a decision, validate the official documentation and resource matrix for the selected region and tier.