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/configure-custom-domain.md
+11-16Lines changed: 11 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,42 +55,36 @@ There are several API Management service endpoints to which you can assign a cus
55
55
56
56
## Domain certificate options
57
57
58
-
The following table lists the options to add domain certificates in API Management:
59
-
60
-
|Option|Description|
61
-
|-|-|
62
-
| Upload a [custom certificate](#custom-certificate)| If you already have a private certificate from a third-party provider, you can upload it to your API Management instance. |
63
-
| Import a [certificate from Key Vault](#key-vault-certificate)| Useful if you use [Azure Key Vault](../key-vault/index.yml) to manage your PKCS12 certificates. |
64
-
| Enable a free [managed TLS certificate](#managed-tls-certificate) (preview) | API Management can configure and manage a certificate free of charge if you just need to secure your Gateway domain in your API Management service. |
58
+
API Management supports custom TLS certificates or certificates imported from Azure Key Vault. You can also enable a free, managed certificate.
65
59
66
60
> [!WARNING]
67
-
> If you wish to improve the security of your applications with certificate pinning, you should use a custom domain name and a certificate that you manage, not the default certificate or the free managed certificate. We don't recommend taking a hard dependency on a certificate that you don't manage.
61
+
> If you wish to improve the security of your applications with certificate pinning, you should use a custom domain name and either a custom or Key Vault certificate, not the default certificate or the free, managed certificate. We don't recommend taking a hard dependency on a certificate that you don't manage.
If you choose to upload or import a private certificate to API Management, your certificate must meet the following requirements. If you use a free certificate managed by API Management, it already meets these requirements.
65
+
If you already have a private certificate from a third-party provider, you can upload it to your API Management instance. It must meet the following requirements. (If you enable the free certificate managed by API Management, it already meets these requirements.)
72
66
73
67
* Exported as a PFX file, encrypted using triple DES, and optionally password protected.
74
68
* Contains private key at least 2048 bits long
75
69
* Contains all intermediate certificates and the root certificate in the certificate chain.
We recommend using [Azure Key Vault for managing certificates](../key-vault/certificates/about-certificates.md) and setting them to `autorenew`.
73
+
We recommend using Azure Key Vault to [manage your certificates](../key-vault/certificates/about-certificates.md) and setting them to `autorenew`.
80
74
81
-
If you use Azure Key Vault to manage a custom domain TLS/SSL certificate, make sure the certificate is inserted into Key Vault [as a _certificate_](/rest/api/keyvault/createcertificate/createcertificate), not a _secret_.
75
+
If you use Azure Key Vault to manage a custom domain TLS certificate, make sure the certificate is inserted into Key Vault [as a _certificate_](/rest/api/keyvault/createcertificate/createcertificate), not a _secret_.
82
76
83
77
To fetch a TLS/SSL certificate, API Management must have the list and get secrets permissions on the Azure Key Vault containing the certificate.
84
-
* When using the Azure portal to import the certificate, all the necessary configuration steps are completed automatically.
85
-
* When using command-line tools or management API, these permissions must be granted manually, in two steps:
78
+
* When you use the Azure portal to import the certificate, all the necessary configuration steps are completed automatically.
79
+
* When you use command-line tools or management API, these permissions must be granted manually, in two steps:
86
80
1. On the **Managed identities** page of your API Management instance, enable a system-assigned or user-assigned [managed identity](api-management-howto-use-managed-service-identity.md). Note the principal Id on that page.
87
81
1. Give the list and get secrets permissions to this principal Id on the Azure Key Vault containing the certificate.
88
82
89
83
If the certificate is set to `autorenew` and your API Management tier has an SLA (that is, in all tiers except the Developer tier), API Management will pick up the latest version automatically, without downtime to the service.
90
84
91
85
For more information, see [Use managed identities in Azure API Management](api-management-howto-use-managed-service-identity.md).
API Management offers a free, managed TLS certificate for your domain, if you don't wish to purchase and manage your own certificate. The certificate is autorenewed automatically.
96
90
@@ -103,6 +97,7 @@ API Management offers a free, managed TLS certificate for your domain, if you do
103
97
* Not supported in the following Azure regions: France South and South Africa West
104
98
* Currently available only in the Azure cloud
105
99
* Does not support root domain names (for example, `contoso.com`). Requires a fully qualified name such as `api.contoso.com`.
0 commit comments