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

Request successful. Returns the details of the nat rule.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Virtual Network Gateway NAT rule.
type	string	Resource type.

list_by_virtual_network_gateway

Request successful. Returns all Nat rules for a virtual network gateway.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Virtual Network Gateway NAT rule.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualNetworkGatewayName, natRuleName		Retrieves the details of a nat rule.
list_by_virtual_network_gateway	select	subscriptionId, resourceGroupName, virtualNetworkGatewayName		Retrieves all nat rules for a particular virtual network gateway.
create_or_update	insert	subscriptionId, resourceGroupName, virtualNetworkGatewayName, natRuleName		Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
delete	delete	subscriptionId, resourceGroupName, virtualNetworkGatewayName, natRuleName		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
natRuleName	string	The name of the nat rule.
resourceGroupName	string	The resource group name of the Virtual Network Gateway.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualNetworkGatewayName	string	The name of the gateway.

SELECT examples

get

Retrieves the details of a nat rule.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.virtual_network_gateway_nat_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' -- required
AND natRuleName = '{{ natRuleName }}' -- required
;

list_by_virtual_network_gateway

Retrieves all nat rules for a particular virtual network gateway.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.virtual_network_gateway_nat_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' -- 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 (
data__properties,
data__name,
data__id,
subscriptionId,
resourceGroupName,
virtualNetworkGatewayName,
natRuleName
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualNetworkGatewayName }}',
'{{ natRuleName }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_gateway_nat_rules
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_network_gateway_nat_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_network_gateway_nat_rules resource.
    - name: virtualNetworkGatewayName
      value: string
      description: Required parameter for the virtual_network_gateway_nat_rules resource.
    - name: natRuleName
      value: string
      description: Required parameter for the virtual_network_gateway_nat_rules resource.
    - name: properties
      value: object
      description: |
        Properties of the Virtual Network Gateway NAT rule.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a nat rule.

DELETE FROM azure.network.virtual_network_gateway_nat_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}' --required
AND natRuleName = '{{ natRuleName }}' --required
;