[AppService]: Feature Azure#19496 Added -Tag parameter support to New-AzWebApp & New-AzWebAppSlot (Azure#20019)

Kotasudhakarreddy · web-flow · commit eed22af0719a · 2022-11-08T13:09:36.000+08:00
* [AppService]: Feature Azure#19496 Please add -Tag parameter to New-AzWebAppSlot * Update WebAppTests.ps1 Review comments are updated * Update WebAppSlotTests.ps1 * Review Comments updated * Update NewAzureWebAppSlot.cs * Update NewAzureWebAppSlot.cs
diff --git a/src/Websites/Websites.Test/ScenarioTests/WebAppSlotTests.ps1 b/src/Websites/Websites.Test/ScenarioTests/WebAppSlotTests.ps1
@@ -297,6 +297,7 @@ function Test-CreateNewWebAppSlot
 	$planName = Get-WebHostPlanName
 	$tier = "Standard"
 	$resourceType = "Microsoft.Web/sites"
+	$tag= @{"TagKey" = "TagValue"}
 	try
 	{
 		#Setup
@@ -318,7 +319,7 @@ function Test-CreateNewWebAppSlot
 		Assert-AreEqual $serverFarm.Id $result.ServerFarmId
 
 		# Create deployment slot
-		$job = New-AzWebAppSlot -ResourceGroupName $rgname -Name $appname -Slot $slotname -AsJob
+		$job = New-AzWebAppSlot -ResourceGroupName $rgname -Name $appname -Slot $slotname -Tag $tag -AsJob
 		$job | Wait-Job
 		$slot1 = $job | Receive-Job
 
@@ -327,6 +328,8 @@ function Test-CreateNewWebAppSlot
 		# Assert
 		Assert-AreEqual $appWithSlotName $slot1.Name
 		Assert-AreEqual $serverFarm.Id $slot1.ServerFarmId
+		Assert-AreEqual $tag.Keys $slot1.Tags.Keys
+        	Assert-AreEqual $tag.Values $slot1.Tags.Values
 	}
 	finally
 	{
diff --git a/src/Websites/Websites.Test/ScenarioTests/WebAppTests.ps1 b/src/Websites/Websites.Test/ScenarioTests/WebAppTests.ps1
@@ -422,20 +422,23 @@ function Test-CreateNewWebApp
 	$tier = "Shared"
 	$apiversion = "2015-08-01"
 	$resourceType = "Microsoft.Web/sites"
+	$tag= @{"TagKey" = "TagValue"}
 	try
 	{
 		#Setup
 		New-AzResourceGroup -Name $rgname -Location $location
 		$serverFarm = New-AzAppServicePlan -ResourceGroupName $rgname -Name  $whpName -Location  $location -Tier $tier
 		
 		# Create new web app
-		$job = New-AzWebApp -ResourceGroupName $rgname -Name $wname -Location $location -AppServicePlan $whpName -AsJob
+		$job = New-AzWebApp -ResourceGroupName $rgname -Name $wname -Location $location -AppServicePlan $whpName -Tag $tag -AsJob
 		$job | Wait-Job
 		$actual = $job | Receive-Job
 		
 		# Assert
 		Assert-AreEqual $wname $actual.Name
 		Assert-AreEqual $serverFarm.Id $actual.ServerFarmId
+		Assert-AreEqual $tag.Keys $actual.Tags.Keys
+                Assert-AreEqual $tag.Values $actual.Tags.Values
 
 		# Get new web app
 		$result = Get-AzWebApp -ResourceGroupName $rgname -Name $wname
@@ -1589,4 +1592,4 @@ function Test-TagsNotRemovedBySetWebApp
 	$asp = Get-AzAppServicePlan -ResourceGroupName $rgname -Name $aspName
 	Assert-AreEqual $webApp.ServerFarmId $asp.id
 	Assert-notNull $webApp.Tags
-}
+}
diff --git a/src/Websites/Websites.Test/SessionRecords/Microsoft.Azure.Commands.Websites.Test.ScenarioTests.WebAppSlotTests/TestCreateNewWebAppSlot.json b/src/Websites/Websites.Test/SessionRecords/Microsoft.Azure.Commands.Websites.Test.ScenarioTests.WebAppSlotTests/TestCreateNewWebAppSlot.json
diff --git a/src/Websites/Websites.Test/SessionRecords/Microsoft.Azure.Commands.Websites.Test.ScenarioTests.WebAppTests/TestCreateNewWebApp.json b/src/Websites/Websites.Test/SessionRecords/Microsoft.Azure.Commands.Websites.Test.ScenarioTests.WebAppTests/TestCreateNewWebApp.json
diff --git a/src/Websites/Websites.Test/SessionRecords/Microsoft.Azure.Commands.Websites.Test.ScenarioTests.WebAppTests/TestCreateNewWebAppSimple.json b/src/Websites/Websites.Test/SessionRecords/Microsoft.Azure.Commands.Websites.Test.ScenarioTests.WebAppTests/TestCreateNewWebAppSimple.json
diff --git a/src/Websites/Websites/ChangeLog.md b/src/Websites/Websites/ChangeLog.md
@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added Tag parameter for `New-AzWebApp` and `New-AzWebAppSlot`
 
 ## Version 2.11.5
 * Fixed `Publish-AzWebApp` to use latest publish API when deploying war package [#19791]
diff --git a/src/Websites/Websites/Cmdlets/DeploymentSlots/NewAzureWebAppSlot.cs b/src/Websites/Websites/Cmdlets/DeploymentSlots/NewAzureWebAppSlot.cs
@@ -98,7 +98,10 @@ public class NewAzureWebAppSlotCmdlet : WebAppBaseClientCmdLet
 
 
 		[Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
-        public SwitchParameter AsJob { get; set; }
+        	public SwitchParameter AsJob { get; set; }
+
+		[Parameter(Mandatory = false, HelpMessage = "Tags are name/value pairs that enable you to categorize resources")]
+		public Hashtable Tag { get; set; }
 
 		private Hashtable GetAppSettingsToUpdate()
 		{
@@ -181,7 +184,7 @@ public override void ExecuteCmdlet()
             }
 
             var webApp = new PSSite(WebsitesClient.GetWebApp(ResourceGroupName, Name, null));
-			var site = new PSSite(WebsitesClient.CreateWebApp(ResourceGroupName, Name, Slot, webApp.Location, AppServicePlan==null?webApp.ServerFarmId : AppServicePlan, cloningInfo, AseName, AseResourceGroupName));
+	    var site = new PSSite(WebsitesClient.CreateWebApp(ResourceGroupName, Name, Slot, webApp.Location, AppServicePlan==null?webApp.ServerFarmId : AppServicePlan, cloningInfo, AseName, AseResourceGroupName, (IDictionary<string, string>)CmdletHelpers.ConvertToStringDictionary(Tag)));
 			UpdateConfigIfNeeded(site);
         }
     }
