Add edge zone parameter to private endpoint cmdlet (Azure#15287)

* Add edge zone parameter to private endpoint cmdlet

* Scenario test shell

* Update change log

* Boilerplate code

* Refactor test

* Another test refactor

* It is working with edge zone

* Add test session record

* Fix whitespace

Co-authored-by: Will Ehrich <[email protected]>

Author: wdehrich

src/Network/Network.Test/ScenarioTests/PrivateEndpointTests.cs

@@ -33,6 +33,14 @@ public void TestPrivateEndpointCRUD()
             TestRunner.RunTestScript("Test-PrivateEndpointCRUD");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        [Trait(Category.Owner, NrpTeamAlias.sdnnrp)]
+        public void TestPrivateEndpointInEdgeZone()
+        {
+            TestRunner.RunTestScript("Test-PrivateEndpointInEdgeZone");
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         [Trait(Category.Owner, NrpTeamAlias.azdevxps)]

src/Network/Network.Test/ScenarioTests/PrivateEndpointTests.ps1

@@ -265,4 +265,83 @@ function Test-PrivateDnsZoneGroupCRUD
         # Cleanup
         Clean-ResourceGroup $rgname;
     }
+}
+
+<#
+.SYNOPSIS
+Test creating a private endpoint in an edge zone. Subscriptions need to be explicitly whitelisted for access to edge zones.
+#>
+function Test-PrivateEndpointInEdgeZone
+{
+    # Setup
+    $rgname = Get-ResourceGroupName
+    $rname = Get-ResourceName
+    $location = "westus"
+    # Dependency parameters
+    $vnetName = Get-ResourceName
+    $ilbFrontName = "LB-Frontend"
+    $ilbBackendName = "LB-Backend"
+    $ilbName = Get-ResourceName
+    $PrivateLinkServiceConnectionName = "PrivateLinkServiceConnectionName"
+    $IpConfigurationName = "IpConfigurationName"
+    $PrivateLinkServiceName = "PrivateLinkServiceName"
+    $vnetPEName = "VNetPE"
+    $edgeZone = "microsoftlosangeles1"
+
+    try
+    {
+        New-AzResourceGroup -Name $rgname -Location $location
+
+        # Create Virtual networks
+        $frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name "frontendSubnet" -AddressPrefix "10.0.1.0/24"
+        $backendSubnet = New-AzVirtualNetworkSubnetConfig -Name "backendSubnet" -AddressPrefix "10.0.2.0/24"
+        $otherSubnet = New-AzVirtualNetworkSubnetConfig -Name "otherSubnet" -AddressPrefix "10.0.3.0/24" -PrivateLinkServiceNetworkPoliciesFlag "Disabled"
+        $vnet = New-AzVirtualNetwork -Name $vnetName -ResourceGroupName $rgname -Location $location -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet,$otherSubnet -EdgeZone $edgeZone
+
+        # Create LoadBalancer
+        $frontendIP = New-AzLoadBalancerFrontendIpConfig -Name $ilbFrontName -PrivateIpAddress "10.0.1.5" -SubnetId $vnet.subnets[0].Id
+        $beaddresspool= New-AzLoadBalancerBackendAddressPoolConfig -Name $ilbBackendName
+        $ilbcreate = New-AzLoadBalancer -ResourceGroupName $rgname -Name $ilbName -Location $location -FrontendIpConfiguration $frontendIP -BackendAddressPool $beaddresspool -Sku "Standard" -EdgeZone $edgeZone
+
+        # Verfify if load balancer is created successfully
+        Assert-NotNull $ilbcreate
+        Assert-AreEqual $ilbName $ilbcreate.Name
+        Assert-AreEqual $location $ilbcreate.Location
+        Assert-AreEqual "Succeeded" $ilbcreate.ProvisioningState
+
+        # Create PrivateLinkService
+        $IpConfiguration = New-AzPrivateLinkServiceIpConfig -Name $IpConfigurationName -PrivateIpAddress 10.0.3.5 -Subnet $vnet.subnets[2]
+        $LoadBalancerFrontendIpConfiguration = Get-AzLoadBalancer -Name $ilbName | Get-AzLoadBalancerFrontendIpConfig
+
+        $vPrivateLinkService = New-AzPrivateLinkService -ResourceGroupName $rgname -Name $PrivateLinkServiceName -Location $location -IpConfiguration $IpConfiguration -LoadBalancerFrontendIpConfiguration $LoadBalancerFrontendIpConfiguration -EdgeZone $edgeZone
+
+        # Verfify if private link service is created successfully
+        Assert-NotNull $vPrivateLinkService
+        Assert-AreEqual $PrivateLinkServiceName $vPrivateLinkService.Name
+        Assert-NotNull $vPrivateLinkService.IpConfigurations;
+        Assert-True { $vPrivateLinkService.IpConfigurations.Length -gt 0 }
+        Assert-AreEqual "Succeeded" $vPrivateLinkService.ProvisioningState
+
+        # Create virtual network for private endpoint
+        $peSubnet = New-AzVirtualNetworkSubnetConfig -Name "peSubnet" -AddressPrefix "11.0.1.0/24" -PrivateEndpointNetworkPoliciesFlag "Disabled"
+        $vnetPE = New-AzVirtualNetwork -Name $vnetPEName -ResourceGroupName $rgName -Location $location -AddressPrefix "11.0.0.0/16" -Subnet $peSubnet -EdgeZone $edgeZone
+
+        # Create PrivateEndpoint
+        $PrivateLinkServiceConnection = New-AzPrivateLinkServiceConnection -Name $PrivateLinkServiceConnectionName -PrivateLinkServiceId  $vPrivateLinkService.Id
+        New-AzPrivateEndpoint -ResourceGroupName $rgname -Name $rname -Location $location -Subnet $vnetPE.subnets[0] -PrivateLinkServiceConnection $PrivateLinkServiceConnection -EdgeZone $edgeZone
+
+        $vPrivateEndpoint = Get-AzPrivateEndpoint -Name $rname -ResourceGroupName $rgname
+
+        Assert-AreEqual $vPrivateEndpoint.ExtendedLocation.Name $edgeZone
+        Assert-AreEqual $vPrivateEndpoint.ExtendedLocation.Type "EdgeZone"
+    }
+    catch [Microsoft.Azure.Commands.Network.Common.NetworkCloudException]
+    {
+        Assert-NotNull { $_.Exception.Message -match 'Resource type .* does not support edge zone .* in location .* The supported edge zones are .*' }
+    }
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname
+    }
 }

