top_level_domains

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

Overview

Name	top_level_domains
Type	Resource
Id	azure.domain_registration.top_level_domains

Fields

The following fields are returned by SELECT queries:

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.
kind	string	Kind of resource.
privacy	boolean	If true, then the top level domain supports domain privacy; otherwise, false.
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".

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.
kind	string	Kind of resource.
privacy	boolean	If true, then the top level domain supports domain privacy; otherwise, false.
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, subscription_id		Get details of a top-level domain. Description for Get details of a top-level domain.
list	select	subscription_id		Get all top-level domains supported for registration. Description for Get all top-level domains supported for registration.
list_agreements	exec	name, subscription_id		Gets all legal agreements that user needs to accept before purchasing a domain. Description for Gets all legal agreements that user needs to accept before purchasing a domain.

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
name	string	Name of the top-level domain. Required.
subscription_id	string

SELECT examples

get

Get details of a top-level domain. Description for Get details of a top-level domain.

SELECT
id,
name,
kind,
privacy,
systemData,
type
FROM azure.domain_registration.top_level_domains
WHERE name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all top-level domains supported for registration. Description for Get all top-level domains supported for registration.

SELECT
id,
name,
kind,
privacy,
systemData,
type
FROM azure.domain_registration.top_level_domains
WHERE subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_agreements

Gets all legal agreements that user needs to accept before purchasing a domain. Description for Gets all legal agreements that user needs to accept before purchasing a domain.

EXEC azure.domain_registration.top_level_domains.list_agreements 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"includePrivacy": {{ includePrivacy }}, 
"forTransfer": {{ forTransfer }}
}'
;