Add new AzureRM.Sql cmdlets [Get/Set]-AzureRmSqlDatabaseBackupShortTermRetentionPolicy

src/ResourceManager/Sql/AzureRM.Sql.psd1

@@ -132,7 +132,9 @@ CmdletsToExport = 'Get-AzureRmSqlDatabaseTransparentDataEncryption',
                'Get-AzureRmSqlDatabaseGeoBackupPolicy', 
                'Set-AzureRmSqlDatabaseGeoBackupPolicy', 
                'Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy', 
-               'Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy', 
+               'Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy',
+               'Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy', 
+               'Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy', 
                'Get-AzureRmSqlDatabaseLongTermRetentionBackup', 
                'Remove-AzureRmSqlDatabaseLongTermRetentionBackup', 
                'Get-AzureRmSqlDeletedDatabaseBackup', 

src/ResourceManager/Sql/ChangeLog.md

@@ -18,17 +18,18 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Add new cmdlets 'Get-AzureRmSqlDatabaseBackupShortTermRetention' and 'Set-AzureRmSqlDatabaseBackupShortTermRetention' to support getting/setting the retention policy for point-in-time-restore backups
 
-## Version 4.5.0-preview
-* Added new cmdlets for CRUD operations on Managed Instance and Managed Database
-* Add commandlets for new feature - Instance Failover Groups
-	- Get-AzureRmSqlDatabaseInstanceFailoverGroup get the Instance Failover Group entity
-	- New-AzureRmSqlDatabaseInstanceFailoverGroup creates a new Instance Failover Group
-	- Remove-AzureRmSqlDatabaseInstanceFailoverGroup Instance Failover Group deletes the Failover Group
-	- Set-AzureRmSqlDatabaseInstanceFailoverGroup set Azure Sql Database Failover Policy and Grace Period entities of the Instance Failover Group
-	- Switch-AzureRmSqlDatabaseInstanceFailoverGroup issues the failover operation with data loss or without data loss
+## Version 4.5.0
 * Updated Auditing cmdlets to allow removing AuditActions or AuditActionGroups
-* Fixed issue with Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy when setting a new flexible retention policy where the command would fail with "Configure long term retention policy with azure recovery service vault and policy is no longer supported. Please submit request with the new flexible retention policy".
+* Fixed issue with Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy when setting a new flexible retention policy where the command would fail with 'Configure long term retention policy with azure recovery service vault and policy is no longer supported. Please submit request with the new flexible retention policy'.
+* Update all Azure Sql Database/ElasticPool Creation/Update related cmdlets to use the new Database API, which support Sku property for scale and tier-related properties.
+* The updated cmdlets including: 
+	- New-AzureRmSqlDatabase; Set-AzureRmSqlDatabase
+	- New-AzureRmSqlElasticPool; Set-AzureRmSqlElasticPool
+	- New-AzureRmSqlDatabaseCopy
+	- New-AzureRmSqlDatabaseSecondary
+	- Restore-AzureRmSqlDatabase
 
 ## Version 4.4.1
 * Set minimum dependency of module to PowerShell 5.0 

src/ResourceManager/Sql/Commands.Sql.Test/Commands.Sql.Test.csproj

@@ -76,10 +76,10 @@
     <Reference Include="Microsoft.Azure.Management.Network, Version=19.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <HintPath>..\..\..\packages\Microsoft.Azure.Management.Network.19.0.0-preview\lib\net452\Microsoft.Azure.Management.Network.dll</HintPath>
     </Reference>
-    <Reference Include="Microsoft.Azure.Management.Sql, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
-	  <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\packages\Microsoft.Azure.Management.Sql.1.15.0-preview\lib\net452\Microsoft.Azure.Management.Sql.dll</HintPath>
-	  <Private>True</Private>
+    <Reference Include="Microsoft.Azure.Management.Sql, Version=1.16.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\..\packages\Microsoft.Azure.Management.Sql.1.16.0-preview\lib\net452\Microsoft.Azure.Management.Sql.dll</HintPath>
+      <Private>True</Private>
     </Reference>
     <Reference Include="Microsoft.Azure.Management.Storage">
       <HintPath>..\..\..\packages\Microsoft.Azure.Management.Storage.2.4.0-preview\lib\net40\Microsoft.Azure.Management.Storage.dll</HintPath>
