Add database readscale related properties support (#13549)

* rename db property and update tests

* add secondaryType property

* Update help files

* update change log

* Add back ReadReplicaCount

* Add back ReadReplicaCount to the model

* Make ReadReplicaCount an alias

* Add ReadReplicaCount back to model

Author: bradrich-msft

src/Sql/Sql.Test/ScenarioTests/DatabaseBackupTests.ps1

@@ -30,7 +30,7 @@ function Test-ListDatabaseRestorePoints
 		# Create data warehouse database with all parameters.
 		$databaseName = Get-DatabaseName
 		$dwdb = New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName `
-			-Edition DataWarehouse -RequestedServiceObjectiveName DW100
+			-Edition DataWarehouse -RequestedServiceObjectiveName DW100c
 
 		$databaseName = Get-DatabaseName
 		$standarddb = New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName `

src/Sql/Sql.Test/ScenarioTests/DatabaseCrudTests.ps1

@@ -59,7 +59,7 @@ function Test-CreateDatabaseInternal ($location = "westcentralus")
 		$collationName = "SQL_Latin1_General_CP1_CI_AS"
 		$maxSizeBytes = 250GB
 		$job2 = New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName `
-				-CollationName $collationName -MaxSizeBytes $maxSizeBytes -Edition DataWarehouse -RequestedServiceObjectiveName DW100 -AsJob
+				-CollationName $collationName -MaxSizeBytes $maxSizeBytes -Edition DataWarehouse -RequestedServiceObjectiveName DW100c -AsJob
 		$job2 | Wait-Job
 		$dwdb  = $job2.Output
 
@@ -68,7 +68,7 @@ function Test-CreateDatabaseInternal ($location = "westcentralus")
 		Assert-AreEqual $dwdb.DatabaseName $databaseName
 		Assert-AreEqual $dwdb.MaxSizeBytes $maxSizeBytes
 		Assert-AreEqual $dwdb.Edition DataWarehouse
-		Assert-AreEqual $dwdb.CurrentServiceObjectiveName DW100
+		Assert-AreEqual $dwdb.CurrentServiceObjectiveName DW100c
 		Assert-AreEqual $dwdb.CollationName $collationName
 
 		Write-Debug "Create with all parameters"
@@ -391,17 +391,17 @@ function Test-UpdateDatabaseInternal ($location = "southeastasia")
 		$collationName = "SQL_Latin1_General_CP1_CI_AS"
 		$maxSizeBytes = 250GB
 		$dwdb = New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName `
-		-CollationName $collationName -MaxSizeBytes $maxSizeBytes -Edition DataWarehouse -RequestedServiceObjectiveName DW100 -Force
+		-CollationName $collationName -MaxSizeBytes $maxSizeBytes -Edition DataWarehouse -RequestedServiceObjectiveName DW100c -Force
 
 		$job = Set-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $dwdb.DatabaseName `
-				-MaxSizeBytes $maxSizeBytes -RequestedServiceObjectiveName DW200 -Edition DataWarehouse -AsJob
+				-MaxSizeBytes $maxSizeBytes -RequestedServiceObjectiveName DW200c -Edition DataWarehouse -AsJob
 		$job | Wait-Job
 		$dwdb2 = $job.Output
 
 		Assert-AreEqual $dwdb2.DatabaseName $dwdb.DatabaseName
 		Assert-AreEqual $dwdb2.MaxSizeBytes $maxSizeBytes
 		Assert-AreEqual $dwdb2.Edition DataWarehouse
-		Assert-AreEqual $dwdb2.CurrentServiceObjectiveName DW200
+		Assert-AreEqual $dwdb2.CurrentServiceObjectiveName DW200c
 		Assert-AreEqual $dwdb2.CollationName $collationName
 	}
 	finally
@@ -759,7 +759,7 @@ function Test-GetDatabaseInternal  ($location = "westcentralus")
 		# Create data warehouse database.
 		$databaseName = Get-DatabaseName
 		$dwdb = New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName `
-				-CollationName SQL_Latin1_General_CP1_CI_AS -MaxSizeBytes 250GB -Edition DataWarehouse -RequestedServiceObjectiveName DW100
+				-CollationName SQL_Latin1_General_CP1_CI_AS -MaxSizeBytes 250GB -Edition DataWarehouse -RequestedServiceObjectiveName DW100c
 		$dwdb2 = Get-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupname -ServerName $server.ServerName -DatabaseName $dwdb.DatabaseName 
 		Assert-AreEqual $dwdb2.DatabaseName $dwdb.DatabaseName
 		Assert-AreEqual $dwdb2.MaxSizeBytes $dwdb.MaxSizeBytes
@@ -885,7 +885,7 @@ function Test-RemoveDatabaseInternal  ($location = "westcentralus")
 		# Create data warehouse database
 		$databaseName = Get-DatabaseName
 		$dwdb = New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName `
-			-CollationName "SQL_Latin1_General_CP1_CI_AS" -MaxSizeBytes 250GB -Edition DataWarehouse -RequestedServiceObjectiveName DW100 -Force
+			-CollationName "SQL_Latin1_General_CP1_CI_AS" -MaxSizeBytes 250GB -Edition DataWarehouse -RequestedServiceObjectiveName DW100c -Force
 		Assert-AreEqual $dwdb.DatabaseName $databaseName
 
 		Remove-AzSqlDatabase -ResourceGroupName $server.ResourceGroupname -ServerName $server.ServerName -DatabaseName $dwdb.DatabaseName -Force

src/Sql/Sql.Test/ScenarioTests/DatabaseReplicationTests.ps1

@@ -166,29 +166,40 @@ function Test-CreateNamedSecondaryDatabase()
 	$rg = Create-ResourceGroupForTest $location
 	$server = Create-ServerForTest $rg $location
 	$database = Create-DatabaseForTest $rg $server
+	$hsDatabase = Create-HyperscaleDatabaseForTest $rg $server
 
 	$partRg = Create-ResourceGroupForTest $location
 	$partServer = Create-ServerForTest $partRg $location
 
 	try
 	{
-		# Create Named Readable Secondary
-		$readSecondary = New-AzSqlDatabaseSecondary -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $database.DatabaseName `
-		 -PartnerResourceGroupName $partRg.ResourceGroupName -PartnerServerName $partServer.ServerName -PartnerDatabaseName "secondary" -AllowConnections All
-		Assert-NotNull $readSecondary.LinkId
-		Assert-AreEqual $readSecondary.ResourceGroupName $rg.ResourceGroupName
-		Assert-AreEqual $readSecondary.ServerName $server.ServerName
-		Assert-AreEqual $readSecondary.DatabaseName $database.DatabaseName
-		Assert-AreEqual $readSecondary.Role "Primary"
-		Assert-AreEqual $readSecondary.Location $location
-		Assert-AreEqual $readSecondary.PartnerResourceGroupName $partRg.ResourceGroupName
-		Assert-AreEqual $readSecondary.PartnerServerName $partServer.ServerName
-		Assert-AreEqual $readSecondary.PartnerDatabaseName "secondary"
-		Assert-NotNull $readSecondary.PartnerRole
-		Assert-AreEqual $readSecondary.PartnerLocation $location
-		Assert-NotNull $readSecondary.AllowConnections
-		Assert-NotNull $readSecondary.ReplicationState
-		Assert-NotNull $readSecondary.PercentComplete
+		# Create Geo Secondary
+		$geoSecondary = New-AzSqlDatabaseSecondary -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $database.DatabaseName `
+		 -PartnerResourceGroupName $partRg.ResourceGroupName -PartnerServerName $partServer.ServerName -PartnerDatabaseName "secondary" -AllowConnections All -SecondaryType "Geo"
+		Assert-NotNull $geoSecondary.LinkId
+		Assert-AreEqual $geoSecondary.ResourceGroupName $rg.ResourceGroupName
+		Assert-AreEqual $geoSecondary.ServerName $server.ServerName
+		Assert-AreEqual $geoSecondary.DatabaseName $database.DatabaseName
+		Assert-AreEqual $geoSecondary.Role "Primary"
+		Assert-AreEqual $geoSecondary.Location $location
+		Assert-AreEqual $geoSecondary.PartnerResourceGroupName $partRg.ResourceGroupName
+		Assert-AreEqual $geoSecondary.PartnerServerName $partServer.ServerName
+		Assert-AreEqual $geoSecondary.PartnerDatabaseName "secondary"
+		Assert-NotNull $geoSecondary.PartnerRole
+		Assert-AreEqual $geoSecondary.PartnerLocation $location
+		Assert-NotNull $geoSecondary.AllowConnections
+		Assert-NotNull $geoSecondary.ReplicationState
+		Assert-NotNull $geoSecondary.PercentComplete
+
+		$newDb = Get-AzSqlDatabase -ResourceGroupName $partRg.ResourceGroupName -ServerName $partServer.ServerName -DatabaseName "secondary"
+		Assert-AreEqual "Geo" $newDb.SecondaryType
+
+		# Create Named Replica
+		$namedReplica = New-AzSqlDatabaseSecondary -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $hsDatabase.DatabaseName `
+		 -PartnerResourceGroupName $rg.ResourceGroupName -PartnerServerName $server.ServerName -PartnerDatabaseName "secondary" -SecondaryType "Named"
+
+		$newDb = Get-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName "secondary"
+		Assert-AreEqual "Named" $newDb.SecondaryType
 	}
 	finally
 	{
@@ -360,6 +371,16 @@ function Create-VcoreDatabaseForTest  ($rg, $server, $numCores = 2, $licenseType
 	New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName -VCore $numCores -ComputeGeneration Gen5 -Edition GeneralPurpose -LicenseType $licenseType
 }
 
+<#
+	.SYNOPSIS
+	Creates test database
+#>
+function Create-HyperscaleDatabaseForTest  ($rg, $server, $numCores = 2, $licenseType = "LicenseIncluded")
+{
+	$databaseName = Get-DatabaseName
+	New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName -VCore $numCores -ComputeGeneration Gen5 -Edition Hyperscale -LicenseType $licenseType
+}
+
 <#
 	.SYNOPSIS
 	Creates test database with BackupStorageRedundancy

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

@@ -67,15 +67,15 @@ function Test-CreateVcoreElasticPool
 		## Create Vcore based pool with all VcorePoolParameterSet
 		$poolName = Get-ElasticPoolName
 		$job = New-AzSqlElasticPool -ServerName $server.ServerName -ResourceGroupName $rg.ResourceGroupName `
-				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen4  -DatabaseVCoreMin 0.1 -DatabaseVCoreMax 2 -AsJob
+				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen5 -DatabaseVCoreMin 0.25 -DatabaseVCoreMax 2 -AsJob
 		$job | Wait-Job
 		$ep1 = $job.Output
 
 		Assert-NotNull $ep1
-		Assert-AreEqual GP_Gen4 $ep1.SkuName
+		Assert-AreEqual GP_Gen5 $ep1.SkuName
 		Assert-AreEqual GeneralPurpose $ep1.Edition
 		Assert-AreEqual 2 $ep1.Capacity
-		Assert-AreEqual 0.1 $ep1.DatabaseCapacityMin
+		Assert-AreEqual 0.25 $ep1.DatabaseCapacityMin
 		Assert-AreEqual 2.0 $ep1.DatabaseCapacityMax
 
 		# Create BC_Gen4_1 elastic pool which is not supported and check the error Message
@@ -106,23 +106,23 @@ function Test-CreateVcoreElasticPoolWithLicenseType
 		## Create default Vcore based pool
 		$poolName = Get-ElasticPoolName
 		$ep1 = New-AzSqlElasticPool -ServerName $server.ServerName -ResourceGroupName $rg.ResourceGroupName `
-				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen4  -DatabaseVCoreMin 0.1 -DatabaseVCoreMax 2
+				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen5  -DatabaseVCoreMin 0.25 -DatabaseVCoreMax 2
 
 		Assert-NotNull $ep1
 		Assert-AreEqual LicenseIncluded $ep1.LicenseType # default license type
 
 		## Create Vcore based pool with BasePrice license type
 		$poolName = Get-ElasticPoolName
 		$ep2 = New-AzSqlElasticPool -ServerName $server.ServerName -ResourceGroupName $rg.ResourceGroupName `
-				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen4  -DatabaseVCoreMin 0.1 -DatabaseVCoreMax 2 -LicenseType BasePrice
+				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen5  -DatabaseVCoreMin 0.25 -DatabaseVCoreMax 2 -LicenseType BasePrice
 
 		Assert-NotNull $ep2
 		Assert-AreEqual BasePrice $ep2.LicenseType
 
 		## Create Vcore based pool with LicenseIncluded license type
 		$poolName = Get-ElasticPoolName
 		$ep3 = New-AzSqlElasticPool -ServerName $server.ServerName -ResourceGroupName $rg.ResourceGroupName `
-				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen4  -DatabaseVCoreMin 0.1 -DatabaseVCoreMax 2 -LicenseType LicenseIncluded
+				-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen5  -DatabaseVCoreMin 0.25 -DatabaseVCoreMax 2 -LicenseType LicenseIncluded
 
 		Assert-NotNull $ep3
 		Assert-AreEqual LicenseIncluded $ep3.LicenseType
@@ -241,7 +241,7 @@ function Test-UpdateVcoreElasticPool
 	# Create a Vcore Pool
 	$poolName = Get-ElasticPoolName
 	$ep1 = New-AzSqlElasticPool  -ServerName $server.ServerName -ResourceGroupName $rg.ResourceGroupName `
-		-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen4
+		-ElasticPoolName $poolName -VCore 2 -Edition GeneralPurpose -ComputeGeneration Gen5
 	Assert-NotNull $ep1
 
 	# Create a Dtu pool
@@ -268,26 +268,26 @@ function Test-UpdateVcoreElasticPool
 
 		# Update a Dtu pool to Vcore pool using piping
 		$sep2 = $server | Set-AzSqlElasticPool -ElasticPoolName $ep2.ElasticPoolName -VCore 2 `
-			-Edition GeneralPurpose -ComputeGeneration Gen4 -StorageMB 204800
+			-Edition GeneralPurpose -ComputeGeneration Gen5 -StorageMB 204800
 
 		Assert-NotNull $sep2
 		Assert-AreEqual 2 $sep2.Capacity
 		Assert-AreEqual 214748364800 $sep2.MaxSizeBytes
 		Assert-AreEqual GeneralPurpose $sep2.Edition
-		Assert-AreEqual GP_Gen4 $sep2.SkuName
+		Assert-AreEqual GP_Gen5 $sep2.SkuName
 		Assert-AreEqual 0 $sep2.DatabaseCapacityMin
 		Assert-AreEqual 2 $sep2.DatabaseCapacityMax
 
 		# Update VCore pool only on DatabaseVCoreMin
-		$sep3 = $server | Set-AzSqlElasticPool -ElasticPoolName $ep2.ElasticPoolName -DatabaseVCoreMin 0.1
+		$sep3 = $server | Set-AzSqlElasticPool -ElasticPoolName $ep2.ElasticPoolName -DatabaseVCoreMin 0.25
 		Assert-NotNull $sep3
-		Assert-AreEqual 0.1 $sep3.DatabaseCapacityMin
+		Assert-AreEqual 0.25 $sep3.DatabaseCapacityMin
 
 		# Update Vcore pool only on VCores
-		$sep4 = $server | Set-AzSqlElasticPool -ElasticPoolName $ep2.ElasticPoolName -VCore 1
+		$sep4 = $server | Set-AzSqlElasticPool -ElasticPoolName $ep2.ElasticPoolName -VCore 2
 		Assert-NotNull $sep4
-		Assert-AreEqual 1 $sep4.Capacity
-		Assert-AreEqual 0.1 $sep4.DatabaseCapacityMin
+		Assert-AreEqual 2 $sep4.Capacity
+		Assert-AreEqual 0.25 $sep4.DatabaseCapacityMin
 	}
 	finally
 	{

src/Sql/Sql.Test/ScenarioTests/ReadScaleCrudTests.ps1

@@ -59,13 +59,11 @@ function Test-GetDatabaseReadScale ($serverVersion = "12.0", $location = "Southe
 	{
 		$db1 = Get-AzSqlDatabase -ResourceGroupName $server.ResourceGroupname -ServerName $server.ServerName -DatabaseName $db.DatabaseName
 		Assert-AreEqual Enabled $db1.ReadScale
-		Assert-AreEqual 1 $db1.ReadReplicaCount
 
-		# Alter read scale properties, Premium ignores ReadReplicaCount
+		# Alter read scale properties, Premium ignores HighAvailabilityReplicaCount
 		$db2 = Set-AzSqlDatabase -ResourceGroupName $db.ResourceGroupName -ServerName $db.ServerName -DatabaseName $db.DatabaseName `
-			-ReadScale Disabled -ReadReplicaCount -1
+			-ReadScale Disabled -HighAvailabilityReplicaCount -1
 		Assert-AreEqual Disabled $db2.ReadScale
-		Assert-AreEqual 0 $db2.ReadReplicaCount
 	}
 	finally
 	{
@@ -76,7 +74,7 @@ function Test-GetDatabaseReadScale ($serverVersion = "12.0", $location = "Southe
 
 <#
 	.SYNOPSIS
-	Tests database ReadReplicaCount option
+	Tests database HighAvailabilityReplicaCount option
 #>
 function Test-DatabaseReadReplicaCount ($serverVersion = "12.0", $location = "Southeast Asia")
 {
@@ -94,13 +92,19 @@ function Test-DatabaseReadReplicaCount ($serverVersion = "12.0", $location = "So
 	{
 		$db1 = Get-AzSqlDatabase -ResourceGroupName $server.ResourceGroupname -ServerName $server.ServerName -DatabaseName $db.DatabaseName
 		Assert-AreEqual Enabled $db1.ReadScale
-		Assert-AreEqual 1 $db1.ReadReplicaCount
+		Assert-AreEqual 1 $db1.HighAvailabilityReplicaCount
 
 		# Alter read scale properties, Hyperscale ignores ReadScale
 		$db2 = Set-AzSqlDatabase -ResourceGroupName $db.ResourceGroupName -ServerName $db.ServerName -DatabaseName $db.DatabaseName `
-			-ReadScale Enabled -ReadReplicaCount 0
+			-ReadScale Enabled -HighAvailabilityReplicaCount 0
 		Assert-AreEqual Disabled $db2.ReadScale
-		Assert-AreEqual 0 $db2.ReadReplicaCount
+		Assert-AreEqual 0 $db2.HighAvailabilityReplicaCount
+
+		# Alter read scale properties using alias
+		$db3 = Set-AzSqlDatabase -ResourceGroupName $db.ResourceGroupName -ServerName $db.ServerName -DatabaseName $db.DatabaseName `
+			-ReadScale Enabled -ReadReplicaCount 1
+		Assert-AreEqual Enabled $db3.ReadScale
+		Assert-AreEqual 1 $db3.HighAvailabilityReplicaCount
 	}
 	finally
 	{