Skip to content

Commit a613710

Browse files
authored
Merge pull request #299851 from v-albemi/ca-certificates
Freshness Edit: Azure API Management
2 parents 26211e9 + 8359eab commit a613710

File tree

4 files changed

+22
-21
lines changed

4 files changed

+22
-21
lines changed

articles/api-management/api-management-howto-ca-certificates.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,57 @@
11
---
2-
title: Add a custom CA certificate - Azure API Management | Microsoft Docs
3-
description: Learn how to add a custom CA certificate in Azure API Management. You can also see instructions to delete a certificate.
2+
title: Add a Custom CA Certificate - API Management | Microsoft Docs
3+
description: Learn how to add a custom CA certificate in Azure API Management. Also learn how to delete a certificate.
44
services: api-management
55
author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 06/01/2021
9+
ms.date: 05/16/2025
1010
ms.author: danlep
1111
ms.custom:
12+
13+
#customer intent: As an API developer, I want to add a custom CA certificate in API Management.
1214
---
1315

1416
# How to add a custom CA certificate in Azure API Management
1517

16-
[!INCLUDE [api-management-availability-premium-dev-standard-basic-no-v2](../../includes/api-management-availability-premium-dev-standard-basic-no-v2.md)]
18+
**APPLIES TO: Developer | Basic | Standard | Premium**
1719

18-
Azure API Management allows installing CA certificates on the machine inside the trusted root and intermediate certificate stores. This functionality should be used if your services require a custom CA certificate.
20+
Azure API Management allows you to install CA certificates on the machine inside the trusted root and intermediate certificate stores. You should use this functionality if your services require a custom CA certificate.
1921

20-
The article shows how to manage CA certificates of an Azure API Management service instance in the Azure portal. For example, if you use self-signed client certificates, you can upload custom trusted root certificates to API Management.
22+
This article shows how to manage CA certificates of an API Management instance in the Azure portal. For example, if you use self-signed client certificates, you can upload custom trusted root certificates to API Management.
2123

22-
CA certificates uploaded to API Management can only be used for certificate validation by the managed API Management gateway. If you use the [self-hosted gateway](self-hosted-gateway-overview.md), learn how to [create a custom CA for self-hosted gateway](#create-custom-ca-for-self-hosted-gateway), later in this article.
24+
CA certificates uploaded to API Management can be used for certificate validation only by the managed API Management gateway. If you use the [self-hosted gateway](self-hosted-gateway-overview.md), you can learn how to [create a custom CA for self-hosted gateway](#create-custom-ca-for-a-self-hosted-gateway) later in this article.
2325

2426
[!INCLUDE [api-management-workspace-availability](../../includes/api-management-workspace-availability.md)]
2527

2628
[!INCLUDE [updated-for-az](~/reusable-content/ce-skilling/azure/includes/updated-for-az.md)]
2729

2830

29-
## <a name="step1"> </a>Upload a CA certificate
31+
## Upload a CA certificate
3032

31-
:::image type="content" source="media/api-management-howto-ca-certificates/00.png" alt-text="CA certificates in the Azure portal":::
33+
Complete the following steps to upload a new CA certificate. If you haven't created an API Management instance yet, see [Create an API Management service instance](get-started-create-service-instance.md).
3234

33-
Follow the steps below to upload a new CA certificate. If you have not created an API Management service instance yet, see the tutorial [Create an API Management service instance](get-started-create-service-instance.md).
35+
1. Go to your Azure API Management instance in the Azure portal.
3436

35-
1. Navigate to your Azure API Management service instance in the Azure portal.
37+
1. In the left menu, under **Security**, select **Certificates**. On the **Certificates** page, select **CA certificates** > **+ Add**.
3638

37-
1. In the menu, under **Security**, select **Certificates > CA certificates > + Add**.
39+
1. In the **Upload CA certificate** window, select the file icon and browse for the certificate .cer file. In the **Store** box, select a certificate store. Only the public key is needed, so the password is optional.
3840

39-
1. Browse for the certificate .cer file and decide on the certificate store. Only the public key is needed, so the password is optional.
41+
:::image type="content" source="media/api-management-howto-ca-certificates/02.png" alt-text="Screenshot that shows the steps for adding a CA certificate in the Azure portal." lightbox="media/api-management-howto-ca-certificates/02.png":::
4042

41-
:::image type="content" source="media/api-management-howto-ca-certificates/02.png" alt-text="Add CA certificate in the Azure portal":::
42-
1. Select **Save**. This operation may take a few minutes.
43+
1. Select the **Add** button at the bottom of the window, and then select **Save**. This operation might take a few minutes.
4344

4445
> [!NOTE]
45-
> You can also upload a CA certificate using the `New-AzApiManagementSystemCertificate` PowerShell command.
46+
> You can also upload a CA certificate by using the `New-AzApiManagementSystemCertificate` PowerShell command.
4647
47-
## <a name="step1a"> </a>Delete a CA certificate
48+
## Delete a CA certificate
4849

49-
Select the certificate, and select **Delete** in the context menu (**...**).
50+
Select the certificate, and then select **Delete** in the **...** menu.
5051

51-
## Create custom CA for self-hosted gateway
52+
## Create custom CA for a self-hosted gateway
5253

53-
If you use a [self-hosted gateway](self-hosted-gateway-overview.md), validation of server and client certificates using CA root certificates uploaded to API Management service is not supported. To establish trust, configure a specific client certificate so that it's trusted by the gateway as a custom certificate authority.
54+
If you use a [self-hosted gateway](self-hosted-gateway-overview.md), validation of server and client certificates via CA root certificates uploaded to API Management service isn't supported. To establish trust, configure a specific client certificate so that it's trusted by the gateway as a custom certificate authority.
5455

5556
Use the [Gateway Certificate Authority](/rest/api/apimanagement/current-ga/gateway-certificate-authority) REST APIs to create and manage custom CAs for a self-hosted gateway. To create a custom CA:
5657

articles/api-management/api-management-howto-configure-custom-domain-gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Add a custom domain certificate (.PFX) file to your API Management instance, or
5555
9. Select **Add** to assign the custom domain name to the selected self-hosted gateway.
5656

5757
> [!NOTE]
58-
> If clients connecting to the self-hosted gateway using the custom domain expect to be presented with all intermediate certificates in the chain, you must upload individual CA certificates to your API Management Service and associate them with the self-hosted gateway. For instructions on how to achieve this, see [Create custom CA for self-hosted gateway](api-management-howto-ca-certificates.md#create-custom-ca-for-self-hosted-gateway) .
58+
> If clients connecting to the self-hosted gateway using the custom domain expect to be presented with all intermediate certificates in the chain, you must upload individual CA certificates to your API Management Service and associate them with the self-hosted gateway. For instructions on how to achieve this, see [Create custom CA for self-hosted gateway](api-management-howto-ca-certificates.md#create-custom-ca-for-a-self-hosted-gateway) .
5959
## Related content
6060

6161
[Upgrade and scale your service](upgrade-and-scale.md)
Binary file not shown.
-42.8 KB
Loading

0 commit comments

Comments
 (0)