virtual_network_gateway_nat_rules

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

Overview

Name	virtual_network_gateway_nat_rules
Type	Resource
Id	azure.network.virtual_network_gateway_nat_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
externalMappings	array	The private IP address external mapping for NAT.
internalMappings	array	The private IP address internal mapping for NAT.
ipConfigurationId	string	The IP Configuration ID this NAT rule applies to.
mode	string	The Source NAT direction of a VPN NAT. Known values are: "EgressSnat" and "IngressSnat". (EgressSnat, IngressSnat)
provisioningState	string	The provisioning state of the NAT Rule resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list_by_virtual_network_gateway

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
externalMappings	array	The private IP address external mapping for NAT.
internalMappings	array	The private IP address internal mapping for NAT.
ipConfigurationId	string	The IP Configuration ID this NAT rule applies to.
mode	string	The Source NAT direction of a VPN NAT. Known values are: "EgressSnat" and "IngressSnat". (EgressSnat, IngressSnat)
provisioningState	string	The provisioning state of the NAT Rule resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_network_gateway_name, nat_rule_name, subscription_id		Retrieves the details of a nat rule.
list_by_virtual_network_gateway	select	resource_group_name, virtual_network_gateway_name, subscription_id		Retrieves all nat rules for a particular virtual network gateway.
create_or_update	insert	resource_group_name, virtual_network_gateway_name, nat_rule_name, subscription_id		Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
create_or_update	replace	resource_group_name, virtual_network_gateway_name, nat_rule_name, subscription_id		Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
delete	delete	resource_group_name, virtual_network_gateway_name, nat_rule_name, subscription_id		Deletes a nat rule.

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
nat_rule_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_network_gateway_name	string	The name of the virtual network gateway. Required.

SELECT examples

get

Retrieves the details of a nat rule.

SELECT
id,
name,
etag,
externalMappings,
internalMappings,
ipConfigurationId,
mode,
provisioningState,
type
FROM azure.network.virtual_network_gateway_nat_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_gateway_name = '{{ virtual_network_gateway_name }}' -- required
AND nat_rule_name = '{{ nat_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_virtual_network_gateway

Retrieves all nat rules for a particular virtual network gateway.

SELECT
id,
name,
etag,
externalMappings,
internalMappings,
ipConfigurationId,
mode,
provisioningState,
type
FROM azure.network.virtual_network_gateway_nat_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_gateway_name = '{{ virtual_network_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.

INSERT INTO azure.network.virtual_network_gateway_nat_rules (
id,
name,
properties,
resource_group_name,
virtual_network_gateway_name,
nat_rule_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_network_gateway_name }}',
'{{ nat_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_gateway_nat_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_network_gateway_nat_rules resource.
  - name: virtual_network_gateway_name
    value: "{{ virtual_network_gateway_name }}"
    description: Required parameter for the virtual_network_gateway_nat_rules resource.
  - name: nat_rule_name
    value: "{{ nat_rule_name }}"
    description: Required parameter for the virtual_network_gateway_nat_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_network_gateway_nat_rules resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the Virtual Network Gateway NAT rule.
    value:
      provisioningState: "{{ provisioningState }}"
      type: "{{ type }}"
      mode: "{{ mode }}"
      internalMappings:
        - addressSpace: "{{ addressSpace }}"
          portRange: "{{ portRange }}"
      externalMappings:
        - addressSpace: "{{ addressSpace }}"
          portRange: "{{ portRange }}"
      ipConfigurationId: "{{ ipConfigurationId }}"

REPLACE examples

create_or_update

Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.

REPLACE azure.network.virtual_network_gateway_nat_rules
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_gateway_name = '{{ virtual_network_gateway_name }}' --required
AND nat_rule_name = '{{ nat_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes a nat rule.

DELETE FROM azure.network.virtual_network_gateway_nat_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_gateway_name = '{{ virtual_network_gateway_name }}' --required
AND nat_rule_name = '{{ nat_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;