July 22, 2024


Our trade has seen an evolution in how we run software program. Historically, platforms have been working in on-premises datacenters however began to transition to the cloud. Nonetheless, not all workloads can transfer or prospects need to have resiliency throughout clouds and edge which launched multi-cloud situations.

With our self-hosted gateway capabilities, prospects can use our present tooling to increase to their on-premises and multi-cloud APIs with the identical role-based entry controls, API insurance policies, observability choices, and administration aircraft that they’re already utilizing for his or her Azure-based APIs.

New to the self-hosted gateway, how does it work?

When deploying an Azure API Administration occasion in Azure prospects get three foremost constructing blocks:

  • A developer portal (additionally known as consumer aircraft) for permitting inner and exterior customers to seek out documentation, take a look at APIs, get entry to APIs, and see primary utilization information amongst different options.
  • An API gateway (additionally known as information aircraft), which comprises the principle networking element that exposes API implementations, applies API insurance policies, secures APIs, and captures metrics and logs of utilization amongst different options.
  • Lastly, a Administration Airplane, which is used by means of the Azure Portal, Azure Useful resource Supervisor (ARM), Azure Software program Improvement Kits (SDKs), Visible Studio and Code extensions, and command-line interfaces (CLIs) that permit to handle and implement permissions to the opposite elements. Examples of this are organising APIs, configuring the infrastructure, and defining insurance policies.

Architecture diagram depicting the components and features of Azure API Management Gateway.

Determine 1: Structure diagram depicting the elements and options of Azure API Administration Gateway.

Within the case of the self-hosted gateway, we offer prospects with a container picture that hosts a model of our API Gateway. Clients can run a number of cases of this API Gateway in non-Azure environments and the one requirement is to permit outbound communications to the Administration Airplane of an Azure API Administration occasion to fetch configuration and expose APIs working in these non-Azure environments.

Architecture diagram depicting the components of a distributed API Gateway solution using the self-hosted gateway.

Determine 2: Structure diagram depicting the elements of a distributed API Gateway resolution utilizing the self-hosted gateway.

Supported Azure API Administration tiers

The self-hosted gateway v2 is now typically out there and absolutely supported. Nonetheless, the next circumstances apply:

  • You want an energetic Azure API Administration occasion; this occasion must be on the Developer tier or Premium tier.

    • Within the developer tier, on this case the characteristic is free for testing, with limitations of 1 energetic occasion.
    • Within the Premium tier, you’ll be able to run as many cases as you need. Study extra about pricing at our pricing desk.

  • Azure API Administration will at all times provision an API Gateway in Azure, which we sometimes name our managed API gateway.

    • Bear in mind that there are variations in options between our numerous API gateway choices. Study extra in regards to the variations in our documentation.

Pricing and gateway deployment

Within the case of the self-hosted gateway, we are able to outline a self-hosted gateway by assigning a reputation to our gateway, a location (which is a logical grouping that aligns with your online business, not an Azure area), an outline, and eventually what APIs we need to expose on this gateway. This permits us to do bodily isolation of APIs on the gateway stage, which is barely attainable within the self-hosted gateway at this second. This mixture of location, APIs, and hostname is what defines a self-hosted gateway deployment, this “self-hosted gateway deployment” shouldn’t be confused with a Kubernetes “deployment” object.

For instance, utilizing a single deployment, the place the identical APIs are configured in all areas:

Architecture diagram describing the pricing model for a single deployment of a self-hosted gateway.

Determine three: Structure diagram describing the pricing mannequin for a single deployment of a self-hosted gateway.

Nonetheless, you too can create a number of self-hosted gateway deployments to have extra granular management over the completely different APIs which can be being uncovered:

Architecture diagram describing the pricing model for two deployments of a self-hosted gateway.

Determine four: Structure diagram describing the pricing mannequin for 2 deployments of a self-hosted gateway.

Supportability and shared tasks

One other essential side is the assist, within the case of the self-hosted gateway, the infrastructure just isn’t essentially managed by Azure, subsequently as a buyer you’ve got extra tasks to make sure the correct functioning of the gateway:

Microsoft Azure

Shared Tasks


Managed service service stage agreements ( SLA), for the administration aircraft, entry to configuration and talent to obtain telemetry.

Securing self-hosted gateway communication with Configuration endpoint: the communication between the self-hosted gateway and the configuration endpoint is secured by an entry token, this token expires routinely each 30 days and must be up to date for the working containers.

Gateway internet hosting, deploying, and working the gateway infrastructure: digital machines with container runtime or Kubernetes clusters.

Gateway upkeep, bug fixes and patches to container picture.

Conserving the gateway updated: usually updating the gateway to the newest model and newest options.

Community configuration, vital to keep up administration aircraft connectivity and API entry.

Gateway updates, efficiency, and practical enhancements to container picture.


Gateway SLA, capability administration, scaling, and uptime



Conserving the gateway updated, usually updating the gateway to the newest model and newest options.



Offering diagnostics information to assist, amassing, and sharing diagnostics information with assist engineers



Third get together open-source software program (OSS ) software program elements, including further layers like Prometheus, Grafana, service meshes, container runtimes, Kubernetes distributions, proxies are buyer duty.

New options and capabilities of v2 and v1 retirement

When utilizing the newest variations of our v2 container picture, tag 2.zero.zero and or increased, you’ll be capable of use the next options:

  • Opentelemetry metrics: the self-hosted gateway might be configured to routinely accumulate and ship metrics to an OpenTelemetry Collector. This lets you carry your personal metrics assortment and reporting resolution for the self-hosted gateway. Right here yow will discover an inventory of supported metrics.
  • New picture tagging: we offer 4 tagging methods to satisfy your wants relating to updates, stability, patching, and manufacturing environments.
  • Helm chart: a brand new deployment possibility with a number of variables so that you can configure at deployment time like backups, logs, OpenTelemetry, ingress, probes, and in addition Distributed Utility Runtime (DAPR) configurations. This helm chart along with our pattern Yaml recordsdata can be utilized for automated deployments with steady integration and steady supply (CI and CD ) instruments and even Gitops instruments.
  • Artifact registry: yow will discover all our artifacts in our centralized Microsoft Artifact Registry for all of the container photographs offered by Microsoft.
  • New EventGrid occasions: a brand new batch of supported EventGrid occasions associated to the self-hosted gateway operations and configurations. The total listing of occasions might be discovered right here.

Please keep in mind that we’ll be retiring assist for the v1 model of our self-hosted gateway, so that is the right time to improve to v2. We additionally present a migration information and a information for working the self-hosted gateway in manufacturing.


Source link