Compute platform for Azure API Management

As a cloud platform-as-a-service (PaaS), Azure API Management abstracts many details of the infrastructure used to host and run your service. You can create, manage, and scale most aspects of your API Management instance without needing to know about its underlying resources.

To enhance service capabilities, we're upgrading the API Management compute platform version - the Azure compute resources that host the service - for instances in several service tiers. This article gives you context about the upgrade and the major versions of API Management's compute platform: stv1 and stv2.

We've minimized impacts of this upgrade on your operation of your API Management instance. Upgrades are managed by the platform, and new instances created in service tiers other than the Consumption tier are mostly hosted on the stv2 platform. However, for existing instances hosted on the stv1 platform, you have options to trigger migration to the stv2 platform.

What are the compute platforms for API Management?

The following table summarizes the compute platforms currently used for instances in the different API Management service tiers.

Version Description Architecture Tiers
stv2 Single-tenant v2 Azure-allocated compute infrastructure that supports availability zones, private endpoints Developer, Basic, Standard, Premium1
stv1 Single-tenant v1 Azure-allocated compute infrastructure Developer, Basic, Standard, Premium
mtv1 Multi-tenant v1 Shared infrastructure that supports native autoscaling and scaling down to zero in times of no traffic Consumption

1 Newly created instances in these tiers, created using the Azure portal or specifying API version 2021-01-01-preview or later. Includes some existing instances in Developer and Premium tiers configured with virtual networks or availability zones.

Note

Currently, the stv2 platform isn't available in the US Government cloud or in the following Azure regions: China East, China East 2, China North, China North 2.

How do I know which platform hosts my API Management instance?

Starting with API version 2021-04-01-preview, the API Management instance exposes a read-only platformVersion property that shows this platform information.

You can find this information using the portal or the API Management REST API.

To find the platformVersion property in the portal:

  1. Go to your API Management instance.

  2. On the Overview page, select JSON view.

  3. In API version, select a current version such as 2021-08-01 or later.

  4. In the JSON view, scroll down to find the platformVersion property.

    platformVersion property in JSON view

How do I migrate to the stv2 platform?

The following table summarizes migration options for instances in the different API Management service tiers that are currently hosted on the stv1 platform. See the linked documentation for detailed steps.

Note

Check the platformVersion property before starting migration, and after your configuration change.

Tier Migration options
Premium 1. Enable zone redundancy
-or-
2. Create new external or internal VNet connection1
-or-
3. Update existing VNet configuration
Developer 1. Create new external or internal VNet connection1
-or-
2. Update existing VNet configuration
Standard 1. Change your service tier (downgrade to Developer or upgrade to Premium). Follow migration options in new tier.
-or-
2. Deploy new instance in existing tier and migrate configurations2
Basic 1. Change your service tier (downgrade to Developer or upgrade to Premium). Follow migration options in new tier
-or-
2. Deploy new instance in existing tier and migrate configurations2
Consumption Not applicable

1 Use Azure portal or specify API version 2021-01-01-preview or later.

2 Migrate configurations with the following mechanisms: Backup and restore, Migration script for the developer portal, APIOps with Azure API Management.

Update VNet configuration

If you have an existing Developer or Premium tier instance that's connected to a virtual network and hosted on the stv1 platform, trigger migration to the stv2 platform by updating the VNet configuration.

Prerequisites

  • A new or existing virtual network and subnet in the same region and subscription as your API Management instance. The subnet must be different from the one currently used for the instance hosted on the stv1 platform, and a network security group must be attached.

  • A new or existing Standard SKU public IPv4 address resource in the same region and subscription as your API Management instance.

To update the existing external or internal VNet configuration using the portal:

  1. Navigate to your API Management instance.
  2. In the left menu, select Network > Virtual network.
  3. Select the network connection in the location you want to update.
  4. Select the virtual network, subnet, and IP address resources you want to configure, and select Apply.
  5. Continue configuring VNet settings for the remaining locations of your API Management instance.
  6. In the top navigation bar, select Save, then select Apply network configuration.

The virtual network configuration is updated, and the instance is migrated to the stv2 platform. Confirm migration by checking the platformVersion property.

Note

  • Updating the VNet configuration takes from 15 to 45 minutes to complete.
  • The VIP address(es) of your API Management instance will change.

Next steps