@@ -606,6 +606,9 @@
     <None Include="SessionRecords\Microsoft.Azure.Commands.Sql.Test.ScenarioTests.DatabaseBackupTests\TestDatabaseGeoBackupPolicy.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="SessionRecords\Microsoft.Azure.Commands.Sql.Test.ScenarioTests.DatabaseBackupTests\TestShortTermRetentionPolicy.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Include="SessionRecords\Microsoft.Azure.Commands.Sql.Test.ScenarioTests.DatabaseCrudStretchTests\TestStretchDatabaseCreate.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

src/ResourceManager/Sql/Commands.Sql.Test/ScenarioTests/DatabaseBackupTests.cs

@@ -147,5 +147,11 @@ public void TestRemoveDatabaseRestorePoint()
                 RunPowerShellTest("Test-RemoveDatabaseRestorePoint");
             }
         }
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestShortTermRetentionPolicy()
+        {
+            RunPowerShellTest("Test-ShortTermRetentionPolicy");
+        }
     }
 }

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

@@ -383,4 +383,73 @@ function Test-RemoveDatabaseRestorePoint
 	{
 		Remove-ResourceGroupForTest $rg
 	}
+}
+
+function Test-ShortTermRetentionPolicy
+{
+	# Setup
+	$location = Get-Location "Microsoft.Sql" "servers" "West US 2"
+	$rg = Create-ResourceGroupForTest $location
+	$server = Create-ServerForTest $rg $location
+
+	# Not divisible by 7, client should error
+	$invalidRetention = 20
+
+	try
+	{
+		# Create db with default values
+		$databaseName = Get-DatabaseName
+		$db = New-AzureRmSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName
+
+		# Test default parameter set
+		$retention = 28
+		$policy = Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName -RetentionDays $retention
+		Assert-AreEqual $policy.Count 1
+		Assert-AreEqual $retention $policy[0].RetentionDays
+		$policy = Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName
+		Assert-AreEqual $policy.Count 1
+		Assert-AreEqual $retention $policy[0].RetentionDays
+
+		# Test InputObject
+		$retention = 21
+		$policy = Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -AzureSqlDatabase $db -RetentionDays $retention
+		Assert-AreEqual 1 $policy.Count
+		Assert-AreEqual $retention $policy[0].RetentionDays
+		$policy = Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -AzureSqlDatabase $db
+		Assert-AreEqual 1 $policy.Count
+		Assert-AreEqual $retention $policy[0].RetentionDays
+
+		# Test ResourceId
+		$retention = 14
+		$resourceId = $db.ResourceId + "/backupShortTermRetentionPolicies/default"
+		$policy = Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceId $resourceId -RetentionDays $retention
+		Assert-AreEqual 1 $policy.Count
+		Assert-AreEqual $retention $policy[0].RetentionDays
+		$policy = Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -ResourceId $resourceId
+		Assert-AreEqual 1 $policy.Count
+		Assert-AreEqual $retention $policy[0].RetentionDays
+
+		# Test Piping
+		$retention = 7
+		$policy = $db | Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -RetentionDays $retention
+		Assert-AreEqual 1 $policy.Count
+		Assert-AreEqual $retention $policy[0].RetentionDays
+		$policy = $db | Get-AzureRmSqlDatabaseBackupShortTermRetentionPolicy
+		Assert-AreEqual 1 $policy.Count
+		Assert-AreEqual $retention $policy[0].RetentionDays
+
+		# Test client-side error handling
+		try {
+			$db | Set-AzureRmSqlDatabaseBackupShortTermRetentionPolicy -RetentionDays $invalidRetention
+		}
+		catch [System.Management.Automation.PSArgumentException] {
+			# We expect an error here
+			Assert-AreEqual $_.Count 1
+		}
+
+	}
+	finally
+	{
+		Remove-ResourceGroupForTest $rg
+	}
 }

src/ResourceManager/Sql/Commands.Sql.Test/packages.config

@@ -8,7 +8,7 @@
   <package id="Microsoft.Azure.Management.Authorization" version="2.0.0" targetFramework="net45" />
   <package id="Microsoft.Azure.Management.Network" version="19.0.0-preview" targetFramework="net452" />
   <package id="Microsoft.Azure.Management.Resources" version="2.20.0-preview" targetFramework="net45" />
-  <package id="Microsoft.Azure.Management.Sql" version="1.15.0-preview" targetFramework="net452" />
+  <package id="Microsoft.Azure.Management.Sql" version="1.16.0-preview" targetFramework="net452" />
   <package id="Microsoft.Azure.Management.Storage" version="2.4.0-preview" targetFramework="net45" />
   <package id="Microsoft.Azure.Test.Framework" version="1.0.6179.26854-prerelease" targetFramework="net45" />
   <package id="Microsoft.Azure.Test.HttpRecorder" version="1.6.7-preview" targetFramework="net45" />

