Skip to content

Commit 88b2534

Browse files
authored
Merge pull request #298968 from halkazwini/afd-apim
Prerequisites update
2 parents 05c80ba + 30b0832 commit 88b2534

File tree

5 files changed

+48
-37
lines changed

5 files changed

+48
-37
lines changed
59.3 KB
Loading
52.3 KB
Loading
Binary file not shown.
Binary file not shown.

articles/frontdoor/standard-premium/how-to-enable-private-link-apim.md

Lines changed: 48 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: 'Connect Azure Front Door Premium to an Azure API Management origin with Private Link'
3-
titleSuffix: Azure Private Link
2+
title: 'Connect Front Door Premium to an Azure API Management origin with Private Link'
43
description: Learn how to connect your Azure Front Door Premium to an Azure API Management privately.
54
author: halkazwini
65
ms.author: halkazwini
76
ms.service: azure-frontdoor
87
ms.topic: how-to
9-
ms.date: 09/26/2024
8+
ms.date: 04/28/2025
109
ms.custom: ai-usage
1110
zone_pivot_groups: front-door-dev-exp-portal-ps-cli
1211
---
@@ -20,50 +19,59 @@ This article guides you through the steps to configure an Azure Front Door Premi
2019
## Prerequisites
2120

2221
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
23-
- Have a functioning Azure Front Door Premium profile and an endpoint. For more information on how to create an Azure Front Door profile, see [Create a Front Door](../create-front-door-portal.md).
24-
- Have a functioning Azure API Management instance. For more information on how to create an API Management instance, see [Create a new Azure API Management instance](../../api-management/get-started-create-service-instance.md)
25-
- Private endpoint support for Azure API Management Standard v2 tier is currently in public preview.
22+
23+
- An Azure Front Door Premium profile and an endpoint. For more information on how to create an Azure Front Door profile, see [Create a Front Door using the Azure portal](../create-front-door-portal.md).
24+
25+
- An Azure API Management instance. For more information on how to create an API Management instance, see [Create a new Azure API Management instance](../../api-management/get-started-create-service-instance.md). For v1 tiers, the instance should be deployed in public mode and not in virtual network mode.
26+
27+
> [!NOTE]
28+
> Private endpoint support in the API Management Standard v2 tier is currently in preview.
2629
2730
## Create an origin group and add the API Management instance as an origin
2831

29-
1. In your Azure Front Door Premium profile, go to *Settings* and select **Origin groups**.
32+
1. Under **Settings** of your Azure Front Door Premium profile, select **Origin groups**.
33+
34+
1. Select **Add**
3035

31-
1. Click on **Add**
32-
2. Enter a name for the origin group
33-
3. Select **+ Add an origin**
34-
4. Use the following table to configure the settings for the origin:
36+
1. Enter a name for the origin group.
37+
38+
1. Select **+ Add an origin**
39+
40+
1. Use the following table to configure the origin settings:
3541

3642
| Setting | Value |
3743
| ------- | ----- |
3844
| Name | Enter a name to identify this origin. |
39-
| Origin Type | API Management |
45+
| Origin Type | Select **API Management**. |
4046
| Host name | Select the host from the dropdown that you want as an origin. |
41-
| Origin host header | Will be autopopulated with the host of the chosen API Management instance|
42-
| HTTP port | 80 (default) |
43-
| HTTPS port | 443 (default) |
47+
| Origin host header | Will be autopopulated with the host of the chosen API Management instance. |
48+
| HTTP port | 80 (default). |
49+
| HTTPS port | 443 (default). |
4450
| Priority | Assign different priorities to origins for primary, secondary, and backup purposes. |
4551
| Weight | 1000 (default). Use weights to distribute traffic among different origins. |
4652
| Region | Select the region that matches or is closest to your origin. |
47-
| Target sub resource | Choose 'Gateway' |
53+
| Target sub resource | Select **Gateway**. |
4854
| Request message | Enter a custom message to display while approving the Private Endpoint. |
4955

50-
:::image type="content" source="../media/private-link/apim-privatelink.png" alt-text="Screenshot of origin settings for configuring API Management as a private origin.":::
56+
:::image type="content" source="../media/how-to-enable-private-link-apim/apim-private-link.png" alt-text="Screenshot of origin settings for configuring API Management as a private origin." lightbox="../media/how-to-enable-private-link-apim/apim-private-link.png":::
57+
58+
1. Select **Add** to save your origin settings
5159

52-
6. Select **Add** to save your origin settings
53-
7. Select **Add** to save the origin group settings.
60+
1. Select **Add** to save the origin group settings.
5461

5562
## Approve the private endpoint
5663

57-
1. Navigate to the API Management instance you configured with Private Link in the previous section. Under **Deployment + infrastructure**, select **Network**.
64+
1. Go to the API Management instance you configured with Private Link in the previous section.
65+
66+
1. Under **Deployment + infrastructure**, select **Network**.
5867

5968
1. Select **Inbound private endpoint connections** tab.
6069

6170
1. Find the *pending* private endpoint request from Azure Front Door Premium and select **Approve**.
6271

