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/self-hosted-gateway-support-policies.md
+43-27Lines changed: 43 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,76 +5,92 @@ author: dlepow
5
5
ms.service: azure-api-management
6
6
ms.topic: concept-article
7
7
ms.author: danlep
8
-
ms.date: 09/25/2024
8
+
ms.date: 02/06/2026
9
+
#customer intent: As a developer responsible for an API using Azure API Management, I need to understand how to support this technology on a self-hosted gateway.
The Azure API Management service, in the Developer and Premium tiers, allows the deployment of the API Management gateway as a container running in on-premises infrastructure, other clouds, and Azure infrastructure options that support containers. This article provides details about technical support policies and limitations for the API Management [self-hosted gateway](self-hosted-gateway-overview.md).
16
+
The Azure API Management service, in the Developer and Premium tiers, allows the deployment of the API Management gateway as a *self-hosted gateway*. A self-hosted gateway runs on a container in on-premises infrastructure, other clouds, and Azure infrastructure options that support containers.
17
+
18
+
This article provides details about technical support policies and limitations for the API Management [self-hosted gateway](self-hosted-gateway-overview.md).
16
19
17
20
## Differences between managed gateway and self-hosted gateway
18
21
19
-
When deploying an instance of the API Management service, you'll always get a managed API gateway as part of the service. This gateway runs in infrastructure managed by Azure, and the software is also managed, updated, and managed by Azure.
22
+
When you deploy an instance of the API Management service, you always get a managed API gateway as part of the service. This gateway runs in infrastructure managed by Azure. Azure manages and updates the software.
20
23
21
24
In supported service tiers, the self-hosted gateway is an optional deployment option.
22
25
23
-
While the managed and self-hosted gateways share many common features, there are also [several differences](api-management-gateways-overview.md#feature-comparison-managed-versus-self-hosted-gateways).
26
+
Managed and self-hosted gateways share common features. For more information, see [Feature comparison](api-management-gateways-overview.md#feature-comparison-managed-versus-self-hosted-gateways).
24
27
25
28
## Responsibilities
26
29
27
30
The following table shows Microsoft's responsibilities, shared responsibilities, and customers' responsibilities for managing and supporting the self-hosted gateway.
|▪️ **Configuration endpoint (management plane)** - The self-hosted gateway depends on a configuration endpoint that provides the configuration, APIs, hostnames, and policy information. This configuration endpoint is part of the management plane of every API Management service.<br/><br/>▪️ **Gateway container image maintenance and updates** - Bug fixes, patches, performance improvements, and new features in the self-hosted gateway [container image](self-hosted-gateway-overview.md#packaging). |▪ **Securing self-hosted gateway communication with configuration endpoint** - The communication between the self-hosted gateway and the configuration endpoint can be secured by two mechanisms: either an access token that expires automatically every 30 days and needs to be updated for the running containers; or authentication with Microsoft Entra ID, which doesn't require token refresh.<br/><br/> ▪ **Keeping the gateway up to date** - The customer oversees regularly updating the gateway to the latest version and latest features. And Microsoft will provide updated images with new features, bug fixes, and patches. | ▪ **Gateway hosting** - Deploying and operating the gateway infrastructure: virtual machines with container runtime and/or Kubernetes cluster.<br/><br/>▪ **Network configuration** - Necessary to maintain management plane connectivity and API access.<br/><br/> ▪ **Gateway SLA** - Capacity management, scaling, and uptime.<br/><br/> ▪ **Providing diagnostics data to support** - Collecting and sharing diagnostics data with support engineers.<br/><br/>▪ **Third party OSS (open-source software) software components** - Combining the self-hosted gateway with other software like Prometheus, Grafana, service meshes, container runtimes, Kubernetes distributions, and proxies are the customer's responsibility. |
34
+
|▪️ **Configuration endpoint (management plane)**. The self-hosted gateway depends on a configuration endpoint that provides the configuration, APIs, hostnames, and policy information. This configuration endpoint is part of the management plane of every API Management service.<br/><br/>▪️ **Gateway container image maintenance and updates**. Bug fixes, patches, performance improvements, and new features in the self-hosted gateway [container image](self-hosted-gateway-overview.md#packaging). |▪ **Securing self-hosted gateway communication with configuration endpoint**. The communication between the self-hosted gateway and the configuration endpoint can be secured by two mechanisms: <br/>- An access token that expires automatically every 30 days and needs to be updated for the running containers. <br/>- Authentication with Microsoft Entra ID, which doesn't require token refresh.<br/><br/> ▪ **Keeping the gateway up to date**. The customer oversees regularly updating the gateway to the latest version and latest features. Microsoft provides updated images with new features, bug fixes, and patches. | ▪ **Gateway hosting**. Deploying and operating the gateway infrastructure: virtual machines with container runtime or Kubernetes cluster.<br/><br/>▪ **Network configuration**. Necessary to maintain management plane connectivity and API access.<br/><br/> ▪ **Gateway SLA**. Capacity management, scaling, and uptime.<br/><br/> ▪ **Providing diagnostics data to support**. Collecting and sharing diagnostics data with support engineers.<br/><br/>▪ **Third party OSS (open-source software) software components**. Combining the self-hosted gateway with other software like Prometheus, Grafana, service meshes, container runtimes, Kubernetes distributions, and proxies are the customer's responsibility. |
33
35
34
36
## Self-hosted gateway container image support coverage
35
37
36
-
We have the following tagging strategy for the [self-hosted gateway container image](self-hosted-gateway-overview.md#packaging), following the major, minor, patch convention: `{major}.{minor}.{patch}`. You can find a full list of [available tags](https://mcr.microsoft.com/product/azure-api-management/gateway/tags). As a best practice, we recommend that customers run the latest stable version of our container image. Given the continuous releases of our container image, we'll provide official support for the following versions:
38
+
Microsoft has the following tagging strategy for the [self-hosted gateway container image](self-hosted-gateway-overview.md#packaging), following the major, minor, patch convention: `{major}.{minor}.{patch}`. For a full list of available tags, see [available tags](https://mcr.microsoft.com/product/azure-api-management/gateway/tags).
39
+
40
+
We recommend that you run the latest stable version of our container image. Given the continuous releases of our container image, Microsoft provides official support for the following versions.
37
41
38
42
> [!TIP]
39
-
> We highly encourage customers to upgrade to a newer self-hosted gateway by following [Safe Deployment Practices (SDP)](https://azure.microsoft.com/blog/advancing-safe-deployment-practices/).
43
+
> We highly encourage you to upgrade to a newer self-hosted gateway by following [Safe Deployment Practices (SDP)](https://azure.microsoft.com/blog/advancing-safe-deployment-practices/).
40
44
41
45
### Supported versions
42
46
43
-
***Last major version and the last three minor releases**
47
+
-**Last major version and the last three minor releases**
44
48
45
-
For example, if the latest version is 2.2.0, we'll support all 2.2.x, 2.1.x, and 2.0.x minor releases. For all previous versions, we'll ask you to update to a supported version.
49
+
For example, if the latest version is 2.2.0, we support all 2.2.x, 2.1.x, and 2.0.x minor releases. For all previous versions, we ask you to update to a supported version.
46
50
47
-
***Fixes**
51
+
-**Fixes**
48
52
49
-
If we discover a bug, CVE, or performance issue in a supported version - for example, a bug is found in the container image 2.0.0 - the fix will land as a patch in the latest minor version, for example 2.2.x.
53
+
If we discover a bug, CVE, or performance issue in a supported version, the fix appears as a patch in the latest minor version. For example, if a bug is found in the container image 2.0.0, the fix lands in 2.2.x.
50
54
51
55
### Unsupported versions
52
56
53
-
* Container images with the `beta` tag.
57
+
- Container images with the `beta` tag.
54
58
55
-
* Any version with the `preview` suffix.
59
+
- Any version with the `preview` suffix.
56
60
57
61
## Self-hosted gateway support scenarios
58
62
59
-
### Microsoft provides technical support for the following examples
63
+
Microsoft provides technical support for the following situations:
64
+
65
+
- Configuration endpoint and management plane uptime and configuration for the supported tiers.
66
+
67
+
- Self-hosted gateway container image bugs, performance issues, and improvements.
60
68
61
-
* Configuration endpoint and management plane uptime and configuration for the supported tiers.
69
+
- Self-hosted gateway container image security patches (CVEs) are fixed as soon as possible.
62
70
63
-
* Self-hosted gateway container image bugs, performance issues, and improvements.
71
+
- Supported non-Microsoft open-source projects, for example: Open Telemetry and Distributed Application Runtime (DAPR).
64
72
65
-
* Self-hosted gateway container image security patches (CVEs) will be fixed as soon as possible.
73
+
Microsoft Support doesn't provide technical support for the following issues:
66
74
67
-
* Supported third-party open-source projects, for example: Open Telemetry and DAPR (Distributed Application Runtime).
75
+
- Questions about how to use the self-hosted gateway inside Kubernetes. For example, Microsoft Support doesn't provide advice on how to:
68
76
69
-
### Microsoft does not provide technical support for the following examples
77
+
- Create custom ingress controllers
78
+
- Create service mesh
79
+
- Use application workloads
80
+
- Apply non-Microsoft or open-source software packages or tools
70
81
71
-
* Questions about how to use the self-hosted gateway inside Kubernetes. For example, Microsoft Support doesn't provide advice on how to create custom ingress controllers, service mesh, use application workloads, or apply third-party or open-source software packages or tools.
82
+
- Non-Microsoft open-source projects combined with our self-hosted gateway, except for specific supported projects, for example: Open Telemetry and DAPR.
72
83
73
-
* Third-party open-source projects combined with our self-hosted gateway, except for specific supported projects, for example: Open Telemetry and DAPR (Distributed Application Runtime).
84
+
- Non-Microsoft closed-source software, including security scanning tools and networking devices or software.
74
85
75
-
* Third-party closed-source software, including security scanning tools and networking devices or software.
86
+
- Microsoft Support checks only that the communication between self-hosted gateway and the configuration endpoint works. Microsoft Support doesn't troubleshoot:
76
87
77
-
* Troubleshooting network customizations, CNIs, service meshes, network policies, firewalls, and complex networking circuits. Microsoft will only check that the communication between self-hosted gateway and the configuration endpoint is working.
88
+
- Network customization
89
+
- Container Network Interfaces (CNIs)
90
+
- Service meshes
91
+
- Network policies
92
+
- Firewalls
93
+
- Complex networking circuits
78
94
79
95
## Bugs and issues
80
96
@@ -92,10 +108,10 @@ If you have a support plan and you need technical help, create a [support requ
92
108
93
109
1. For **Problem type**, select **Self-Hosted Gateway**.
94
110
95
-
You can also get help from our communities. You can file an issue on [GitHub](https://aka.ms/apim/sputnik/repo) or ask questions on [Stack Overflow](https://aka.ms/apimso) and tag them with "azure-api-management".
111
+
You can also get help from our communities. You can file an issue on [GitHub](https://aka.ms/apim/sputnik/repo) or ask questions on [Stack Overflow](https://aka.ms/apimso) and tag them with `azure-api-management`.
96
112
97
113
## Related content
98
114
99
-
* Learn how to deploy the API Management self-hosted gateway to [Azure Arc-enabled Kubernetes clusters](how-to-deploy-self-hosted-gateway-azure-arc.md), [Azure Kubernetes Service](how-to-deploy-self-hosted-gateway-azure-kubernetes-service.md), or a Kubernetes cluster using [YAML](how-to-deploy-self-hosted-gateway-kubernetes.md) or a [Helm chart](how-to-deploy-self-hosted-gateway-kubernetes-helm.md).
115
+
- Learn how to deploy the API Management self-hosted gateway to [Azure Arc-enabled Kubernetes clusters](how-to-deploy-self-hosted-gateway-azure-arc.md), [Azure Kubernetes Service](how-to-deploy-self-hosted-gateway-azure-kubernetes-service.md), or a Kubernetes cluster using [YAML](how-to-deploy-self-hosted-gateway-kubernetes.md) or a [Helm chart](how-to-deploy-self-hosted-gateway-kubernetes-helm.md).
100
116
101
-
* Review guidance for running the self-hosted gateway on [Kubernetes in production](how-to-self-hosted-gateway-on-kubernetes-in-production.md).
117
+
- Review guidance for running the self-hosted gateway on [Kubernetes in production](how-to-self-hosted-gateway-on-kubernetes-in-production.md).
0 commit comments