nat_gateways

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

Overview

Name	nat_gateways
Type	Resource
Id	azure.network.nat_gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
idleTimeoutInMinutes	integer	The idle timeout of the nat gateway.
location	string	Resource location.
nat64	string	Whether Nat64 is enabled for the NAT gateway resource. Known values are: "None", "Enabled", and "Disabled". (None, Enabled, Disabled)
provisioningState	string	The provisioning state of the NAT gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIpAddresses	array	An array of public ip addresses V4 associated with the nat gateway resource.
publicIpAddressesV6	array	An array of public ip addresses V6 associated with the nat gateway resource.
publicIpPrefixes	array	An array of public ip prefixes V4 associated with the nat gateway resource.
publicIpPrefixesV6	array	An array of public ip prefixes V6 associated with the nat gateway resource.
resourceGuid	string	The resource GUID property of the NAT gateway resource.
serviceGateway	object	Reference to another subresource.
sku	object	The nat gateway SKU.
sourceVirtualNetwork	object	Reference to another subresource.
subnets	array	An array of references to the subnets using this nat gateway resource.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting the zone in which Nat Gateway should be deployed.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
idleTimeoutInMinutes	integer	The idle timeout of the nat gateway.
location	string	Resource location.
nat64	string	Whether Nat64 is enabled for the NAT gateway resource. Known values are: "None", "Enabled", and "Disabled". (None, Enabled, Disabled)
provisioningState	string	The provisioning state of the NAT gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIpAddresses	array	An array of public ip addresses V4 associated with the nat gateway resource.
publicIpAddressesV6	array	An array of public ip addresses V6 associated with the nat gateway resource.
publicIpPrefixes	array	An array of public ip prefixes V4 associated with the nat gateway resource.
publicIpPrefixesV6	array	An array of public ip prefixes V6 associated with the nat gateway resource.
resourceGuid	string	The resource GUID property of the NAT gateway resource.
serviceGateway	object	Reference to another subresource.
sku	object	The nat gateway SKU.
sourceVirtualNetwork	object	Reference to another subresource.
subnets	array	An array of references to the subnets using this nat gateway resource.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting the zone in which Nat Gateway should be deployed.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
idleTimeoutInMinutes	integer	The idle timeout of the nat gateway.
location	string	Resource location.
nat64	string	Whether Nat64 is enabled for the NAT gateway resource. Known values are: "None", "Enabled", and "Disabled". (None, Enabled, Disabled)
provisioningState	string	The provisioning state of the NAT gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIpAddresses	array	An array of public ip addresses V4 associated with the nat gateway resource.
publicIpAddressesV6	array	An array of public ip addresses V6 associated with the nat gateway resource.
publicIpPrefixes	array	An array of public ip prefixes V4 associated with the nat gateway resource.
publicIpPrefixesV6	array	An array of public ip prefixes V6 associated with the nat gateway resource.
resourceGuid	string	The resource GUID property of the NAT gateway resource.
serviceGateway	object	Reference to another subresource.
sku	object	The nat gateway SKU.
sourceVirtualNetwork	object	Reference to another subresource.
subnets	array	An array of references to the subnets using this nat gateway resource.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting the zone in which Nat Gateway should be deployed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, nat_gateway_name, subscription_id	$expand	Gets the specified nat gateway in a specified resource group.
list	select	resource_group_name, subscription_id		Gets all nat gateways in a resource group.
list_all	select	subscription_id		Gets all the Nat Gateways in a subscription.
create_or_update	insert	resource_group_name, nat_gateway_name, subscription_id		Creates or updates a nat gateway.
update_tags	update	resource_group_name, nat_gateway_name, subscription_id		Updates nat gateway tags.
create_or_update	replace	resource_group_name, nat_gateway_name, subscription_id		Creates or updates a nat gateway.
delete	delete	resource_group_name, nat_gateway_name, subscription_id		Deletes the specified nat gateway.

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_gateway_name	string	The name of the nat gateway. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

Gets the specified nat gateway in a specified resource group.

SELECT
id,
name,
etag,
idleTimeoutInMinutes,
location,
nat64,
provisioningState,
publicIpAddresses,
publicIpAddressesV6,
publicIpPrefixes,
publicIpPrefixesV6,
resourceGuid,
serviceGateway,
sku,
sourceVirtualNetwork,
subnets,
tags,
type,
zones
FROM azure.network.nat_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND nat_gateway_name = '{{ nat_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all nat gateways in a resource group.

SELECT
id,
name,
etag,
idleTimeoutInMinutes,
location,
nat64,
provisioningState,
publicIpAddresses,
publicIpAddressesV6,
publicIpPrefixes,
publicIpPrefixesV6,
resourceGuid,
serviceGateway,
sku,
sourceVirtualNetwork,
subnets,
tags,
type,
zones
FROM azure.network.nat_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the Nat Gateways in a subscription.

SELECT
id,
name,
etag,
idleTimeoutInMinutes,
location,
nat64,
provisioningState,
publicIpAddresses,
publicIpAddressesV6,
publicIpPrefixes,
publicIpPrefixesV6,
resourceGuid,
serviceGateway,
sku,
sourceVirtualNetwork,
subnets,
tags,
type,
zones
FROM azure.network.nat_gateways
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a nat gateway.

INSERT INTO azure.network.nat_gateways (
id,
location,
tags,
properties,
sku,
zones,
resource_group_name,
nat_gateway_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ sku }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ nat_gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: nat_gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the nat_gateways resource.
  - name: nat_gateway_name
    value: "{{ nat_gateway_name }}"
    description: Required parameter for the nat_gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the nat_gateways resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Nat Gateway properties.
    value:
      idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
      publicIpAddresses:
        - id: "{{ id }}"
      publicIpAddressesV6:
        - id: "{{ id }}"
      publicIpPrefixes:
        - id: "{{ id }}"
      publicIpPrefixesV6:
        - id: "{{ id }}"
      subnets:
        - id: "{{ id }}"
      sourceVirtualNetwork:
        id: "{{ id }}"
      serviceGateway:
        id: "{{ id }}"
      nat64: "{{ nat64 }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
  - name: sku
    description: |
      The nat gateway SKU.
    value:
      name: "{{ name }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      A list of availability zones denoting the zone in which Nat Gateway should be deployed.

UPDATE examples

update_tags

Updates nat gateway tags.

UPDATE azure.network.nat_gateways
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND nat_gateway_name = '{{ nat_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates a nat gateway.

REPLACE azure.network.nat_gateways
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND nat_gateway_name = '{{ nat_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified nat gateway.

DELETE FROM azure.network.nat_gateways
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND nat_gateway_name = '{{ nat_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;