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

Request successful. The operation returns the resulting NatGateway resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Nat Gateway properties.
sku	object	The nat gateway SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
zones	array	A list of availability zones denoting the zone in which Nat Gateway should be deployed.

list

Request successful. The operation returns a list of NatGateway resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Nat Gateway properties.
sku	object	The nat gateway SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
zones	array	A list of availability zones denoting the zone in which Nat Gateway should be deployed.

list_all

Request successful. The operation returns a list of NatGateway resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Nat Gateway properties.
sku	object	The nat gateway SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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	resourceGroupName, natGatewayName, subscriptionId	$expand	Gets the specified nat gateway in a specified resource group.
list	select	resourceGroupName, subscriptionId		Gets all nat gateways in a resource group.
list_all	select	subscriptionId		Gets all the Nat Gateways in a subscription.
create_or_update	insert	resourceGroupName, natGatewayName, subscriptionId		Creates or updates a nat gateway.
delete	delete	resourceGroupName, natGatewayName, subscriptionId		Deletes the specified nat gateway.
update_tags	exec	resourceGroupName, natGatewayName, subscriptionId		Updates nat gateway tags.

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
natGatewayName	string	The name of the nat gateway.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified nat gateway in a specified resource group.

SELECT
id,
name,
etag,
properties,
sku,
systemData,
type,
zones
FROM azure.network.nat_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND natGatewayName = '{{ natGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all nat gateways in a resource group.

SELECT
id,
name,
etag,
properties,
sku,
systemData,
type,
zones
FROM azure.network.nat_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_all

Gets all the Nat Gateways in a subscription.

SELECT
id,
name,
etag,
properties,
sku,
systemData,
type,
zones
FROM azure.network.nat_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a nat gateway.

INSERT INTO azure.network.nat_gateways (
data__sku,
data__properties,
data__zones,
resourceGroupName,
natGatewayName,
subscriptionId
)
SELECT 
'{{ sku }}',
'{{ properties }}',
'{{ zones }}',
'{{ resourceGroupName }}',
'{{ natGatewayName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
sku,
systemData,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: nat_gateways
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the nat_gateways resource.
    - name: natGatewayName
      value: string
      description: Required parameter for the nat_gateways resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the nat_gateways resource.
    - name: sku
      value: object
      description: |
        The nat gateway SKU.
    - name: properties
      value: object
      description: |
        Nat Gateway properties.
    - name: zones
      value: array
      description: |
        A list of availability zones denoting the zone in which Nat Gateway should be deployed.

DELETE examples

delete

Deletes the specified nat gateway.

DELETE FROM azure.network.nat_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND natGatewayName = '{{ natGatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates nat gateway tags.

EXEC azure.network.nat_gateways.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@natGatewayName='{{ natGatewayName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;