Edit Get & Set ShortTermRetentionPolicy For Adding New Parameter: DiffBackupIntervalInHours (#12562)

* Draft ShortTermRetentionPolicy Get and Set cmdlets to include new parameter DiffBackupIntervalInHours PR (except record test session).

* set RetentionDays nullable and remove parameters' position requirement.

* scenario test passed.

* Removed .Value to allowe either retentionDays or diffBackupInterval can be set individually.
Added its related scenario tests and re-record; Added one related example;

* Add Position back to avoid breaking change;
Add retentionDays nullable changes exception;
Re-upload records.

* undid position of DiffBackupIntervalInHours

Co-authored-by: Lillian Liu <[email protected]>
Co-authored-by: Yeming Liu <[email protected]>

Author: 3 people

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

@@ -443,55 +443,84 @@ function Test-RemoveDatabaseRestorePoint
 function Test-ShortTermRetentionPolicy
 {
 	# Setup
-	$location = Get-Location "Microsoft.Sql" "servers" "West US 2"
-	$rg = Create-ResourceGroupForTest $location
-	$server = Create-ServerForTest $rg $location
+	$location = "southeast asia"
+	$rg = "PowershellStageResourceGroup"
+	$server = "pssqlserverfortest"
 
  	try
 	{
 		# Create db with default values
 		$databaseName = Get-DatabaseName
-		$db = New-AzureRmSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName
+		$db = New-AzSqlDatabase -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName -Force:$true
 
- 		# Test default parameter set
-		$retention = 28
-		$policy = Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName -RetentionDays $retention
+		# Test GET default values. 
+		$defaultRetention = 7
+		# After we configure Backup Service's default DiffBackupIntervalInHours to 24 hours for new created databases, $defaultDiffbackupinterval should be changed to 24.
+		$defaultDiffbackupinterval = 12
+		$policy = Get-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName
 		Assert-AreEqual $policy.Count 1
-		Assert-AreEqual $retention $policy[0].RetentionDays
-		$policy = Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName
+		Assert-AreEqual $defaultRetention $policy[0].RetentionDays
+		Assert-AreEqual $defaultDiffbackupinterval $policy[0].DiffBackupIntervalInHours
+
+ 		# Test SET
+		$retention = 6
+		$diffbackupinterval = 24
+		$policy = Set-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName -RetentionDays $retention -DiffBackupIntervalInHours $diffbackupinterval
 		Assert-AreEqual $policy.Count 1
 		Assert-AreEqual $retention $policy[0].RetentionDays
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
+
+		$retentionOnly = 5
+		$policy = Set-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName -RetentionDays $retentionOnly
+		Assert-AreEqual $policy.Count 1
+		Assert-AreEqual $retentionOnly $policy[0].RetentionDays
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
+
+		$diffbackupintervalOnly = 12
+		$policy = Set-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName -DiffBackupIntervalInHours $diffbackupintervalOnly
+		Assert-AreEqual $policy.Count 1
+		Assert-AreEqual $retentionOnly $policy[0].RetentionDays
+		Assert-AreEqual $diffbackupintervalOnly $policy[0].DiffBackupIntervalInHours
 
  		# Test InputObject
-		$retention = 21
-		$policy = Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -AzureSqlDatabase $db -RetentionDays $retention
+		$retention = 7
+		$diffbackupinterval = 24
+		$policy = Set-AzSqlDatabaseBackupShortTermRetentionPolicy -AzureSqlDatabase $db -RetentionDays $retention -DiffBackupIntervalInHours $diffbackupinterval
 		Assert-AreEqual 1 $policy.Count
 		Assert-AreEqual $retention $policy[0].RetentionDays
-		$policy = Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -AzureSqlDatabase $db
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
+		$policy = Get-AzSqlDatabaseBackupShortTermRetentionPolicy -AzureSqlDatabase $db
 		Assert-AreEqual 1 $policy.Count
 		Assert-AreEqual $retention $policy[0].RetentionDays
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
 
  		# Test ResourceId
-		$retention = 14
+		$retention = 6
+		$diffbackupinterval = 12
 		$resourceId = $db.ResourceId + "/backupShortTermRetentionPolicies/default"
-		$policy = Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceId $resourceId -RetentionDays $retention
+		$policy = Set-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceId $resourceId -RetentionDays $retention -DiffBackupIntervalInHours $diffbackupinterval
 		Assert-AreEqual 1 $policy.Count
 		Assert-AreEqual $retention $policy[0].RetentionDays
-		$policy = Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceId $resourceId
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
+		$policy = Get-AzSqlDatabaseBackupShortTermRetentionPolicy -ResourceId $resourceId
 		Assert-AreEqual 1 $policy.Count
 		Assert-AreEqual $retention $policy[0].RetentionDays
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
 
  		# Test Piping
 		$retention = 7
-		$policy = $db | Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -RetentionDays $retention
+		$diffbackupinterval = 24
+		$policy = $db | Set-AzSqlDatabaseBackupShortTermRetentionPolicy -RetentionDays $retention -DiffBackupIntervalInHours $diffbackupinterval
 		Assert-AreEqual 1 $policy.Count
 		Assert-AreEqual $retention $policy[0].RetentionDays
-		$policy = $db | Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
+		$policy = $db | Get-AzSqlDatabaseBackupShortTermRetentionPolicy
 		Assert-AreEqual 1 $policy.Count
 		Assert-AreEqual $retention $policy[0].RetentionDays
+		Assert-AreEqual $diffbackupinterval $policy[0].DiffBackupIntervalInHours
  	}
 	finally
 	{
-		Remove-ResourceGroupForTest $rg
+		Remove-AzSqlDatabase -ResourceGroupName $rg -ServerName $server -DatabaseName $databaseName
 	}
 }

src/Sql/Sql.Test/SessionRecords/Microsoft.Azure.Commands.Sql.Test.ScenarioTests.DatabaseBackupTests/TestShortTermRetentionPolicy.json

@@ -19,7 +19,7 @@
     <PackageReference Include="Microsoft.Azure.KeyVault.WebKey" Version="3.0.1" />
     <PackageReference Include="Microsoft.Azure.Management.KeyVault" Version="3.0.0" />
     <PackageReference Include="Microsoft.Azure.Management.OperationalInsights" Version="0.21.0-preview" />
-    <PackageReference Include="Microsoft.Azure.Management.Sql" Version="1.44.2-preview" />
+    <PackageReference Include="Microsoft.Azure.Management.Sql" Version="1.45.0-preview" />
   </ItemGroup>
 
   <ItemGroup>

src/Sql/Sql.Test/Sql.Test.csproj

@@ -18,41 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
-* Update Azure Paired Regions URL in Backup Storage Redundancy Warnings 
-
-## Version 2.11.0
-* Added BackupStorageRedundancy to the following: 
-    - `Restore-AzureRmSqlDatabase`
-    - `New-AzSqlDatabaseCopy`
-    - `New-AzSqlDatabaseSecondary`
-* Removed case sensitivity for BackupStorageRedundancy parameter for all SQL DB references 
-* Updated BackupStorageRedundancy warning message names
-* Added support for Managed HSM Uris for SQL DB and Managed Instance
-
-## Version 2.10.1
-* Added warning for BackupStorageRedundancy configuration in select regions in `New-AzSqlDatabase` (Ignore Case for BackupStorageRedundancy configuration input)
-* Fixed for bug in `New-AzSqlDatabaseExport`
-* Removed case sensitivity for BackupStorageRedundancy parameter for `New-AzSqlInstance` 
-
-## Version 2.10.0
-* Added BackupStorageRedundancy to `New-AzSqlInstance` and `Get-AzSqlInstance`
-* Added cmdlet `Get-AzSqlServerActiveDirectoryOnlyAuthentication`
-* Added cmdlet `Enable-AzSqlServerActiveDirectoryOnlyAuthentication`
-* Added Force parameter to `New-AzSqlInstance`
-* Added cmdlets for Managed Database Log Replay service
-	- `Start-AzSqlInstanceDatabaseLogReplay`
-	- `Get-AzSqlInstanceDatabaseLogReplay`
-	- `Complete-AzSqlInstanceDatabaseLogReplay`
-	- `Stop-AzSqlInstanceDatabaseLogReplay`
-* Added cmdlet `Get-AzSqlInstanceActiveDirectoryOnlyAuthentication`
-* Added cmdlet `Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication`
-* Added cmdlet `Disable-AzSqlInstanceActiveDirectoryOnlyAuthentication`
-* Updated cmdlets `New-AzSqlDatabaseImport` and `New-AzSqlDatabaseExport` to support network isolation functionality
-* Added cmdlet `New-AzSqlDatabaseImportExisting`
-* Updated Databases cmdlets to support backup storage type specification
-* Added Force parameter to `New-AzSqlDatabase`
-* Updated ActiveDirectoryOnlyAuthentication cmdlets for server and instance to include ResourceId and InputObject
-* Added support for Managed HSM Uris for SQL DB and Managed Instance
+* Added DiffBackupIntervalInHours to `Set-AzSqlDatabaseBackupShortTermRetentionPolicy` 
 
 ## Version 2.9.1
 * Fixed potential server name case insensitive error in `New-AzSqlServer` and `Set-AzSqlServer`

src/Sql/Sql/ChangeLog.md

@@ -16,6 +16,7 @@
 using System.Linq;
 using System.Management.Automation;
 using Microsoft.Azure.Commands.Sql.Backup.Model;
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
 
 namespace Microsoft.Azure.Commands.Sql.Backup.Cmdlet
 {
@@ -28,12 +29,18 @@ public class SetAzureRmSqlDatabaseBackupShortTermRetentionPolicy : AzureSqlDatab
         /// <summary>
         /// Gets or sets backup retention days.
         /// </summary>
-        [Parameter(Mandatory = true,
+        [Parameter(Mandatory = false,
             Position = 3,
             HelpMessage = "The backup retention setting, in days.")]
-        [ValidateNotNullOrEmpty]
-        public int RetentionDays{ get; set; }
+        public int RetentionDays { get; set; }
 
+        /// <summary>
+        /// Gets or sets differential backup interval hours.
+        /// </summary>
+        [Parameter(Mandatory = false,
+            HelpMessage = "The differential backup interval, in hours.")]
+        public int DiffBackupIntervalInHours { get; set; }	
+			
         /// <summary>
         /// Get the entities from the service
         /// </summary>
@@ -64,7 +71,10 @@ protected override IEnumerable<AzureSqlDatabaseBackupShortTermRetentionPolicyMod
                     ResourceGroupName,
                     ServerName,
                     DatabaseName,
-                    new Management.Sql.Models.BackupShortTermRetentionPolicy(retentionDays: RetentionDays))
+                    new Management.Sql.Models.BackupShortTermRetentionPolicy(
+                        retentionDays: this.IsParameterBound(c => c.RetentionDays) ? RetentionDays : null as int?, 
+                        diffBackupIntervalInHours: this.IsParameterBound(c => c.DiffBackupIntervalInHours) ? DiffBackupIntervalInHours : null as int?)
+                )
             };
         }
 