diff --git a/src/Websites/Websites/Cmdlets/WebApps/NewAzureWebApp.cs b/src/Websites/Websites/Cmdlets/WebApps/NewAzureWebApp.cs
@@ -137,6 +137,9 @@ public class NewAzureWebAppCmdlet : WebAppBaseClientCmdLet
         [Parameter(Mandatory = false, HelpMessage = "Path to the GitHub repository containign the web application to deploy.", ParameterSetName = SimpleParameterSet)]
         public string GitRepositoryPath { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Tags are name/value pairs that enable you to categorize resources", ParameterSetName = SimpleParameterSet)]
+        public Hashtable Tag { get; set; }
+
         protected override void ProcessRecord()
         {
             try
@@ -386,7 +389,8 @@ public async Task<ResourceConfig<Site>> CreateConfigAsync()
                 // If ContainerImageName is specified and appservice plan doesn’t exist (appServiceplan == null) we will try to create plan with windows container 
                 var farmStrategy = planRG.CreateServerFarmConfig(planResourceGroup, planName, appServiceplan == null && _cmdlet.ContainerImageName != null);
 
-                return rgStrategy.CreateSiteConfig(farmStrategy, _cmdlet.Name, this.GetNewConfig(appServiceplan));
+                return rgStrategy.CreateSiteConfig(farmStrategy, _cmdlet.Name, this.GetNewConfig(appServiceplan)
+                    , (IDictionary<string, string>)CmdletHelpers.ConvertToStringDictionary(_cmdlet.Tag));
             }
         }
 
