domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	azure.domain_registration.domains

Fields

The following fields are returned by SELECT queries:

get_ownership_identifier

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
kind	string	Kind of resource.
ownershipId	string	Ownership Id.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authCode	string	Authorization code for the domain.
autoRenew	boolean	true if the domain should be automatically renewed; otherwise, false.
consent	object	Legal agreement consent. Required.
contactAdmin	object	Administrative contact. Required.
contactBilling	object	Billing contact. Required.
contactRegistrant	object	Registrant contact. Required.
contactTech	object	Technical contact. Required.
createdTime	string (date-time)	Domain creation timestamp.
dnsType	string	Current DNS type. Known values are: "AzureDns" and "DefaultDomainRegistrarDns". (AzureDns, DefaultDomainRegistrarDns)
dnsZoneId	string	Azure DNS Zone to use.
domainNotRenewableReasons	array	Reasons why domain is not renewable.
expirationTime	string (date-time)	Domain expiration timestamp.
kind	string	Kind of resource.
lastRenewedTime	string (date-time)	Timestamp when the domain was renewed last time.
location	string	The geo-location where the resource lives. Required.
managedHostNames	array	All hostnames derived from the domain and assigned to Azure resources.
nameServers	array	Name servers.
privacy	boolean	true if domain privacy is enabled for this domain; otherwise, false.
provisioningState	string	Domain provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
readyForDnsRecordManagement	boolean	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 \n it is hosted on name servers Azure has programmatic access to.
registrationStatus	string	Domain registration status. Known values are: "Active", "Awaiting", "Cancelled", "Confiscated", "Disabled", "Excluded", "Expired", "Failed", "Held", "Locked", "Parked", "Pending", "Reserved", "Reverted", "Suspended", "Transferred", "Unknown", "Unlocked", "Unparked", "Updated", and "JsonConverterFailed". (Active, Awaiting, Cancelled, Confiscated, Disabled, Excluded, Expired, Failed, Held, Locked, Parked, Pending, Reserved, Reverted, Suspended, Transferred, Unknown, Unlocked, Unparked, Updated, JsonConverterFailed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetDnsType	string	Target DNS type (would be used for migration). Known values are: "AzureDns" and "DefaultDomainRegistrarDns". (AzureDns, DefaultDomainRegistrarDns)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authCode	string	Authorization code for the domain.
autoRenew	boolean	true if the domain should be automatically renewed; otherwise, false.
consent	object	Legal agreement consent. Required.
contactAdmin	object	Administrative contact. Required.
contactBilling	object	Billing contact. Required.
contactRegistrant	object	Registrant contact. Required.
contactTech	object	Technical contact. Required.
createdTime	string (date-time)	Domain creation timestamp.
dnsType	string	Current DNS type. Known values are: "AzureDns" and "DefaultDomainRegistrarDns". (AzureDns, DefaultDomainRegistrarDns)
dnsZoneId	string	Azure DNS Zone to use.
domainNotRenewableReasons	array	Reasons why domain is not renewable.
expirationTime	string (date-time)	Domain expiration timestamp.
kind	string	Kind of resource.
lastRenewedTime	string (date-time)	Timestamp when the domain was renewed last time.
location	string	The geo-location where the resource lives. Required.
managedHostNames	array	All hostnames derived from the domain and assigned to Azure resources.
nameServers	array	Name servers.
privacy	boolean	true if domain privacy is enabled for this domain; otherwise, false.
provisioningState	string	Domain provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
readyForDnsRecordManagement	boolean	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 \n it is hosted on name servers Azure has programmatic access to.
registrationStatus	string	Domain registration status. Known values are: "Active", "Awaiting", "Cancelled", "Confiscated", "Disabled", "Excluded", "Expired", "Failed", "Held", "Locked", "Parked", "Pending", "Reserved", "Reverted", "Suspended", "Transferred", "Unknown", "Unlocked", "Unparked", "Updated", and "JsonConverterFailed". (Active, Awaiting, Cancelled, Confiscated, Disabled, Excluded, Expired, Failed, Held, Locked, Parked, Pending, Reserved, Reverted, Suspended, Transferred, Unknown, Unlocked, Unparked, Updated, JsonConverterFailed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetDnsType	string	Target DNS type (would be used for migration). Known values are: "AzureDns" and "DefaultDomainRegistrarDns". (AzureDns, DefaultDomainRegistrarDns)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authCode	string	Authorization code for the domain.
autoRenew	boolean	true if the domain should be automatically renewed; otherwise, false.
consent	object	Legal agreement consent. Required.
contactAdmin	object	Administrative contact. Required.
contactBilling	object	Billing contact. Required.
contactRegistrant	object	Registrant contact. Required.
contactTech	object	Technical contact. Required.
createdTime	string (date-time)	Domain creation timestamp.
dnsType	string	Current DNS type. Known values are: "AzureDns" and "DefaultDomainRegistrarDns". (AzureDns, DefaultDomainRegistrarDns)
dnsZoneId	string	Azure DNS Zone to use.
domainNotRenewableReasons	array	Reasons why domain is not renewable.
expirationTime	string (date-time)	Domain expiration timestamp.
kind	string	Kind of resource.
lastRenewedTime	string (date-time)	Timestamp when the domain was renewed last time.
location	string	The geo-location where the resource lives. Required.
managedHostNames	array	All hostnames derived from the domain and assigned to Azure resources.
nameServers	array	Name servers.
privacy	boolean	true if domain privacy is enabled for this domain; otherwise, false.
provisioningState	string	Domain provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
readyForDnsRecordManagement	boolean	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 \n it is hosted on name servers Azure has programmatic access to.
registrationStatus	string	Domain registration status. Known values are: "Active", "Awaiting", "Cancelled", "Confiscated", "Disabled", "Excluded", "Expired", "Failed", "Held", "Locked", "Parked", "Pending", "Reserved", "Reverted", "Suspended", "Transferred", "Unknown", "Unlocked", "Unparked", "Updated", and "JsonConverterFailed". (Active, Awaiting, Cancelled, Confiscated, Disabled, Excluded, Expired, Failed, Held, Locked, Parked, Pending, Reserved, Reverted, Suspended, Transferred, Unknown, Unlocked, Unparked, Updated, JsonConverterFailed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetDnsType	string	Target DNS type (would be used for migration). Known values are: "AzureDns" and "DefaultDomainRegistrarDns". (AzureDns, DefaultDomainRegistrarDns)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ownership_identifier	select	resource_group_name, domain_name, name, subscription_id		Get ownership identifier for domain. Description for Get ownership identifier for domain.
get	select	resource_group_name, domain_name, subscription_id		Get a domain. Description for Get a domain.
list_by_resource_group	select	resource_group_name, subscription_id		Get all domains in a resource group. Description for Get all domains in a resource group.
list	select	subscription_id		Get all domains in a subscription. Description for Get all domains in a subscription.
create_or_update	insert	resource_group_name, domain_name, subscription_id, location		Creates or updates a domain. Description for Creates or updates a domain.
update	update	resource_group_name, domain_name, subscription_id		Creates or updates a domain. Description for Creates or updates a domain.
create_or_update	replace	resource_group_name, domain_name, subscription_id, location		Creates or updates a domain. Description for Creates or updates a domain.
delete	delete	resource_group_name, domain_name, subscription_id	forceHardDeleteDomain	Delete a domain. Description for Delete a domain.
list_ownership_identifiers	exec	resource_group_name, domain_name, subscription_id		Lists domain ownership identifiers. Description for Lists domain ownership identifiers.
list_recommendations	exec	subscription_id		Get domain name recommendations based on keywords. Description for Get domain name recommendations based on keywords.
create_or_update_ownership_identifier	exec	resource_group_name, domain_name, name, subscription_id		Creates an ownership identifier for a domain or updates identifier details for an existing identifier. Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.
update_ownership_identifier	exec	resource_group_name, domain_name, name, subscription_id		Creates an ownership identifier for a domain or updates identifier details for an existing identifier. Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.
delete_ownership_identifier	exec	resource_group_name, domain_name, name, subscription_id		Delete ownership identifier for domain. Description for Delete ownership identifier for domain.
get_control_center_sso_request	exec	subscription_id		Generate a single sign-on request for the domain management portal. Description for Generate a single sign-on request for the domain management portal.
renew	exec	resource_group_name, domain_name, subscription_id		Renew a domain. Description for Renew a domain.
transfer_out	exec	resource_group_name, domain_name, subscription_id		Transfer out domain to another registrar. Transfer out domain to another registrar.
check_availability	exec	subscription_id		Check if a domain is available for registration. Description for Check if a domain is available for registration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	Name of the domain. Required.
name	string	Name of identifier. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
forceHardDeleteDomain	boolean	Specify true to delete the domain immediately. The default is false which deletes the domain after 24 hours. Default value is None.

SELECT examples

get_ownership_identifier

Get ownership identifier for domain. Description for Get ownership identifier for domain.

SELECT
id,
name,
kind,
ownershipId,
systemData,
type
FROM azure.domain_registration.domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a domain. Description for Get a domain.

SELECT
id,
name,
authCode,
autoRenew,
consent,
contactAdmin,
contactBilling,
contactRegistrant,
contactTech,
createdTime,
dnsType,
dnsZoneId,
domainNotRenewableReasons,
expirationTime,
kind,
lastRenewedTime,
location,
managedHostNames,
nameServers,
privacy,
provisioningState,
readyForDnsRecordManagement,
registrationStatus,
systemData,
tags,
targetDnsType,
type
FROM azure.domain_registration.domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all domains in a resource group. Description for Get all domains in a resource group.

SELECT
id,
name,
authCode,
autoRenew,
consent,
contactAdmin,
contactBilling,
contactRegistrant,
contactTech,
createdTime,
dnsType,
dnsZoneId,
domainNotRenewableReasons,
expirationTime,
kind,
lastRenewedTime,
location,
managedHostNames,
nameServers,
privacy,
provisioningState,
readyForDnsRecordManagement,
registrationStatus,
systemData,
tags,
targetDnsType,
type
FROM azure.domain_registration.domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all domains in a subscription. Description for Get all domains in a subscription.

SELECT
id,
name,
authCode,
autoRenew,
consent,
contactAdmin,
contactBilling,
contactRegistrant,
contactTech,
createdTime,
dnsType,
dnsZoneId,
domainNotRenewableReasons,
expirationTime,
kind,
lastRenewedTime,
location,
managedHostNames,
nameServers,
privacy,
provisioningState,
readyForDnsRecordManagement,
registrationStatus,
systemData,
tags,
targetDnsType,
type
FROM azure.domain_registration.domains
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a domain. Description for Creates or updates a domain.

INSERT INTO azure.domain_registration.domains (
tags,
location,
properties,
kind,
resource_group_name,
domain_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ domain_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the domains resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the domains resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Domain resource specific properties.
    value:
      contactAdmin:
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        email: "{{ email }}"
        fax: "{{ fax }}"
        jobTitle: "{{ jobTitle }}"
        nameFirst: "{{ nameFirst }}"
        nameLast: "{{ nameLast }}"
        nameMiddle: "{{ nameMiddle }}"
        organization: "{{ organization }}"
        phone: "{{ phone }}"
      contactBilling:
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        email: "{{ email }}"
        fax: "{{ fax }}"
        jobTitle: "{{ jobTitle }}"
        nameFirst: "{{ nameFirst }}"
        nameLast: "{{ nameLast }}"
        nameMiddle: "{{ nameMiddle }}"
        organization: "{{ organization }}"
        phone: "{{ phone }}"
      contactRegistrant:
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        email: "{{ email }}"
        fax: "{{ fax }}"
        jobTitle: "{{ jobTitle }}"
        nameFirst: "{{ nameFirst }}"
        nameLast: "{{ nameLast }}"
        nameMiddle: "{{ nameMiddle }}"
        organization: "{{ organization }}"
        phone: "{{ phone }}"
      contactTech:
        addressMailing:
          address1: "{{ address1 }}"
          address2: "{{ address2 }}"
          city: "{{ city }}"
          country: "{{ country }}"
          postalCode: "{{ postalCode }}"
          state: "{{ state }}"
        email: "{{ email }}"
        fax: "{{ fax }}"
        jobTitle: "{{ jobTitle }}"
        nameFirst: "{{ nameFirst }}"
        nameLast: "{{ nameLast }}"
        nameMiddle: "{{ nameMiddle }}"
        organization: "{{ organization }}"
        phone: "{{ phone }}"
      registrationStatus: "{{ registrationStatus }}"
      provisioningState: "{{ provisioningState }}"
      nameServers:
        - "{{ nameServers }}"
      privacy: {{ privacy }}
      createdTime: "{{ createdTime }}"
      expirationTime: "{{ expirationTime }}"
      lastRenewedTime: "{{ lastRenewedTime }}"
      autoRenew: {{ autoRenew }}
      readyForDnsRecordManagement: {{ readyForDnsRecordManagement }}
      managedHostNames:
        - name: "{{ name }}"
          siteNames: "{{ siteNames }}"
          azureResourceName: "{{ azureResourceName }}"
          azureResourceType: "{{ azureResourceType }}"
          customHostNameDnsRecordType: "{{ customHostNameDnsRecordType }}"
          hostNameType: "{{ hostNameType }}"
      consent:
        agreementKeys:
          - "{{ agreementKeys }}"
        agreedBy: "{{ agreedBy }}"
        agreedAt: "{{ agreedAt }}"
      domainNotRenewableReasons:
        - "{{ domainNotRenewableReasons }}"
      dnsType: "{{ dnsType }}"
      dnsZoneId: "{{ dnsZoneId }}"
      targetDnsType: "{{ targetDnsType }}"
      authCode: "{{ authCode }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of resource.

UPDATE examples

update

Creates or updates a domain. Description for Creates or updates a domain.

UPDATE azure.domain_registration.domains
SET 
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a domain. Description for Creates or updates a domain.

REPLACE azure.domain_registration.domains
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a domain. Description for Delete a domain.

DELETE FROM azure.domain_registration.domains
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND forceHardDeleteDomain = '{{ forceHardDeleteDomain }}'
;

Lifecycle Methods

list_ownership_identifiers

Lists domain ownership identifiers. Description for Lists domain ownership identifiers.

EXEC azure.domain_registration.domains.list_ownership_identifiers 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_recommendations

Get domain name recommendations based on keywords. Description for Get domain name recommendations based on keywords.

EXEC azure.domain_registration.domains.list_recommendations 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keywords": "{{ keywords }}", 
"maxDomainRecommendations": {{ maxDomainRecommendations }}
}'
;

create_or_update_ownership_identifier

Creates an ownership identifier for a domain or updates identifier details for an existing identifier. Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.

EXEC azure.domain_registration.domains.create_or_update_ownership_identifier 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

update_ownership_identifier

Creates an ownership identifier for a domain or updates identifier details for an existing identifier. Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.

EXEC azure.domain_registration.domains.update_ownership_identifier 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

delete_ownership_identifier

Delete ownership identifier for domain. Description for Delete ownership identifier for domain.

EXEC azure.domain_registration.domains.delete_ownership_identifier 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_control_center_sso_request

Generate a single sign-on request for the domain management portal. Description for Generate a single sign-on request for the domain management portal.

EXEC azure.domain_registration.domains.get_control_center_sso_request 
@subscription_id='{{ subscription_id }}' --required
;

renew

Renew a domain. Description for Renew a domain.

EXEC azure.domain_registration.domains.renew 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

transfer_out

Transfer out domain to another registrar. Transfer out domain to another registrar.

EXEC azure.domain_registration.domains.transfer_out 
@resource_group_name='{{ resource_group_name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

check_availability

Check if a domain is available for registration. Description for Check if a domain is available for registration.

EXEC azure.domain_registration.domains.check_availability 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;