Microsoft.Network natGateways 2019-04-01
Article 10/24/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@2019-04-01' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
idleTimeoutInMinutes: int
provisioningState: 'string'
publicIpAddresses: [
{
id: 'string'
}
]
publicIpPrefixes: [
{
id: 'string'
}
]
resourceGuid: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property values
Microsoft.Network/natGateways
Name
Description
Value
etag
A unique read-only string that changes whenever the resource is updated.
string
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[]
Name
Description
Value
idleTimeoutInMinutes
The idle timeout of the nat gateway.
int
provisioningState
The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
string
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 []
resourceGuid
The resource GUID property of the nat gateway resource.
string
NatGatewaySku
Name
Description
Value
name
Name of Nat Gateway SKU.
'Standard'
SubResource
Name
Description
Value
id
Resource ID.
string
Quickstart samples
The following quickstart samples 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": "2019-04-01",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"idleTimeoutInMinutes": "int",
"provisioningState": "string",
"publicIpAddresses": [
{
"id": "string"
}
],
"publicIpPrefixes": [
{
"id": "string"
}
],
"resourceGuid": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property values
Microsoft.Network/natGateways
Name
Description
Value
apiVersion
The api version
'2019-04-01'
etag
A unique read-only string that changes whenever the resource is updated.
string
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[]
Name
Description
Value
idleTimeoutInMinutes
The idle timeout of the nat gateway.
int
provisioningState
The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
string
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 []
resourceGuid
The resource GUID property of the nat gateway resource.
string
NatGatewaySku
Name
Description
Value
name
Name of Nat Gateway SKU.
'Standard'
SubResource
Name
Description
Value
id
Resource ID.
string
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@2019-04-01"
name = "string"
etag = "string"
location = "string"
body = jsonencode({
properties = {
idleTimeoutInMinutes = int
provisioningState = "string"
publicIpAddresses = [
{
id = "string"
}
]
publicIpPrefixes = [
{
id = "string"
}
]
resourceGuid = "string"
}
})
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
zones = [
"string"
]
}
Property values
Microsoft.Network/natGateways
Name
Description
Value
etag
A unique read-only string that changes whenever the resource is updated.
string
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@2019-04-01"
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
provisioningState
The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
string
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 []
resourceGuid
The resource GUID property of the nat gateway resource.
string
NatGatewaySku
Name
Description
Value
name
Name of Nat Gateway SKU.
'Standard'
SubResource
Name
Description
Value
id
Resource ID.
string