Microsoft.Network natGateways
Article 05/07/2024
1 contributor
Feedback
In this article
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 .
To create a Microsoft.Network/natGateways resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/natGateways@2023-11-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[]
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.
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 .
To create a Microsoft.Network/natGateways resource, add the following JSON to your template.
{
"type": "Microsoft.Network/natGateways",
"apiVersion": "2023-11-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
'2023-11-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[]
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.
The natGateways resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Network/natGateways resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/natGateways@2023-11-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@2023-11-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[]
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"