Add edge zone parameter to private link service cmdlet (#15282)

* Add edge zone parameter to private link service

* UT boilerplate code

* Update change log

* UT is passing

* Refactor UT

* Update test and add session record

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

Author: wdehrich

src/Network/Network.Test/ScenarioTests/PrivateLinkServiceTests.cs

@@ -33,6 +33,14 @@ public void TestPrivateLinkServiceCRUD()
             TestRunner.RunTestScript("Test-PrivateLinkServiceCRUD");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        [Trait(Category.Owner, NrpTeamAlias.sdnnrp)]
+        public void TestPrivateLinkServiceInEdgeZone()
+        {
+            TestRunner.RunTestScript("Test-PrivateLinkServiceInEdgeZone");
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         [Trait(Category.Owner, NrpTeamAlias.sdnnrp)]

src/Network/Network.Test/ScenarioTests/PrivateLinkServiceTests.ps1

@@ -260,3 +260,64 @@ function Test-StoragePrivateEndpoint
         Clean-ResourceGroup $rgname;
     }
 }
+
+<#
+.SYNOPSIS
+Test creating a private link service in an edge zone. Subscriptions need to be explicitly whitelisted for access to edge zones.
+#>
+function Test-PrivateLinkServiceInEdgeZone
+{
+    # Setup
+    $rgname = Get-ResourceGroupName
+    $rname = Get-ResourceName
+    $location = "westus"
+    # Dependency parameters
+    $IpConfigurationName = "IpConfigurationName"
+    $vnetName = Get-ResourceName
+    $ilbFrontName = "LB-Frontend"
+    $ilbBackendName = "LB-Backend"
+    $ilbName = Get-ResourceName
+    $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 (Normalize-Location $location) $ilbcreate.Location
+        Assert-AreEqual "Succeeded" $ilbcreate.ProvisioningState
+
+        # Create required dependencies
+        $IpConfiguration = New-AzPrivateLinkServiceIpConfig -Name $IpConfigurationName -PrivateIpAddress 10.0.3.5 -Subnet $vnet.subnets[2]
+        $LoadBalancerFrontendIpConfiguration = Get-AzLoadBalancer -Name $ilbName | Get-AzLoadBalancerFrontendIpConfig
+
+        # Create PrivateLinkService
+        New-AzPrivateLinkService -ResourceGroupName $rgName -Name $rname -Location $location -IpConfiguration $IpConfiguration -LoadBalancerFrontendIpConfiguration $LoadBalancerFrontendIpConfiguration -EdgeZone $edgeZone
+        $vPrivateLinkService = Get-AzPrivateLinkService -Name $rname -ResourceGroupName $rgName
+
+        Assert-AreEqual $vPrivateLinkService.ExtendedLocation.Name $edgeZone
+        Assert-AreEqual $vPrivateLinkService.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.PrivateLinkServiceTests/TestPrivateLinkServiceInEdgeZone.json

@@ -22,6 +22,7 @@
 * Updated cmdlets to enable specification of edge zone
     - `New-AzPublicIpPrefix`
     - `New-AzLoadBalancer`
+    - `New-AzPrivateLinkService`
 * 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 Newtonsoft.Json;
@@ -49,6 +37,8 @@ public partial class PSPrivateLinkService : PSTopLevelResource
 
         public bool? EnableProxyProtocol { get; set; }
 
+        public PSExtendedLocation ExtendedLocation { get; set; }
+
         [JsonIgnore]
         public string LoadBalancerFrontendIpConfigurationsText
         {
@@ -84,5 +74,11 @@ public string AutoApprovalText
         {
             get { return JsonConvert.SerializeObject(AutoApproval, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
         }
+
+        [JsonIgnore]
+        public string ExtendedLocationText
+        {
+            get { return JsonConvert.SerializeObject(ExtendedLocation, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
+        }
     }
 }

src/Network/Network/Models/PSPrivateLinkService.cs

@@ -5317,6 +5317,10 @@
                 <Label>NetworkInterfaces</Label>
                 <PropertyName>NetworkInterfacesText</PropertyName>
               </ListItem>
+              <ListItem>
+                <Label>ExtendedLocation</Label>
+                <PropertyName>ExtendedLocationText</PropertyName>
+              </ListItem>
             </ListItems>
           </ListEntry>
         </ListEntries>

src/Network/Network/Network.format.ps1xml

@@ -82,6 +82,12 @@ public class NewAzurePrivateLinkService : PrivateLinkServiceBaseCmdlet
             HelpMessage = "Whether to enable proxy protocol or not")]
         public SwitchParameter EnableProxyProtocol { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The edge zone of the private link service")]
+        public string EdgeZone { get; set; }
+
         [Parameter(
             Mandatory = false,
             ValueFromPipelineByPropertyName = true,
@@ -124,6 +130,11 @@ private PSPrivateLinkService CreatePSPrivateLinkService()
 
             psPrivateLinkService.EnableProxyProtocol = this.EnableProxyProtocol.IsPresent;
 
+            if (!string.IsNullOrEmpty(this.EdgeZone))
+            {
+                psPrivateLinkService.ExtendedLocation = new PSExtendedLocation(this.EdgeZone);
+            }
+
             var plsModel = NetworkResourceManagerProfile.Mapper.Map<MNM.PrivateLinkService>(psPrivateLinkService);
             plsModel.Tags = TagsConversionHelper.CreateTagDictionary(Tag, validate: true);
 

src/Network/Network/PrivateLinkService/NewAzurePrivateLinkServiceCommand.cs

@@ -15,9 +15,9 @@ Creates a private link service
 ```
 New-AzPrivateLinkService -Name <String> -ResourceGroupName <String> -Location <String>
  -LoadBalancerFrontendIpConfiguration <PSFrontendIPConfiguration[]>
- -IpConfiguration <PSPrivateLinkServiceIpConfiguration[]> [-Visibility <String[]>] [-AutoApproval <String[]>] [-EnableProxyProtocol]
- [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+ -IpConfiguration <PSPrivateLinkServiceIpConfiguration[]> [-Visibility <String[]>] [-AutoApproval <String[]>]
+ [-EnableProxyProtocol] [-EdgeZone <String>] [-Tag <Hashtable>] [-Force] [-AsJob]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -87,6 +87,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -EdgeZone
+The edge zone of the private link service
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -EnableProxyProtocol
 Enable proxy protocol for the private link service.
 
@@ -98,7 +113,7 @@ Aliases:
 Required: False
 Position: Named
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```