Check Front Door Name Availability With Subscription - Check Front Door Name Availability With Subscription

Service:

Front Door Service

API Version:

2020-04-01

Check the availability of a Front Door subdomain.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/checkFrontDoorNameAvailability?api-version=2020-04-01

URI Parameters

Name	In	Required	Type	Description
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
name	True	string	The resource name to validate.
type	True	ResourceType	The type of the resource whose name is to be validated.

Responses

Name	Type	Description
200 OK	CheckNameAvailabilityOutput	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

CheckNameAvailabilityWithSubscription

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/checkFrontDoorNameAvailability?api-version=2020-04-01

{
  "name": "sampleName",
  "type": "Microsoft.Network/frontDoors/frontendEndpoints"
}

Sample response

Status code:

200

{
  "nameAvailability": "Unavailable",
  "reason": "Name is already in use",
  "message": "Name not available"
}

Definitions

Name	Description
Availability	Indicates whether the name is available.
CheckNameAvailabilityInput	Input of CheckNameAvailability API.
CheckNameAvailabilityOutput	Output of check name availability API.
ErrorResponse	Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
ResourceType	Type of Front Door resource used in CheckNameAvailability.

Availability

Enumeration

Indicates whether the name is available.

Value	Description
Available
Unavailable

CheckNameAvailabilityInput

Object

Input of CheckNameAvailability API.

Name	Type	Description
name	string	The resource name to validate.
type	ResourceType	The type of the resource whose name is to be validated.

CheckNameAvailabilityOutput

Object

Output of check name availability API.

Name	Type	Description
message	string	The detailed error message describing why the name is not available.
nameAvailability	Availability	Indicates whether the name is available.
reason	string	The reason why the name is not available.

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.

ResourceType

Enumeration

Type of Front Door resource used in CheckNameAvailability.

Value	Description
Microsoft.Network/frontDoors
Microsoft.Network/frontDoors/frontendEndpoints