Add new IsParent parameter to New-AzCustomIpPrefix cmdlet (#19577)

* fix

* add files

* fix

* Add new IsParent parameter to New-AzCustomIpPrefix cmdlet

* Add usage examples

Co-authored-by: Weiheng Li <[email protected]>
Co-authored-by: Yunchi Wang <[email protected]>

Author: 3 people

src/Network/Network/BYOIP/CustomIpPrefix/NewAzureCustomIpPrefixCommand.cs

@@ -21,6 +21,7 @@ namespace Microsoft.Azure.Commands.Network
     using System.Collections;
     using System.Linq;
     using System.Management.Automation;
+    using System.Text.RegularExpressions;
     using MNM = Microsoft.Azure.Management.Network.Models;
 
     [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CustomIpPrefix", SupportsShouldProcess = true), OutputType(typeof(PSCustomIpPrefix))]
@@ -99,10 +100,13 @@ public class NewAzureCustomIpPrefixCommand : CustomIpPrefixBaseCmdlet
 
         [Parameter(
             Mandatory = false,
-            HelpMessage = "Parent CustomIpPrefix for /64 IPv6 CustomIpPrefix",
+            HelpMessage = "Parent CustomIpPrefix for Child CustomIpPrefix",
             ValueFromPipelineByPropertyName = true)]
         public PSCustomIpPrefix CustomIpPrefixParent { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Denotes that resource is being created as a Parent CustomIpPrefix")]
+        public SwitchParameter IsParent { get; set; }
+
         [Parameter(
             Mandatory = false,
             HelpMessage = "A list of availability zones denoting the IP allocated for the resource needs to come from.",
@@ -152,6 +156,22 @@ private PSCustomIpPrefix CreateCustomIpPrefix()
                 ExpressRouteAdvertise = this.ExpressRouteAdvertise
             };
 
+            if (IsIPv4CIDR())
+            {
+                if (this.IsParent)
+                {
+                    psModel.PrefixType = "Parent";
+                }
+                else if (this.CustomIpPrefixParent != null)
+                {
+                    psModel.PrefixType = "Child";
+                }
+                else
+                {
+                    psModel.PrefixType = "Singular";
+                }
+            }
+
             var sdkModel = NetworkResourceManagerProfile.Mapper.Map<MNM.CustomIpPrefix>(psModel);
 
             sdkModel.Tags = TagsConversionHelper.CreateTagDictionary(this.Tag, validate: true);
@@ -167,5 +187,17 @@ private PSCustomIpPrefix CreateCustomIpPrefix()
 
             return null;
         }
+
+        private bool IsIPv4CIDR()
+        {
+            if (this.Cidr != null)
+            {
+                return Regex.IsMatch(this.Cidr, @"^\d+\.\d+\.\d+\.\d+/\d+$");
+            }
+            else
+            {
+                return false;
+            }
+        }
     }
 }

src/Network/Network/ChangeLog.md

@@ -34,10 +34,12 @@
 * Updated commandlet to support bypassing NVA for spoke vNet traffic.
     - `NewAzureRmRoutingConfigurationCommand.cs`
 * Updated commandlet to support new parameters: asn, geo, expressrouteadvertise.
-    - `Update-AzCustomIpPrefix
+    - `Update-AzCustomIpPrefix`
 * Updated cmdlets to enable verification on client certificate revocation by using a new property VerifyClientRevocation in ApplicationGatewayClientAuthConfiguration
     - `New-AzApplicationGatewayClientAuthConfiguration`
     - `Set-AzApplicationGatewayClientAuthConfiguration`
+* Updated commandlet to support IPv4 Parent/Child CustomIpPrefix creation.
+    - `New-AzCustomIpPrefix`
 * Added Uppercase Transform in New-AzApplicationGatewayFirewallCondition
 * Added DdosProtectionMode parameter in New-AzPublicIpAddress
 * Added ProbeThreshold parameter to Load Balancer Probe 

src/Network/Network/Models/BYOIP/PSCustomIpPrefix.cs

@@ -45,6 +45,8 @@ public class PSCustomIpPrefix : PSTopLevelResource
 
         public bool? ExpressRouteAdvertise { get; set; }
 
+        public string PrefixType { get; set; }
+
         [JsonIgnore]
         public string PublicIpPrefixesText
         {

src/Network/Network/help/New-AzCustomIpPrefix.md

@@ -13,9 +13,10 @@ Creates a CustomIpPrefix resource
 ## SYNTAX
 
 ```
-New-AzCustomIpPrefix -Name <String> -ResourceGroupName <String> -Location <String> -Cidr <String> [-Geo <String>] 
- [-Asn <String>] [-ExpressRouteAdvertise] [-Zone <String[]>] [-Tag <Hashtable>] [-SignedMessage <String>] [-AuthorizationMessage <String>]
- [-CustomIpPrefixParent <CustomIpPrefix>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
+New-AzCustomIpPrefix -Name <String> -ResourceGroupName <String> -Location <String> -Cidr <String>
+ [-Asn <String>] [-Geo <String>] [-SignedMessage <String>] [-AuthorizationMessage <String>]
+ [-ExpressRouteAdvertise] [-CustomIpPrefixParent <PSCustomIpPrefix>] [-IsParent] [-Zone <String[]>]
+ [-Tag <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
@@ -31,13 +32,27 @@ $myCustomIpPrefix = New-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $r
 
 This command kicks off the provisioning process for a new zone-redundant IPv4 Custom IP Prefix resource with name $prefixName in resource group $rgName with a CIDR of 40.40.40.0/24 in West US 2 region.  Note the AuthorizationMessage is a contactenated string (containing the subscription ID, CIDR, and Route Origin Authorization expiration date) and the SignedMessage is the same string signed by X509 certificate offline. 
 
+### Example 2
+```powershell
+$myV4ParentPrefix = New-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Cidr "40.40.40.0/24" -Location westus2 -IsParent -AuthorizationMessage $authorizationMessage -SignedMessage $signedMessage
+```
+
+This command kicks off the provisioning process for a new Parent IPv4 Custom IP Prefix resource with name $prefixName in resource group $rgName with a CIDR of 40.40.40.0/24.
+
+### Example 3
+```powershell
+$myV4ChildIpPrefix = New-AzCustomIpPrefix -Name $prefixName -ResourceGroupName $rgName -Cidr "40.40.40.0/25" -Location westus2 -CustomIpPrefixParent $myV4ParentPrefix
+```
+
+This command kicks off the provisioning process for a new Child IPv4 Custom IP Prefix resource with name $prefixName in resource group $rgName with a CIDR of 40.40.40.0/25. Its parent prefix is $myV4ParentPrefix.
+
 ## PARAMETERS
 
 ### -AsJob
 Run cmdlet in the background
 
 ```yaml
-Type: SwitchParameter
+Type: System.Management.Automation.SwitchParameter
 Parameter Sets: (All)
 Aliases:
 
@@ -48,26 +63,26 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Cidr
-The CustomIpPrefix CIDR.
+### -Asn
+The customIpPrefix ASN code.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -Geo
-The CustomIpPrefix Geo code.
+### -AuthorizationMessage
+Authorization message for WAN validation.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: (All)
 Aliases:
 
@@ -78,41 +93,41 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -Asn
-The CustomIpPrefix Geo code.
+### -Cidr
+The CustomIpPrefix CIDR.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: (All)
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -ExpressRouteAdvertise
-Need to use ExpressRoute to advertise the CustomIpPrefix
+### -CustomIpPrefixParent
+Parent CustomIpPrefix of resource.
 
 ```yaml
-Type: SwitchParameter
+Type: Microsoft.Azure.Commands.Network.Models.PSCustomIpPrefix
 Parameter Sets: (All)
 Aliases:
 
 Required: False
 Position: Named
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
 ### -DefaultProfile
 The credentials, account, tenant, and subscription used for communication with Azure.
 
 ```yaml
-Type: IAzureContextContainer
+Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
 Parameter Sets: (All)
 Aliases: AzContext, AzureRmContext, AzureCredential
 
@@ -123,41 +138,57 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Location
-The CustomIpPrefix location.
+### -ExpressRouteAdvertise
+Using expressRoute advertise.
 
 ```yaml
-Type: String
+Type: System.Management.Automation.SwitchParameter
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -Name
-The resource name.
+### -Geo
+The customIpPrefix GEO code.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: (All)
-Aliases: ResourceName
+Aliases:
+Accepted values: AFRI, APAC, AQ, EURO, LATAM, ME, NAM, OCEANIA
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -ResourceGroupName
-The resource group name.
+### -IsParent
+Denotes that resource is being created as a Parent CustomIpPrefix
 
 ```yaml
-Type: String
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Location
+The CustomIpPrefix location.
+
+```yaml
+Type: System.String
 Parameter Sets: (All)
 Aliases:
 
@@ -168,41 +199,41 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -Tag
-A hashtable which represents resource tags.
+### -Name
+The resource name.
 
 ```yaml
-Type: Hashtable
+Type: System.String
 Parameter Sets: (All)
-Aliases:
+Aliases: ResourceName
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -SignedMessage
-Signed message for WAN validation.
+### -ResourceGroupName
+The resource group name.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: (All)
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -AuthorizationMessage
-Authorization message for WAN validation.
+### -SignedMessage
+Signed message for WAN validation.
 
 ```yaml
-Type: String
+Type: System.String
 Parameter Sets: (All)
 Aliases:
 
@@ -213,11 +244,11 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -CustomIpPrefixParent
-Parent CustomIpPrefix of resource.
+### -Tag
+A hashtable which represents resource tags.
 
 ```yaml
-Type: CustomIpPrefix
+Type: System.Collections.Hashtable
 Parameter Sets: (All)
 Aliases:
 
@@ -232,7 +263,7 @@ Accept wildcard characters: False
 A list of availability zones denoting the IP allocated for the resource needs to come from.
 
 ```yaml
-Type: String[]
+Type: System.String[]
 Parameter Sets: (All)
 Aliases:
 
@@ -247,7 +278,7 @@ Accept wildcard characters: False
 Prompts you for confirmation before running the cmdlet.
 
 ```yaml
-Type: SwitchParameter
+Type: System.Management.Automation.SwitchParameter
 Parameter Sets: (All)
 Aliases: cf
 
@@ -263,7 +294,7 @@ Shows what would happen if the cmdlet runs.
 The cmdlet is not run.
 
 ```yaml
-Type: SwitchParameter
+Type: System.Management.Automation.SwitchParameter
 Parameter Sets: (All)
 Aliases: wi