src/Sql/Sql/Database Backup/Cmdlet/GetAzureRmSqlDatabaseBackupShortTermRetentionPolicy.cs renamed to src/Sql/Sql/Database Backup/Cmdlet/GetAzureSqlDatabaseBackupShortTermRetentionPolicy.cs

@@ -12,6 +12,8 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using System;
+
 namespace Microsoft.Azure.Commands.Sql.Backup.Model
 {
     public class AzureSqlDatabaseBackupShortTermRetentionPolicyModel
@@ -34,7 +36,12 @@ public class AzureSqlDatabaseBackupShortTermRetentionPolicyModel
         /// <summary>
         /// Gets or sets the retention days of this policy.
         /// </summary>
-        public int RetentionDays { get; set; }
+        public int? RetentionDays { get; set; }
+
+        /// <summary>
+        /// Gets or sets the differential backup interval of this policy.
+        /// </summary>
+        public int? DiffBackupIntervalInHours { get; set; }
 
         /// <summary>
         /// Construct AzureSqlDatabaseBackupShortTermRetentionPolicyModel from Management.Sql.BackupShortTermRetentionPolicy object
@@ -44,10 +51,16 @@ public class AzureSqlDatabaseBackupShortTermRetentionPolicyModel
         /// <param name="policy"></param>
         public AzureSqlDatabaseBackupShortTermRetentionPolicyModel(string resourceGroup, string serverName, string databaseName, Management.Sql.Models.BackupShortTermRetentionPolicy policy)
         {
+            if (policy.RetentionDays == null && policy.DiffBackupIntervalInHours == null)
+            {
+                throw new ArgumentException(string.Format(Microsoft.Azure.Commands.Sql.Properties.Resources.SetAzSqlDatabaseBackupShortTermRetentionInvalidParameters, "RetentionDays", "DiffBackupIntervalInHours"));
+            }
+
             ResourceGroupName = resourceGroup;
             ServerName = serverName;
             DatabaseName = databaseName;
-            RetentionDays = policy.RetentionDays.Value;
+            RetentionDays = policy.RetentionDays;
+            DiffBackupIntervalInHours = policy.DiffBackupIntervalInHours;
         }
     }
 }

