Microsoft.Network natGateways 2020-08-01

Bicep resource definition

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

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@2020-08-01' = {
  location: 'string'
  name: 'string'
  properties: {
    idleTimeoutInMinutes: int
    publicIpAddresses: [
      {
        id: 'string'
      }
    ]
    publicIpPrefixes: [
      {
        id: 'string'
      }
    ]
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

Microsoft.Network/natGateways

Name Description Value
location Resource location. string
name The resource name string (required)
properties Nat Gateway properties. NatGatewayPropertiesFormat
sku The nat gateway SKU. NatGatewaySku
tags Resource tags Dictionary of tag names and values. See Tags in templates
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[]

NatGatewaySku

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

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
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.
Azure Databricks All-in-one Template for VNet Injection This template allows you to create a network security group, a virtual network, a NAT gateway and an Azure Databricks workspace with the virtual network.
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.
AzureDatabricks Virtual Network - VNet Injection NAT Gateway This template allows you to create a Virtual Network for Azure Databricks VNet injection with natgateway.
Create a cross-region load balancer This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Create a standard internal load balancer This template creates a standard internal Azure Load Balancer with a rule load-balancing port 80
Create a standard load-balancer This template creates an Internet-facing load-balancer, load balancing rules, and three VMs for the backend pool with each VM in a redundant zone.
Deploy Secure Azure AI Studio with a managed virtual network This template creates a secure Azure AI Studio environment with robust network and identity security restrictions.
Virtual Network NAT Deploy a NAT gateway and virtual network
Virtual Network NAT with VM Deploy a NAT gateway and virtual machine

ARM template resource definition

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

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": "2020-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "idleTimeoutInMinutes": "int",
    "publicIpAddresses": [
      {
        "id": "string"
      }
    ],
    "publicIpPrefixes": [
      {
        "id": "string"
      }
    ]
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property values

Microsoft.Network/natGateways

Name Description Value
apiVersion The api version '2020-08-01'
location Resource location. string
name The resource name string (required)
properties Nat Gateway properties. NatGatewayPropertiesFormat
sku The nat gateway SKU. NatGatewaySku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/natGateways'
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[]

NatGatewaySku

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

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
AKS Cluster with a NAT Gateway and an Application Gateway

Deploy to Azure
This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
Azure Databricks All-in-one Template for VNet Injection

Deploy to Azure
This template allows you to create a network security group, a virtual network, a NAT gateway and an Azure Databricks workspace with the virtual network.
AzureDatabricks Template for VNet Injection with NAT Gateway

Deploy to Azure
This template allows you to create a NAT gateway, network security group, a virtual network and an Azure Databricks workspace with the virtual network.
AzureDatabricks Virtual Network - VNet Injection NAT Gateway

Deploy to Azure
This template allows you to create a Virtual Network for Azure Databricks VNet injection with natgateway.
Create a cross-region load balancer

Deploy to Azure
This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Create a standard internal load balancer

Deploy to Azure
This template creates a standard internal Azure Load Balancer with a rule load-balancing port 80
Create a standard load-balancer

Deploy to Azure
This template creates an Internet-facing load-balancer, load balancing rules, and three VMs for the backend pool with each VM in a redundant zone.
Deploy Darktrace Autoscaling vSensors

Deploy to Azure
This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
Deploy Secure Azure AI Studio with a managed virtual network

Deploy to Azure
This template creates a secure Azure AI Studio environment with robust network and identity security restrictions.
Virtual Network NAT

Deploy to Azure
Deploy a NAT gateway and virtual network
Virtual Network NAT with VM

Deploy to Azure
Deploy a NAT gateway and virtual machine

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@2020-08-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      idleTimeoutInMinutes = int
      publicIpAddresses = [
        {
          id = "string"
        }
      ]
      publicIpPrefixes = [
        {
          id = "string"
        }
      ]
    }
  })
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
}

Property values

Microsoft.Network/natGateways

Name Description Value
location Resource location. string
name The resource name string (required)
properties Nat Gateway properties. NatGatewayPropertiesFormat
sku The nat gateway SKU. NatGatewaySku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/natGateways@2020-08-01"
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[]

NatGatewaySku

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

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string