New-AzNatGateway

Create new Nat Gateway resource with properties Public Ip Address/Public Ip Prefix, IdleTimeoutInMinutes and Sku.

Syntax

New-AzNatGateway
   -ResourceGroupName <String>
   -Name <String>
   [-IdleTimeoutInMinutes <Int32>]
   [-Zone <String[]>]
   [-Sku <String>]
   [-Location <String>]
   [-Tag <Hashtable>]
   [-PublicIpAddress <PSResourceId[]>]
   [-PublicIpPrefix <PSResourceId[]>]
   [-Force]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzNatGateway cmdlet creates a Nat Gateway Resource. A natgateway requires the following:

  • Public Ip Address and/or Public Ip Prefix
  • IdleTimeoutInMinutes
  • Sku
  • ResourceGroupName
  • ResourceName
  • Location

Examples

Example 1 : Create Nat Gateway with Public Ip Address

PS C:> $pip = New-AzPublicIpAddress -Name "pip" -ResourceGroupName "natgateway_test" -Location "eastus2" -Sku "Standard" -IdleTimeoutInMinutes 4 -AllocationMethod "static"
PS C:> $natgateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpAddress $pip

Example 2 : Create Nat Gateway with Public Ip Prefix

PS C:> $publicipprefix = New-AzPublicIpPrefix -Name "prefix2" -ResourceGroupName "natgateway_test" -Location "eastus2" -Sku "Standard" -PrefixLength "31"
PS C:> $natgateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpPrefix $publicipprefix

Example 3 : Create Nat Gateway with Public IP Address in Availability Zone 1

PS C:> $pip = New-AzPublicIpAddress -Name "pip" -ResourceGroupName "natgateway_test" -Location "eastus2" -Sku "Standard" -IdleTimeoutInMinutes 4 -AllocationMethod "static"
PS C:> $natgateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpAddress $pip -Zone "1"

The first command creates standard Public IP Address. The second command creates NAT Gateway with Public IP Address in Availability Zone 1.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Do not ask for confirmation if you want to overwrite a resource

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IdleTimeoutInMinutes

The idle timeout of the nat gateway.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Location

The location.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

The name of the nat gateway.

Type:String
Aliases:ResourceName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PublicIpAddress

An array of public ip addresses associated with the nat gateway resource.

Type:Microsoft.Azure.Commands.Network.Models.PSResourceId[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PublicIpPrefix

An array of public ip prefixes associated with the nat gateway resource.

Type:Microsoft.Azure.Commands.Network.Models.PSResourceId[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

The resource group name of the nat gateway.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Sku

Name of a NAT gateway SKU.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Tag

A hashtable which represents resource tags.

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Zone

A list of availability zones denoting the zone in which Nat Gateway should be deployed.

Type:System.String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Int32

Hashtable

Microsoft.Azure.Commands.Network.Models.PSResourceId[]

Outputs

Microsoft.Azure.Commands.Network.Models.PSNatGateway