src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.PrivateEndpointTests/TestPrivateEndpointInEdgeZone.json

@@ -23,6 +23,7 @@
     - `New-AzPublicIpPrefix`
     - `New-AzLoadBalancer`
     - `New-AzPrivateLinkService`
+    - `New-AzPrivateEndpoint`
 * Added support for viewing extended location of virtual network in the console
     - `New-AzVirtualNetwork`
     - `Get-AzVirtualNetwork`

src/Network/Network/ChangeLog.md

@@ -1,28 +1,16 @@
-// <auto-generated>
-// Copyright (c) Microsoft and contributors.  All rights reserved.
-// 
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-//   http://www.apache.org/licenses/LICENSE-2.0
-// 
+// http://www.apache.org/licenses/LICENSE-2.0
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// 
 // See the License for the specific language governing permissions and
 // limitations under the License.
-// 
-// 
-// Warning: This code was generated by a tool.
-// 
-// Changes to this file may cause incorrect behavior and will be lost if the
-// code is regenerated.
-// 
-// For documentation on code generator please visit
-//   https://aka.ms/nrp-code-generation
-// Please contact [email protected] if you need to make changes to this file.
-// </auto-generated>
+// ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Management.Network.Models;
 using Microsoft.WindowsAzure.Commands.Common.Attributes;
@@ -41,6 +29,7 @@ public partial class PSPrivateEndpoint : PSTopLevelResource
         public List<PSPrivateLinkServiceConnection> PrivateLinkServiceConnections { get; set; }
         public List<PSPrivateLinkServiceConnection> ManualPrivateLinkServiceConnections { get; set; }
         public List<PSPrivateEndpointCustomDnsConfig> CustomDnsConfigs { get; set; }
+        public PSExtendedLocation ExtendedLocation { get; set; }
 
         [JsonIgnore]
         public string SubnetText
@@ -72,6 +61,11 @@ public string CustomDnsConfigsText
             get { return JsonConvert.SerializeObject(CustomDnsConfigs, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
         }
 
+        [JsonIgnore]
+        public string ExtendedLocationText
+        {
+            get { return JsonConvert.SerializeObject(ExtendedLocation, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
+        }
 
         public bool ShouldSerializeNetworkInterfaces()
         {

src/Network/Network/Models/PSPrivateEndpoint.cs

@@ -5129,6 +5129,10 @@
                 <Label>CustomDnsConfigs</Label>
                 <PropertyName>CustomDnsConfigsText</PropertyName>
               </ListItem>
+              <ListItem>
+                <Label>ExtendedLocation</Label>
+                <PropertyName>ExtendedLocationText</PropertyName>
+              </ListItem>
             </ListItems>
           </ListEntry>
         </ListEntries>

src/Network/Network/Network.format.ps1xml

@@ -69,6 +69,12 @@ public class NewAzurePrivateEndpoint : PrivateEndpointBaseCmdlet
            HelpMessage = "Using manual request.")]
         public SwitchParameter ByManualRequest { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The edge zone of the private endpoint")]
+        public string EdgeZone { get; set; }
+
         [Parameter(
             Mandatory = false,
             ValueFromPipelineByPropertyName = true,
@@ -103,7 +109,12 @@ private PSPrivateEndpoint CreatePSPrivateEndpoint()
             {
                 psPrivateEndpoint.PrivateLinkServiceConnections = this.PrivateLinkServiceConnection.ToList();
             }
-            
+
+            if (!string.IsNullOrEmpty(this.EdgeZone))
+            {
+                psPrivateEndpoint.ExtendedLocation = new PSExtendedLocation(this.EdgeZone);
+            }
+
             var peModel = NetworkResourceManagerProfile.Mapper.Map<MNM.PrivateEndpoint>(psPrivateEndpoint);
             peModel.Tags = TagsConversionHelper.CreateTagDictionary(Tag, validate: true);
 

src/Network/Network/PrivateEndpoint/NewAzurePrivateEndpointCommand.cs

@@ -12,12 +12,11 @@ Creates a private endpoint.
 
 ## SYNTAX
 
-### All
-
 ```
 New-AzPrivateEndpoint -Name <String> -ResourceGroupName <String> -Location <String> -Subnet <PSSubnet>
- -PrivateLinkServiceConnection <PSPrivateLinkServiceConnection[]> [-ByManualRequest] [-Tag <Hashtable>]
- [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ -PrivateLinkServiceConnection <PSPrivateLinkServiceConnection[]> [-ByManualRequest] [-EdgeZone <String>]
+ [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -88,6 +87,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -EdgeZone
+The edge zone of the private endpoint
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -Force
 
 Do not ask for confirmation to overwrite a resource.
@@ -236,11 +250,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
--InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
--WarningAction, and -WarningVariable. For more information, see
-[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS