Merge pull request #5762 from payiAzure/azure-powershell-br1

Add new cmdlet, update commands.Sql and tests for 'List database operation' and 'List/Cancel elastic pool operation'

Author: Maddie Clayton

src/ResourceManager/Sql/AzureRM.Sql.psd1

@@ -188,7 +188,8 @@ CmdletsToExport = 'Get-AzureRmSqlDatabaseTransparentDataEncryption',
                'Remove-AzureRmSqlServerVirtualNetworkRule', 
                'Stop-AzureRmSqlDatabaseActivity', 'Get-AzureRmSqlServerDnsAlias', 
                'Remove-AzureRmSqlServerDnsAlias', 'New-AzureRmSqlServerDnsAlias', 
-               'Set-AzureRmSqlServerDnsAlias'
+               'Set-AzureRmSqlServerDnsAlias',
+               'Stop-AzureRmSqlElasticPoolActivity'
 
 # Variables to export from this module
 # VariablesToExport = @()

src/ResourceManager/Sql/ChangeLog.md

@@ -18,6 +18,8 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Add new cmdlet 'Stop-AzureRmSqlElasticPoolActivity' to support canceling the asynchronous operations on elastic pool
+* Update the response for cmdlets Get-AzureRmSqlDatabaseActivity and Get-AzureRmSqlElasticPoolActivity to reflect more information in the response
 * Updated to the latest version of the Azure ClientRuntime
 
 ## Version 4.3.1
@@ -181,3 +183,4 @@
     - To configure ReadScale, user simply specify "ReadScale" paramter with "Enabled/Disabled" at database creation with New-AzureRmSqlDatabase cmdlet,
 
 ## Version 2.3.0
+

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

@@ -734,6 +734,9 @@
     </None>
     <None Include="SessionRecords\Microsoft.Azure.Commands.Sql.Test.ScenarioTests.ElasticPoolCrudTests\TestElasticPoolUpdateWithZoneRedundancy.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+	<None Include="SessionRecords\Microsoft.Azure.Commands.Sql.Test.ScenarioTests.ElasticPoolCrudTests\TestElasticPoolCancelOperation.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
     <None Include="SessionRecords\Microsoft.Azure.Commands.Sql.Test.ScenarioTests.FailoverGroupTests\TestCreateFailoverGroup_AutomaticPolicy.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>

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

@@ -563,16 +563,17 @@ function Test-CancelDatabaseOperation
 	.SYNOPSIS
 	Tests listing and cancelling a database operation
 #>
-function Test-CancelDatabaseOperationInternal ($location = "westcentralus")
+function Test-CancelDatabaseOperationInternal
 {
 	# Setup
-	$rg = Create-ResourceGroupForTest
+	$location = Get-Location "Microsoft.Sql" "operations" "Southeast Asia"
+	$rg = Create-ResourceGroupForTest $location
 	$server = Create-ServerForTest $rg $location
 
 	$databaseName = Get-DatabaseName
 	$db = New-AzureRmSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName `
 		-Edition Standard -MaxSizeBytes 250GB -RequestedServiceObjectiveName S0
-	Assert-AreEqual $db.DatabaseName $databaseName
+	Assert-AreEqual $db.DatabaseName $databaseName 'Create database failed.'
 
 	# Database will be Standard s0 with maxsize: 268435456000 (250GB)
 
@@ -581,9 +582,9 @@ function Test-CancelDatabaseOperationInternal ($location = "westcentralus")
 		# Alter all properties
 		$db1 = Set-AzureRmSqlDatabase -ResourceGroupName $db.ResourceGroupName -ServerName $db.ServerName -DatabaseName $db.DatabaseName `
 			-Edition Standard -RequestedServiceObjectiveName S1
-		Assert-AreEqual $db1.DatabaseName $db.DatabaseName
-		Assert-AreEqual $db1.Edition Standard
-		Assert-AreEqual $db1.CurrentServiceObjectiveName S1
+		Assert-AreEqual $db1.DatabaseName $db.DatabaseName 'Alter db name not equal'
+		Assert-AreEqual $db1.Edition Standard 'Alter db edition not equal'
+		Assert-AreEqual $db1.CurrentServiceObjectiveName S1 'Alter db slo not equal'
 
 		# list and cancel a database operation
 		$dbactivity = Get-AzureRmSqlDatabaseActivity -ResourceGroupName $db.ResourceGroupName -ServerName $db.ServerName -DatabaseName $db.DatabaseName

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

@@ -73,5 +73,12 @@ public void TestElasticPoolRemove()
         {
             RunPowerShellTest("Test-RemoveElasticPool");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestElasticPoolCancelOperation()
+        {
+            RunPowerShellTest("Test-ListAndCancelElasticPoolOperation");
+        }
     }
 }

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

