[Sql] Overhaul failover group cmdlets to use current API and support multiple secondaries (#23898)

* rework failover group cmdlets to use current sdk instead of legacy sdk; update get to accomodate multiple secondary failover groups

* default to manual failover policy

* update changelog

* remove commented out import statement

* Update src/Sql/Sql/ChangeLog.md

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

* Update src/Sql/Sql/Failover Group/Cmdlet/NewAzureSqlFailoverGroup.cs

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

* Update src/Sql/Sql/Failover Group/Cmdlet/SetAzureSqlFailoverGroup.cs

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

* modify changelog lines to be in upcoming release instead of previously released version

* update help files with updated default param values

---------

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

Author: alecbain

src/Sql/Sql.Test/ScenarioTests/FailoverGroupTests.ps1

@@ -45,16 +45,26 @@ function Handle-FailoverGroupTestWithFailoverGroup($scriptBlock, $failoverPolicy
 	}.GetNewClosure()
 }
 
-function Validate-FailoverGroup($server, $partnerServer, $name, $role, $failoverPolicy, $gracePeriod, $readOnlyFailoverPolicy, $databases, $fg, $message="no context provided")
+function Validate-FailoverGroup($server, $partnerServer, $name, $role, $failoverPolicy, $gracePeriod, $readOnlyFailoverPolicy, $databases, $fg, $message="no context provided", $isMultiServer = $false, $partnerServersList = $null)
 {
 	Assert-NotNull $fg.Id "`$fg.Id ($message)"
 	Assert-NotNull $fg.PartnerServers "`$fg.PartnerServers ($message)"
 	Assert-AreEqual $name $fg.FailoverGroupName "`$fg.FailoverGroupName ($message)"
 	# Assert-AreEqual $true $partnerServer.ResourceId.Contains($fg.PartnerSubscriptionId) "`$fg.PartnerSubscriptionId ($message)"
-	Assert-AreEqual $server.ResourceGroupName $fg.ResourceGroupName "`$fg.ResourceGroupName ($message)"
-	Assert-AreEqual $partnerServer.ResourceGroupName $fg.PartnerResourceGroupName "`$fg.PartnerResourceGroupName ($message)"
-	Assert-AreEqual $server.ServerName $fg.ServerName "`$fg.ServerName ($message)"
-	Assert-AreEqual $partnerServer.ServerName $fg.PartnerServerName "`$fg.PartnerServerName ($message)"
+	if ($isMultiServer) 
+	{
+		foreach ($server in $partnerServersList)
+		{
+			Assert-AreEqual $true $fg.PartnerServers.Contains($server) "`$fg.PartnerServers[$($server)] ($message)"
+		}
+	}
+	else 
+	{
+		Assert-AreEqual $server.ResourceGroupName $fg.ResourceGroupName "`$fg.ResourceGroupName ($message)"
+		Assert-AreEqual $partnerServer.ResourceGroupName $fg.PartnerResourceGroupName "`$fg.PartnerResourceGroupName ($message)"
+		Assert-AreEqual $server.ServerName $fg.ServerName "`$fg.ServerName ($message)"
+		Assert-AreEqual $partnerServer.ServerName $fg.PartnerServerName "`$fg.PartnerServerName ($message)"
+	}
 	# Commented out because server location is a location id, but FG location is a location friendly name
 	# Assert-AreEqual $server.Location $fg.Location "`$fg.Location ($message)"
 	# Assert-AreEqual $partnerServer.Location $fg.PartnerLocation "`$fg.PartnerLocation ($message)"
@@ -431,6 +441,6 @@ function Test-FailoverGroupMultipleSecondaries()
 
 		$fgName = Get-FailoverGroupName
 		$fg = New-AzSqlDatabaseFailoverGroup -ResourceGroupName $primaryServer.ResourceGroupName -ServerName $primaryServer.ServerName -PartnerServerName $partnerServer.ServerName -FailoverGroupName $fgName -FailoverPolicy Automatic -GracePeriodWithDataLossHours 1 -AllowReadOnlyFailoverToPrimary Enabled -PartnerServerList $partnerServers -ReadOnlyEndpointTargetServer $partnerServer.ResourceId
-		Validate-FailoverGroup $primaryServer $server $fgName Primary Automatic 1 Enabled @() $fg
+		Validate-FailoverGroup $primaryServer $server $fgName Primary Automatic 1 Enabled @() $fg -isMultiServer $true -PartnerServerList $partnerServers
 	}
 }