Pricing Templates
Log in Sign up
Integrations / Azure App Service (Web Apps) / ...

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/?api-version=2023-01-01

Description for Creates or updates a domain.

Servers

Path parameters

Name Type Required Description
subscriptionId String Yes

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
domainName String Yes

Name of the domain.
resourceGroupName String Yes

Name of the resource group to which the resource belongs.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String No

The name of the resource
systemData Object No

Metadata pertaining to creation and last modification of the resource.
systemData.createdByType String No

The type of identity that created the resource.

Possible values:

  • "ManagedIdentity"
  • "Key"
  • "Application"
  • "User"
systemData.lastModifiedAt String No

The timestamp of resource last modification (UTC)
systemData.createdAt String No

The timestamp of resource creation (UTC).
systemData.lastModifiedBy String No

The identity that last modified the resource.
systemData.lastModifiedByType String No

The type of identity that last modified the resource.

Possible values:

  • "ManagedIdentity"
  • "Key"
  • "Application"
  • "User"
systemData.createdBy String No

The identity that created the resource.
properties Object No

Domain resource specific properties
properties.contactTech Object Yes

Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.
properties.contactTech.email String Yes

Email address.
properties.contactTech.fax String No

Fax number.
properties.contactTech.nameLast String Yes

Last name.
properties.contactTech.nameMiddle String No

Middle name.
properties.contactTech.phone String Yes

Phone number.
properties.contactTech.jobTitle String No

Job title.
properties.contactTech.nameFirst String Yes

First name.
properties.contactTech.organization String No

Organization contact belongs to.
properties.contactTech.addressMailing Object No

Address information for domain registration.
properties.contactTech.addressMailing.postalCode String Yes

The postal code for the address.
properties.contactTech.addressMailing.address2 String No

The second line of the Address. Optional.
properties.contactTech.addressMailing.address1 String Yes

First line of an Address.
properties.contactTech.addressMailing.country String Yes

The country for the address.
properties.contactTech.addressMailing.state String Yes

The state or province for the address.
properties.contactTech.addressMailing.city String Yes

The city for the address.
properties.createdTime String No

Domain creation timestamp.
properties.dnsZoneId String No

Azure DNS Zone to use
properties.registrationStatus String No

Domain registration status.

Possible values:

  • "Held"
  • "Excluded"
  • "Transferred"
  • "Suspended"
  • "Reverted"
  • "Locked"
  • "Unparked"
  • "Parked"
  • "Updated"
  • "Disabled"
  • "Expired"
  • "Unlocked"
  • "Active"
  • "Unknown"
  • "Confiscated"
  • "Pending"
  • "Cancelled"
  • "JsonConverterFailed"
  • "Awaiting"
  • "Reserved"
  • "Failed"
properties.lastRenewedTime String No

Timestamp when the domain was renewed last time.
properties.contactRegistrant Object Yes

Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.
properties.contactRegistrant.email String Yes

Email address.
properties.contactRegistrant.fax String No

Fax number.
properties.contactRegistrant.nameLast String Yes

Last name.
properties.contactRegistrant.nameMiddle String No

Middle name.
properties.contactRegistrant.phone String Yes

Phone number.
properties.contactRegistrant.jobTitle String No

Job title.
properties.contactRegistrant.nameFirst String Yes

First name.
properties.contactRegistrant.organization String No

Organization contact belongs to.
properties.contactRegistrant.addressMailing Object No

Address information for domain registration.
properties.contactRegistrant.addressMailing.postalCode String Yes

The postal code for the address.
properties.contactRegistrant.addressMailing.address2 String No

The second line of the Address. Optional.
properties.contactRegistrant.addressMailing.address1 String Yes

First line of an Address.
properties.contactRegistrant.addressMailing.country String Yes

The country for the address.
properties.contactRegistrant.addressMailing.state String Yes

The state or province for the address.
properties.contactRegistrant.addressMailing.city String Yes

The city for the address.
properties.readyForDnsRecordManagement Boolean No

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.
properties.targetDnsType String No