src/ResourceManager/Sql/Commands.Sql/Commands.Sql.Netcore.csproj

@@ -28,7 +28,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.Management.Sql" Version="1.15.0-preview" />
+    <PackageReference Include="Microsoft.Azure.Management.Sql" Version="1.16.0-preview" />
     <PackageReference Include="Microsoft.Azure.Management.Storage" Version="7.1.0-preview" />
     <PackageReference Include="Microsoft.WindowsAzure.Management.Storage" Version="5.1.1" />
   </ItemGroup>

src/ResourceManager/Sql/Commands.Sql/Commands.Sql.csproj

@@ -62,9 +62,13 @@
     <Compile Include="Auditing\Model\DatabaseBlobAuditingSettingsModel.cs" />
     <Compile Include="Auditing\Model\ServerBlobAuditingSettingsModel.cs" />
     <Compile Include="Common\ResourceIdentityHelper.cs" />
+    <Compile Include="Database Backup\Cmdlet\AzureSqlDatabaseBackupShortTermRetentionPolicyCmdletBase.cs" />
     <Compile Include="Database Backup\Cmdlet\AzureSqlDatabaseLongTermRetentionBackupCmdletBase.cs" />
+    <Compile Include="Database Backup\Cmdlet\GetAzureRmSqlDatabaseBackupShortTermRetentionPolicy.cs" />
     <Compile Include="Database Backup\Cmdlet\RemoveAzureRmSqlDatabaseLongTermRetentionBackup.cs" />
     <Compile Include="Database Backup\Cmdlet\GetAzureRmSqlDatabaseLongTermRetentionBackup.cs" />
+    <Compile Include="Database Backup\Cmdlet\SetAzureRmSqlDatabaseBackupShortTermRetentionPolicy.cs" />
+    <Compile Include="Database Backup\Model\AzureSqlDatabaseBackupShortTermRetentionPolicyModel.cs" />
     <Compile Include="Database Backup\Model\AzureSqlDatabaseLongTermRetentionBackupModel.cs" />
     <Compile Include="Database Backup\Model\AzureSqlDatabaseLongTermRetentionPolicyModel.cs" />
     <Compile Include="Database\Cmdlet\StopAzureSqlDatabaseActivity.cs" />
@@ -486,7 +490,7 @@
     </ProjectReference>
     <Reference Include="Microsoft.Azure.Management.Sql, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\packages\Microsoft.Azure.Management.Sql.1.15.0-preview\lib\net452\Microsoft.Azure.Management.Sql.dll</HintPath>
+      <HintPath>..\..\..\packages\Microsoft.Azure.Management.Sql.1.16.0-preview\lib\net452\Microsoft.Azure.Management.Sql.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="Microsoft.Azure.Management.Storage">

src/ResourceManager/Sql/Commands.Sql/Database Backup/Cmdlet/AzureSqlDatabaseBackupShortTermRetentionPolicyCmdletBase.cs

