dns_resolver_domain_lists

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

Overview

Name	dns_resolver_domain_lists
Type	Resource
Id	azure.dns_resolver.dns_resolver_domain_lists

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.
domains	array	The domains in the domain list. Will be null if user is using large domain list.
domainsUrl	string	The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
resourceGuid	string	The resourceGuid property of the DNS resolver domain list resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
domains	array	The domains in the domain list. Will be null if user is using large domain list.
domainsUrl	string	The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
resourceGuid	string	The resourceGuid property of the DNS resolver domain list resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
domains	array	The domains in the domain list. Will be null if user is using large domain list.
domainsUrl	string	The URL for bulk upload or download for domain lists containing larger set of domains. This will be populated if domains is empty or null.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
resourceGuid	string	The resourceGuid property of the DNS resolver domain list resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, dns_resolver_domain_list_name, subscription_id		Gets properties of a DNS resolver domain list.
list_by_resource_group	select	resource_group_name, subscription_id	$top	Lists DNS resolver domain lists within a resource group.
list	select	subscription_id	$top	Lists DNS resolver domain lists in all resource groups of a subscription.
create_or_update	insert	resource_group_name, dns_resolver_domain_list_name, subscription_id, location		Creates or updates a DNS resolver domain list.
update	update	resource_group_name, dns_resolver_domain_list_name, subscription_id		Updates a DNS resolver domain list.
create_or_update	replace	resource_group_name, dns_resolver_domain_list_name, subscription_id, location		Creates or updates a DNS resolver domain list.
delete	delete	resource_group_name, dns_resolver_domain_list_name, subscription_id		Deletes a DNS resolver domain list. WARNING: This operation cannot be undone.
bulk	exec	resource_group_name, dns_resolver_domain_list_name, subscription_id, properties		Uploads or downloads the list of domains for a DNS Resolver Domain List from a storage link.

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
dns_resolver_domain_list_name	string	The name of the DNS resolver domain list. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of results to return. If not specified, returns up to 100 results. Default value is None.

SELECT examples

get

Gets properties of a DNS resolver domain list.

SELECT
id,
name,
domains,
domainsUrl,
etag,
location,
provisioningState,
resourceGuid,
systemData,
tags,
type
FROM azure.dns_resolver.dns_resolver_domain_lists
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_resolver_domain_list_name = '{{ dns_resolver_domain_list_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists DNS resolver domain lists within a resource group.

SELECT
id,
name,
domains,
domainsUrl,
etag,
location,
provisioningState,
resourceGuid,
systemData,
tags,
type
FROM azure.dns_resolver.dns_resolver_domain_lists
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list

Lists DNS resolver domain lists in all resource groups of a subscription.

SELECT
id,
name,
domains,
domainsUrl,
etag,
location,
provisioningState,
resourceGuid,
systemData,
tags,
type
FROM azure.dns_resolver.dns_resolver_domain_lists
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a DNS resolver domain list.

INSERT INTO azure.dns_resolver.dns_resolver_domain_lists (
tags,
location,
properties,
resource_group_name,
dns_resolver_domain_list_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dns_resolver_domain_list_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dns_resolver_domain_lists
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dns_resolver_domain_lists resource.
  - name: dns_resolver_domain_list_name
    value: "{{ dns_resolver_domain_list_name }}"
    description: Required parameter for the dns_resolver_domain_lists resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dns_resolver_domain_lists resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the DNS resolver domain list.
    value:
      domains:
        - "{{ domains }}"
      domainsUrl: "{{ domainsUrl }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"

UPDATE examples

update

Updates a DNS resolver domain list.

UPDATE azure.dns_resolver.dns_resolver_domain_lists
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_domain_list_name = '{{ dns_resolver_domain_list_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a DNS resolver domain list.

REPLACE azure.dns_resolver.dns_resolver_domain_lists
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_domain_list_name = '{{ dns_resolver_domain_list_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a DNS resolver domain list. WARNING: This operation cannot be undone.

DELETE FROM azure.dns_resolver.dns_resolver_domain_lists
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_domain_list_name = '{{ dns_resolver_domain_list_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

bulk

Uploads or downloads the list of domains for a DNS Resolver Domain List from a storage link.

EXEC azure.dns_resolver.dns_resolver_domain_lists.bulk 
@resource_group_name='{{ resource_group_name }}' --required, 
@dns_resolver_domain_list_name='{{ dns_resolver_domain_list_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;