Skip to content

API Management instances should use multi-region deployment#

Reliability · API Management · Rule · 2024_06 · Important

Enhance service availability and resilience by deploying API Management instances across multiple regions.

Description#

API Management supports multi-region deployment, which allows the API gateway to be available in more than one region. This configuration enhances service availability by ensuring that if one region experiences an outage, the API gateway remains operational in another region. Multi-region deployment is crucial for maintaining high availability and reducing latency for global users.

This feature is available exclusively in the Premium SKU for API Management.

Recommendation#

Consider deploying API Management instances across multiple regions to enhance service availability and resilience.

Examples#

Configure with Azure template#

To deploy API Management instances that pass this rule:

  • Configure the properties.additionalLocations property.

For example:

Azure Template snippet
{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2021-12-01-preview",
  "name": "[parameters('apiManagementServiceName')]",
  "location": "eastus",
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "properties": {
    "additionalLocations": [
      {
        "location": "westeurope",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "disableGateway": false
      }
    ]
  }
}

Configure with Bicep#

To deploy API Management instances that pass this rule:

  • Configure the properties.additionalLocations property.

For example:

Azure Bicep snippet
resource apiManagementService 'Microsoft.ApiManagement/service@2021-12-01-preview' = {
  name: apiManagementServiceName
  location: 'eastus'
  sku: {
    name: 'Premium'
    capacity: 1
  }
  properties: {
    additionalLocations: [
      {
        location: 'westeurope'
        sku: {
          name: 'Premium'
          capacity: 1
        }
        disableGateway: false
      }
    ]
  }
}

Notes#

It is recommended to configure zone redundancy if the region supports it.

Virtual network settings must be configured in the added region, if networking is configured in the existing region or regions. The rule does not take this into consideration.

For developer environments, suppressing the rule might make sense as configuring multi-region for an API Management instance requries the Premium SKU currently.

Comments