forwarding_rules

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

Overview

Name	forwarding_rules
Type	Resource
Id	azure.dns_resolver.forwarding_rules

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.
domainName	string	The domain name for the forwarding rule. 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.").
forwardingRuleState	string	The state of forwarding rule. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
metadata	object	Metadata attached to the forwarding rule.
provisioningState	string	The current provisioning state of the forwarding rule. 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)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetDnsServers	array	DNS servers to forward the DNS query to. Required.
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.
domainName	string	The domain name for the forwarding rule. 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.").
forwardingRuleState	string	The state of forwarding rule. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
metadata	object	Metadata attached to the forwarding rule.
provisioningState	string	The current provisioning state of the forwarding rule. 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)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetDnsServers	array	DNS servers to forward the DNS query to. Required.
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, forwarding_rule_name, subscription_id		Gets properties of a forwarding rule in a DNS forwarding ruleset.
list	select	resource_group_name, dns_forwarding_ruleset_name, subscription_id	$top	Lists forwarding rules in a DNS forwarding ruleset.
create_or_update	insert	resource_group_name, dns_forwarding_ruleset_name, forwarding_rule_name, subscription_id, properties		Creates or updates a forwarding rule in a DNS forwarding ruleset.
update	update	resource_group_name, dns_forwarding_ruleset_name, forwarding_rule_name, subscription_id		Updates a forwarding rule in a DNS forwarding ruleset.
create_or_update	replace	resource_group_name, dns_forwarding_ruleset_name, forwarding_rule_name, subscription_id, properties		Creates or updates a forwarding rule in a DNS forwarding ruleset.
delete	delete	resource_group_name, dns_forwarding_ruleset_name, forwarding_rule_name, subscription_id		Deletes a forwarding rule in a DNS forwarding ruleset. 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
dns_forwarding_ruleset_name	string	The name of the DNS forwarding ruleset. Required.
forwarding_rule_name	string	The name of the forwarding rule. 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 forwarding rule in a DNS forwarding ruleset.

SELECT
id,
name,
domainName,
etag,
forwardingRuleState,
metadata,
provisioningState,
systemData,
targetDnsServers,
type
FROM azure.dns_resolver.forwarding_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' -- required
AND forwarding_rule_name = '{{ forwarding_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists forwarding rules in a DNS forwarding ruleset.

SELECT
id,
name,
domainName,
etag,
forwardingRuleState,
metadata,
provisioningState,
systemData,
targetDnsServers,
type
FROM azure.dns_resolver.forwarding_rules
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 $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a forwarding rule in a DNS forwarding ruleset.

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

Manifest

# Description fields are for documentation purposes
- name: forwarding_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the forwarding_rules resource.
  - name: dns_forwarding_ruleset_name
    value: "{{ dns_forwarding_ruleset_name }}"
    description: Required parameter for the forwarding_rules resource.
  - name: forwarding_rule_name
    value: "{{ forwarding_rule_name }}"
    description: Required parameter for the forwarding_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the forwarding_rules resource.
  - name: properties
    description: |
      Properties of the forwarding rule. Required.
    value:
      domainName: "{{ domainName }}"
      targetDnsServers:
        - ipAddress: "{{ ipAddress }}"
          port: {{ port }}
      metadata: "{{ metadata }}"
      forwardingRuleState: "{{ forwardingRuleState }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates a forwarding rule in a DNS forwarding ruleset.

UPDATE azure.dns_resolver.forwarding_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' --required
AND forwarding_rule_name = '{{ forwarding_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a forwarding rule in a DNS forwarding ruleset.

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

DELETE examples

delete

Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.

DELETE FROM azure.dns_resolver.forwarding_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dns_forwarding_ruleset_name = '{{ dns_forwarding_ruleset_name }}' --required
AND forwarding_rule_name = '{{ forwarding_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;