Skip to content

Latest commit

 

History

History
90 lines (50 loc) · 4.13 KB

README-common.md

File metadata and controls

90 lines (50 loc) · 4.13 KB
Raw

Azure API Management (APIM) - Big Picture View

This architecture shows the big picture view of Azure API Management (APIM) and introduction to the terminology and common design components used in different sections of this series. This reference architecture also demonstrates the high level placement of APIM in different modes (Internal,External and Default/None). The main focus of this series is the different networking modes which are detailed out in seperate sections throughout the series.

Reference Architecture

APIM Architecture Download Multi-tab Visio and PDF

Azure Documentation links

  1. APIM External Mode
  2. APIM Internal Mode
  3. Terminology

Design Components and Terminology

APIM Endpoints

Note: APIM creates a secure facade for your APIs. The varios sevice endpoints with APIM are listed below. Default service endpoints are registered in public DNS for External and Default mode. None of the service endpoints are registered on public DNS in internal mode.

Example:

API Gateway :           nnapi-default.azure-api.net

API Legacy Portal:      nnapi-default.portal.azure-api.net

API Developer Portal:   nnapi-default.developer.azure-api.net

API Management Endpoint nnapi-default.management.azure-api.net

API Git                 nnapi-default.scm.azure-api.net

Backend API

A backend in APIM is an HTTP service that implements the CRUD operations. This could run in Azure PaaS services like AKS, Azure Functions or Azure logic Apps. This could also run on a IaaS VM in Azure or on-premises. The backend API URLs are referenced in the APIs created with APIM.

APIM Architecture

Products

APIM Products contains one or more APIs. Developers subscribe to products using the developer portal and cosume the APIs. APIM Architecture

Subscriptions

In APIM, API consumers access APIs using subscription keys. Azure documentation link here

APIM Architecture

APIM Network Modes

This section is the key area of focus for the series of reference architectures. Each of these modes are detailed out in next sections.

Default/None mode: This mode does not integrate with an Azure VNET. APIM Endpoints are accessible from the internet.

Internal Mode: APIM is deployed in an Azure subnet and has a virtual IP (VIP) in the APIM subnet. APIM Endpoints are not accessible from the Intenet but accessible within the VNET and over a private connection. APIM can access backend APIs within the VNETs and over the private connection to an on-premises datacenter. Note: Use APIM with application gateway for inbound public access to APIM endpoints.

External Mode: APIM is deployed in an Azure subnet. APIM endpoints are accessible from the public internet. Backend APIs and resources are accessible within the VNET and using a private connection.

Example:

APIM Architecture

Developer/Consumer Portal

Developer portal is used by consumers (developers) to access the APIs. Developer portal can be customized. Developer portal is exposed via private IP in case of the internal mode APIM. DNS considerations apply.

APIM Architecture

Azure Portal

Azure portal is used by the administrator to configure and manage an APIM PaaS service

APIM Architecture

Other Design Components

Please refer to specific article in this series for more details on other design components

  1. LetsEncrypt Certificates and Custom Domain
  2. Identity Components (AAD and B2C)
  3. APIM Internal Mode with Application Gateway
  4. APIM with Azure Firewall
  5. APIM Multi-region
  6. Postman Collection