Check Front Door Name Availability - Check Front Door Name Availability
Check the availability of a Front Door resource name.
POST https://management.azure.com/providers/Microsoft.Network/checkFrontDoorNameAvailability?api-version=2019-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Client API version. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
name | True |
string |
The resource name to validate. |
type | True |
The type of the resource whose name is to be validated. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. The request has succeeded. |
|
Other Status Codes |
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
CheckNameAvailability
Sample Request
POST https://management.azure.com/providers/Microsoft.Network/checkFrontDoorNameAvailability?api-version=2019-05-01
{
"name": "sampleName",
"type": "Microsoft.Network/frontDoors"
}
Sample Response
{
"nameAvailability": "Unavailable",
"reason": "Name is already in use",
"message": "Name not available"
}
Definitions
Name | Description |
---|---|
Availability |
Indicates whether the name is available. |
Check |
Input of CheckNameAvailability API. |
Check |
Output of check name availability API. |
Error |
Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message. |
Resource |
Type of Front Door resource used in CheckNameAvailability. |
Availability
Indicates whether the name is available.
Name | Type | Description |
---|---|---|
Available |
string |
|
Unavailable |
string |
CheckNameAvailabilityInput
Input of CheckNameAvailability API.
Name | Type | Description |
---|---|---|
name |
string |
The resource name to validate. |
type |
The type of the resource whose name is to be validated. |
CheckNameAvailabilityOutput
Output of check name availability API.
Name | Type | Description |
---|---|---|
message |
string |
The detailed error message describing why the name is not available. |
nameAvailability |
Indicates whether the name is available. |
|
reason |
string |
The reason why the name is not available. |
ErrorResponse
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
Type of Front Door resource used in CheckNameAvailability.
Name | Type | Description |
---|---|---|
Microsoft.Network/frontDoors |
string |
|
Microsoft.Network/frontDoors/frontendEndpoints |
string |