[SQL] Add TryPlannedBeforeForcedFailover parameter to Switch-AzSqlDatabaseFailoverGroup (#21897)

* Add Failover option TryPlannedBeforeForcedFailover

* Update help file

* Add -TryPlannedBeforeForcedFailover Test

* Update ChangeLog.md

* Modify description

* Add test

* Remove parameter set

* Modify help file

* Upload test records

* Remove pattern check

* update README

* update README

* Addressed review comments

---------

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

Author: subhrob

src/Sql/Sql.Sdk/Generated/FailoverGroupsOperations.cs

@@ -21,6 +21,48 @@ namespace Microsoft.Azure.Management.Sql
     /// </summary>
     public static partial class FailoverGroupsOperationsExtensions
     {
+            /// <summary>
+            /// Lists the failover groups in a server.
+            /// </summary>
+            /// <param name='operations'>
+            /// The operations group for this extension method.
+            /// </param>
+            /// <param name='resourceGroupName'>
+            /// The name of the resource group that contains the resource. You can obtain
+            /// this value from the Azure Resource Manager API or the portal.
+            /// </param>
+            /// <param name='serverName'>
+            /// The name of the server containing the failover group.
+            /// </param>
+            public static IPage<FailoverGroup> ListByServer(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName)
+            {
+                return operations.ListByServerAsync(resourceGroupName, serverName).GetAwaiter().GetResult();
+            }
+
+            /// <summary>
+            /// Lists the failover groups in a server.
+            /// </summary>
+            /// <param name='operations'>
+            /// The operations group for this extension method.
+            /// </param>
+            /// <param name='resourceGroupName'>
+            /// The name of the resource group that contains the resource. You can obtain
+            /// this value from the Azure Resource Manager API or the portal.
+            /// </param>
+            /// <param name='serverName'>
+            /// The name of the server containing the failover group.
+            /// </param>
+            /// <param name='cancellationToken'>
+            /// The cancellation token.
+            /// </param>
+            public static async Task<IPage<FailoverGroup>> ListByServerAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, CancellationToken cancellationToken = default(CancellationToken))
+            {
+                using (var _result = await operations.ListByServerWithHttpMessagesAsync(resourceGroupName, serverName, null, cancellationToken).ConfigureAwait(false))
+                {
+                    return _result.Body;
+                }
+            }
+
             /// <summary>
             /// Gets a failover group.
             /// </summary>
@@ -223,7 +265,7 @@ public static FailoverGroup Update(this IFailoverGroupsOperations operations, st
             }
 
             /// <summary>
-            /// Lists the failover groups in a server.
+            /// Fails over from the current primary server to this server.
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -235,13 +277,16 @@ public static FailoverGroup Update(this IFailoverGroupsOperations operations, st
             /// <param name='serverName'>
             /// The name of the server containing the failover group.
             /// </param>
-            public static IPage<FailoverGroup> ListByServer(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName)
+            /// <param name='failoverGroupName'>
+            /// The name of the failover group.
+            /// </param>
+            public static FailoverGroup Failover(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName)
             {
-                return operations.ListByServerAsync(resourceGroupName, serverName).GetAwaiter().GetResult();
+                return operations.FailoverAsync(resourceGroupName, serverName, failoverGroupName).GetAwaiter().GetResult();
             }
 
             /// <summary>
-            /// Lists the failover groups in a server.
+            /// Fails over from the current primary server to this server.
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -253,19 +298,23 @@ public static IPage<FailoverGroup> ListByServer(this IFailoverGroupsOperations o
             /// <param name='serverName'>
             /// The name of the server containing the failover group.
             /// </param>
+            /// <param name='failoverGroupName'>
+            /// The name of the failover group.
+            /// </param>
             /// <param name='cancellationToken'>
             /// The cancellation token.
             /// </param>
-            public static async Task<IPage<FailoverGroup>> ListByServerAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, CancellationToken cancellationToken = default(CancellationToken))
+            public static async Task<FailoverGroup> FailoverAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName, CancellationToken cancellationToken = default(CancellationToken))
             {
-                using (var _result = await operations.ListByServerWithHttpMessagesAsync(resourceGroupName, serverName, null, cancellationToken).ConfigureAwait(false))
+                using (var _result = await operations.FailoverWithHttpMessagesAsync(resourceGroupName, serverName, failoverGroupName, null, cancellationToken).ConfigureAwait(false))
                 {
                     return _result.Body;
                 }
             }
 
             /// <summary>
-            /// Fails over from the current primary server to this server.
+            /// Fails over from the current primary server to this server. This operation
+            /// might result in data loss.
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -280,13 +329,14 @@ public static IPage<FailoverGroup> ListByServer(this IFailoverGroupsOperations o
             /// <param name='failoverGroupName'>
             /// The name of the failover group.
             /// </param>
-            public static FailoverGroup Failover(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName)
+            public static FailoverGroup ForceFailoverAllowDataLoss(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName)
             {
-                return operations.FailoverAsync(resourceGroupName, serverName, failoverGroupName).GetAwaiter().GetResult();
+                return operations.ForceFailoverAllowDataLossAsync(resourceGroupName, serverName, failoverGroupName).GetAwaiter().GetResult();
             }
 
             /// <summary>
-            /// Fails over from the current primary server to this server.
+            /// Fails over from the current primary server to this server. This operation
+            /// might result in data loss.
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -304,17 +354,17 @@ public static FailoverGroup Failover(this IFailoverGroupsOperations operations,
             /// <param name='cancellationToken'>
             /// The cancellation token.
             /// </param>
-            public static async Task<FailoverGroup> FailoverAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName, CancellationToken cancellationToken = default(CancellationToken))
+            public static async Task<FailoverGroup> ForceFailoverAllowDataLossAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName, CancellationToken cancellationToken = default(CancellationToken))
             {
-                using (var _result = await operations.FailoverWithHttpMessagesAsync(resourceGroupName, serverName, failoverGroupName, null, cancellationToken).ConfigureAwait(false))
+                using (var _result = await operations.ForceFailoverAllowDataLossWithHttpMessagesAsync(resourceGroupName, serverName, failoverGroupName, null, cancellationToken).ConfigureAwait(false))
                 {
                     return _result.Body;
                 }
             }
 
             /// <summary>
             /// Fails over from the current primary server to this server. This operation
-            /// might result in data loss.
+            /// tries planned before forced failover but might still result in data loss.
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -324,19 +374,19 @@ public static FailoverGroup Failover(this IFailoverGroupsOperations operations,
             /// this value from the Azure Resource Manager API or the portal.
             /// </param>
             /// <param name='serverName'>
-            /// The name of the server containing the failover group.
+            /// The name of the server.
             /// </param>
             /// <param name='failoverGroupName'>
             /// The name of the failover group.
             /// </param>
-            public static FailoverGroup ForceFailoverAllowDataLoss(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName)
+            public static FailoverGroup TryPlannedBeforeForcedFailover(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName)
             {
-                return operations.ForceFailoverAllowDataLossAsync(resourceGroupName, serverName, failoverGroupName).GetAwaiter().GetResult();
+                return operations.TryPlannedBeforeForcedFailoverAsync(resourceGroupName, serverName, failoverGroupName).GetAwaiter().GetResult();
             }
 
             /// <summary>
             /// Fails over from the current primary server to this server. This operation
-            /// might result in data loss.
+            /// tries planned before forced failover but might still result in data loss.
             /// </summary>
             /// <param name='operations'>
             /// The operations group for this extension method.
@@ -346,17 +396,17 @@ public static FailoverGroup ForceFailoverAllowDataLoss(this IFailoverGroupsOpera
             /// this value from the Azure Resource Manager API or the portal.
             /// </param>
             /// <param name='serverName'>
-            /// The name of the server containing the failover group.
+            /// The name of the server.
             /// </param>
             /// <param name='failoverGroupName'>
             /// The name of the failover group.
             /// </param>
             /// <param name='cancellationToken'>
             /// The cancellation token.
             /// </param>
-            public static async Task<FailoverGroup> ForceFailoverAllowDataLossAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName, CancellationToken cancellationToken = default(CancellationToken))
+            public static async Task<FailoverGroup> TryPlannedBeforeForcedFailoverAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName, CancellationToken cancellationToken = default(CancellationToken))
             {
-                using (var _result = await operations.ForceFailoverAllowDataLossWithHttpMessagesAsync(resourceGroupName, serverName, failoverGroupName, null, cancellationToken).ConfigureAwait(false))
+                using (var _result = await operations.TryPlannedBeforeForcedFailoverWithHttpMessagesAsync(resourceGroupName, serverName, failoverGroupName, null, cancellationToken).ConfigureAwait(false))
                 {
                     return _result.Body;
                 }
@@ -613,6 +663,56 @@ public static FailoverGroup BeginForceFailoverAllowDataLoss(this IFailoverGroups
                 }
             }
 
+            /// <summary>
+            /// Fails over from the current primary server to this server. This operation
+            /// tries planned before forced failover but might still result in data loss.
+            /// </summary>
+            /// <param name='operations'>
+            /// The operations group for this extension method.
+            /// </param>
+            /// <param name='resourceGroupName'>
+            /// The name of the resource group that contains the resource. You can obtain
+            /// this value from the Azure Resource Manager API or the portal.
+            /// </param>
+            /// <param name='serverName'>
+            /// The name of the server.
+            /// </param>
+            /// <param name='failoverGroupName'>
+            /// The name of the failover group.
+            /// </param>
+            public static FailoverGroup BeginTryPlannedBeforeForcedFailover(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName)
+            {
+                return operations.BeginTryPlannedBeforeForcedFailoverAsync(resourceGroupName, serverName, failoverGroupName).GetAwaiter().GetResult();
+            }
+
+            /// <summary>
+            /// Fails over from the current primary server to this server. This operation
+            /// tries planned before forced failover but might still result in data loss.
+            /// </summary>
+            /// <param name='operations'>
+            /// The operations group for this extension method.
+            /// </param>
+            /// <param name='resourceGroupName'>
+            /// The name of the resource group that contains the resource. You can obtain
+            /// this value from the Azure Resource Manager API or the portal.
+            /// </param>
+            /// <param name='serverName'>
+            /// The name of the server.
+            /// </param>
+            /// <param name='failoverGroupName'>
+            /// The name of the failover group.
+            /// </param>
+            /// <param name='cancellationToken'>
+            /// The cancellation token.
+            /// </param>
+            public static async Task<FailoverGroup> BeginTryPlannedBeforeForcedFailoverAsync(this IFailoverGroupsOperations operations, string resourceGroupName, string serverName, string failoverGroupName, CancellationToken cancellationToken = default(CancellationToken))
+            {
+                using (var _result = await operations.BeginTryPlannedBeforeForcedFailoverWithHttpMessagesAsync(resourceGroupName, serverName, failoverGroupName, null, cancellationToken).ConfigureAwait(false))
+                {
+                    return _result.Body;
+                }
+            }
+
             /// <summary>
             /// Lists the failover groups in a server.
             /// </summary>