dns_forwarding_rulesets

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

Overview

Name	dns_forwarding_rulesets
Type	Resource
Id	azure.dns_resolver.dns_forwarding_rulesets

Fields

The following fields are returned by SELECT queries:

get

The DNS forwarding ruleset was found.

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

list_by_virtual_network

List of DNS forwarding ruleset resource IDs and virtual network link resource IDs attached to the virtual network.

Name	Datatype	Description
id	string	DNS Forwarding Ruleset Resource ID.
properties	object	Properties of the virtual network link sub-resource reference.

list_by_resource_group

List of DNS forwarding rulesets in the resource group.

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

list

List of DNS forwarding rulesets in the subscription.

Name	Datatype	Description
etag	string	ETag of the DNS forwarding ruleset.
location	string	The geo-location where the resource lives
properties	object	Properties of the DNS forwarding ruleset.
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, dnsForwardingRulesetName		Gets a DNS forwarding ruleset properties.
list_by_virtual_network	select	subscriptionId, resourceGroupName, virtualNetworkName	$top	Lists DNS forwarding ruleset resource IDs attached to a virtual network.
list_by_resource_group	select	subscriptionId, resourceGroupName	$top	Lists DNS forwarding rulesets within a resource group.
list	select	subscriptionId	$top	Lists DNS forwarding rulesets in all resource groups of a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, dnsForwardingRulesetName, data__properties	If-Match, If-None-Match	Creates or updates a DNS forwarding ruleset.
update	update	subscriptionId, resourceGroupName, dnsForwardingRulesetName	If-Match	Updates a DNS forwarding ruleset.
delete	delete	subscriptionId, resourceGroupName, dnsForwardingRulesetName	If-Match	Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.

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
dnsForwardingRulesetName	string	The name of the DNS forwarding ruleset.
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 a DNS forwarding ruleset properties.

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

list_by_virtual_network

Lists DNS forwarding ruleset resource IDs attached to a virtual network.

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

list_by_resource_group

Lists DNS forwarding rulesets within a resource group.

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

list

Lists DNS forwarding rulesets in all resource groups of a subscription.

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

INSERT examples

create_or_update

Creates or updates a DNS forwarding ruleset.

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

Manifest

# Description fields are for documentation purposes
- name: dns_forwarding_rulesets
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the dns_forwarding_rulesets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dns_forwarding_rulesets resource.
    - name: dnsForwardingRulesetName
      value: string
      description: Required parameter for the dns_forwarding_rulesets resource.
    - name: properties
      value: object
      description: |
        Properties of the DNS forwarding ruleset.
    - 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 forwarding ruleset.

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

DELETE examples

delete

Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.

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