Microsoft.Network natGateways template reference

Template format

To create a Microsoft.Network/natGateways resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/natGateways",
  "apiVersion": "2019-02-01",
  "location": "string",
  "tags": {},
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "idleTimeoutInMinutes": "integer",
    "publicIpAddresses": [
      {
        "id": "string"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "string"
      }
    ],
    "resourceGuid": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/natGateways object

Name Type Required Value
name string Yes The name of the nat gateway.
type enum Yes Microsoft.Network/natGateways
apiVersion enum Yes 2019-02-01
location string Yes Resource location.
tags object No Resource tags.
sku object No The nat gateway SKU. - NatGatewaySku object
properties object Yes Nat Gateway properties. - NatGatewayPropertiesFormat object

NatGatewaySku object

Name Type Required Value
name enum No Name of Nat Gateway SKU. - Standard

NatGatewayPropertiesFormat object

Name Type Required Value
idleTimeoutInMinutes integer No The idle timeout of the nat gateway.
publicIpAddresses array No An array of public ip addresses associated with the nat gateway resource. - SubResource object
publicIpPrefixes array No An array of public ip prefixes associated with the nat gateway resource. - SubResource object
resourceGuid string No The resource GUID property of the nat gateway resource.

SubResource object

Name Type Required Value
id string No Resource ID.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Virtual Network NAT

Deploy to Azure
Deploy a NAT gateway and virtual machine
Virtual Network NAT

Deploy to Azure
Deploy a NAT gateway and virtual network