Skip to content

Commit 7ae927b

Browse files
authored
Merge pull request #212003 from tomkerkhove/shgw-edit
docs: Provide scalable overview of SHGW configuration requirements
2 parents e5cfad2 + d6db32e commit 7ae927b

File tree

2 files changed

+16
-34
lines changed

2 files changed

+16
-34
lines changed

articles/api-management/self-hosted-gateway-migration-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Learn more about the connectivity of our gateway, our new infrastructure require
2929

3030
## Prerequisites
3131

32-
Before you can migrate to self-hosted gateway v2, you need to ensure your infrastructure [meets the requirements](self-hosted-gateway-overview.md#gateway-v2-requirements).
32+
Before you can migrate to self-hosted gateway v2, you need to ensure your infrastructure [meets the requirements](self-hosted-gateway-overview.md#fqdn-dependencies).
3333

3434
## Migrating to self-hosted gateway v2
3535

@@ -55,8 +55,8 @@ Currently, Azure API Management provides the following Configuration APIs for se
5555

5656
| Configuration Service | URL | Supported | Requirements |
5757
| --- | --- | --- | --- |
58-
| v2 | `{name}.configuration.azure-api.net` | Yes | [Link](self-hosted-gateway-overview.md#gateway-v2-requirements) |
59-
| v1 | `{name}.management.azure-api.net/subscriptions/{sub-id}/resourceGroups/{rg-name}/providers/Microsoft.ApiManagement/service/{name}?api-version=2021-01-01-preview` | No | [Link](self-hosted-gateway-overview.md#gateway-v1-requirements) |
58+
| v2 | `{name}.configuration.azure-api.net` | Yes | [Link](self-hosted-gateway-overview.md#fqdn-dependencies) |
59+
| v1 | `{name}.management.azure-api.net/subscriptions/{sub-id}/resourceGroups/{rg-name}/providers/Microsoft.ApiManagement/service/{name}?api-version=2021-01-01-preview` | No | [Link](self-hosted-gateway-overview.md#fqdn-dependencies) |
6060

6161
Customer must use the new Configuration API v2 by changing their deployment scripts to use the new URL and meet infrastructure requirements.
6262

articles/api-management/self-hosted-gateway-overview.md

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -92,43 +92,25 @@ Self-hosted gateways require outbound TCP/IP connectivity to Azure on port 443.
9292

9393
To operate properly, each self-hosted gateway needs outbound connectivity on port 443 to the following endpoints associated with its cloud-based API Management instance:
9494

95-
- [Gateway v2 requirements](#gateway-v2-requirements)
96-
- [Gateway v1 requirements](#gateway-v1-requirements)
95+
| Description | Required for v1 | Required for v2 | Notes |
96+
|:------------|:---------------------|:---------------------|:------|
97+
| Hostname of the configuration endpoint | `<apim-service-name>.management.azure-api.net` | `<apim-service-name>.configuration.azure-api.net` | |
98+
| Public IP address of the API Management instance | ✔️ | ✔️ | IP addresses of primary location is sufficient. |
99+
| Public IP addresses of Azure Storage [service tag](../virtual-network/service-tags-overview.md) | ✔️ | Optional<sup>1</sup> | IP addresses must correspond to primary location of API Management instance. |
100+
| Hostname of Azure Blob Storage account | ✔️ | Optional<sup>1</sup> | Account associated with instance (`<blob-storage-account-name>.blob.core.windows.net`) |
101+
| Hostname of Azure Table Storage account | ✔️ | Optional<sup>1</sup> | Account associated with instance (`<table-storage-account-name>.table.core.windows.net`) |
102+
| Endpoints for [Azure Application Insights integration](api-management-howto-app-insights.md) | Optional<sup>2</sup> | Optional<sup>2</sup> | Minimal required endpoints are:<ul><li>`rt.services.visualstudio.com:443`</li><li>`dc.services.visualstudio.com:443`</li><li>`{region}.livediagnostics.monitor.azure.com:443`</li></ul>Learn more in [Azure Monitor docs](../azure-monitor/app/ip-addresses.md#outgoing-ports) |
103+
| Endpoints for [Event Hubs integration](api-management-howto-log-event-hubs.md) | Optional<sup>2</sup> | Optional<sup>2</sup> | Learn more in [Azure Event Hubs docs](../event-hubs/network-security.md) |
104+
| Endpoints for [external cache integration](api-management-howto-cache-external.md) | Optional<sup>2</sup> | Optional<sup>2</sup> | This requirement depends on the external cache that is being used |
105+
106+
<sup>1</sup> Only required in v2 when API inspector or quotas are used in policies.<br/>
107+
<sup>2</sup> Only required when feature is used and requires public IP address, port and hostname information.<br/>
97108

98109
> [!IMPORTANT]
99110
> * DNS hostnames must be resolvable to IP addresses and the corresponding IP addresses must be reachable.
100111
> * The associated storage account names are listed in the service's **Network connectivity status** page in the Azure portal.
101112
> * Public IP addresses underlying the associated storage accounts are dynamic and can change without notice.
102113
103-
If integrated with your API Management instance, also enable outbound connectivity to the associated public IP addresses, ports, and hostnames for:
104-
105-
* [Event Hubs](api-management-howto-log-event-hubs.md)
106-
* [Application Insights](api-management-howto-app-insights.md)
107-
* [External cache](api-management-howto-cache-external.md)
108-
109-
#### Gateway v2 requirements
110-
111-
The self-hosted gateway v2 requires the following:
112-
113-
* The public IP address of the API Management instance in its primary location
114-
* The hostname of the instance's configuration endpoint: `<apim-service-name>.configuration.azure-api.net`
115-
116-
Additionally, customers that use API inspector or quotas in their policies have to ensure that the following dependencies are accessible:
117-
118-
* The hostname of the instance's associated blob storage account: `<blob-storage-account-name>.blob.core.windows.net`
119-
* The hostname of the instance's associated table storage account: `<table-storage-account-name>.table.core.windows.net`
120-
* Public IP addresses from the Storage [service tag](../virtual-network/service-tags-overview.md) corresponding to the primary location of the API Management instance
121-
122-
#### Gateway v1 requirements
123-
124-
The self-hosted gateway v1 requires the following:
125-
126-
* The public IP address of the API Management instance in its primary location
127-
* The hostname of the instance's management endpoint: `<apim-service-name>.management.azure-api.net`
128-
* The hostname of the instance's associated blob storage account: `<blob-storage-account-name>.blob.core.windows.net`
129-
* The hostname of the instance's associated table storage account: `<table-storage-account-name>.table.core.windows.net`
130-
* Public IP addresses from the Storage [service tag](../virtual-network/service-tags-overview.md) corresponding to the primary location of the API Management instance
131-
132114
### Connectivity failures
133115

134116
When connectivity to Azure is lost, the self-hosted gateway is unable to receive configuration updates, report its status, or upload telemetry.

0 commit comments

Comments
 (0)