[CosmosDB] Exposing backup policy migration state (#16637)

* Exposing backup policy migration state

* Added test for migration state validation

Co-authored-by: REDMOND\amisi <amisi@microsoft.com>

Author: kavskalyan

src/CosmosDB/CosmosDB.Test/ScenarioTests/RestoreTests.cs

@@ -68,5 +68,12 @@ public void TestMongoDBCollectionBackupInformationCmdLets()
         {
             TestController.NewInstance.RunPowerShellTest(_logger, "Test-MongoDBCollectionBackupInformationCmdLets");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestUpdateCosmosDBAccountBackupPolicyCmdLet()
+        {
+            TestController.NewInstance.RunPowerShellTest(_logger, "Test-UpdateCosmosDBAccountBackupPolicyCmdLet");
+        }
     }
 }

src/CosmosDB/CosmosDB.Test/ScenarioTests/RestoreTests.ps1

@@ -325,3 +325,31 @@ function Test-MongoDBCollectionBackupInformationCmdLets {
   Assert-NotNull $backupInfo
   Assert-NotNull $backupInfo.LatestRestorableTimestamp
 }
+
+function Test-UpdateCosmosDBAccountBackupPolicyCmdLet {
+  $rgName = "CosmosDBResourceGroup20"
+  $location = "Central US"
+  $cosmosDBAccountName = "cosmosdb-1220"
+  $apiKind = "Sql"
+  $consistencyLevel = "Session"
+  $locations = @()
+  $locations += New-AzCosmosDBLocationObject -Location $location -FailoverPriority 0 -IsZoneRedundant 0
+
+  $resourceGroup = New-AzResourceGroup -ResourceGroupName $rgName -Location $location
+
+  Try {
+    New-AzCosmosDBAccount -ResourceGroupName $rgName -LocationObject $locations -Name $cosmosDBAccountName -ApiKind $apiKind -DefaultConsistencyLevel $consistencyLevel
+  }
+  Catch {
+    Assert-AreEqual $_.Exception.Message ("Resource with Name " + $cosmosDBAccountName + " already exists.")
+  }
+
+  $updatedCosmosDBAccount = Update-AzCosmosDBAccount -ResourceGroupName $rgName -Name $cosmosDBAccountName -BackupPolicyType Continuous
+  Start-Sleep -s 50
+
+  $updatedCosmosDBAccount = Get-AzCosmosDBAccount -ResourceGroupName $rgName -Name $cosmosDBAccountName
+  Assert-NotNull $updatedCosmosDBAccount.BackupPolicy.BackupPolicyMigrationState
+  Assert-NotNull $updatedCosmosDBAccount.BackupPolicy.BackupPolicyMigrationState.Status
+  Assert-NotNull $updatedCosmosDBAccount.BackupPolicy.BackupPolicyMigrationState.TargetType
+  Assert-NotNull $updatedCosmosDBAccount.BackupPolicy.BackupPolicyMigrationState.StartTime
+}

src/CosmosDB/CosmosDB.Test/SessionRecords/Microsoft.Azure.Commands.CosmosDB.Test.ScenarioTests.ScenarioTest.RestoreTests/TestUpdateCosmosDBAccountBackupPolicyCmdLet.json

@@ -19,6 +19,8 @@
 -->
 
 ## Upcoming Release
+* Exposing BackupPolicyMigrationState as a part of Get-AzCosmosDBAccount response. 
+This shows the status of a backup policy migration state when an account is being converted from peroidic backup mode to continuous.
 
 ## Version 1.5.0
 * Fixed when a warning about the value of AnalyticalStorageSchemaType is displayed when no value was given.

src/CosmosDB/CosmosDB/ChangeLog.md

@@ -42,6 +42,11 @@ public PSBackupPolicy(BackupPolicy backupPolicy)
             {
                 BackupType = ContinuousModeBackupType;
             }
+
+            if (backupPolicy.MigrationState != null)
+            {
+                BackupPolicyMigrationState = new PSBackupPolicyMigrationState(backupPolicy.MigrationState);
+            }
         }
 
         public int? BackupIntervalInMinutes { get; set; }
@@ -52,11 +57,14 @@ public PSBackupPolicy(BackupPolicy backupPolicy)
 
         public string BackupStorageRedundancy { get; set; }
 
+        public PSBackupPolicyMigrationState BackupPolicyMigrationState { get; set;}
+
         public BackupPolicy ToSDKModel()
         {
+            BackupPolicy backupPolicy;
             if (BackupType.Equals(PSBackupPolicy.ContinuousModeBackupType))
             {
-                return new ContinuousModeBackupPolicy();
+                backupPolicy = new ContinuousModeBackupPolicy();
             }
             else
             {
@@ -70,8 +78,10 @@ public BackupPolicy ToSDKModel()
                     }
                 };
 
-                return periodicModeBackupPolicy;
+                backupPolicy = periodicModeBackupPolicy;
             }
+
+            return backupPolicy;
         }
     }
 }

src/CosmosDB/CosmosDB/Models/DatabaseAccount/PSBackupPolicy.cs

@@ -0,0 +1,60 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System;
+using Microsoft.Azure.Management.CosmosDB.Models;
+
+namespace Microsoft.Azure.Commands.CosmosDB.Models
+{
+    public class PSBackupPolicyMigrationState
+    {
+        public PSBackupPolicyMigrationState()
+        {
+        }
+
+        public PSBackupPolicyMigrationState(BackupPolicyMigrationState backupPolicyMigrationState)
+        {
+            Status = backupPolicyMigrationState.Status;
+            TargetType = backupPolicyMigrationState.TargetType;
+            StartTime = backupPolicyMigrationState.StartTime;
+        }
+
+        //
+        // Summary:
+        //     Gets or sets describes the status of migration between backup policy types. Possible
+        //     values include: 'Invalid', 'InProgress', 'Completed', 'Failed'
+        public string Status { get; set; }
+        //
+        // Summary:
+        //     Gets or sets describes the target backup policy type of the backup policy migration.
+        //     Possible values include: 'Periodic', 'Continuous'
+        public string TargetType { get; set; }
+        //
+        // Summary:
+        //     Gets or sets time at which the backup policy migration started (ISO-8601 format).
+        public DateTime? StartTime { get; set; }
+
+        public BackupPolicyMigrationState ToSDKModel()
+        {
+            BackupPolicyMigrationState backupPolicyMigrationState = new BackupPolicyMigrationState
+            {
+                StartTime = StartTime,
+                Status = Status,
+                TargetType = TargetType
+            };
+
+            return backupPolicyMigrationState;
+        }
+    }
+}