Added new parameters ApplicationSecurityGroup, IpConfiguration, CustomNetworkInterfaceName for Get-AzPrivateEndpoint and New-AzPrivateEndpoint (#16643)

vidai-msft · web-flow · commit 46e5917be747 · 2021-12-23T11:17:40.000+08:00
* Added new parameters ApplicationSecurityGroups, IpConfigurations and CustomNetworkInterfaceName for Get-AzPrivateEndpoint and Set-AzPrivateEndpoint

* Added new parameter ApplicationSecurityGroups for Get-AzPrivateEndpoint and Set-AzPrivateEndpoint

* Renamed parameter name from ApplicationSecurityGroups to ApplicationSecurityGroup for cmdlet New-AzPrivateEndpoint

* Update ChangeLog.md

* Update Az.Network.psd1

* Update NewAzurePrivateEndpointIPConfigurationCommand.cs

* Update NewAzurePrivateEndpointIPConfigurationCommand.cs

* Update SignatureIssues.csv
diff --git a/src/Network/Network.Test/ScenarioTests/PrivateEndpointTests.cs b/src/Network/Network.Test/ScenarioTests/PrivateEndpointTests.cs
@@ -48,5 +48,29 @@ public void TestPrivateDnsZoneGroupCRUD()
         {
             TestRunner.RunTestScript("Test-PrivateDnsZoneGroupCRUD");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        [Trait(Category.Owner, NrpTeamAlias.azdevxps)]
+        public void TestPrivateEndpointApplicationSecurityGroup()
+        {
+            TestRunner.RunTestScript("Test-PrivateEndpointApplicationSecurityGroup");
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        [Trait(Category.Owner, NrpTeamAlias.azdevxps)]
+        public void TestPrivateEndpointIpConfiguration()
+        {
+            TestRunner.RunTestScript("Test-PrivateEndpointIpConfiguration");
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        [Trait(Category.Owner, NrpTeamAlias.azdevxps)]
+        public void TestPrivateEndpointCustomNetworkInterfaceName()
+        {
+            TestRunner.RunTestScript("Test-PrivateEndpointCustomNetworkInterfaceName");
+        }
     }
 }
diff --git a/src/Network/Network.Test/ScenarioTests/PrivateEndpointTests.ps1 b/src/Network/Network.Test/ScenarioTests/PrivateEndpointTests.ps1
diff --git a/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.PrivateEndpointTests/TestPrivateEndpointApplicationSecurityGroup.json b/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.PrivateEndpointTests/TestPrivateEndpointApplicationSecurityGroup.json
diff --git a/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.PrivateEndpointTests/TestPrivateEndpointCustomNetworkInterfaceName.json b/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.PrivateEndpointTests/TestPrivateEndpointCustomNetworkInterfaceName.json
diff --git a/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.PrivateEndpointTests/TestPrivateEndpointIpConfiguration.json b/src/Network/Network.Test/SessionRecords/Commands.Network.Test.ScenarioTests.PrivateEndpointTests/TestPrivateEndpointIpConfiguration.json
diff --git a/src/Network/Network/Az.Network.psd1 b/src/Network/Network/Az.Network.psd1
@@ -546,7 +546,8 @@ CmdletsToExport = 'Add-AzApplicationGatewayAuthenticationCertificate',
                'Remove-AzVirtualNetworkGatewayNatRule',
                'Get-AzVirtualHubBgpConnection', 'New-AzVirtualHubBgpConnection',
                'Remove-AzVirtualHubBgpConnection',
-               'Update-AzVirtualHubBgpConnection'
+               'Update-AzVirtualHubBgpConnection',
+               'New-AzPrivateEndpointIpConfiguration'
 
 # Variables to export from this module
 # VariablesToExport = @()
diff --git a/src/Network/Network/ChangeLog.md b/src/Network/Network/ChangeLog.md
@@ -19,6 +19,11 @@
 --->
 
 ## Upcoming Release
+* Added new properties ApplicationSecurityGroup, IpConfiguration and CustomNetworkInterfaceName for Private Endpoint cmdlets
+    - `Get-AzPrivateEndpoint`
+    - `New-AzPrivateEndpoint`
+* Added new cmdlet to create new IpConfiguration object for building Private Endpoint
+    - `New-AzPrivateEndpointIpConfiguration`
 * Added OrdinalIgnoreCase for string comparison of resourceIdentifier type for flowlog cmdlets
 * Fixed typo in error message of InvalidWorkspaceResourceId
 
diff --git a/src/Network/Network/Common/NetworkResourceManagerProfile.cs b/src/Network/Network/Common/NetworkResourceManagerProfile.cs
@@ -1357,8 +1357,14 @@ private static void Initialize()
                 // MNM to CNM
                 cfg.CreateMap<MNM.VirtualNetworkTap, CNM.PSVirtualNetworkTap>();
 
-                cfg.CreateMap<CNM.PSPrivateEndpoint, MNM.PrivateEndpoint>();
-                cfg.CreateMap<MNM.PrivateEndpoint, CNM.PSPrivateEndpoint>();
+                cfg.CreateMap<CNM.PSPrivateEndpoint, MNM.PrivateEndpoint>()
+                    .ForMember(dest => dest.ApplicationSecurityGroups, opt => opt.MapFrom(src => src._psApplicationSecurityGroups))
+                    .ForMember(dest => dest.IpConfigurations, opt => opt.MapFrom(src => src._psIpConfigurations));
+                cfg.CreateMap<MNM.PrivateEndpoint, CNM.PSPrivateEndpoint>()
+                    .ForMember(dest => dest._psApplicationSecurityGroups, opt => opt.MapFrom(src => src.ApplicationSecurityGroups))
+                    .ForMember(dest => dest._psIpConfigurations, opt => opt.MapFrom(src => src.IpConfigurations));
+                cfg.CreateMap<CNM.PSPrivateEndpointIPConfiguration, MNM.PrivateEndpointIPConfiguration>();
+                cfg.CreateMap<MNM.PrivateEndpointIPConfiguration, CNM.PSPrivateEndpointIPConfiguration>();
                 cfg.CreateMap<CNM.PSPrivateDnsZoneGroup, MNM.PrivateDnsZoneGroup>();
                 cfg.CreateMap<MNM.PrivateDnsZoneGroup, CNM.PSPrivateDnsZoneGroup>();
                 cfg.CreateMap<CNM.PSPrivateDnsZoneConfig, MNM.PrivateDnsZoneConfig>();
diff --git a/src/Network/Network/Models/PSPrivateEndpoint.cs b/src/Network/Network/Models/PSPrivateEndpoint.cs
@@ -31,6 +31,30 @@ public partial class PSPrivateEndpoint : PSTopLevelResource
         public List<PSPrivateEndpointCustomDnsConfig> CustomDnsConfigs { get; set; }
         public PSExtendedLocation ExtendedLocation { get; set; }
 
+        /// <summary>
+        /// Need this interim property due to a bug in AutoMapper 6.6.2
+        /// https://github.com/AutoMapper/AutoMapper/issues/2507 - Not able to map null to null for IEnumerable/IReadOnlyList object except for IList
+        /// </summary>
+        internal List<PSApplicationSecurityGroup> _psApplicationSecurityGroups { get; set; }
+
+        /// <summary>
+        /// IReadOnlyList object due to ApplicationSecurityGroups is not applicable for Set-AzPrivateEndpoint
+        /// </summary>
+        public IReadOnlyList<PSApplicationSecurityGroup> ApplicationSecurityGroups => _psApplicationSecurityGroups.AsReadOnly();
+
+        /// <summary>
+        /// Need this interim property due to a bug in AutoMapper 6.6.2
+        /// https://github.com/AutoMapper/AutoMapper/issues/2507 - Not able to map null to null for IEnumerable/IReadOnlyList object except for IList
+        /// </summary>
+        internal List<PSPrivateEndpointIPConfiguration> _psIpConfigurations { get; set; }
+
+        /// <summary>
+        /// IReadOnlyList object due to PrivateEndpointIPConfigurations is not applicable for Set-AzPrivateEndpoint
+        /// </summary>
+        public IReadOnlyList<PSPrivateEndpointIPConfiguration> IpConfigurations => _psIpConfigurations.AsReadOnly();
+
+        public string CustomNetworkInterfaceName { get; internal set; }
+
         [JsonIgnore]
         public string SubnetText
         {
@@ -67,6 +91,18 @@ public string ExtendedLocationText
             get { return JsonConvert.SerializeObject(ExtendedLocation, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
         }
 
+        [JsonIgnore]
+        public string ApplicationSecurityGroupsText
+        {
+            get { return JsonConvert.SerializeObject(ApplicationSecurityGroups, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
+        }
+
+        [JsonIgnore]
+        public string IpConfigurationsText
+        {
+            get { return JsonConvert.SerializeObject(IpConfigurations, Formatting.Indented, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore }); }
+        }
+
         public bool ShouldSerializeNetworkInterfaces()
         {
             return !string.IsNullOrEmpty(this.Name);
diff --git a/src/Network/Network/Models/PSPrivateEndpointIPConfiguration.cs b/src/Network/Network/Models/PSPrivateEndpointIPConfiguration.cs
@@ -0,0 +1,24 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Text.Json.Serialization;
+
+namespace Microsoft.Azure.Commands.Network.Models
+{
+    public class PSPrivateEndpointIPConfiguration
+    {
+
+        public string Name { get; internal set; }
+
+        public string GroupId { get; internal set; }
+
+        public string MemberName { get; internal set; }
+
+        [Newtonsoft.Json.JsonProperty("PrivateIpAddress")]
+        public string PrivateIPAddress { get; internal set; }
+
+        public string Type { get; private set; }
+
+        public string Etag { get; private set; }
+    }
+}
diff --git a/src/Network/Network/Network.format.ps1xml b/src/Network/Network/Network.format.ps1xml
@@ -5175,7 +5175,19 @@
                 <Label>ExtendedLocation</Label>
                 <PropertyName>ExtendedLocationText</PropertyName>
               </ListItem>
-            </ListItems>
+			  <ListItem>
+				<Label>ApplicationSecurityGroups</Label>
+				<PropertyName>ApplicationSecurityGroupsText</PropertyName>
+			  </ListItem>
+			  <ListItem>
+				<Label>IpConfigurations</Label>
+				<PropertyName>IpConfigurationsText</PropertyName>
+			  </ListItem>
+			  <ListItem>
+				<Label>CustomNetworkInterfaceName</Label>
+				<PropertyName>CustomNetworkInterfaceName</PropertyName>
+			  </ListItem>
+			</ListItems>
           </ListEntry>
         </ListEntries>
       </ListControl>
diff --git a/src/Network/Network/PrivateEndpoint/NewAzurePrivateEndpointCommand.cs b/src/Network/Network/PrivateEndpoint/NewAzurePrivateEndpointCommand.cs
@@ -21,6 +21,7 @@
 using MNM = Microsoft.Azure.Management.Network.Models;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Collections;
+using Microsoft.Azure.Management.Network.Models;
 
 namespace Microsoft.Azure.Commands.Network
 {
@@ -91,6 +92,15 @@ public class NewAzurePrivateEndpoint : PrivateEndpointBaseCmdlet
             HelpMessage = "Run cmdlet in the background")]
         public SwitchParameter AsJob { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "The application security group")]
+        public PSApplicationSecurityGroup[] ApplicationSecurityGroup { get; set; }
+
+        [Parameter(Mandatory = false, HelpMessage = "The private endpoint IP configuration")]
+        public PSPrivateEndpointIPConfiguration[] IpConfiguration { get; set; }
+
+        [Parameter(Mandatory = false, HelpMessage = "The custom network interface name")]
+        public string CustomNetworkInterfaceName { get; set; }
+
         private PSPrivateEndpoint CreatePSPrivateEndpoint()
         {
             var psPrivateEndpoint = new PSPrivateEndpoint
@@ -115,6 +125,21 @@ private PSPrivateEndpoint CreatePSPrivateEndpoint()
                 psPrivateEndpoint.ExtendedLocation = new PSExtendedLocation(this.EdgeZone);
             }
 
+            // Add support for new properties ApplicationSecurityGroup, IpConfiguration, CustomNetworkInterfaceName
+            if (this.ApplicationSecurityGroup != null && this.ApplicationSecurityGroup.Length > 0)
+            {
+                psPrivateEndpoint._psApplicationSecurityGroups = ApplicationSecurityGroup.ToList();
+            }
+            if (this.IpConfiguration != null && this.IpConfiguration.Length > 0)
+            {
+                psPrivateEndpoint._psIpConfigurations = this.IpConfiguration.ToList();
+            }
+            if (this.CustomNetworkInterfaceName != null)
+            {
+                psPrivateEndpoint.CustomNetworkInterfaceName = this.CustomNetworkInterfaceName;
+            }
+
+
             var peModel = NetworkResourceManagerProfile.Mapper.Map<MNM.PrivateEndpoint>(psPrivateEndpoint);
             peModel.Tags = TagsConversionHelper.CreateTagDictionary(Tag, validate: true);
 
diff --git a/src/Network/Network/PrivateEndpoint/PrivateEndpointIPConfiguration/NewAzurePrivateEndpointIPConfigurationCommand.cs b/src/Network/Network/PrivateEndpoint/PrivateEndpointIPConfiguration/NewAzurePrivateEndpointIPConfigurationCommand.cs
@@ -0,0 +1,43 @@
+﻿using Microsoft.Azure.Commands.Network.Models;
+using System;
+using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text;
+
+namespace Microsoft.Azure.Commands.Network
+{
+    [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PrivateEndpointIpConfiguration"), OutputType(typeof(PSPrivateEndpointIPConfiguration))]
+    public class NewAzurePrivateEndpointIPConfigurationCommand : NetworkBaseCmdlet
+    {
+        [Parameter(Mandatory = true, HelpMessage = "The name of the private endpoint IP configuration.")]
+        [ValidateNotNullOrEmpty]
+        public string Name { get; set; }
+
+        [Parameter(Mandatory = false, HelpMessage = "The ID of a group that the private endpoint connects to.")]
+        [ValidateNotNullOrEmpty]
+        public string GroupId { get; set; }
+
+        [Parameter(Mandatory = false, HelpMessage = "The member name of a group that the private endpoint connects to.")]
+        [ValidateNotNullOrEmpty]
+        public string MemberName { get; set; }
+
+        [Parameter(Mandatory = true, HelpMessage = "The private ip address of the private endpoint's subnet.")]
+        [ValidateNotNullOrEmpty]
+        public string PrivateIpAddress { get; set; }
+
+        public override void Execute()
+        {
+            base.Execute();
+
+            var psPeIpConfig = new PSPrivateEndpointIPConfiguration
+            {
+                Name = Name,
+                GroupId = GroupId,
+                MemberName = MemberName,
+                PrivateIPAddress = PrivateIpAddress
+            };
+
+            WriteObject(psPeIpConfig);
+        }
+    }
+}
diff --git a/src/Network/Network/help/Az.Network.md b/src/Network/Network/help/Az.Network.md
@@ -933,6 +933,9 @@ Creates a private DNS zone group in the specified private endpoint.
 ### [New-AzPrivateEndpoint](New-AzPrivateEndpoint.md)
 Creates a private endpoint.
 
+### [New-AzPrivateEndpointIpConfiguration](New-AzPrivateEndpointIpConfiguration.md)
+Creates an IpConfiguration object for private endpoint.
+
 ### [New-AzPrivateLinkService](New-AzPrivateLinkService.md)
 Creates a private link service
 
diff --git a/src/Network/Network/help/Get-AzPrivateEndpoint.md b/src/Network/Network/help/Get-AzPrivateEndpoint.md
@@ -151,7 +151,7 @@ Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
-Accept wildcard characters: False
+Accept wildcard characters: True
 ```
 
 ```yaml
@@ -163,7 +163,7 @@ Required: True
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
-Accept wildcard characters: False
+Accept wildcard characters: True
 ```
 
 ### -ResourceGroupName
@@ -178,7 +178,7 @@ Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
-Accept wildcard characters: False
+Accept wildcard characters: True
 ```
 
 ```yaml
@@ -190,7 +190,7 @@ Required: True
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
-Accept wildcard characters: False
+Accept wildcard characters: True
 ```
 
 ### CommonParameters
diff --git a/src/Network/Network/help/New-AzPrivateEndpoint.md b/src/Network/Network/help/New-AzPrivateEndpoint.md
@@ -15,8 +15,9 @@ Creates a private endpoint.
 ```
 New-AzPrivateEndpoint -Name <String> -ResourceGroupName <String> -Location <String> -Subnet <PSSubnet>
  -PrivateLinkServiceConnection <PSPrivateLinkServiceConnection[]> [-ByManualRequest] [-EdgeZone <String>]
- [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+ [-Tag <Hashtable>] [-Force] [-AsJob] [-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>]
+ [-IpConfiguration <PSPrivateEndpointIPConfiguration[]>] [-CustomNetworkInterfaceName <String>]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -39,6 +40,21 @@ New-AzPrivateEndpoint -Name 'MyPrivateEndpoint' -ResourceGroup 'myResourceGroup'
 
 ## PARAMETERS
 
+### -ApplicationSecurityGroup
+The application security group
+
+```yaml
+Type: Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -AsJob
 
 Run cmdlet as a job in the background.
@@ -71,6 +87,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -CustomNetworkInterfaceName
+The custom network interface name
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+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.
@@ -118,6 +149,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -IpConfiguration
+The private endpoint IP configuration
+
+```yaml
+Type: Microsoft.Azure.Commands.Network.Models.PSPrivateEndpointIPConfiguration[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Location
 
 Specifies a location for the private endpoint. Use [Get-AzLocation](/powershell/module/az.resources/get-azlocation)
diff --git a/src/Network/Network/help/New-AzPrivateEndpointIpConfiguration.md b/src/Network/Network/help/New-AzPrivateEndpointIpConfiguration.md
diff --git a/tools/StaticAnalysis/Exceptions/Az.Network/SignatureIssues.csv b/tools/StaticAnalysis/Exceptions/Az.Network/SignatureIssues.csv
