Microsoft Azure API Management and How Cloudockit Can Help You Document It?


Regan Kong


3 min

Azure API management (APIM) allows you to publish, secure, transform, maintain and monitor multiple APIs.

APIM allows organizations to use their existing back-end services to create complete API programs by creating consistent and modern API gateways. It offers developer engagement, business insights, analytics, security and protection. Azure offers a secure platform to manage APIs that can verify credentials, enforce policies, log data to be used for analytics purposes, manage users and much more.

An application programming interface (API) is a computing interface exposed by a particular software program, library, operating system or internet service, to allow third parties to use the functionality of that software application. Wikipedia

Currently, Azure offers the following features at different tier prices:

Microsoft Azure APIM Security

APIM is used to help secure your resources by stripping response headers, limiting the number of calls made to the API. It also has the following built-in security controls:

The Typical Architecture of Microsoft Azure API Management

The Azure API Management is composed of 3 components:

The API gateway

The API gateway serves as an endpoint that handles API calls, credentials, usage quotas, caching and more. The gateway can connect to REST, RESTful and SOAP APIs. It can also connect to the following azure resources: Logic Apps, App Services and Function Apps.

The Azure portal

The Microsoft Azure portal is a web interface where the API program is set up. It offers functionalities such as API packaging, policy settings, user management and more. Furthermore, an analytics portal is also available to consult data on users, requests, subscriptions and operations.

The developer portal

The developer portal allows developers to read the API documentation, try out the API, get API keys and access analytics based on their own usage.

Let Cloudockit auto-generate your cloud diagrams

Free Trial

Dependencies of APIMs with Cloudockit

Cloudockit can easily detect the following dependencies for API Manager in your Azure environment:

    • API
    • Logic Apps
    • App Services
    • Function Apps

APIMs in a Diagrams

An API Management diagram should display its dependencies on any external resources or APIs.

Currently, Azure API Management can use Logic Apps, App Services, Function Apps and external APIs. As your API Manager grows, so will its dependencies, that is where Cloudockit comes into play. Cloudockit can scan your cloud environments and detect all dependencies related to your API Management resources. Below is an example of a diagram generated by Cloudockit for an API Management resource that uses two external APIs, a Function App, an App Service and a Logic App.

Coupled with the Cloudockit’s Track Changes feature, it is possible to detect changes made to an API Management resource. For example, it is possible to be notified when an API is added or deleted between two document generations.

APIMs in Word Documents

Cloudockit detects every APIM on your environment and generates a Word Document with relevant information such as its name, resource group, location, type, date of creation, developer portal URL, gateway URL, Tier, Virtual IP addresses and products.

One tool to rule them all

AWS Amazon Web Services
Microsoft Azure
Microsoft Hyper-V