Target DNS type (would be used for migration)

Possible values:

  • "DefaultDomainRegistrarDns"
  • "AzureDns"
properties.nameServers[] Array No

Name servers.
properties.autoRenew Boolean No

true if the domain should be automatically renewed; otherwise, false.

Default value: true
properties.provisioningState String No

Domain provisioning state.

Possible values:

  • "Succeeded"
  • "Deleting"
  • "Canceled"
  • "InProgress"
  • "Failed"
properties.domainNotRenewableReasons[] Array No

Reasons why domain is not renewable.
properties.managedHostNames[] Array No

All hostnames derived from the domain and assigned to Azure resources.
properties.managedHostNames[].azureResourceName String No

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.
properties.managedHostNames[].name String No

Name of the hostname.
properties.managedHostNames[].hostNameType String No

Type of the hostname.

Possible values:

  • "Verified"
  • "Managed"
properties.managedHostNames[].siteNames[] Array No

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.
properties.managedHostNames[].customHostNameDnsRecordType String No

Type of the DNS record.

Possible values:

  • "A"
  • "CName"
properties.managedHostNames[].azureResourceType String No

Type of the Azure resource the hostname is assigned to.

Possible values:

  • "TrafficManager"
  • "Website"
properties.dnsType String No

Current DNS type

Possible values:

  • "DefaultDomainRegistrarDns"
  • "AzureDns"
properties.contactAdmin Object Yes

Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.
properties.contactAdmin.email String Yes

Email address.
properties.contactAdmin.fax String No

Fax number.
properties.contactAdmin.nameLast String Yes

Last name.
properties.contactAdmin.nameMiddle String No

Middle name.
properties.contactAdmin.phone String Yes

Phone number.
properties.contactAdmin.jobTitle String No

Job title.
properties.contactAdmin.nameFirst String Yes

First name.
properties.contactAdmin.organization String No

Organization contact belongs to.
properties.contactAdmin.addressMailing Object No

Address information for domain registration.
properties.contactAdmin.addressMailing.postalCode String Yes

The postal code for the address.
properties.contactAdmin.addressMailing.address2 String No

The second line of the Address. Optional.
properties.contactAdmin.addressMailing.address1 String Yes

First line of an Address.
properties.contactAdmin.addressMailing.country String Yes

The country for the address.
properties.contactAdmin.addressMailing.state String Yes

The state or province for the address.
properties.contactAdmin.addressMailing.city String Yes

The city for the address.
properties.consent Object Yes

Domain purchase consent object, representing acceptance of applicable legal agreements.
properties.consent.agreementKeys[] Array No

List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.
properties.consent.agreedAt String No

Timestamp when the agreements were accepted.
properties.consent.agreedBy String No

Client IP address.
properties.contactBilling Object Yes

Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.
properties.contactBilling.email String Yes

Email address.
properties.contactBilling.fax String No

Fax number.
properties.contactBilling.nameLast String Yes

Last name.
properties.contactBilling.nameMiddle String No

Middle name.
properties.contactBilling.phone String Yes

Phone number.
properties.contactBilling.jobTitle String No

Job title.
properties.contactBilling.nameFirst String Yes

First name.
properties.contactBilling.organization String No

Organization contact belongs to.
properties.contactBilling.addressMailing Object No

Address information for domain registration.
properties.contactBilling.addressMailing.postalCode String Yes

The postal code for the address.
properties.contactBilling.addressMailing.address2 String No

The second line of the Address. Optional.
properties.contactBilling.addressMailing.address1 String Yes

First line of an Address.
properties.contactBilling.addressMailing.country String Yes

The country for the address.
properties.contactBilling.addressMailing.state String Yes

The state or province for the address.
properties.contactBilling.addressMailing.city String Yes

The city for the address.
properties.expirationTime String No

Domain expiration timestamp.
properties.privacy Boolean No

true if domain privacy is enabled for this domain; otherwise, false.
properties.authCode String No
type String No

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy