Add -AsJob to Remove-AzSqlInstande and -SubnetId to Set-AzSqlInstance (#15578)

* Iteration 1:
- Add -AsJob parameter to the Remove-AzSqlInstance
- Add the -SubnetId parameter to support the X-subnet update SLO
- Updated tests to validate these two changes
- Added new recordings
- Updated TestSetManagedInstance test to use the new environment, recorded it and removed the skip flag
- Updated TestCreateUpdateManagedInstanceWithMinimalTlsVersion test to use the new environment, recorded it and removed the skip flag

* Iteration 2:
- Updated ChangeLog.md file

* Iteration 3:
- Updated help markdown for the new parameter in Remove-AzSqlInstance

* Iteration 5:
- Generated Remote-AzSqlInstance.md uring platyPS

* Iteration 6:
Updated -SubnetId help message and help markdown file.

Co-authored-by: Nemanja <[email protected]>

Author: v-nestan

src/Sql/Sql.Test/ScenarioTests/Common.ps1

@@ -961,16 +961,27 @@ function Get-DNSNameBasedOnEnvironment ()
 	.SYNOPSIS
 	Creates the test environment needed to perform the Sql managed instance CRUD tests
 #>
-function Create-ManagedInstanceForTest ($resourceGroup, $subnetId)
+function Create-ManagedInstanceForTest ($resourceGroup, $subnetId, $vCore)
 {
 	$managedInstanceName = Get-ManagedInstanceName
 	$credentials = Get-ServerCredential
- 	$vCore = 16
+	if($vCore -eq $null)
+	{
+		$vCore = 16
+	}
+
  	$skuName = "GP_Gen5"
 
 	$managedInstance = New-AzSqlInstance -ResourceGroupName $resourceGroup.ResourceGroupName -Name $managedInstanceName `
  			-Location $resourceGroup.Location -AdministratorCredential $credentials -SubnetId $subnetId `
-  			-Vcore $vCore -SkuName $skuName -AssignIdentity
+ 			-Vcore $vCore -SkuName $skuName -AssignIdentity
+
+	# The previous command keeps polling until managed instance becomes ready. However, it can happen that the managed instance
+	# becomes ready but the create operation is still in progress. Because of that, we should wait until the operation is completed.
+	if([Microsoft.Azure.Test.HttpRecorder.HttpMockServer]::Mode -eq "Record"){
+		Start-Sleep -s 30
+	}
+
 
 	return $managedInstance
 }
@@ -1029,14 +1040,14 @@ function Get-InstancePoolTestProperties()
     $instancePoolTestProperties = @{
         resourceGroup = "ps3995"
         name = "myinstancepool1"
-        subnetName = "ManagedInsanceSubnet"
-        vnetName = "MIVirtualNetwork"
+        subnetName = "ManagedInstance"
+        vnetName = "vnet-portal-testing"
         tags = $tags
         computeGen = "Gen5"
         edition = "GeneralPurpose"
         location = "westeurope"
         licenseType = "LicenseIncluded"
-        vCores = 16
+        vCores = 4
     }
     return $instancePoolTestProperties
 }

src/Sql/Sql.Test/ScenarioTests/ManagedInstanceCrudScenarioTests.cs

@@ -43,7 +43,7 @@ public void TestCreateManagedInstance()
             RunPowerShellTest("Test-CreateManagedInstance");
         }
 
