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

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.
dnsResolverOutboundEndpoints	array	The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. Required.
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 forwarding ruleset. 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 for the DNS forwarding ruleset.
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_virtual_network

Name	Datatype	Description
id	string	DNS Forwarding Ruleset Resource ID.
virtualNetworkLink	object	Reference to another ARM resource.

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.
dnsResolverOutboundEndpoints	array	The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. Required.
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 forwarding ruleset. 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 for the DNS forwarding ruleset.
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.
dnsResolverOutboundEndpoints	array	The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. Required.
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 forwarding ruleset. 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 for the DNS forwarding ruleset.
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_forwarding_ruleset_name, subscription_id		Gets a DNS forwarding ruleset properties.
list_by_virtual_network	select	resource_group_name, virtual_network_name, subscription_id	$top	Lists DNS forwarding ruleset resource IDs attached to a virtual network.
list_by_resource_group	select	resource_group_name, subscription_id	$top	Lists DNS forwarding rulesets within a resource group.
list	select	subscription_id	$top	Lists DNS forwarding rulesets in all resource groups of a subscription.
create_or_update	insert	resource_group_name, dns_forwarding_ruleset_name, subscription_id, location, properties		Creates or updates a DNS forwarding ruleset.
update	update	resource_group_name, dns_forwarding_ruleset_name, subscription_id		Updates a DNS forwarding ruleset.
create_or_update	replace	resource_group_name, dns_forwarding_ruleset_name, subscription_id, location, properties		Creates or updates a DNS forwarding ruleset.
delete	delete	resource_group_name, dns_forwarding_ruleset_name, subscription_id		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
dns_forwarding_ruleset_name	string	The name of the DNS forwarding ruleset. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_network_name	string	The name of the VirtualNetwork. Required.
$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 a DNS forwarding ruleset properties.

SELECT
id,
name,
dnsResolverOutboundEndpoints,
etag,
location,
provisioningState,
resourceGuid,
systemData,
tags,
type
FROM azure.dns_resolver.dns_forwarding_rulesets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_virtual_network

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

SELECT
id,
virtualNetworkLink
FROM azure.dns_resolver.dns_forwarding_rulesets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_name = '{{ virtual_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_resource_group

Lists DNS forwarding rulesets within a resource group.

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

list

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

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

INSERT examples

create_or_update

Creates or updates a DNS forwarding ruleset.

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

Manifest

# Description fields are for documentation purposes
- name: dns_forwarding_rulesets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dns_forwarding_rulesets resource.
  - name: dns_forwarding_ruleset_name
    value: "{{ dns_forwarding_ruleset_name }}"
    description: Required parameter for the dns_forwarding_rulesets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dns_forwarding_rulesets 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 forwarding ruleset. Required.
    value:
      dnsResolverOutboundEndpoints:
        - id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"

UPDATE examples

update

Updates a DNS forwarding ruleset.

UPDATE azure.dns_resolver.dns_forwarding_rulesets
SET 
dnsResolverOutboundEndpoints = '{{ dnsResolverOutboundEndpoints }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_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 forwarding ruleset.

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

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 resource_group_name = '{{ resource_group_name }}' --required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;