You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/compute-infrastructure.md
+59-24Lines changed: 59 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn about the compute platform used to host your API Management s
4
4
author: dlepow
5
5
ms.service: api-management
6
6
ms.topic: conceptual
7
-
ms.date: 08/23/2021
7
+
ms.date: 03/16/2022
8
8
ms.author: danlep
9
9
ms.custom:
10
10
---
@@ -14,47 +14,82 @@ As a cloud platform-as-a-service (PaaS), Azure API Management abstracts many det
14
14
15
15
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](api-management-features.md). This article gives you context about the upgrade and the major versions of API Management's compute platform: `stv1` and `stv2`.
16
16
17
-
We've minimized impacts of this upgrade on your operation of your API Management instance. However, if your instance is connected to an [Azure virtual network](virtual-network-concepts.md), you'll need to change some network configuration settings when the instance upgrades to the `stv2` platform version.
17
+
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.
18
18
19
-
## Compute platform versions
19
+
## What are the compute platforms for API Management?
20
20
21
-
| Version | Description | Architecture | API Management tiers |
<sup>1</sup> 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.
27
30
28
31
## How do I know which platform hosts my API Management instance?
29
32
30
-
### Developer, Basic, Standard, and Premium tiers
33
+
Starting with API version `2021-04-01-preview`, the API Management instance exposes a read-only `platformVersion` property that shows this platform information.
34
+
35
+
You can find this information using the portal or the API Management [REST API](/rest/api/apimanagement/current-ga/api-management-service/get).
36
+
37
+
To find the `platformVersion` property in the portal:
38
+
39
+
1. Go to your API Management instance.
40
+
1. On the **Overview** page, select **JSON view**.
41
+
1. In **API version**, select a current version such as `2021-08-01` or later.
42
+
1. In the JSON view, scroll down to find the `platformVersion` property.
43
+
44
+
:::image type="content" source="media/compute-infrastructure/platformversion property.png" alt-text="platformVersion property in JSON view":::
45
+
46
+
## How do I migrate to the `stv2` platform?
31
47
32
-
* Instances with virtual network connections created or updated using the Azure portal after **April 2021**, or using the API Management REST API version **2021-01-01-preview** or later, are hosted on the `stv2` platform
33
-
* If you enabled [zone redundancy](zone-redundancy.md) in your Premium tier instance, it's hosted on the `stv2` platform
34
-
* Otherwise, the instance is hosted on the `stv1` platform
48
+
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.
35
49
36
-
> [!TIP]
37
-
> Starting with API version `2021-04-01-preview`, the API Management instance has a read-only `PlatformVersion` property that shows this platform information.
50
+
> [!NOTE]
51
+
> Check the [`platformVersion` property](#how-do-i-know-which-platform-hosts-my-api-management-instance) before starting migration, and after your configuration change.
|Developer | 1. Create new [external](api-management-using-with-vnet.md) or [internal](api-management-using-with-internal-vnet.md) VNet connection<sup>1</sup><br/>-or-<br/> 2. Update existing [VNet configuration](#update-vnet-configuration)|
57
+
| Standard | 1. [Change your service tier](upgrade-and-scale.md#change-your-api-management-service-tier) (downgrade to Developer or upgrade to Premium). Follow migration options in new tier.<br/>-or-<br/>2. Deploy new instance in existing tier and migrate configurations<sup>2</sup> |
58
+
| Basic | 1. [Change your service tier](upgrade-and-scale.md#change-your-api-management-service-tier) (downgrade to Developer or upgrade to Premium). Follow migration options in new tier<br/>-or-<br/>2. Deploy new instance in existing tier and migrate configurations<sup>2</sup> |
59
+
| Consumption | Not applicable |
40
60
41
-
* All instances are hosted on the `mtv1` platform
61
+
<sup>1</sup> Use Azure portal or specify API version 2021-01-01-preview or later.
62
+
63
+
<sup>2</sup> Migrate configurations with the following mechanisms: [Backup and restore](api-management-howto-disaster-recovery-backup-restore.md), [Migration script for the developer portal](automate-portal-deployments.md), [APIOps with Azure API Management](/azure/architecture/example-scenario/devops/automated-api-deployments-apiops).
42
64
43
-
## How do I upgrade to the `stv2` platform?
65
+
## Update VNet configuration
44
66
45
-
Update is only possible for an instance in the Developer, Basic, Standard, or Premium tier.
67
+
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.
46
68
47
-
Create or update the virtual network connection, or availability zone configuration, in an API Management instance using:
69
+
### Prerequisites
48
70
49
-
*[Azure portal](https://portal.azure.com)
50
-
* Azure REST API, or ARM template, specifying API version **2021-01-01-preview** or later
71
+
* A new or existing virtual network and subnet in the same region and subscription as your API Management instance.
51
72
52
-
> [!IMPORTANT]
53
-
> When you update the compute platform version of an instance connected to an Azure [virtual network](virtual-network-concepts.md):
54
-
> * You must provide a Standard SKU [public IPv4 address](../virtual-network/ip-services/public-ip-addresses.md#sku) resource
73
+
* A new or existing Standard SKU [public IPv4 address](../virtual-network/ip-services/public-ip-addresses.md#sku) resource in the same region and subscription as your API Management instance.
74
+
75
+
To update the existing external or internal VNet configuration using the portal:
76
+
77
+
1. Navigate to your API Management instance.
78
+
1. In the left menu, select **Network** > **Virtual network**.
79
+
1. Select the network connection in the location you want to update.
80
+
1. Select the virtual network, subnet, and IP address resources you want to configure, and select **Apply**.
81
+
1. Continue configuring VNet settings for the remaining locations of your API Management instance.
82
+
1. In the top navigation bar, select **Save**, then select **Apply network configuration**.
83
+
84
+
The virtual network configuration is updated, and the instance is migrated to the `stv2` platform. Confirm migration by checking the [`platformVersion` property](#how-do-i-know-which-platform-hosts-my-api-management-instance).
85
+
86
+
> [!NOTE]
87
+
> * Updating the VNet configuration takes from 15 to 45 minutes to complete.
55
88
> * The VIP address(es) of your API Management instance will change.
56
89
90
+
57
91
## Next steps
58
92
59
93
* Learn more about using a [virtual network](virtual-network-concepts.md) with API Management.
60
94
* Learn more about [zone redundancy](zone-redundancy.md).
0 commit comments