Merge pull request Azure#9299 from khannarheams/netApril

Add Zones property to nat gateway

Author: markcowl

src/Network/Network.Test/ScenarioTests/NatGatewayTests.ps1

@@ -52,16 +52,20 @@ function Test-NatGatewayCRUDMinimalParameters
         $resourceGroup = New-AzResourceGroup -Name $rgname -Location $rglocation;
 
         # Create NatGateway
-        $vNatGateway = New-AzNatGateway -ResourceGroupName $rgname -Name $rname -Location $location -Sku Standard;
+        $vNatGateway = New-AzNatGateway -ResourceGroupName $rgname -Name $rname -Location $location -Sku Standard -Zone "1";
         Assert-NotNull $vNatGateway;
         Assert-True { Check-CmdletReturnType "New-AzNatGateway" $vNatGateway };
         Assert-AreEqual $rname $vNatGateway.Name;
+        Assert-AreEqual $vNatGateway.Zones.Count 1;
+        Assert-AreEqual $vNatGateway.Zones[0] "1";
 
         # Get NatGateway
         $vNatGateway = Get-AzNatGateway -ResourceGroupName $rgname -Name $rname;
         Assert-NotNull $vNatGateway;
         Assert-True { Check-CmdletReturnType "Get-AzNatGateway" $vNatGateway };
         Assert-AreEqual $rname $vNatGateway.Name;
+        Assert-AreEqual $vNatGateway.Zones.Count 1;
+        Assert-AreEqual $vNatGateway.Zones[0] "1";
 
         # Get all NatGateways in resource group
         $listNatGateway = Get-AzNatGateway -ResourceGroupName $rgname;
@@ -276,4 +280,4 @@ function Test-NatGatewayCRUDAllParameters
         # Cleanup
         Clean-ResourceGroup $rgname;
     }
-}
+}

src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.NatGatewayTests/TestNatGatewayCRUDAllParameters.json

@@ -50,7 +50,7 @@
 * Fixed displaying of VirtualNetworkTaps in NetworkInterfaceIpConfiguration
 * Fixed Cortex Get cmdlets for list all part
 * Fixed VirtualHub reference creation for ExpressRouteGateways, VpnGateway
-* Add Availability Zones support for Azure Firewall
+* Added support for Availability Zones in AzureFirewall and NatGateway
 * Added cmdlet Get-AzNetworkServiceTag
 
 * Add support for multiple public IP addresses for Azure Firewall

src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.NatGatewayTests/TestNatGatewayCRUDMinimalParameters.json

@@ -27,6 +27,7 @@ public partial class PSNatGateway : PSTopLevelResource
         public string ProvisioningState { get; set; }
         [Ps1Xml(Label = "Sku Name", Target = ViewControl.Table, ScriptBlock = "$_.Sku.Name")]
         public PSNatGatewaySku Sku { get; set; }
+        public List<string> Zones { get; set; }
         public List<PSResourceId> PublicIpAddresses { get; set; }
         public List<PSResourceId> PublicIpPrefixes { get; set; }
 

src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.NatGatewayTests/TestNatGatewayWithSubnet.json

@@ -50,6 +50,16 @@ public partial class NewAzureRmNatGateway : NetworkBaseCmdlet
             HelpMessage = "The idle timeout of the nat gateway.")]
         public int IdleTimeoutInMinutes { get; set; } = 4;
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "A list of availability zones denoting the zone in which Nat Gateway should be deployed.")]
+        [PSArgumentCompleter(
+            "1",
+            "2",
+            "3"
+        )]
+        public string[] Zone { get; set; }
+
         [Parameter(
             Mandatory = false,
             HelpMessage = "Name of a NAT gateway SKU.")]
@@ -120,6 +130,8 @@ public override void Execute()
                 PublicIpPrefixes = vPublicIpPrefixes,
             };
 
+            vNatGateway.Zones = this.Zone?.ToList();
+
             var vNatGatewayModel = NetworkResourceManagerProfile.Mapper.Map<MNM.NatGateway>(vNatGateway);
             vNatGatewayModel.Tags = TagsConversionHelper.CreateTagDictionary(this.Tag, validate: true);
             var present = true;

src/Network/Network/ChangeLog.md

@@ -13,9 +13,10 @@ Create new Nat Gateway resource with properties Public Ip Address/Public Ip Pref
 ## SYNTAX
 
 ```
-New-AzNatGateway -ResourceGroupName <String> -Name <String> [-IdleTimeoutInMinutes <Int32>] [-Sku <String>]
- [-Location <String>] [-Tag <Hashtable>] [-PublicIpAddress <PSResourceId[]>] [-PublicIpPrefix <PSResourceId[]>]
- [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+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
@@ -42,6 +43,15 @@ PS C:> $publicipprefix = New-AzPublicIpPrefix -Name "prefix2" -ResourceGroupName
 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
+```powershell
+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
@@ -209,6 +219,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Zone
+A list of availability zones denoting the zone in which Nat Gateway should be deployed.
+
+```yaml
+Type: System.String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Confirm
 Prompts you for confirmation before running the cmdlet.