@@ -0,0 +1,160 @@
+using System;
+using System.Collections.Generic;
+using Microsoft.Azure.Commands.Sql.Backup.Services;
+using Microsoft.Azure.Commands.Sql.Common;
+using System.Management.Automation;
+using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
+using Microsoft.Azure.Commands.Sql.Database_Backup.Model;
+using Microsoft.Azure.Commands.Sql.Database.Model;
+using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+
+namespace Microsoft.Azure.Commands.Sql.Database_Backup.Cmdlet
+{
+    public abstract class AzureSqlDatabaseBackupShortTermRetentionPolicyCmdletBase : AzureSqlCmdletBase<IEnumerable<AzureSqlDatabaseBackupShortTermRetentionPolicyModel>, AzureSqlDatabaseBackupAdapter>
+    {
+        /// <summary>
+        /// The expected number of segments in a short term retention policy resource id.
+        /// </summary>
+        private const int BackupShortTermRetentionPolicyResourceIdSegmentsLength = 12;
+
+        /// <summary>
+        /// Parameter set with ResourceGroup name, Server name and Database name.
+        /// </summary>
+        protected const string PolicyByResourceServerDatabaseSet = "PolicyByResourceServerDatabaseSet";
+
+        /// <summary>
+        /// Parameter set for using a Database Input Object.
+        /// </summary>
+        private const string PolicyByInputObjectSet = "PolicyByInputObjectSet";
+
+        /// <summary>
+        /// Parameter set for using a resource Id.
+        /// </summary>
+        private const string PolicyByResourceIdSet = "PolicyByResourceIdSet";
+
+        /// <summary>
+        /// Gets or sets the Database object to get the policy for.
+        /// </summary>
+        [Parameter(
+            ParameterSetName = PolicyByInputObjectSet,
+            Mandatory = true,
+            ValueFromPipeline = true,
+            HelpMessage = "The database object to get the policy for.")]
+        [ValidateNotNullOrEmpty]
+        public AzureSqlDatabaseModel AzureSqlDatabase { get; set; }
+
+        /// <summary>
+        /// Gets or sets the Database object to get the policy for.
+        /// </summary>
+        [Parameter(
+            ParameterSetName = PolicyByResourceIdSet,
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The short term retention policy resource Id.")]
+        [ValidateNotNullOrEmpty]
+        public string ResourceId { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the resource group to use.
+        /// </summary>
+        [Parameter(
+            ParameterSetName = PolicyByResourceServerDatabaseSet,
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = true,
+            Position = 0,
+            HelpMessage = "The name of the resource group.")]
+        [ResourceGroupCompleter]
+        [ValidateNotNullOrEmpty]
+        public override string ResourceGroupName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the database server to use.
+        /// </summary>
+        [Parameter(ParameterSetName = PolicyByResourceServerDatabaseSet,
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = true,
+            Position = 1,
+            HelpMessage = "The name of the Azure SQL Server the database is in.")]
+        [ValidateNotNullOrEmpty]
+        public string ServerName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the database to use.
+        /// </summary>
+        [Parameter(
+            ParameterSetName = PolicyByResourceServerDatabaseSet,
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = true,
+            Position = 2,
+            HelpMessage = "The name of the Azure SQL Database to use.")]
+        [ValidateNotNullOrEmpty]
+        public string DatabaseName { get; set; }
+
+        /// <summary>
+        /// Initializes the adapter
+        /// </summary>
+        /// <param name="subscription">The subscription to operate on</param>
+        /// <returns></returns>
+        protected override AzureSqlDatabaseBackupAdapter InitModelAdapter(IAzureSubscription subscription)
+        {
+            return new AzureSqlDatabaseBackupAdapter(DefaultProfile.DefaultContext);
+        }
+
+        public override void ExecuteCmdlet()
+        {
+            if (AzureSqlDatabase != null)
+            {
+                this.ResourceGroupName = AzureSqlDatabase.ResourceGroupName;
+                this.ServerName = AzureSqlDatabase.ServerName;
+                this.DatabaseName = AzureSqlDatabase.DatabaseName;
+            }
+            else if (!string.IsNullOrEmpty(ResourceId))
+            {
+                ParseResourceId();
+            }
+
+            base.ExecuteCmdlet();
+        }
+
+        /// <summary>
+        /// Helper method to parse resourceGroupName, serverName, databaseName from resourceId
+        /// Ideally this would utilize Microsoft.Azure.Management.Internal.Resources.Utilities.Models.ResourceIdentifier
+        /// However, that class is not setup to handle resources that have an ancestry higher than just parent level.
+        /// That class could recursively create a parent ResourceIdentifier on a __get__ ParentResource,
+        /// rather than just a string, so a consumer could work all the way to the root resource easily.
+        /// Leave as a TODO for now, as many other cmdlets consume that class, and I will work on it in separate change.
+        /// </summary>
+        private void ParseResourceId()
+        {
+            string[] tokens = ResourceId.Split(new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries);
+
+            // "/subscriptions/<subId>/resourceGroups/<resourceGroup>/providers/Microsoft.Sql/servers/<server>/databases/<database>/backupShortTermRetentionPolicies/default"
+            if (tokens.Length != BackupShortTermRetentionPolicyResourceIdSegmentsLength)
+            {
+                throw new ArgumentException("Invalid format of the resource identifier.", "ResourceId");
+            }
+
+            // Convert tokens into TYPE:NAME key value pairs, ignoring case
+            Dictionary<string, string> segments = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);
+            int i = 0;
+            while (i < tokens.Length)
+            {
+                string type = tokens[i++];
+                string name = tokens[i++];
+                segments[type] = name;
+            }
+
+            try
+            {
+                this.ResourceGroupName = segments["resourceGroups"];
+                this.ServerName = segments["servers"];
+                this.DatabaseName = segments["databases"];
+            }
+            catch (KeyNotFoundException)
+            {
+                throw new ArgumentException(
+                    "Invalid format of the resource identifier. ResourceID should follow format /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Sql/servers/<serverName>/databases/<databaseName>/backupShortTermRetentionPolicies/default");
+            }
+        }
+    }
+}