Microsoft.DomainRegistration (stable:2024-11-01)

2025/05/15 • 20 new methods

DomainRegistrationProvider_ListOperations (new)
Description :  Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DomainRegistration/operations
{
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Required: False ,
}
string ,
isDataAction:
{
Required: False ,
}
boolean ,
display:
{
Description: Meta data about operation used for display in portal. ,
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
operation:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Description: Properties available for a Microsoft.Web resource provider operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Resource metrics service provided by Microsoft.Insights resource provider. ,
Required: False ,
}
{
metricSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
displayDescription:
{
Required: False ,
}
string ,
unit:
{
Required: False ,
}
string ,
aggregationType:
{
Required: False ,
}
string ,
supportsInstanceLevelAggregation:
{
Required: False ,
}
boolean ,
enableRegionalMdmAccount:
{
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Required: False ,
}
string ,
sourceMdmNamespace:
{
Required: False ,
}
string ,
metricFilterPattern:
{
Required: False ,
}
string ,
fillGapWithZero:
{
Required: False ,
}
boolean ,
isInternal:
{
Required: False ,
}
boolean ,
dimensions:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
internalName:
{
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Required: False ,
}
boolean ,
}
,
]
,
category:
{
Required: False ,
}
string ,
availabilities:
{
Required: False ,
}
[
{
timeGrain:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
}
,
]
,
supportedTimeGrainTypes:
{
Required: False ,
}
[
string ,
]
,
supportedAggregationTypes:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
logSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
logFilterPattern:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_CheckAvailability (new)
Description :  Description for Check if a domain is available for registration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability
{
identifier:
{
Description: Name of the domain. ,
Required: True ,
}
{
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the domain. ,
Required: False ,
}
string ,
available:
{
Description: true if domain can be purchased using CreateDomain API; otherwise, false. ,
Required: False ,
}
boolean ,
domainType:
{
Description: 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. ,
Enum:
{
Regular: No description available. ,
SoftDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_List (new)
Description :  Description for Get all domains in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_GetControlCenterSsoRequest (new)
Description :  Description for Generate a single sign-on request for the domain management portal.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
url:
{
Description: URL where the single sign-on request is to be made. ,
Required: False ,
}
string ,
postParameterKey:
{
Description: Post parameter key. ,
Required: False ,
}
string ,
postParameterValue:
{
Description: Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_ListRecommendations (new)
Description :  Description for Get domain name recommendations based on keywords.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations
{
parameters:
{
Description: Search parameters for domain name recommendations. ,
Required: True ,
}
{
keywords:
{
Description: Keywords to be used for generating domain recommendations. ,
Required: False ,
}
string ,
maxDomainRecommendations:
{
Description: Maximum number of recommendations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Name of the object. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_ListByResourceGroup (new)
Description :  Description for Get all domains in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_Get (new)
Description :  Description for Get a domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_CreateOrUpdate (new)
Description :  Description for Creates or updates a domain.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
domain:
{
Description: Domain registration information. ,
Required: True ,
}
{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_Delete (new)
Description :  Description for Delete a domain.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
forceHardDeleteDomain:
{
Description: Specify true to delete the domain immediately. The default is false which deletes the domain after 24 hours. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_Update (new)
Description :  Description for Creates or updates a domain.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
domain:
{
Description: Domain registration information. ,
Required: True ,
}
{
properties:
{
Description: DomainPatchResource resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_ListOwnershipIdentifiers (new)
Description :  Description for Lists domain ownership identifiers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of domain. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: DomainOwnershipIdentifier resource specific properties ,
Required: False ,
}
{
ownershipId:
{
Description: Ownership Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_GetOwnershipIdentifier (new)
Description :  Description for Get ownership identifier for domain
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of domain. ,
Required: True ,
}
string ,
name:
{
Description: Name of identifier. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DomainOwnershipIdentifier resource specific properties ,
Required: False ,
}
{
ownershipId:
{
Description: Ownership Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_CreateOrUpdateOwnershipIdentifier (new)
Description :  Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of domain. ,
Required: True ,
}
string ,
name:
{
Description: Name of identifier. ,
Required: True ,
}
string ,
domainOwnershipIdentifier:
{
Description: A JSON representation of the domain ownership properties. ,
Required: True ,
}
{
properties:
{
Description: DomainOwnershipIdentifier resource specific properties ,
Required: False ,
}
{
ownershipId:
{
Description: Ownership Id. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DomainOwnershipIdentifier resource specific properties ,
Required: False ,
}
{
ownershipId:
{
Description: Ownership Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_DeleteOwnershipIdentifier (new)
Description :  Description for Delete ownership identifier for domain
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of domain. ,
Required: True ,
}
string ,
name:
{
Description: Name of identifier. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_UpdateOwnershipIdentifier (new)
Description :  Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of domain. ,
Required: True ,
}
string ,
name:
{
Description: Name of identifier. ,
Required: True ,
}
string ,
domainOwnershipIdentifier:
{
Description: A JSON representation of the domain ownership properties. ,
Required: True ,
}
{
properties:
{
Description: DomainOwnershipIdentifier resource specific properties ,
Required: False ,
}
{
ownershipId:
{
Description: Ownership Id. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DomainOwnershipIdentifier resource specific properties ,
Required: False ,
}
{
ownershipId:
{
Description: Ownership Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_Renew (new)
Description :  Description for Renew a domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/renew
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of the domain. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Domains_TransferOut (new)
Description :  Transfer out domain to another registrar
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/transferOut
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
domainName:
{
Description: Name of domain. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Domain resource specific properties ,
Required: False ,
}
{
contactAdmin:
{
Description: Administrative contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactBilling:
{
Description: Billing contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactRegistrant:
{
Description: Registrant contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
contactTech:
{
Description: Technical contact. ,
Required: True ,
}
{
addressMailing:
{
Description: Mailing address. ,
Required: False ,
}
{
address1:
{
Description: First line of an Address. ,
Required: True ,
}
string ,
address2:
{
Description: The second line of the Address. Optional. ,
Required: False ,
}
string ,
city:
{
Description: The city for the address. ,
Required: True ,
}
string ,
country:
{
Description: The country for the address. ,
Required: True ,
}
string ,
postalCode:
{
Description: The postal code for the address. ,
Required: True ,
}
string ,
state:
{
Description: The state or province for the address. ,
Required: True ,
}
string ,
}
,
email:
{
Description: Email address. ,
Required: True ,
}
string ,
fax:
{
Description: Fax number. ,
Required: False ,
}
string ,
jobTitle:
{
Description: Job title. ,
Required: False ,
}
string ,
nameFirst:
{
Description: First name. ,
Required: True ,
}
string ,
nameLast:
{
Description: Last name. ,
Required: True ,
}
string ,
nameMiddle:
{
Description: Middle name. ,
Required: False ,
}
string ,
organization:
{
Description: Organization contact belongs to. ,
Required: False ,
}
string ,
phone:
{
Description: Phone number. ,
Required: True ,
}
string ,
}
,
registrationStatus:
{
Description: Domain registration status. ,
Enum:
{
Active: No description available. ,
Awaiting: No description available. ,
Cancelled: No description available. ,
Confiscated: No description available. ,
Disabled: No description available. ,
Excluded: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
Held: No description available. ,
Locked: No description available. ,
Parked: No description available. ,
Pending: No description available. ,
Reserved: No description available. ,
Reverted: No description available. ,
Suspended: No description available. ,
Transferred: No description available. ,
Unknown: No description available. ,
Unlocked: No description available. ,
Unparked: No description available. ,
Updated: No description available. ,
JsonConverterFailed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Domain provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
nameServers:
{
Description: Name servers. ,
Required: False ,
}
[
string ,
]
,
privacy:
{
Description: true if domain privacy is enabled for this domain; otherwise, false. ,
Required: False ,
}
boolean ,
createdTime:
{
Description: Domain creation timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Domain expiration timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastRenewedTime:
{
Description: Timestamp when the domain was renewed last time. ,
Format: date-time ,
Required: False ,
}
string ,
autoRenew:
{
Description: true if the domain should be automatically renewed; otherwise, false. ,
Required: False ,
}
boolean ,
readyForDnsRecordManagement:
{
Description: true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. ,
Required: False ,
}
boolean ,
managedHostNames:
{
Description: All hostnames derived from the domain and assigned to Azure resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the hostname. ,
Required: False ,
}
string ,
siteNames:
{
Description: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. ,
Required: False ,
}
[
string ,
]
,
azureResourceName:
{
Description: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. ,
Required: False ,
}
string ,
azureResourceType:
{
Description: Type of the Azure resource the hostname is assigned to. ,
Enum:
{
Website: No description available. ,
TrafficManager: No description available. ,
}
,
Required: False ,
}
enum ,
customHostNameDnsRecordType:
{
Description: Type of the DNS record. ,
Enum:
{
CName: No description available. ,
A: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameType:
{
Description: Type of the hostname. ,
Enum:
{
Verified: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
consent:
{
Description: Legal agreement consent. ,
Required: True ,
}
{
agreementKeys:
{
Description: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. ,
Required: False ,
}
[
string ,
]
,
agreedBy:
{
Description: Client IP address. ,
Required: False ,
}
string ,
agreedAt:
{
Description: Timestamp when the agreements were accepted. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
domainNotRenewableReasons:
{
Description: Reasons why domain is not renewable. ,
Required: False ,
}
[
string ,
]
,
dnsType:
{
Description: Current DNS type ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
dnsZoneId:
{
Description: Azure DNS Zone to use ,
Required: False ,
}
string ,
targetDnsType:
{
Description: Target DNS type (would be used for migration) ,
Enum:
{
AzureDns: No description available. ,
DefaultDomainRegistrarDns: No description available. ,
}
,
Required: False ,
}
enum ,
authCode:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
TopLevelDomains_List (new)
Description :  Description for Get all top-level domains supported for registration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains
{
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: TopLevelDomain resource specific properties ,
Required: False ,
}
{
privacy:
{
Description: If true, then the top level domain supports domain privacy; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
TopLevelDomains_Get (new)
Description :  Description for Get details of a top-level domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}
{
name:
{
Description: Name of the top-level domain. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: TopLevelDomain resource specific properties ,
Required: False ,
}
{
privacy:
{
Description: If true, then the top level domain supports domain privacy; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
TopLevelDomains_ListAgreements (new)
Description :  Description for Gets all legal agreements that user needs to accept before purchasing a domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements
{
name:
{
Description: Name of the top-level domain. ,
Required: True ,
}
string ,
agreementOption:
{
Description: Domain agreement options. ,
Required: True ,
}
{
includePrivacy:
{
Description: If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. ,
Required: False ,
}
boolean ,
forTransfer:
{
Description: If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
agreementKey:
{
Description: Unique identifier for the agreement. ,
Required: True ,
}
string ,
title:
{
Description: Agreement title. ,
Required: True ,
}
string ,
content:
{
Description: Agreement details. ,
Required: True ,
}
string ,
url:
{
Description: URL where a copy of the agreement details is hosted. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}