6372
1. After approval, the connection status will update. It can take a few minutes for the connection to fully establish. Once established, you can access your API Management through Front Door.
6473

65-
66-
:::image type="content" source="../media/private-link/apim-private-endpoint-connections.png" alt-text="Screenshot of private endpoint connections tab in API Management portal.":::
74+
:::image type="content" source="../media/how-to-enable-private-link-apim/apim-private-endpoint-connections.png" alt-text="Screenshot of private endpoint connections tab in API Management portal." lightbox="../media/how-to-enable-private-link-apim/apim-private-endpoint-connections.png":::
6775

6876
::: zone-end
6977

@@ -72,18 +80,16 @@ This article guides you through the steps to configure an Azure Front Door Premi
7280
## Prerequisites
7381

7482
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
83+
- An Azure Front Door Premium profile and an endpoint. For more information on how to create an Azure Front Door profile, see [Create a Front Door using Azure PowerShell](../create-front-door-powershell.md)
84+
- An Azure API Management instance. For more information on how to create an API Management instance, see [Create a new Azure API Management instance using PowerShell](../../api-management/powershell-create-service-instance.md). For v1 tiers, the instance should be deployed in public mode and not in virtual network mode.
85+
- Azure Cloud Shell or Azure PowerShell.
7586

76-
- Azure PowerShell installed locally or Azure Cloud Shell.
77-
78-
[!INCLUDE [updated-for-az](~/reusable-content/ce-skilling/azure/includes/updated-for-az.md)]
87+
The steps in this article run the Azure PowerShell cmdlets interactively in [Azure Cloud Shell](/azure/cloud-shell/overview). To run the cmdlets in the Cloud Shell, select **Open Cloud Shell** at the upper-right corner of a code block. Select **Copy** to copy the code and then paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the Azure portal.
7988

80-
[!INCLUDE [cloud-shell-try-it.md](~/reusable-content/ce-skilling/azure/includes/cloud-shell-try-it.md)]
89+
You can also [install Azure PowerShell locally](/powershell/azure/install-azure-powershell) to run the cmdlets. If you run PowerShell locally, sign in to Azure using the [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet.
8190

82-
- Have a functioning Azure API Management instance. For more information on how to create an API Management instance, see [Create a new Azure API Management instance by using PowerShell](../../api-management/powershell-create-service-instance.md)
83-
84-
- Have a functioning Azure Front Door Premium profile and an endpoint. For more information on how to create an Azure Front Door profile, see [Create a Front Door - PowerShell](../create-front-door-powershell.md)
85-
86-
- Private endpoint support for Azure API Management Standard v2 tier is currently in public preview.
91+
> [!NOTE]
92+
> Private endpoint support in the API Management Standard v2 tier is currently in preview.
8793
8894
## Create an origin group and add the API Management instance as an origin
8995

@@ -176,15 +182,19 @@ Your Azure Front Door profile is now fully functional after completing the final
176182

177183
::: zone pivot="front-door-cli"
178184

179-
[!INCLUDE[azure-cli-prepare-your-environment](~/reusable-content/azure-cli/azure-cli-prepare-your-environment.md)]
185+
## Prerequisites
180186

181187
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
188+
- An Azure Front Door Premium profile and an endpoint. For more information on how to create an Azure Front Door profile, see [Create a Front Door using the Azure CLI](../create-front-door-cli.md).
189+
- An Azure API Management instance. For more information on how to create an API Management instance, see [Create a new Azure API Management instance by using the Azure CLI](../../api-management/get-started-create-service-instance-cli.md). For v1 tiers, the instance should be deployed in public mode and not in virtual network mode.
190+
- Azure Cloud Shell or Azure CLI.
182191

183-
- A functioning Azure Front Door Premium profile and endpoint. See [Create a Front Door - CLI](../create-front-door-cli.md).
192+
The steps in this article run the Azure CLI commands interactively in [Azure Cloud Shell](/azure/cloud-shell/overview). To run the commands in the Cloud Shell, select **Open Cloud Shell** at the upper-right corner of a code block. Select **Copy** to copy the code, and paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the Azure portal.
184193

185-
- A functioning Azure API Management instance. See [Create a new Azure API Management instance by using the Azure CLI](../../api-management/get-started-create-service-instance-cli.md)
194+
You can also [install Azure CLI locally](/cli/azure/install-azure-cli) to run the commands. If you run Azure CLI locally, sign in to Azure using the [az login](/cli/azure/reference-index#az-login) command.
186195

187-
- Private endpoint support for Azure API Management Standard v2 tier is currently in public preview.
196+
> [!NOTE]
197+
> Private endpoint support in the API Management Standard v2 tier is currently in preview.
188198
189199
## Create an origin group and add the API Management instance as an origin
190200

@@ -262,6 +272,7 @@ Your Azure Front Door profile is now fully functional after completing the final
262272

263273
::: zone-end
264274

265-
## Next steps
275+
## Next step
266276

267-
Learn about [Private Link service with storage account](../../storage/common/storage-private-endpoints.md).
277+
> [!div class="nextstepaction"]
278+
> [Private Link service with storage account](../../storage/common/storage-private-endpoints.md)

0 commit comments

Comments
 (0)