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

vw_forwarding_rules

Name	Datatype	Description
dnsForwardingRulesetName	text	field from the properties object
domain_name	text	field from the properties object
etag	text	ETag of the forwarding rule.
forwardingRuleName	text	field from the properties object
forwarding_rule_state	text	field from the properties object
metadata	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
target_dns_servers	text	field from the properties object

forwarding_rules

Name	Datatype	Description
etag	string	ETag of the forwarding rule.
properties	object	Represents the properties of a forwarding rule within a DNS forwarding ruleset.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	dnsForwardingRulesetName, forwardingRuleName, resourceGroupName, subscriptionId	Gets properties of a forwarding rule in a DNS forwarding ruleset.
list	SELECT	dnsForwardingRulesetName, resourceGroupName, subscriptionId	Lists forwarding rules in a DNS forwarding ruleset.
create_or_update	INSERT	dnsForwardingRulesetName, forwardingRuleName, resourceGroupName, subscriptionId, data__properties	Creates or updates a forwarding rule in a DNS forwarding ruleset.
delete	DELETE	dnsForwardingRulesetName, forwardingRuleName, resourceGroupName, subscriptionId	Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.
update	UPDATE	dnsForwardingRulesetName, forwardingRuleName, resourceGroupName, subscriptionId	Updates a forwarding rule in a DNS forwarding ruleset.

SELECT examples

Lists forwarding rules in a DNS forwarding ruleset.

vw_forwarding_rules

SELECT
dnsForwardingRulesetName,
domain_name,
etag,
forwardingRuleName,
forwarding_rule_state,
metadata,
provisioning_state,
resourceGroupName,
subscriptionId,
system_data,
target_dns_servers
FROM azure.dns_resolver.vw_forwarding_rules
WHERE dnsForwardingRulesetName = '{{ dnsForwardingRulesetName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

forwarding_rules

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

INSERT example

Use the following StackQL query and manifest file to create a new forwarding_rules resource.

All Properties

/*+ create */
INSERT INTO azure.dns_resolver.forwarding_rules (
dnsForwardingRulesetName,
forwardingRuleName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ dnsForwardingRulesetName }}',
'{{ forwardingRuleName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: etag
      value: string
    - name: properties
      value:
        - name: domainName
          value: string
        - name: targetDnsServers
          value:
            - - name: ipAddress
                value: string
              - name: port
                value: integer
        - name: metadata
          value: object
        - name: forwardingRuleState
          value: string
        - name: provisioningState
          value: []
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a forwarding_rules resource.

/*+ update */
UPDATE azure.dns_resolver.forwarding_rules
SET 
properties = '{{ properties }}'
WHERE 
dnsForwardingRulesetName = '{{ dnsForwardingRulesetName }}'
AND forwardingRuleName = '{{ forwardingRuleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified forwarding_rules resource.

/*+ delete */
DELETE FROM azure.dns_resolver.forwarding_rules
WHERE dnsForwardingRulesetName = '{{ dnsForwardingRulesetName }}'
AND forwardingRuleName = '{{ forwardingRuleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';