Custom subdomain names for Azure AI services
Starting in July 2019, Azure AI services use custom subdomain names for each resource created through the Azure portal, Azure Cloud Shell, or Azure CLI. Unlike regional endpoints, which were common for all customers in a specific Azure region, custom subdomain names are unique to the resource. Custom subdomain names are required to enable features like Microsoft Entra ID for authentication.
How does this impact existing resources?
Azure AI services resources created before July 1, 2019, use the regional endpoints for the associated service. These endpoints work with existing and new resources.
If you'd like to migrate an existing resource to use custom subdomain names to enable features like Microsoft Entra ID, follow these instructions:
- Sign in to the Azure portal and locate the Azure AI services resource that you'd like to add a custom subdomain name to.
- In the Overview section, locate and select Generate Custom Domain Name.
- This opens a panel with instructions to create a unique custom subdomain for your resource.
Warning
After you create a custom subdomain name, it can not be changed.
Do I need to update my existing resources?
No. The regional endpoint continues to work for new and existing Azure AI services and the custom subdomain name is optional. Even if a custom subdomain name is added, the regional endpoint continues to work with the resource.
What if an SDK asks me for the region for a resource?
Warning
Speech Services use custom subdomains with private endpoints only. In all other cases, use regional endpoints with Speech Services and associated SDKs.
Regional endpoints and custom subdomain names are both supported and can be used interchangeably. However, the full endpoint is required.
Region information is available in the Overview section for your resource in the Azure portal. For the full list of regional endpoints, see Is there a list of regional endpoints?
Are custom subdomain names regional?
Yes. Using a custom subdomain name doesn't change any of the regional aspects of your Azure AI services resource.
What are the requirements for a custom subdomain name?
A custom subdomain name is unique to your resource. The name can only include alphanumeric characters and the - character; it must be between 2 and 64 characters in length and can't end with a -.
Can I change a custom domain name?
No. After a custom subdomain name is created and associated with a resource, it can't be changed.
Can I reuse a custom domain name?
Each custom subdomain name is unique. In order to reuse a custom subdomain name that you've assigned to an Azure AI services resource, you'll need to delete the existing resource. After the resource is deleted, you can reuse the custom subdomain name.
Is there a list of regional endpoints?
Yes. This is a list of regional endpoints that you can use with Azure AI services resources.
Note
The Translator service and Bing Search APIs use global endpoints.
| Endpoint type | Region | Endpoint |
|---|---|---|
| Public | Global (Translator & Bing) | https://api.cognitive.microsoft.com |
| Australia East | https://australiaeast.api.cognitive.microsoft.com |
|
| Brazil South | https://brazilsouth.api.cognitive.microsoft.com |
|
| Canada Central | https://canadacentral.api.cognitive.microsoft.com |
|
| Central US | https://centralus.api.cognitive.microsoft.com |
|
| East Asia | https://eastasia.api.cognitive.microsoft.com |
|
| East US | https://eastus.api.cognitive.microsoft.com |
|
| East US 2 | https://eastus2.api.cognitive.microsoft.com |
|
| France Central | https://francecentral.api.cognitive.microsoft.com |
|
| India Central | https://centralindia.api.cognitive.microsoft.com |
|
| Japan East | https://japaneast.api.cognitive.microsoft.com |
|
| Korea Central | https://koreacentral.api.cognitive.microsoft.com |
|
| North Central US | https://northcentralus.api.cognitive.microsoft.com |
|
| North Europe | https://northeurope.api.cognitive.microsoft.com |
|
| South Africa North | https://southafricanorth.api.cognitive.microsoft.com |
|
| South Central US | https://southcentralus.api.cognitive.microsoft.com |
|
| Southeast Asia | https://southeastasia.api.cognitive.microsoft.com |
|
| UK South | https://uksouth.api.cognitive.microsoft.com |
|
| West Central US | https://westcentralus.api.cognitive.microsoft.com |
|
| West Europe | https://westeurope.api.cognitive.microsoft.com |
|
| West US | https://westus.api.cognitive.microsoft.com |
|
| West US 2 | https://westus2.api.cognitive.microsoft.com |
|
| US Gov | US Gov Virginia | https://virginia.api.cognitive.microsoft.us |
| China | China East 2 | https://chinaeast2.api.cognitive.azure.cn |
| China North | https://chinanorth.api.cognitive.azure.cn |