Microsoft.Network natGateways 2022-05-01

• Latest
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01

Bicep resource definition

The natGateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/natGateways resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/natGateways@2022-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'Standard'
  }
  properties: {
    idleTimeoutInMinutes: int
    publicIpAddresses: [
      {
        id: 'string'
      }
    ]
    publicIpPrefixes: [
      {
        id: 'string'
      }
    ]
  }
  zones: [
    'string'
  ]
}

Property values

natGateways

Name	Description	Value
name	The resource name	string (required)
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
sku	The nat gateway SKU.	NatGatewaySku
properties	Nat Gateway properties.	NatGatewayPropertiesFormat
zones	A list of availability zones denoting the zone in which Nat Gateway should be deployed.	string[]

NatGatewayPropertiesFormat

Name	Description	Value
idleTimeoutInMinutes	The idle timeout of the nat gateway.	int
publicIpAddresses	An array of public ip addresses associated with the nat gateway resource.	SubResource[]
publicIpPrefixes	An array of public ip prefixes associated with the nat gateway resource.	SubResource[]

SubResource

Name	Description	Value
id	Resource ID.	string

NatGatewaySku

Name	Description	Value
name	Name of Nat Gateway SKU.	'Standard'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Darktrace Autoscaling vSensors	This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
AKS Cluster with a NAT Gateway and an Application Gateway	This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
AzureDatabricks Template for VNet Injection with NAT Gateway	This template allows you to create a NAT gateway, network security group, a virtual network and an Azure Databricks workspace with the virtual network.
Virtual Network NAT with VM	Deploy a NAT gateway and virtual machine
Virtual Network NAT	Deploy a NAT gateway and virtual network

ARM template resource definition

The natGateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Network/natGateways",
  "apiVersion": "2022-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "idleTimeoutInMinutes": "int",
    "publicIpAddresses": [
      {
        "id": "string"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "string"
      }
    ]
  },
  "zones": [ "string" ]
}

Property values

natGateways

Name	Description	Value
type	The resource type	'Microsoft.Network/natGateways'
apiVersion	The resource api version	'2022-05-01'
name	The resource name	string (required)
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
sku	The nat gateway SKU.	NatGatewaySku
properties	Nat Gateway properties.	NatGatewayPropertiesFormat
zones	A list of availability zones denoting the zone in which Nat Gateway should be deployed.	string[]

NatGatewayPropertiesFormat

Name	Description	Value
idleTimeoutInMinutes	The idle timeout of the nat gateway.	int
publicIpAddresses	An array of public ip addresses associated with the nat gateway resource.	SubResource[]
publicIpPrefixes	An array of public ip prefixes associated with the nat gateway resource.	SubResource[]

SubResource

Name	Description	Value
id	Resource ID.	string

NatGatewaySku

Name	Description	Value
name	Name of Nat Gateway SKU.	'Standard'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Darktrace Autoscaling vSensors	This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
AKS Cluster with a NAT Gateway and an Application Gateway	This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
AzureDatabricks Template for VNet Injection with NAT Gateway	This template allows you to create a NAT gateway, network security group, a virtual network and an Azure Databricks workspace with the virtual network.
Virtual Network NAT with VM	Deploy a NAT gateway and virtual machine
Virtual Network NAT	Deploy a NAT gateway and virtual network

Terraform (AzAPI provider) resource definition

The natGateways resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/natGateways resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/natGateways@2022-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      idleTimeoutInMinutes = int
      publicIpAddresses = [
        {
          id = "string"
        }
      ]
      publicIpPrefixes = [
        {
          id = "string"
        }
      ]
    }
    zones = [
      "string"
    ]
    sku = {
      name = "Standard"
    }
  })
}

Property values

natGateways

Name	Description	Value
type	The resource type	"Microsoft.Network/natGateways@2022-05-01"
name	The resource name	string (required)
location	Resource location.	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
sku	The nat gateway SKU.	NatGatewaySku
properties	Nat Gateway properties.	NatGatewayPropertiesFormat
zones	A list of availability zones denoting the zone in which Nat Gateway should be deployed.	string[]

NatGatewayPropertiesFormat

Name	Description	Value
idleTimeoutInMinutes	The idle timeout of the nat gateway.	int
publicIpAddresses	An array of public ip addresses associated with the nat gateway resource.	SubResource[]
publicIpPrefixes	An array of public ip prefixes associated with the nat gateway resource.	SubResource[]

SubResource

Name	Description	Value
id	Resource ID.	string

NatGatewaySku

Name	Description	Value
name	Name of Nat Gateway SKU.	"Standard"