Add hyperscale elastic pool read scale (#17744)

* Added support for HS EP read scale units

* Added tests for update and create EP with replica count

* Fixed bug in updating replica count for HS EP

* Added aditional tests for HS EP read scale

* Added help files for add and set elastic pool cmlets

* Added session recordings for HS EP tests

* Updated ChangeLog.md with changes information

* Fixed default read scale value from 1 to null as in standalone

* Updated Session Records from tests

Co-authored-by: Christian Valencia <[email protected]>

Author: christianvalencia7

src/Sql/Sql.Test/ScenarioTests/ElasticPoolCrudTests.cs

@@ -66,6 +66,20 @@ public void TestElasticPoolCreateWithMaintenanceConfigurationId()
             RunPowerShellTest("Test-CreateElasticPoolWithMaintenanceConfigurationId");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestHyperscaleElasticPoolCreate()
+        {
+            RunPowerShellTest("Test-CreateHyperscaleElasticPool");
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestHyperscaleElasticPoolCreateWithReplica()
+        {
+            RunPowerShellTest("Test-CreateHyperscaleElasticPoolWithReplica");
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestElasticPoolUpdate()
@@ -101,6 +115,20 @@ public void TestElasticPoolUpdateWithMaintenanceConfigurationId()
             RunPowerShellTest("Test-UpdateElasticPoolWithMaintenanceConfigurationId");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestHyperscaleElasticPoolUpdateReplicaCount()
+        {
+            RunPowerShellTest("Test-UpdateHyperscaleElasticPoolReplicaCount");
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestMoveDatabaseOutHyperscaleElasticPool()
+        {
+            RunPowerShellTest("Test-MoveDatabaseOutHyperscaleElasticPool");
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestElasticPoolGet()
@@ -122,6 +150,13 @@ public void TestElasticPoolGetWithMaintenanceConfigurationId()
             RunPowerShellTest("Test-GetElasticPoolWithMaintenanceConfigurationId");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestHyperscaleElasticPoolGet()
+        {
+            RunPowerShellTest("Test-GetHyperscaleElasticPool");
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestElasticPoolRemove()

src/Sql/Sql.Test/ScenarioTests/ElasticPoolCrudTests.ps1

@@ -217,6 +217,67 @@ function Test-CreateElasticPoolWithMaintenanceConfigurationId
 	}
 }
 
+<#
+	.SYNOPSIS
+	Tests creating a Hyperscale elastic pool
+#>
+function Test-CreateHyperscaleElasticPool
+{
+	# Setup
+	$location = "north europe"
+	$rg = "PowershellTestsNE"
+	$server = "hs-ep-powershelltests"
+
+	try
+	{
+		## Create Hyperscale pool with 2 high availability replicas
+		$poolName = Get-ElasticPoolName
+		$job = New-AzSqlElasticPool -ServerName $server -ResourceGroupName $rg `
+				-ElasticPoolName $poolName -VCore 4 -Edition Hyperscale -ComputeGeneration Gen5 -AsJob
+		$job | Wait-Job
+		$ep1 = $job.Output
+
+		Assert-NotNull $ep1
+		Assert-AreEqual Hyperscale $ep1.Edition
+		Assert-AreEqual 4 $ep1.Capacity
+		Assert-AreEqual 1 $ep1.HighAvailabilityReplicaCount #Default number of high availability replicas
+	}
+	finally
+	{
+		Remove-AzSqlElasticPool -ElasticPoolName $poolName -ResourceGroupName $rg -ServerName $server
+	}
+}
+
+<#
+	.SYNOPSIS
+	Tests creating a Hyperscale elastic pool with 2 high availability replicas
+#>
+function Test-CreateHyperscaleElasticPoolWithReplica
+{
+	# Setup
+	$location = "north europe"
+	$rg = "PowershellTestsNE"
+	$server = "hs-ep-powershelltests"
+
+	try
+	{
+		## Create Hyperscale pool with 2 high availability replicas
+		$poolName = Get-ElasticPoolName
+		$job = New-AzSqlElasticPool -ServerName $server -ResourceGroupName $rg `
+				-ElasticPoolName $poolName -VCore 4 -Edition Hyperscale -ComputeGeneration Gen5 -HighAvailabilityReplicaCount 2 -AsJob
+		$job | Wait-Job
+		$ep1 = $job.Output
+
+		Assert-NotNull $ep1
+		Assert-AreEqual Hyperscale $ep1.Edition
+		Assert-AreEqual 2 $ep1.HighAvailabilityReplicaCount
+	}
+	finally
+	{
+		Remove-AzSqlElasticPool -ElasticPoolName $poolName -ResourceGroupName $rg -ServerName $server
+	}
+}
+
 <#
 	.SYNOPSIS
 	Tests updating an elastic pool
@@ -445,6 +506,89 @@ function Test-UpdateElasticPoolWithMaintenanceConfigurationId
 	}
 }
 
+<#
+	.SYNOPSIS
+	Tests updating a Hyperscale elastic pool's number of high availability replicas
+#>
+function Test-UpdateHyperscaleElasticPoolReplicaCount
+{
+	# Setup
+	$location = "north europe"
+	$rg = "PowershellTestsNE"
+	$server = "hs-ep-powershelltests"
+
+	try
+	{
+		# Create elastic pool without specifying HighAvailabilityReplicaCount
+		$poolName = Get-ElasticPoolName
+		$ep1 = New-AzSqlElasticPool -ServerName $server -ResourceGroupName $rg `
+				-ElasticPoolName $poolName -VCore 4 -Edition Hyperscale -ComputeGeneration Gen5
+
+		Assert-NotNull $ep1
+		Assert-AreEqual Hyperscale $ep1.Edition
+		Assert-AreEqual 4 $ep1.Capacity
+		Assert-AreEqual 1 $ep1.HighAvailabilityReplicaCount
+
+		# Alter pool's HighAvailabilityReplicaCount
+		$sep1 = Set-AzSqlElasticPool -ResourceGroupName $ep1.ResourceGroupName -ServerName $ep1.ServerName -ElasticPoolName $ep1.ElasticPoolName `
+			-HighAvailabilityReplicaCount 2
+
+		Assert-AreEqual $sep1.ElasticPoolName $poolName
+		Assert-AreEqual Hyperscale $sep1.Edition
+		Assert-AreEqual 4 $sep1.Capacity
+		Assert-AreEqual 2 $sep1.HighAvailabilityReplicaCount
+	}
+	finally
+	{
+		Remove-AzSqlElasticPool -ElasticPoolName $poolName -ResourceGroupName $rg -ServerName $server
+	}
+}
+
+<#
+	.SYNOPSIS
+	Tests moving a database out of a Hyperscale elastic pool
+#>
+function Test-MoveDatabaseOutHyperscaleElasticPool
+{
+	# Setup
+	$location = "north europe"
+	$rg = "PowershellTestsNE"
+	$server = "hs-ep-powershelltests"
+
+	try
+	{
+		# Create Hyperscale elastic pool 
+		$poolName = Get-ElasticPoolName
+		$ep1 = New-AzSqlElasticPool -ServerName $server -ResourceGroupName $rg `
+				-ElasticPoolName $poolName -VCore 4 -Edition Hyperscale -ComputeGeneration Gen5 -HighAvailabilityReplicaCount 2
+
+		Assert-NotNull $ep1
+		Assert-AreEqual Hyperscale $ep1.Edition
+		Assert-AreEqual 4 $ep1.Capacity
+		Assert-AreEqual 2 $ep1.HighAvailabilityReplicaCount
+
+		# Create database inside pool
+		$databaseName = Get-DatabaseName
+		$db = New-AzSqlDatabase -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName -ElasticPoolName $poolName
+
+		Assert-NotNull $db
+		Assert-AreEqual Hyperscale $db.Edition
+		Assert-AreEqual 2 $db.HighAvailabilityReplicaCount
+
+		#Move database out of elastic pool
+		$db = Set-AzSqlDatabase -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName -Edition "Hyperscale" -Vcore 4 -ComputeGeneration "Gen5"
+		Assert-NotNull $db
+		Assert-AreEqual Hyperscale $db.Edition
+		Assert-AreEqual 4 $db.Capacity
+		Assert-AreEqual 2 $db.HighAvailabilityReplicaCount
+	}
+	finally
+	{
+		Remove-AzSqlDatabase -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName
+		Remove-AzSqlElasticPool -ElasticPoolName $poolName -ResourceGroupName $rg -ServerName $server
+	}
+}
+
 <#
 	.SYNOPSIS
 	Tests getting an elastic pool
@@ -577,6 +721,38 @@ function Test-GetElasticPoolWithMaintenanceConfigurationId
 	}
 }
 
+<#
+	.SYNOPSIS
+	Tests getting a hyperscale elastic pool
+#>
+function Test-GetHyperscaleElasticPool
+{
+	# Setup
+	$location = "north europe"
+	$rg = "PowershellTestsNE"
+	$server = "hs-ep-powershelltests"
+
+	try
+	{
+		# Create Hyperscale elastic pool 
+		$poolName = Get-ElasticPoolName
+		New-AzSqlElasticPool -ServerName $server -ResourceGroupName $rg `
+				-ElasticPoolName $poolName -VCore 4 -Edition Hyperscale -ComputeGeneration Gen5 -HighAvailabilityReplicaCount 2
+		
+		# Get Hyperscale elastic pool
+		$ep1 = Get-AzSqlElasticPool  -ServerName $server -ResourceGroupName $rg -ElasticPoolName $poolName
+
+		Assert-NotNull $ep1
+		Assert-AreEqual Hyperscale $ep1.Edition
+		Assert-AreEqual 4 $ep1.Capacity
+		Assert-AreEqual 2 $ep1.HighAvailabilityReplicaCount
+	}
+	finally
+	{
+		Remove-AzSqlElasticPool -ElasticPoolName $poolName -ResourceGroupName $rg -ServerName $server
+	}
+}
+
 <#
 	.SYNOPSIS
 	Tests removing an elastic pool