diff --git a/src/Websites/Websites/Strategies/SiteStrategy.cs b/src/Websites/Websites/Strategies/SiteStrategy.cs
@@ -14,6 +14,7 @@
 using Microsoft.Azure.Management.WebSites;
 using Microsoft.Azure.Management.WebSites.Models;
 using Microsoft.Azure.Management.Internal.Resources.Models;
+using System.Collections.Generic;
 
 namespace Microsoft.Azure.Commands.Common.Strategies.WebApps
 {
@@ -28,16 +29,17 @@ static class SiteStrategy
             compulsoryLocation: true);
 
         public static ResourceConfig<Site> CreateSiteConfig(this ResourceConfig<ResourceGroup> resourceGroup,
-            ResourceConfig<AppServicePlan> plan, string siteName, SiteConfig siteConfig = null) =>
+            ResourceConfig<AppServicePlan> plan, string siteName, SiteConfig siteConfig = null, IDictionary<string, string> tags=null) =>
             Strategy.CreateResourceConfig(
                 resourceGroup,
                 siteName,
                 createModel: engine =>
-                    new Site(location: null, name: siteName)
+                    new Site(location: null, name: siteName, tags:tags)
                     {
                         //Name = siteName,
                         SiteConfig = siteConfig,
-                        ServerFarmId = engine.GetId(plan)
+                        ServerFarmId = engine.GetId(plan),
+                        Tags = tags
                     });
     }
 }
diff --git a/src/Websites/Websites/Utilities/WebsitesClient.cs b/src/Websites/Websites/Utilities/WebsitesClient.cs
@@ -53,7 +53,7 @@ public WebSiteManagementClient WrappedWebsitesClient
             private set;
         }
 
-        public Site CreateWebApp(string resourceGroupName, string webAppName, string slotName, string location, string serverFarmId, CloningInfo cloningInfo, string aseName, string aseResourceGroupName)
+        public Site CreateWebApp(string resourceGroupName, string webAppName, string slotName, string location, string serverFarmId, CloningInfo cloningInfo, string aseName, string aseResourceGroupName, IDictionary<string, string> tags = null)
         {
             Site createdWebSite = null;
             string qualifiedSiteName;
@@ -68,7 +68,8 @@ public Site CreateWebApp(string resourceGroupName, string webAppName, string slo
                             Location = location,
                             ServerFarmId = serverFarmId,
                             CloningInfo = cloningInfo,
-                            HostingEnvironmentProfile = profile
+                            HostingEnvironmentProfile = profile,
+                            Tags = tags
                         });
             }
             else
@@ -80,7 +81,8 @@ public Site CreateWebApp(string resourceGroupName, string webAppName, string slo
                             Location = location,
                             ServerFarmId = serverFarmId,
                             CloningInfo = cloningInfo,
-                            HostingEnvironmentProfile = profile
+                            HostingEnvironmentProfile = profile,
+                            Tags = tags
                         });
             }
 
diff --git a/src/Websites/Websites/help/New-AzWebApp.md b/src/Websites/Websites/help/New-AzWebApp.md
@@ -17,7 +17,7 @@ Creates an Azure Web App.
 ```
 New-AzWebApp [[-ResourceGroupName] <String>] [-Name] <String> [[-Location] <String>]
  [[-AppServicePlan] <String>] [-ContainerImageName <String>] [-EnableContainerContinuousDeployment] [-AsJob]
- [-GitRepositoryPath <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
+ [-GitRepositoryPath <String>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
@@ -378,6 +378,21 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -Tag
+Tags are name/value pairs that enable you to categorize resources
+
+```yaml
+Type: System.Collections.Hashtable
+Parameter Sets: S1
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -TrafficManagerProfile
 Resource Id of existing traffic manager profile
 
