Skip to content

Commit b192a1e

Browse files
authored
Merge pull request #108384 from TimShererWithAquent/us1679050n
Change SSL to TLS per 1679050
2 parents a4a0b11 + 35fd5a9 commit b192a1e

9 files changed

+13
-13
lines changed

articles/api-management/api-management-capacity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ To follow the steps from this article, you must have:
4545

4646
+ API Management data plane services, such as request processing, which can include forwarding requests or running a policy.
4747
+ API Management management plane services, such as management actions applied via the Azure Portal or ARM, or load coming from the [developer portal](api-management-howto-developer-portal.md).
48-
+ Selected operating system processes, including processes that involve cost of SSL handshakes on new connections.
48+
+ Selected operating system processes, including processes that involve cost of TLS handshakes on new connections.
4949

5050
Total **capacity** is an average of its own values from every unit of an API Management instance.
5151

articles/api-management/api-management-faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Get the answers to common questions, patterns, and best practices for Azure API
3535
* [Can I configure an OAuth 2.0 authorization server with AD FS security?](#can-i-configure-an-oauth-20-authorization-server-with-ad-fs-security)
3636
* [What routing method does API Management use in deployments to multiple geographic locations?](#what-routing-method-does-api-management-use-in-deployments-to-multiple-geographic-locations)
3737
* [Can I use an Azure Resource Manager template to create an API Management service instance?](#can-i-use-an-azure-resource-manager-template-to-create-an-api-management-service-instance)
38-
* [Can I use a self-signed SSL certificate for a back end?](#can-i-use-a-self-signed-ssl-certificate-for-a-back-end)
38+
* [Can I use a self-signed TLS/SSL certificate for a back end?](#can-i-use-a-self-signed-tlsssl-certificate-for-a-back-end)
3939
* [Why do I get an authentication failure when I try to clone a GIT repository?](#why-do-i-get-an-authentication-failure-when-i-try-to-clone-a-git-repository)
4040
* [Does API Management work with Azure ExpressRoute?](#does-api-management-work-with-azure-expressroute)
4141
* [Why do we require a dedicated subnet in Resource Manager style VNETs when API Management is deployed into them?](#why-do-we-require-a-dedicated-subnet-in-resource-manager-style-vnets-when-api-management-is-deployed-into-them)
@@ -57,7 +57,7 @@ When a feature is in preview, it means that we're actively seeking feedback on h
5757
You have several options to secure the connection between the API Management gateway and your back-end services. You can:
5858

5959
* Use HTTP basic authentication. For more information, see [Import and publish your first API](import-and-publish.md).
60-
* Use SSL mutual authentication as described in [How to secure back-end services by using client certificate authentication in Azure API Management](api-management-howto-mutual-certificates.md).
60+
* Use TLS mutual authentication as described in [How to secure back-end services by using client certificate authentication in Azure API Management](api-management-howto-mutual-certificates.md).
6161
* Use IP whitelisting on your back-end service. In all tiers of API Management with the exception of Consumption tier, the IP address of the gateway remains constant, with a few caveats described in [the IP documentation article](api-management-howto-ip-addresses.md).
6262
* Connect your API Management instance to an Azure Virtual Network.
6363

@@ -110,7 +110,7 @@ API Management uses the [performance traffic routing method](../traffic-manager/
110110
### Can I use an Azure Resource Manager template to create an API Management service instance?
111111
Yes. See the [Azure API Management Service](https://aka.ms/apimtemplate) quickstart templates.
112112

113-
### Can I use a self-signed SSL certificate for a back end?
113+
### Can I use a self-signed TLS/SSL certificate for a back end?
114114
Yes. This can be done through PowerShell or by directly submitting to the API. This will disable certificate chain validation and will allow you to use self-signed or privately-signed certificates when communicating from API Management to the back end services.
115115

116116
#### Powershell method ####

articles/api-management/api-management-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Each API Management [pricing tier](https://aka.ms/apimpricing) offers a distinct
3232
| Built-in cache | No | Yes | Yes | Yes | Yes |
3333
| Built-in analytics | No | Yes | Yes | Yes | Yes |
3434
| [Self-hosted gateway](self-hosted-gateway-overview.md)<sup>3</sup> | No | Yes | No | No | Yes |
35-
| [SSL settings](api-management-howto-manage-protocols-ciphers.md) | Yes | Yes | Yes | Yes | Yes |
35+
| [TLS settings](api-management-howto-manage-protocols-ciphers.md) | Yes | Yes | Yes | Yes | Yes |
3636
| [External cache](https://aka.ms/apimbyoc) | Yes | Yes | Yes | Yes | Yes |
3737
| [Client certificate authentication](api-management-howto-mutual-certificates-for-clients.md) | Yes | Yes | Yes | Yes | Yes |
3838
| [Backup and restore](api-management-howto-disaster-recovery-backup-restore.md) | No | Yes | Yes | Yes | Yes |

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
@@ -34,7 +34,7 @@ To perform the steps described in this article, you must have:
3434
- A self-hosted gateway. For more information, see [How to provision self-hosted gateway](api-management-howto-provision-self-hosted-gateway.md)
3535
- A custom domain name that is owned by you or your organization. This topic does not provide instructions on how to procure a custom domain name.
3636
- A DNS record hosted on a DNS server that maps the custom domain name to the self-hosted gateway's IP address. This topic does not provide instructions on how to host a DNS record.
37-
- You must have a valid certificate with a public and private key (.PFX). Subject or subject alternative name (SAN) has to match the domain name (this enables API Management instance to securely expose URLs over SSL).
37+
- You must have a valid certificate with a public and private key (.PFX). Subject or subject alternative name (SAN) has to match the domain name (this enables API Management instance to securely expose URLs over TLS).
3838

3939
[!INCLUDE [api-management-navigate-to-instance.md](../../includes/api-management-navigate-to-instance.md)]
4040

articles/api-management/api-management-howto-developer-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ This error is shown when a `GET` call to `https://<management-endpoint-hostname>
195195

196196
If your API Management service is in a VNet - refer to the VNet connectivity question above.
197197

198-
The call failure may also be caused by an SSL certificate, which is assigned to a custom domain and is not trusted by the browser. As a mitigation, you can remove the management endpoint custom domain - API Management will fall back to the default endpoint with a trusted certificate.
198+
The call failure may also be caused by an TLS/SSL certificate, which is assigned to a custom domain and is not trusted by the browser. As a mitigation, you can remove the management endpoint custom domain - API Management will fall back to the default endpoint with a trusted certificate.
199199

200200
### What's the browser support for the portal?
201201

articles/api-management/api-management-howto-disaster-recovery-backup-restore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Note the following constraints when making a backup or restore request:
171171
- While backup is in progress, **avoid management changes in the service** such as SKU upgrade or downgrade, change in domain name, and more.
172172
- Restore of a **backup is guaranteed only for 30 days** since the moment of its creation.
173173
- **Usage data** used for creating analytics reports **isn't included** in the backup. Use [Azure API Management REST API][azure api management rest api] to periodically retrieve analytics reports for safekeeping.
174-
- In addition, the following items are not part of the backup data: custom domain SSL certificates and any intermediate or root certificates uploaded by customer, developer portal content, and virtual network integration settings.
174+
- In addition, the following items are not part of the backup data: custom domain TLS/SSL certificates and any intermediate or root certificates uploaded by customer, developer portal content, and virtual network integration settings.
175175
- The frequency with which you perform service backups affect your recovery point objective. To minimize it, we recommend implementing regular backups and performing on-demand backups after you make changes to your API Management service.
176176
- **Changes** made to the service configuration, (for example, APIs, policies, and developer portal appearance) while backup operation is in process **might be excluded from the backup and will be lost**.
177177
- **Allow** access from control plane to Azure Storage Account, if it has [firewall][azure-storage-ip-firewall] enabled. Customer should open the set of [Azure API Management Control Plane IP Addresses][control-plane-ip-address] on their Storage Account for Backup to or Restore from.

articles/api-management/api-management-howto-manage-protocols-ciphers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Manage protocols and ciphers in Azure API Management | Microsoft Docs
3-
description: Learn how to manage protocols (TLS, SSL) and ciphers (DES) in Azure API Management.
3+
description: Learn how to manage protocols (TLS) and ciphers (DES) in Azure API Management.
44
services: api-management
55
documentationcenter: ''
66
author: mikebudzynski

articles/api-management/api-management-using-with-vnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ When an API Management service instance is hosted in a VNET, the ports in the fo
126126
>[!IMPORTANT]
127127
> The Ports for which the *Purpose* is **bold** are required for API Management service to be deployed successfully. Blocking the other ports however will cause degradation in the ability to use and monitor the running service.
128128
129-
+ **SSL functionality**: To enable SSL certificate chain building and validation the API Management service needs Outbound network connectivity to ocsp.msocsp.com, mscrl.microsoft.com and crl.microsoft.com. This dependency is not required, if any certificate you upload to API Management contain the full chain to the CA root.
129+
+ **TLS functionality**: To enable TLS/SSL certificate chain building and validation the API Management service needs Outbound network connectivity to ocsp.msocsp.com, mscrl.microsoft.com and crl.microsoft.com. This dependency is not required, if any certificate you upload to API Management contain the full chain to the CA root.
130130

131131
+ **DNS Access**: Outbound access on port 53 is required for communication with DNS servers. If a custom DNS server exists on the other end of a VPN gateway, the DNS server must be reachable from the subnet hosting API Management.
132132

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To perform the steps described in this article, you must have:
3737
- An API Management instance. For more information, see [Create an Azure API Management instance](get-started-create-service-instance.md).
3838
- A custom domain name that is owned by you or your organization. This topic does not provide instructions on how to procure a custom domain name.
3939
- A CNAME record hosted on a DNS server that maps the custom domain name to the default domain name of your API Management instance. This topic does not provide instructions on how to host a CNAME record.
40-
- You must have a valid certificate with a public and private key (.PFX). Subject or subject alternative name (SAN) has to match the domain name (this enables API Management instance to securely expose URLs over SSL).
40+
- You must have a valid certificate with a public and private key (.PFX). Subject or subject alternative name (SAN) has to match the domain name (this enables API Management instance to securely expose URLs over TLS).
4141

4242
## Use the Azure portal to set a custom domain name
4343

@@ -69,9 +69,9 @@ To perform the steps described in this article, you must have:
6969
7070
> [!TIP]
7171
> We recommend using Azure Key Vault for managing certificates and setting them to autorotate.
72-
> If you use Azure Key Vault to manage the custom domain SSL certificate, make sure the certificate is inserted into Key Vault [as a _certificate_](https://docs.microsoft.com/rest/api/keyvault/CreateCertificate/CreateCertificate), not a _secret_.
72+
> If you use Azure Key Vault to manage the custom domain TLS/SSL certificate, make sure the certificate is inserted into Key Vault [as a _certificate_](https://docs.microsoft.com/rest/api/keyvault/CreateCertificate/CreateCertificate), not a _secret_.
7373
>
74-
> To fetch an SSL certificate, API Management must have the list and get secrets permissions on the Azure Key Vault containing the certificate. When using Azure portal all the necessary configuration steps will be completed automatically. When using command line tools or management API, these permissions must be granted manually. This is done in two steps. First, use Managed identities page on your API Management instance to make sure that Managed Identity is enabled and make a note of the principal id shown on that page. Second, give permission list and get secrets permissions to this principal id on the Azure Key Vault containing the certificate.
74+
> To fetch a TLS/SSL certificate, API Management must have the list and get secrets permissions on the Azure Key Vault containing the certificate. When using Azure portal all the necessary configuration steps will be completed automatically. When using command line tools or management API, these permissions must be granted manually. This is done in two steps. First, use Managed identities page on your API Management instance to make sure that Managed Identity is enabled and make a note of the principal id shown on that page. Second, give permission list and get secrets permissions to this principal id on the Azure Key Vault containing the certificate.
7575
>
7676
> If the certificate is set to autorotate, API Management will pick up the latest version automatically without any downtime to the service (if your API Management tier has SLA - i. e. in all tiers except the Developer tier).
7777

0 commit comments

Comments
 (0)