dns_resolvers

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

Overview

Name	dns_resolvers
Type	Resource
Id	azure.dns_resolver.dns_resolvers

Fields

The following fields are returned by SELECT queries:

get

The DNS resolver was found.

Name	Datatype	Description
etag	string	ETag of the DNS resolver.
location	string	The geo-location where the resource lives
properties	object	Properties of the DNS resolver.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_virtual_network

List of DNS resolver resource IDs linked to the virtual network.

Name	Datatype	Description
id	string	Resource ID.

list_by_resource_group

List of DNS resolvers in the resource group.

Name	Datatype	Description
etag	string	ETag of the DNS resolver.
location	string	The geo-location where the resource lives
properties	object	Properties of the DNS resolver.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

List of DNS resolvers in the subscription.

Name	Datatype	Description
etag	string	ETag of the DNS resolver.
location	string	The geo-location where the resource lives
properties	object	Properties of the DNS resolver.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dnsResolverName		Gets properties of a DNS resolver.
list_by_virtual_network	select	subscriptionId, resourceGroupName, virtualNetworkName	$top	Lists DNS resolver resource IDs linked to a virtual network.
list_by_resource_group	select	subscriptionId, resourceGroupName	$top	Lists DNS resolvers within a resource group.
list	select	subscriptionId	$top	Lists DNS resolvers in all resource groups of a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, dnsResolverName, data__properties	If-Match, If-None-Match	Creates or updates a DNS resolver.
update	update	subscriptionId, resourceGroupName, dnsResolverName	If-Match	Updates a DNS resolver.
delete	delete	subscriptionId, resourceGroupName, dnsResolverName	If-Match	Deletes a DNS resolver. WARNING: This operation cannot be undone.

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
dnsResolverName	string	The name of the DNS resolver.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
virtualNetworkName	string	The name of the virtual network.
$top	integer (int32)	The maximum number of results to return. If not specified, returns up to 100 results.
If-Match	string	ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
If-None-Match	string	Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.

SELECT examples

get

Gets properties of a DNS resolver.

SELECT
etag,
location,
properties,
systemData,
tags
FROM azure.dns_resolver.dns_resolvers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dnsResolverName = '{{ dnsResolverName }}' -- required
;

list_by_virtual_network

Lists DNS resolver resource IDs linked to a virtual network.

SELECT
id
FROM azure.dns_resolver.dns_resolvers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkName = '{{ virtualNetworkName }}' -- required
AND $top = '{{ $top }}'
;

list_by_resource_group

Lists DNS resolvers within a resource group.

SELECT
etag,
location,
properties,
systemData,
tags
FROM azure.dns_resolver.dns_resolvers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $top = '{{ $top }}'
;

list

Lists DNS resolvers in all resource groups of a subscription.

SELECT
etag,
location,
properties,
systemData,
tags
FROM azure.dns_resolver.dns_resolvers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a DNS resolver.

INSERT INTO azure.dns_resolver.dns_resolvers (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
dnsResolverName,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dnsResolverName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: dns_resolvers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the dns_resolvers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dns_resolvers resource.
    - name: dnsResolverName
      value: string
      description: Required parameter for the dns_resolvers resource.
    - name: properties
      value: object
      description: |
        Properties of the DNS resolver.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: If-Match
      value: string
      description: ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.

UPDATE examples

update

Updates a DNS resolver.

UPDATE azure.dns_resolver.dns_resolvers
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dnsResolverName = '{{ dnsResolverName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
etag,
location,
properties,
systemData,
tags;

DELETE examples

delete

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

DELETE FROM azure.dns_resolver.dns_resolvers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dnsResolverName = '{{ dnsResolverName }}' --required
AND If-Match = '{{ If-Match }}'
;