src/Sql/Sql/Database Backup/Cmdlet/SetAzureRmSqlDatabaseBackupShortTermRetentionPolicy.cs renamed to src/Sql/Sql/Database Backup/Cmdlet/SetAzureSqlDatabaseBackupShortTermRetentionPolicy.cs

@@ -585,7 +585,8 @@ internal AzureSqlDatabaseBackupShortTermRetentionPolicyModel SetDatabaseBackupSh
                     databaseName,
                     new Management.Sql.Models.BackupShortTermRetentionPolicy()
                     {
-                        RetentionDays = model.RetentionDays
+                        RetentionDays = model.RetentionDays,
+                        DiffBackupIntervalInHours = model.DiffBackupIntervalInHours
                     });
 
             return new AzureSqlDatabaseBackupShortTermRetentionPolicyModel(resourceGroup, serverName, databaseName, baPolicy);

src/Sql/Sql/Database Backup/Model/AzureSqlDatabaseBackupShortTermRetentionPolicyModel.cs

@@ -652,4 +652,7 @@
   <data name="BackupRedundancyNotChosenTakeSourceWarning" xml:space="preserve">
     <value>You have not specified the value for backup storage redundancy which will default to the source's backup storage redundancy. To learn more about Azure Paired Regions visit aka.ms/azure-ragrs-regions.</value>
   </data>
+  <data name="SetAzSqlDatabaseBackupShortTermRetentionInvalidParameters" xml:space="preserve">
+    <value>Parameter '{0}' and '{1}' both being null is not allowed.</value>
+  </data>
 </root>