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

The forwarding rule was found.

Name	Datatype	Description
etag	string	ETag of the forwarding rule.
properties	object	Properties of the forwarding rule.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list

List of forwarding rules in the DNS forwarding ruleset.

Name	Datatype	Description
etag	string	ETag of the forwarding rule.
properties	object	Properties of the forwarding rule.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dnsForwardingRulesetName, forwardingRuleName		Gets properties of a forwarding rule in a DNS forwarding ruleset.
list	select	subscriptionId, resourceGroupName, dnsForwardingRulesetName	$top	Lists forwarding rules in a DNS forwarding ruleset.
create_or_update	insert	subscriptionId, resourceGroupName, dnsForwardingRulesetName, forwardingRuleName, data__properties	If-Match, If-None-Match	Creates or updates a forwarding rule in a DNS forwarding ruleset.
update	update	subscriptionId, resourceGroupName, dnsForwardingRulesetName, forwardingRuleName	If-Match	Updates a forwarding rule in a DNS forwarding ruleset.
delete	delete	subscriptionId, resourceGroupName, dnsForwardingRulesetName, forwardingRuleName	If-Match	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
dnsForwardingRulesetName	string	The name of the DNS forwarding ruleset.
forwardingRuleName	string	The name of the forwarding rule.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$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 forwarding rule in a DNS forwarding ruleset.

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

list

Lists forwarding rules in a DNS forwarding ruleset.

SELECT
etag,
properties,
systemData
FROM azure.dns_resolver.forwarding_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dnsForwardingRulesetName = '{{ dnsForwardingRulesetName }}' -- 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 (
data__properties,
subscriptionId,
resourceGroupName,
dnsForwardingRulesetName,
forwardingRuleName,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dnsForwardingRulesetName }}',
'{{ forwardingRuleName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
properties,
systemData
;

Manifest

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

UPDATE azure.dns_resolver.forwarding_rules
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dnsForwardingRulesetName = '{{ dnsForwardingRulesetName }}' --required
AND forwardingRuleName = '{{ forwardingRuleName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
etag,
properties,
systemData;

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 subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dnsForwardingRulesetName = '{{ dnsForwardingRulesetName }}' --required
AND forwardingRuleName = '{{ forwardingRuleName }}' --required
AND If-Match = '{{ If-Match }}'
;