-        [Fact(Skip = "Skip due to long setup time for managed instance")]
+        [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestSetManagedInstance()
         {
@@ -71,7 +71,7 @@ public void TestCreateManagedInstanceWithIdentity()
             RunPowerShellTest("Test-CreateManagedInstanceWithIdentity");
         }
 
-        [Fact(Skip = "Skip due to bug in backend which is currently deploying")]
+        [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestCreateUpdateManagedInstanceWithMinimalTlsVersion()
         {

src/Sql/Sql.Test/ScenarioTests/ManagedInstanceCrudScenarioTests.ps1

@@ -112,14 +112,17 @@ function Test-SetManagedInstance
 {
 	# Setup
 	$rg = Create-ResourceGroupForTest "westeurope"
-	$vnetName = "vnet-pcresizeandcreate"
+	$vnetName = "vnet-portal-testing"
 	$subnetName = "ManagedInstance"
+	$targetSubnetResourceId = "/subscriptions/62e48210-5e43-423e-889b-c277f3e08c39/resourceGroups/portalrg/providers/Microsoft.Network/virtualNetworks/vnet-portal-testing/subnets/ManagedInstance2"
+	$vCore = 4
+	$vnetRgName = "portalrg"
 
 	# Setup VNET
-	$virtualNetwork1 = CreateAndGetVirtualNetworkForManagedInstance $vnetName $subnetName $rg.Location "toki"
+	$virtualNetwork1 = Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $vnetRgName
 	$subnetId = $virtualNetwork1.Subnets.where({ $_.Name -eq $subnetName })[0].Id
 
-	$managedInstance = Create-ManagedInstanceForTest $rg $subnetId
+	$managedInstance = Create-ManagedInstanceForTest $rg $subnetId $vCore
 
 	try
 	{
@@ -157,7 +160,7 @@ function Test-SetManagedInstance
 		# Test Set using InputObject
 		$credentials = Get-ServerCredential
 		$licenseType = "BasePrice"
-		$storageSizeInGB = 64
+		$storageSizeInGB = 128
 
 		$managedInstance3 = Set-AzSqlInstance -InputObject $managedInstance `
 			-AdministratorPassword $credentials.Password -LicenseType $licenseType -StorageSizeInGB $storageSizeInGB -Force
@@ -172,7 +175,7 @@ function Test-SetManagedInstance
 		# Test Set using ResourceId
 		$credentials = Get-ServerCredential
 		$licenseType = "BasePrice"
-		$storageSizeInGB = 32
+		$storageSizeInGB = 256
 		$publicDataEndpointEnabled = $true
 		$proxyOverride = "Proxy"
 
@@ -191,10 +194,8 @@ function Test-SetManagedInstance
 		# Test edition change using Edition
 		$credentials = Get-ServerCredential
 		$edition = "BusinessCritical"
-		$vCore = 16
 
-		$managedInstance6 = Set-AzSqlInstance -ResourceGroupName $rg.ResourceGroupName -Name $managedInstance.ManagedInstanceName -Vcore $vCore `
-			-Edition $edition -Force
+		$managedInstance6 = Set-AzSqlInstance -ResourceGroupName $rg.ResourceGroupName -Name $managedInstance.ManagedInstanceName -Edition $edition -Force
 
 		Assert-AreEqual $managedInstance6.ManagedInstanceName $managedInstance.ManagedInstanceName
 		Assert-AreEqual $managedInstance6.AdministratorLogin $managedInstance4.AdministratorLogin
@@ -203,6 +204,17 @@ function Test-SetManagedInstance
 		Assert-AreEqual $managedInstance6.Sku.Tier $edition
 		Assert-AreEqual $managedInstance6.Sku.Family $managedInstance4.Sku.Family
 		Assert-StartsWith ($managedInstance6.ManagedInstanceName + ".") $managedInstance6.FullyQualifiedDomainName
+
+		# Test cross-subnet update SLO. Since the feature is still not rolled-out, the operation should fail.
+		try
+		{
+			Set-AzSqlInstance -Name $managedInstance.ManagedInstanceName -ResourceGroupName $rg.ResourceGroupName -SubnetId $targetSubnetResourceId -Force
+		}
+		catch
+		{
+			$ErrorMessage = $_.Exception.Message
+			Assert-AreEqual True $ErrorMessage.Contains("Long running operation failed with status 'Failed'. Additional Info:'Subnet resource ID '"+$targetSubnetResourceId+"' is invalid. Please provide a correct resource Id for the target subnet.'")
+		}
 	}
 	finally
 	{
@@ -270,31 +282,41 @@ function Test-RemoveManagedInstance
 {
 	# Setup
 	$rg = Create-ResourceGroupForTest "westeurope"
-	$vnetName = "MIVirtualNetwork"
-	$subnetName = "ManagedInsanceSubnet"
+	$vnetRgName = "portalrg"
+	$vnetName = "vnet-portal-testing"
+	$subnetName = "ManagedInstance"
+	$vCore = 4
 
 	# Setup VNET
-	$virtualNetwork1 = CreateAndGetVirtualNetworkForManagedInstance $vnetName $subnetName $rg.Location "v-urmila"
+	$virtualNetwork1 = Get-AzVirtualNetwork -Name $vnetName -ResourceGroupName $vnetRgName
 	$subnetId = $virtualNetwork1.Subnets.where({ $_.Name -eq $subnetName })[0].Id
 
 	try
 	{
 		# Test using parameters
-		$managedInstance1 = Create-ManagedInstanceForTest $rg $subnetId
+		$managedInstance1 = Create-ManagedInstanceForTest $rg $subnetId $vCore
 		Remove-AzSqlInstance -ResourceGroupName $rg.ResourceGroupName -Name $managedInstance1.ManagedInstanceName -Force
-
+		
 		# Test using InputObject
-		$managedInstance2 = Create-ManagedInstanceForTest $rg $subnetId
+		$managedInstance2 = Create-ManagedInstanceForTest $rg $subnetId $vCore
 		Remove-AzSqlInstance -InputObject $managedInstance2 -Force
 
 		# Test using ResourceId
-		$managedInstance3 = Create-ManagedInstanceForTest $rg $subnetId
+		$managedInstance3 = Create-ManagedInstanceForTest $rg $subnetId $vCore
 		Remove-AzSqlInstance -ResourceId $managedInstance3.Id -Force
 
 		# Test piping
-		$managedInstance4 = Create-ManagedInstanceForTest $rg $subnetId
+		$managedInstance4 = Create-ManagedInstanceForTest $rg $subnetId $vCore
 		$managedInstance4 | Remove-AzSqlInstance -Force
 
+		# Test -AsJob
+		$managedInstance5 = Create-ManagedInstanceForTest $rg $subnetId $vCore
+		$job = Remove-AzSqlInstance -ResourceGroupName $rg.ResourceGroupName -Name $managedInstance5.ManagedInstanceName -Force -AsJob
+		$job | Wait-Job
+
+		Assert-AreEqual "Completed" $job.State
+		Assert-AreEqual "Remove-AzSqlInstance" $job.Command
+
 		$all = Get-AzSqlInstance -ResourceGroupName $rg.ResourceGroupName
 		Assert-AreEqual $all.Count 0
 	}
@@ -352,10 +374,10 @@ function Test-CreateManagedInstanceWithIdentity
 function Test-CreateUpdateManagedInstanceWithMinimalTlsVersion
 {
 	# Setup
-	$location = "eastus2euap"
-	$rgName = "DejanDuVnetRG"
-	$subnetId = "/subscriptions/a8c9a924-06c0-4bde-9788-e7b1370969e1/resourceGroups/AndyPG/providers/Microsoft.Network/virtualNetworks/prepare-cl-nimilj/subnets/default"
-	$managedInstanceName = "ps123"
+	$rg = Create-ResourceGroupForTest
+	$location = "westeurope"
+	$subnetId = "/subscriptions/62e48210-5e43-423e-889b-c277f3e08c39/resourceGroups/portalrg/providers/Microsoft.Network/virtualNetworks/vnet-portal-testing/subnets/ManagedInstance"
+	$managedInstanceName = Get-ManagedInstanceName
  	$version = "12.0"
  	$credentials = Get-ServerCredential
  	$licenseType = "BasePrice"
@@ -371,7 +393,7 @@ function Test-CreateUpdateManagedInstanceWithMinimalTlsVersion
  	try
  	{
  		# With SKU name specified
- 		$job = New-AzSqlInstance -ResourceGroupName $rgName -Name $managedInstanceName `
+ 		$job = New-AzSqlInstance -ResourceGroupName $rg.ResourceGroupName -Name $managedInstanceName `
  			-Location $location -AdministratorCredential $credentials -SubnetId $subnetId `
   			-LicenseType $licenseType -StorageSizeInGB $storageSizeInGB -Vcore $vCore -SkuName $skuName -Collation $collation `
 			-TimezoneId $timezoneId -PublicDataEndpointEnabled -ProxyOverride $proxyOverride -MinimalTlsVersion $tls1_2 -AsJob
@@ -381,13 +403,19 @@ function Test-CreateUpdateManagedInstanceWithMinimalTlsVersion
  		Assert-AreEqual $managedInstance1.ManagedInstanceName $managedInstanceName
 		Assert-AreEqual $managedInstance1.MinimalTlsVersion $tls1_2
 
-		$managedInstance2 = Set-AzSqlInstance -MinimalTlsVersion $tls1_1 -ResourceGroupName $rgName -Name "ps123" -Force
+		# Wait until create managed instance operation is completed.
+		if([Microsoft.Azure.Test.HttpRecorder.HttpMockServer]::Mode -eq "Record"){
+			Start-Sleep -s 30
+		}
+
+		$managedInstance2 = Set-AzSqlInstance -MinimalTlsVersion $tls1_1 -ResourceGroupName $rg.ResourceGroupName -Name $managedInstanceName -Force
 
 		Assert-AreEqual $managedInstance2.MinimalTlsVersion $tls1_1
 	}
 	finally
 	{
-		Remove-AzSqlInstance -ResourceGroupName $rgName -Name $managedInstanceName -Force
+		Remove-AzSqlInstance -ResourceGroupName $rg.ResourceGroupName -Name $managedInstanceName -Force
+		Remove-ResourceGroupForTest $rg
 	}
 }