@@ -297,4 +297,91 @@ function Test-RemoveElasticPool
     {
         Remove-ResourceGroupForTest $rg
     }
+}
+
+<#
+	.SYNOPSIS
+	Test listing and cancelling a elastic pool operation
+#>
+function Test-ListAndCancelElasticPoolOperation
+{
+	# Setup
+	$location = Get-Location "Microsoft.Sql" "operations" "Southeast Asia"
+	$rg = Create-ResourceGroupForTest $location
+	$server = Create-ServerForTest $rg $location
+
+	$poolName = Get-ElasticPoolName
+	$ep1 = New-AzureRmSqlElasticPool -ServerName $server.ServerName -ResourceGroupName $rg.ResourceGroupName `
+		-ElasticPoolName $poolName -Edition Premium -Dtu 125 -DatabaseDtuMin 0 -DatabaseDtuMax 50
+	Assert-NotNull $ep1
+
+	$poolName = Get-ElasticPoolName
+	$ep2 = $server | New-AzureRmSqlElasticPool -ElasticPoolName $poolName -Edition Premium -Dtu 250 -DatabaseDtuMin 0 `
+         -DatabaseDtuMax 50
+	Assert-NotNull $ep2
+
+	# Elastic pool will be Premium with DTU 125
+
+	try
+	{
+		# Update the elastic pool ep1 to premium with 250 Dtu
+		$ep1update = Set-AzureRmSqlElasticPool -ResourceGroupName $ep1.ResourceGroupName -ServerName $ep1.ServerName -ElasticPoolName $ep1.ElasticPoolName `
+			-Edition Premium -Dtu 250 -DatabaseDtuMin 25 -DatabaseDtuMax 125
+		Assert-AreEqual $ep1.ElasticPoolName $ep1update.ElasticPoolName
+		Assert-AreEqual Premium $ep1update.Edition
+		Assert-AreEqual 250 $ep1update.Dtu
+
+		# List and Cancel the elastic pool update operation
+		$epactivity = Get-AzureRmSqlElasticPoolActivity -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -ElasticPoolName $ep1update.ElasticPoolName
+		$epactivityId
+
+		For($i=0; $i -lt $epactivity.Length; $i++) {
+			if($epactivity[$i].Operation -eq "UPDATE"){
+				$epactivityId = $epactivity[$i].OperationId
+			}
+		}
+
+		try
+		{
+			# cancel a pool update operation with all values
+			$activityCancel = Stop-AzureRmSqlElasticPoolActivity -ResourceGroupName $ep1.ResourceGroupName -ServerName $ep1.ServerName -ElasticPoolName $ep1.ElasticPoolName -OperationId $epactivityId
+		}
+		Catch
+		{
+			$ErrorMessage = $_.Exception.Message
+			Assert-AreEqual True $ErrorMessage.Contains("Cannot cancel management operation '" + $epactivityId + "' in the current state") $ErrorMessage
+		}
+
+		# piping test on related pool operations
+		# Update ep2 tp Premium with 500 Dtu
+		$ep2update = Set-AzureRmSqlElasticPool -ResourceGroupName $ep2.ResourceGroupName -ServerName $ep2.ServerName -ElasticPoolName $ep2.ElasticPoolName `
+			-Edition Premium -Dtu 500 -DatabaseDtuMin 25 -DatabaseDtuMax 250
+		Assert-AreEqual $ep2.ElasticPoolName $ep2update.ElasticPoolName
+		Assert-AreEqual Premium $ep2update.Edition
+		Assert-AreEqual 500 $ep2update.Dtu
+
+		$epactivity = $ep2update | Get-AzureRmSqlElasticPoolActivity
+		For($i=0; $i -lt $epactivity.Length; $i++) {
+			if($epactivity[$i].Operation -eq "UPDATE"){
+				$epactivityId = $epactivity[$i].OperationId
+			}
+		}
+
+		$epactivity = $ep2update | Get-AzureRmSqlElasticPoolActivity -OperationId $epactivityId
+		
+		try
+		{
+			# cancel a pool update operation using piping
+			$activityCancel = $epactivity | Stop-AzureRmSqlElasticPoolActivity
+		}
+		Catch
+		{
+			$ErrorMessage = $_.Exception.Message
+			Assert-AreEqual True $ErrorMessage.Contains("Cannot cancel management operation '" + $epactivityId + "' in the current state") $ErrorMessage
+		}
+	}
+	finally
+	{
+		Remove-ResourceGroupForTest $rg
+	}
 }

