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

vw_virtual_network_gateway_nat_rules

Name	Datatype	Description
id	text	Resource ID.
name	text	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	text	A unique read-only string that changes whenever the resource is updated.
external_mappings	text	field from the properties object
internal_mappings	text	field from the properties object
ip_configuration_id	text	field from the properties object
mode	text	field from the properties object
natRuleName	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
type	text	Resource type.
virtualNetworkGatewayName	text	field from the properties object

virtual_network_gateway_nat_rules

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	Parameters for VirtualNetworkGatewayNatRule.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	natRuleName, resourceGroupName, subscriptionId, virtualNetworkGatewayName	Retrieves the details of a nat rule.
list_by_virtual_network_gateway	SELECT	resourceGroupName, subscriptionId, virtualNetworkGatewayName	Retrieves all nat rules for a particular virtual network gateway.
create_or_update	INSERT	natRuleName, resourceGroupName, subscriptionId, virtualNetworkGatewayName	Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.
delete	DELETE	natRuleName, resourceGroupName, subscriptionId, virtualNetworkGatewayName	Deletes a nat rule.

SELECT examples

Retrieves all nat rules for a particular virtual network gateway.

vw_virtual_network_gateway_nat_rules

SELECT
id,
name,
etag,
external_mappings,
internal_mappings,
ip_configuration_id,
mode,
natRuleName,
provisioning_state,
resourceGroupName,
subscriptionId,
type,
virtualNetworkGatewayName
FROM azure.network.vw_virtual_network_gateway_nat_rules
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}';

virtual_network_gateway_nat_rules

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.virtual_network_gateway_nat_rules (
natRuleName,
resourceGroupName,
subscriptionId,
virtualNetworkGatewayName,
properties,
name,
id
)
SELECT 
'{{ natRuleName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ virtualNetworkGatewayName }}',
'{{ properties }}',
'{{ name }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: type
          value: string
        - name: mode
          value: string
        - name: internalMappings
          value:
            - - name: addressSpace
                value: string
              - name: portRange
                value: string
        - name: externalMappings
          value:
            - - name: addressSpace
                value: string
              - name: portRange
                value: string
        - name: ipConfigurationId
          value: string
    - name: name
      value: string
    - name: etag
      value: string
    - name: type
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified virtual_network_gateway_nat_rules resource.

/*+ delete */
DELETE FROM azure.network.virtual_network_gateway_nat_rules
WHERE natRuleName = '{{ natRuleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualNetworkGatewayName = '{{ virtualNetworkGatewayName }}';