Skip to content

Commit 1c92347

Browse files
Merge pull request #274012 from seligj95/cdnsupdates
ASEv3 Documentation improvements on ILB Key vault access support/ update and availability checks
2 parents 168f718 + 8865449 commit 1c92347

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

articles/app-service/environment/how-to-custom-domain-suffix.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Configure a custom domain suffix for the Azure App Service Environm
44
author: seligj95
55
ms.topic: tutorial
66
ms.custom: devx-track-arm-template
7-
ms.date: 04/23/2024
7+
ms.date: 05/01/2024
88
ms.author: jordanselig
99
zone_pivot_groups: app-service-environment-portal-arm
1010
---
@@ -33,6 +33,7 @@ The connection to the custom domain suffix endpoint needs to use Server Name Ind
3333

3434
- ILB variation of App Service Environment v3.
3535
- Valid SSL/TLS certificate must be stored in an Azure Key Vault in .PFX format. For more information on using certificates with App Service, see [Add a TLS/SSL certificate in Azure App Service](../configure-ssl-certificate.md).
36+
- Certificate must be less than 20 kb.
3637

3738
### Managed identity
3839

@@ -60,7 +61,7 @@ If you choose to use Azure role-based access control to manage access to your ke
6061

6162
### Certificate
6263

63-
The certificate for custom domain suffix must be stored in an Azure Key Vault. The certificate must be uploaded in .PFX format. Certificates in .PEM format aren't supported at this time. App Service Environment uses the managed identity you selected to get the certificate. The key vault can be accessed publicly or through a [private endpoint](../../private-link/private-endpoint-overview.md) accessible from the subnet that the App Service Environment is deployed to. In the case of public access, you can secure your key vault to only accept traffic from the outbound IP addresses of the App Service Environment.
64+
The certificate for custom domain suffix must be stored in an Azure Key Vault. The certificate must be uploaded in .PFX format and be smaller than 20 kb. Certificates in .PEM format aren't supported at this time. App Service Environment uses the managed identity you selected to get the certificate. The key vault can be accessed publicly or through a [private endpoint](../../private-link/private-endpoint-overview.md) accessible from the subnet that the App Service Environment is deployed to. To learn how to configure a private endpoint, see [Integrate Key Vault with Azure Private Link](../../key-vault/general/private-link-service.md). In the case of public access, you can secure your key vault to only accept traffic from the outbound IP addresses of the App Service Environment.
6465

6566
:::image type="content" source="./media/custom-domain-suffix/key-vault-networking.png" alt-text="Screenshot of a sample networking page for key vault to allow custom domain suffix feature.":::
6667

@@ -74,9 +75,10 @@ If you rotate your certificate in Azure Key Vault, the App Service Environment p
7475

7576
1. From the [Azure portal](https://portal.azure.com), navigate to the **Custom domain suffix** page for your App Service Environment.
7677
1. Enter your custom domain name.
77-
1. Select the managed identity you've defined for your App Service Environment. You can use either a system assigned or user assigned managed identity. You're able to configure your managed identity if you haven't done so already. You can configure the managed identity directly from the custom domain suffix page using the "Add identity" option in the managed identity selection box.
78+
1. Select the managed identity you define for your App Service Environment. You can use either a system assigned or user assigned managed identity. You're able to configure your managed identity if you haven't done so already. You can configure the managed identity directly from the custom domain suffix page using the "Add identity" option in the managed identity selection box.
7879
:::image type="content" source="./media/custom-domain-suffix/managed-identity-selection.png" alt-text="Screenshot of a configuration pane to select and update the managed identity for the App Service Environment.":::
7980
1. Select the certificate for the custom domain suffix.
81+
1. If you use a private endpoint to access the key vault, you can't use the default key vault certificate URL the portal interface provides. You must manually enter and use the private link URL, which is in the format *https://KEY-VAULT-NAME.privatelink.vaultcore.azure.net/secrets/CERTIFICATE-NAME*.
8082
1. Select "Save" at the top of the page. To see the latest configuration updates, refresh the page.
8183
:::image type="content" source="./media/custom-domain-suffix/custom-domain-suffix-portal-experience.png" alt-text="Screenshot of an overview of the custom domain suffix portal experience.":::
8284
1. It takes a few minutes for the custom domain suffix configuration to be set. Check the status by selecting "Refresh" at the top of the page. The banner updates with the latest progress. Once complete, the banner will state that the custom domain suffix is configured.
@@ -88,7 +90,7 @@ If you rotate your certificate in Azure Key Vault, the App Service Environment p
8890

8991
## Use Azure Resource Manager to configure custom domain suffix
9092

91-
To configure a custom domain suffix for your App Service Environment using an Azure Resource Manager template, you need to include the below properties. Ensure that you've met the [prerequisites](#prerequisites) and that your managed identity and certificate are accessible and have the appropriate permissions for the Azure Key Vault.
93+
To configure a custom domain suffix for your App Service Environment using an Azure Resource Manager template, you need to include the below properties. Ensure that you meet the [prerequisites](#prerequisites) and that your managed identity and certificate are accessible and have the appropriate permissions for the Azure Key Vault. If you use a private endpoint to access the key vault, you can't use the default key vault certificate URL. You must use the private link URL, which is in the format *https://KEY-VAULT-NAME.privatelink.vaultcore.azure.net/secrets/CERTIFICATE-NAME*.
9294

9395
You need to configure the managed identity and ensure it exists before assigning it in your template. For more information on managed identities, see the [managed identity overview](../../active-directory/managed-identities-azure-resources/overview.md).
9496

@@ -153,7 +155,7 @@ Alternatively, you can update your existing ILB App Service Environment using [A
153155
1. Scroll to the bottom of the right pane. The **customDnsSuffixConfiguration** attribute is at the bottom.
154156
1. Enter your values for **dnsSuffix**, **certificateUrl**, and **keyVaultReferenceIdentity**.
155157
1. Navigate to the **identity** attribute and enter the details associated with the managed identity you're using.
156-
1. Select the **PUT** button that's located at the top to commit the change to the App Service Environment.
158+
1. Select the **PUT** button at the top to commit the change to the App Service Environment.
157159
1. The **provisioningState** under **customDnsSuffixConfiguration** provides a status on the configuration update.
158160

159161
::: zone-end
@@ -197,7 +199,7 @@ However, just like apps running on the public multitenant service, you can also
197199

198200
## Troubleshooting
199201

200-
If your permissions or network settings for your managed identity, key vault, or App Service Environment aren't set appropriately, you aren't able to configure a custom domain suffix, and you receive an error similar to the example shown in the screenshot. Review the [prerequisites](#prerequisites) to ensure you configured the needed permissions. You also see a similar error message if the App Service platform detects that your certificate is degraded or expired.
202+
The App Service platform periodically checks if your App Service Environment can access your key vault and if your certificate is valid. If your permissions or network settings for your managed identity, key vault, or App Service Environment aren't set appropriately or recently changed, you aren't able to configure a custom domain suffix. You receive an error similar to the example shown in the screenshot. Review the [prerequisites](#prerequisites) to ensure you configured the needed permissions. You also see a similar error message if the App Service platform detects that your certificate is degraded or expired.
201203

202204
:::image type="content" source="./media/custom-domain-suffix/custom-domain-suffix-error.png" alt-text="Screenshot of a sample custom domain suffix error message.":::
203205

0 commit comments

Comments
 (0)