src/ResourceManager/Sql/Commands.Sql.Test/SessionRecords/Microsoft.Azure.Commands.Sql.Test.ScenarioTests.ElasticPoolCrudTests/TestElasticPoolCancelOperation.json

@@ -70,6 +70,7 @@
     <Compile Include="Database\Cmdlet\StopAzureSqlDatabaseActivity.cs" />
     <Compile Include="Database\Model\DatabaseReadScale.cs" />
     <Compile Include="Database\Model\AzureSqlDatabaseCreateOrUpdateModel.cs" />
+    <Compile Include="Elastic Pools\Cmdlet\StopAzureSqlElasticPoolActivity.cs" />
     <Compile Include="Failover Group\Cmdlet\AddAzureSqlDatabaseToFailoverGroup.cs" />
     <Compile Include="Failover Group\Cmdlet\AzureSqlFailoverGroupCmdletBase.cs" />
     <Compile Include="Failover Group\Cmdlet\GetAzureSqlFailoverGroup.cs" />

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

@@ -97,5 +97,20 @@ public class DatabaseState
         /// Gets or sets the state of the properties associated with the request
         /// </summary>
         public DatabaseState Properties { get; set; }
+
+        /// <summary>
+        /// Gets or sets the estimated the completion time of the database operation
+        /// </summary>
+        public DateTime? EstimatedCompletionTime { get; set; }
+
+        /// <summary>
+        /// Gets or sets the detailed description of the database operation
+        /// </summary>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value to indicate if the database operation can be cancelled
+        /// </summary>
+        public bool? IsCancellable { get; set; }
     }
 }

src/ResourceManager/Sql/Commands.Sql/Database/Model/AzureSqlDatabaseActivityModel.cs

@@ -306,7 +306,10 @@ internal IEnumerable<AzureSqlDatabaseActivityModel> ListDatabaseActivity(string
                         {
                             Current = new Dictionary<string, string>(),
                             Requested = new Dictionary<string, string>()
-                        }
+                        },
+                        EstimatedCompletionTime = r.EstimatedCompletionTime,
+                        Description = r.Description,
+                        IsCancellable = r.IsCancellable
                     };
                 });
 

src/ResourceManager/Sql/Commands.Sql/Database/Services/AzureSqlDatabaseAdapter.cs

@@ -17,6 +17,7 @@
 using Microsoft.Azure.Commands.Sql.Common;
 using Microsoft.Azure.Commands.Sql.ElasticPool.Model;
 using Microsoft.Azure.Commands.Sql.ElasticPool.Services;
+using System;
 using System.Collections.Generic;
 using System.Management.Automation;
 
@@ -44,6 +45,15 @@ public abstract class AzureSqlElasticPoolActivityCmdletBase : AzureSqlCmdletBase
         [ValidateNotNullOrEmpty]
         public string ElasticPoolName { get; set; }
 