diff --git a/src/Websites/Websites/help/New-AzWebAppSlot.md b/src/Websites/Websites/help/New-AzWebAppSlot.md
@@ -19,7 +19,7 @@ New-AzWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String
  [[-AppSettingsOverrides] <Hashtable>] [[-AseName] <String>] [[-AseResourceGroupName] <String>]
  [-ContainerImageName <String>] [-ContainerRegistryUrl <String>] [-ContainerRegistryUser <String>]
  [-ContainerRegistryPassword <SecureString>] [-EnableContainerContinuousDeployment] [-AsJob]
- [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
+ [-DefaultProfile <IAzureContextContainer>] [-Tag <Hashtable>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -295,6 +295,21 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -Tag
+Tags are name/value pairs that enable you to categorize resources
+
+```yaml
+Type: System.Collections.Hashtable
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+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](http://go.microsoft.com/fwlink/?LinkID=113216).
 

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,10 @@ public class NewAzureWebAppSlotCmdlet : WebAppBaseClientCmdLet`
`98`	`98`
`99`	`99`
`100`	`100`	`[Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]`
`101`		`- public SwitchParameter AsJob { get; set; }`
	`101`	`+ public SwitchParameter AsJob { get; set; }`
	`102`	`+`
	`103`	`+ [Parameter(Mandatory = false, HelpMessage = "Tags are name/value pairs that enable you to categorize resources")]`
	`104`	`+ public Hashtable Tag { get; set; }`
`102`	`105`
`103`	`106`	`private Hashtable GetAppSettingsToUpdate()`
`104`	`107`	`{`
`@@ -181,7 +184,7 @@ public override void ExecuteCmdlet()`
`181`	`184`	`}`
`182`	`185`
`183`	`186`	`var webApp = new PSSite(WebsitesClient.GetWebApp(ResourceGroupName, Name, null));`
`184`		`- var site = new PSSite(WebsitesClient.CreateWebApp(ResourceGroupName, Name, Slot, webApp.Location, AppServicePlan==null?webApp.ServerFarmId : AppServicePlan, cloningInfo, AseName, AseResourceGroupName));`
	`187`	`+ var site = new PSSite(WebsitesClient.CreateWebApp(ResourceGroupName, Name, Slot, webApp.Location, AppServicePlan==null?webApp.ServerFarmId : AppServicePlan, cloningInfo, AseName, AseResourceGroupName, (IDictionary<string, string>)CmdletHelpers.ConvertToStringDictionary(Tag)));`
`185`	`188`	`UpdateConfigIfNeeded(site);`
`186`	`189`	`}`
`187`	`190`	`}`
Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,9 @@ public class NewAzureWebAppCmdlet : WebAppBaseClientCmdLet`
`137`	`137`	`[Parameter(Mandatory = false, HelpMessage = "Path to the GitHub repository containign the web application to deploy.", ParameterSetName = SimpleParameterSet)]`
`138`	`138`	`public string GitRepositoryPath { get; set; }`
`139`	`139`
	`140`	`+ [Parameter(Mandatory = false, HelpMessage = "Tags are name/value pairs that enable you to categorize resources", ParameterSetName = SimpleParameterSet)]`
	`141`	`+ public Hashtable Tag { get; set; }`
	`142`	`+`
`140`	`143`	`protected override void ProcessRecord()`
`141`	`144`	`{`
`142`	`145`	`try`
`@@ -386,7 +389,8 @@ public async Task<ResourceConfig<Site>> CreateConfigAsync()`
`386`	`389`	`// If ContainerImageName is specified and appservice plan doesn’t exist (appServiceplan == null) we will try to create plan with windows container`
`387`	`390`	`var farmStrategy = planRG.CreateServerFarmConfig(planResourceGroup, planName, appServiceplan == null && _cmdlet.ContainerImageName != null);`
`388`	`391`
`389`		`- return rgStrategy.CreateSiteConfig(farmStrategy, _cmdlet.Name, this.GetNewConfig(appServiceplan));`
	`392`	`+ return rgStrategy.CreateSiteConfig(farmStrategy, _cmdlet.Name, this.GetNewConfig(appServiceplan)`
	`393`	`+ , (IDictionary<string, string>)CmdletHelpers.ConvertToStringDictionary(_cmdlet.Tag));`
`390`	`394`	`}`
`391`	`395`	`}`
`392`	`396`