Domains - Check Availability

Service:

App Service

API Version:

2023-12-01

Description for Check if a domain is available for registration.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Type	Description
name	string	Name of the object.

Responses

Name	Type	Description
200 OK	DomainAvailabilityCheckResult	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

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

Check domain availability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/checkDomainAvailability?api-version=2023-12-01

{
  "name": "abcd.com"
}

Sample Response

Status code:

200

{
  "name": "abcd.com",
  "available": true,
  "domainType": "Regular"
}

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
DomainAvailabilityCheckResult	Domain availability check result.
DomainType	Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything.
Error	Error model.
NameIdentifier	Identifies an object.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

DomainAvailabilityCheckResult

Domain availability check result.

Name	Type	Description
available	boolean	true if domain can be purchased using CreateDomain API; otherwise, false.
domainType	DomainType	Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything.
name	string	Name of the domain.

DomainType

Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything.

Name	Type	Description
Regular	string
SoftDeleted	string

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

NameIdentifier

Identifies an object.

Name	Type	Description
name	string	Name of the object.