Front Doors - Validate Custom Domain

Service:

Front Door Service

API Version:

2019-05-01

Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/validateCustomDomain?api-version=2019-05-01

URI Parameters

Name	In	Required	Type	Description
frontDoorName	path	True	string minLength: 5 maxLength: 64 pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$	Name of the Front Door which is globally unique.
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Name of the Resource group within the Azure subscription.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Request Body

Name	Required	Type	Description
hostName	True	string	The host name of the custom domain. Must be a domain name.

Responses

Name	Type	Description
200 OK	ValidateCustomDomainOutput	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Front Door error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

FrontDoor_ValidateCustomDomain

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/validateCustomDomain?api-version=2019-05-01

{
  "hostName": "www.someDomain.com"
}

Sample response

Status code:

200

{
  "customDomainValidated": true,
  "message": null,
  "reason": null
}

Definitions

Name	Description
ErrorResponse	Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
ValidateCustomDomainInput	Input of the custom domain to be validated for DNS mapping.
ValidateCustomDomainOutput	Output of custom domain validation.

ErrorResponse

Object

Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ValidateCustomDomainInput

Object

Input of the custom domain to be validated for DNS mapping.

Name	Type	Description
hostName	string	The host name of the custom domain. Must be a domain name.

ValidateCustomDomainOutput

Object

Output of custom domain validation.

Name	Type	Description
customDomainValidated	boolean	Indicates whether the custom domain is valid or not.
message	string	Error message describing why the custom domain is not valid.
reason	string	The reason why the custom domain is not valid.