+        /// <summary>
+        /// Gets or sets the operation id to use.
+        /// </summary>
+        [Parameter(Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The ID of the operation to retrieve.")]
+        [ValidateNotNullOrEmpty]
+        public Guid? OperationId { get; set; }
+
         /// <summary>
         /// Initializes the adapter
         /// </summary>

src/ResourceManager/Sql/Commands.Sql/Elastic Pools/Cmdlet/AzureSqlElasticPoolActivityCmdletBase.cs

@@ -0,0 +1,65 @@
+// ----------------------------------------------------------------------------------
+//
+// 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 Microsoft.Azure.Commands.Sql.ElasticPool.Model;
+using System.Collections.Generic;
+using System.Management.Automation;
+
+namespace Microsoft.Azure.Commands.Sql.ElasticPool.Cmdlet
+{
+    [Cmdlet(VerbsLifecycle.Stop, "AzureRmSqlElasticPoolActivity", SupportsShouldProcess = true), OutputType(typeof(AzureSqlElasticPoolActivityModel))]
+    public class StopAzureSqlElasticPoolActivity : AzureSqlElasticPoolActivityCmdletBase
+    {
+        /// <summary>
+        ///  Defines whether the cmdlets will successfully returned at the end of its execution
+        /// </summary>
+        [Parameter(Mandatory = false)]
+        public SwitchParameter PassThru { get; set; }
+
+        /// <summary>
+        /// Gets elastic pool activity
+        /// </summary>
+        /// <returns>List of elastic pool activies</returns>
+        protected override IEnumerable<AzureSqlElasticPoolActivityModel> GetEntity()
+        {
+            return ModelAdapter.GetElasticPoolActivity(this.ResourceGroupName, this.ServerName, this.ElasticPoolName);
+        }
+
+        /// <summary>
+        /// No user input to apply to model
+        /// </summary>
+        /// <param name="model">Model retrieved from service</param>
+        /// <returns>The model that was passed in</returns>
+        protected override IEnumerable<AzureSqlElasticPoolActivityModel> ApplyUserInputToModel(IEnumerable<AzureSqlElasticPoolActivityModel> model)
+        {
+            return model;
+        }
+
+        /// <summary>
+        /// No changes to persist to server
+        /// </summary>
+        /// <param name="entity">The output of apply user input to model</param>
+        /// <returns>The input entity</returns>
+        protected override IEnumerable<AzureSqlElasticPoolActivityModel> PersistChanges(IEnumerable<AzureSqlElasticPoolActivityModel> entity)
+        {
+            return ModelAdapter.CancelElasticPoolActivity(this.ResourceGroupName, this.ServerName, this.ElasticPoolName, this.OperationId);
+        }
+
+        /// <summary>
+        /// Returns true if the model object that was constructed by this cmdlet should be written out
+        /// </summary>
+        /// <returns>True if the model object should be written out, False otherwise</returns>
+        protected override bool WriteResult() { return PassThru; }
+    } 
+}

src/ResourceManager/Sql/Commands.Sql/Elastic Pools/Cmdlet/StopAzureSqlElasticPoolActivity.cs

@@ -36,6 +36,11 @@ public class AzureSqlElasticPoolActivityModel
         /// </summary>
         public string ElasticPoolName { get; set; }
 
+        /// <summary>
+        /// Gets or sets the name of the resource group
+        /// </summary>
+        public string ResourceGroupName { get; set; }
+
         /// <summary>
         /// Gets or sets the state
         /// </summary>
@@ -100,5 +105,20 @@ public class AzureSqlElasticPoolActivityModel
         /// Gets or sets the requested storage limit in GB
         /// </summary>
         public long? RequestedStorageLimitInGB { get; set; }
+
+        /// <summary>
+        /// Gets or sets the estimated completion time of the elastic pool operation
+        /// </summary>
+        public DateTime? EstimatedCompletionTime { get; set; }
+
+        /// <summary>
+        /// Gets or sets the description of the elastic pool operation
+        /// </summary>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value to indicate if the elastic pool operation can be cancelled
+        /// </summary>
+        public bool? IsCancellable { get; set; }
     }
 }