Merge pull request #7134 from chidmdxx/preview

Add Rollback option to resource group level resources

Author: markcowl

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Implementation/ResourceGroupDeployments/NewAzureResourceGroupDeploymentCmdlet.cs

@@ -18,6 +18,7 @@
 using ProjectResources = Microsoft.Azure.Commands.ResourceManager.Cmdlets.Properties.Resources;
 using System.Management.Automation;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using System;
 
 namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
 {
@@ -45,6 +46,12 @@ public class NewAzureResourceGroupDeploymentCmdlet : ResourceWithParameterCmdlet
         [ValidateSet("RequestContent", "ResponseContent", "All", "None", IgnoreCase = true)]
         public string DeploymentDebugLogLevel { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used.")]
+        public SwitchParameter RollbackToLastDeployment { get; set; }
+
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used.")]
+        public string RollBackDeploymentName { get; set; }
+
         [Parameter(Mandatory = false, HelpMessage = "Do not ask for confirmation.")]
         public SwitchParameter Force { get; set; }
 
@@ -66,6 +73,11 @@ public override void ExecuteCmdlet()
                 ResourceGroupName,
                 () =>
                 {
+                    if (RollbackToLastDeployment && !string.IsNullOrEmpty(RollBackDeploymentName))
+                    {
+                        WriteExceptionError(new ArgumentException(ProjectResources.InvalidRollbackParameters));
+                    }
+
                     var parameters = new PSDeploymentCmdletParameters()
                     {
                         ResourceGroupName = ResourceGroupName,
@@ -74,7 +86,14 @@ public override void ExecuteCmdlet()
                         TemplateFile = TemplateUri ?? this.TryResolvePath(TemplateFile),
                         TemplateParameterObject = GetTemplateParameterObject(TemplateParameterObject),
                         ParameterUri = TemplateParameterUri,
-                        DeploymentDebugLogLevel = GetDeploymentDebugLogLevel(DeploymentDebugLogLevel)
+                        DeploymentDebugLogLevel = GetDeploymentDebugLogLevel(DeploymentDebugLogLevel),
+                        OnErrorDeployment = RollbackToLastDeployment || !string.IsNullOrEmpty(RollBackDeploymentName)
+                            ? new OnErrorDeployment
+                            {
+                                Type = RollbackToLastDeployment ? OnErrorDeploymentType.LastSuccessful : OnErrorDeploymentType.SpecificDeployment,
+                                DeploymentName = RollbackToLastDeployment ? null : RollBackDeploymentName
+                            }
+                            : null
                     };
 
                     if (!string.IsNullOrEmpty(parameters.DeploymentDebugLogLevel))

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Implementation/ResourceGroupDeployments/TestAzureResourceGroupDeploymentCmdlet.cs

@@ -16,6 +16,8 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Management.ResourceManager.Models;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
+using ProjectResources = Microsoft.Azure.Commands.ResourceManager.Cmdlets.Properties.Resources;
+using System;
 using System.Collections.Generic;
 using System.Management.Automation;
 
@@ -35,19 +37,37 @@ public class TestAzureResourceGroupDeploymentCmdlet : ResourceWithParameterCmdle
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The deployment mode.")]
         public DeploymentMode Mode { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used.")]
+        public SwitchParameter RollbackToLastDeployment { get; set; }
+
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used.")]
+        public string RollBackDeploymentName { get; set; }
+
         public TestAzureResourceGroupDeploymentCmdlet()
         {
             this.Mode = DeploymentMode.Incremental;
         }
 
         public override void ExecuteCmdlet()
         {
+            if (RollbackToLastDeployment && !string.IsNullOrEmpty(RollBackDeploymentName))
+            {
+                WriteExceptionError(new ArgumentException(ProjectResources.InvalidRollbackParameters));
+            }
+
             PSDeploymentCmdletParameters parameters = new PSDeploymentCmdletParameters()
             {
                 ResourceGroupName = ResourceGroupName,
                 TemplateFile = TemplateUri ?? this.TryResolvePath(TemplateFile),
                 TemplateParameterObject = GetTemplateParameterObject(TemplateParameterObject),
-                ParameterUri = TemplateParameterUri
+                ParameterUri = TemplateParameterUri,
+                OnErrorDeployment = RollbackToLastDeployment || !string.IsNullOrEmpty(RollBackDeploymentName)
+                    ? new OnErrorDeployment
+                    {
+                        Type = RollbackToLastDeployment ? OnErrorDeploymentType.LastSuccessful : OnErrorDeploymentType.SpecificDeployment,
+                        DeploymentName = RollbackToLastDeployment ? null : RollBackDeploymentName
+                    }
+                    : null
             };
 
             WriteObject(ResourceManagerSdkClient.ValidateDeployment(parameters, Mode));

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Properties/Resources.Designer.cs

@@ -357,6 +357,9 @@
   <data name="WarnOnDeploymentDebugSetting" xml:space="preserve">
     <value>The DeploymentDebug setting has been enabled. This can potentially log secrets like passwords used in resource property or listKeys operations when you retrieve the deployment operations through Get-AzureRmResourceGroupDeploymentOperation</value>
   </data>
+  <data name="InvalidRollbackParameters" xml:space="preserve">
+    <value>The paramater -RollbackToLastDeployment and -RollBackDeploymentName can't be defined at the same time.</value>
+  </data>
   <data name="CheckingDeploymentStatus" xml:space="preserve">
     <value>Checking deployment status in {0} seconds</value>
   </data>

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Properties/Resources.resx

@@ -450,6 +450,7 @@ private Deployment CreateBasicDeployment(PSDeploymentCmdletParameters parameters
             }
 
             deployment.Location = parameters.Location;
+            deployment.Properties.OnErrorDeployment = parameters.OnErrorDeployment;
 
             return deployment;
         }

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/SdkClient/ResourceManagerSdkClient.cs

@@ -25,5 +25,7 @@ public class PSDeploymentCmdletParameters
         public string ParameterUri { get; set; }
 
         public string DeploymentDebugLogLevel { get; set; }
+
+        public OnErrorDeployment OnErrorDeployment { get; set; }
     }
 }

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/SdkModels/Deployments/PSDeploymentCmdletParameters.cs

@@ -22,5 +22,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels
     public class PSResourceGroupDeployment: PSDeploymentObject
     { 
         public string ResourceGroupName { get; set; }
+
+        public OnErrorDeploymentExtended OnErrorDeployment { get; set; }
     }
 }

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/SdkModels/Deployments/PSResourceGroupDeployment.cs

@@ -42,6 +42,8 @@ public class NewAzureResourceGroupDeploymentCommandTests : RMTestBase
 
         private string deploymentName = "fooDeployment";
 
+        private string lastDeploymentName = "oldfooDeployment";
+
         private string templateFile = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, @"Resources\sampleTemplateFile.json");
 
         public NewAzureResourceGroupDeploymentCommandTests(ITestOutputHelper output)
@@ -107,6 +109,139 @@ public void CreatesNewPSResourceGroupDeploymentWithUserTemplate()
             Assert.Equal(expectedParameters.DeploymentName, actualParameters.DeploymentName);
             Assert.Equal(expectedParameters.TemplateFile, actualParameters.TemplateFile);
             Assert.NotNull(actualParameters.TemplateParameterObject);
+            Assert.Null(actualParameters.OnErrorDeployment);
+
+            commandRuntimeMock.Verify(f => f.WriteObject(expected), Times.Once());
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void CreatesNewPSResourceGroupDeploymentWithUserTemplateSpecificRollback()
+        {
+            PSDeploymentCmdletParameters expectedParameters = new PSDeploymentCmdletParameters()
+            {
+                TemplateFile = templateFile,
+                DeploymentName = deploymentName,
+                OnErrorDeployment = new OnErrorDeployment
+                {
+                    Type = OnErrorDeploymentType.SpecificDeployment,
+                    DeploymentName = lastDeploymentName
+                }
+            };
+            PSDeploymentCmdletParameters actualParameters = new PSDeploymentCmdletParameters();
+            PSResourceGroupDeployment expected = new PSResourceGroupDeployment()
+            {
+                Mode = DeploymentMode.Incremental,
+                DeploymentName = deploymentName,
+                CorrelationId = "123",
+                Outputs = new Dictionary<string, DeploymentVariable>()
+                {
+                    { "Variable1", new DeploymentVariable() { Value = "true", Type = "bool" } },
+                    { "Variable2", new DeploymentVariable() { Value = "10", Type = "int" } },
+                    { "Variable3", new DeploymentVariable() { Value = "hello world", Type = "string" } }
+                },
+                Parameters = new Dictionary<string, DeploymentVariable>()
+                {
+                    { "Parameter1", new DeploymentVariable() { Value = "true", Type = "bool" } },
+                    { "Parameter2", new DeploymentVariable() { Value = "10", Type = "int" } },
+                    { "Parameter3", new DeploymentVariable() { Value = "hello world", Type = "string" } }
+                },
+                ProvisioningState = ProvisioningState.Succeeded.ToString(),
+                ResourceGroupName = resourceGroupName,
+                TemplateLink = new TemplateLink()
+                {
+                    ContentVersion = "1.0",
+                    Uri = "http://mytemplate.com"
+                },
+                Timestamp = new DateTime(2014, 2, 13),
+                OnErrorDeployment = new OnErrorDeploymentExtended
+                {
+                    Type = OnErrorDeploymentType.SpecificDeployment,
+                    DeploymentName = lastDeploymentName
+                }
+            };
+            resourcesClientMock.Setup(f => f.ExecuteDeployment(
+                It.IsAny<PSDeploymentCmdletParameters>()))
+                .Returns(expected)
+                .Callback((PSDeploymentCmdletParameters p) => { actualParameters = p; });
+
+            cmdlet.ResourceGroupName = resourceGroupName;
+            cmdlet.Name = expectedParameters.DeploymentName;
+            cmdlet.TemplateFile = expectedParameters.TemplateFile;
+            cmdlet.RollBackDeploymentName = lastDeploymentName;
+            cmdlet.ExecuteCmdlet();
+
+            Assert.Equal(expectedParameters.DeploymentName, actualParameters.DeploymentName);
+            Assert.Equal(expectedParameters.TemplateFile, actualParameters.TemplateFile);
+            Assert.NotNull(actualParameters.TemplateParameterObject);
+            Assert.NotNull(actualParameters.OnErrorDeployment);
+            Assert.Equal(expectedParameters.OnErrorDeployment.Type, actualParameters.OnErrorDeployment.Type);
+            Assert.Equal(expectedParameters.OnErrorDeployment.DeploymentName, actualParameters.OnErrorDeployment.DeploymentName);
+
+            commandRuntimeMock.Verify(f => f.WriteObject(expected), Times.Once());
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void CreatesNewPSResourceGroupDeploymentWithUserTemplateEmptyRollback()
+        {
+            PSDeploymentCmdletParameters expectedParameters = new PSDeploymentCmdletParameters()
+            {
+                TemplateFile = templateFile,
+                DeploymentName = deploymentName,
+                OnErrorDeployment = new OnErrorDeployment
+                {
+                    Type = OnErrorDeploymentType.LastSuccessful,
+                }
+            };
+            PSDeploymentCmdletParameters actualParameters = new PSDeploymentCmdletParameters();
+            PSResourceGroupDeployment expected = new PSResourceGroupDeployment()
+            {
+                Mode = DeploymentMode.Incremental,
+                DeploymentName = deploymentName,
+                CorrelationId = "123",
+                Outputs = new Dictionary<string, DeploymentVariable>()
+                {
+                    { "Variable1", new DeploymentVariable() { Value = "true", Type = "bool" } },
+                    { "Variable2", new DeploymentVariable() { Value = "10", Type = "int" } },
+                    { "Variable3", new DeploymentVariable() { Value = "hello world", Type = "string" } }
+                },
+                Parameters = new Dictionary<string, DeploymentVariable>()
+                {
+                    { "Parameter1", new DeploymentVariable() { Value = "true", Type = "bool" } },
+                    { "Parameter2", new DeploymentVariable() { Value = "10", Type = "int" } },
+                    { "Parameter3", new DeploymentVariable() { Value = "hello world", Type = "string" } }
+                },
+                ProvisioningState = ProvisioningState.Succeeded.ToString(),
+                ResourceGroupName = resourceGroupName,
+                TemplateLink = new TemplateLink()
+                {
+                    ContentVersion = "1.0",
+                    Uri = "http://mytemplate.com"
+                },
+                Timestamp = new DateTime(2014, 2, 13),
+                OnErrorDeployment = new OnErrorDeploymentExtended
+                {
+                    Type = OnErrorDeploymentType.LastSuccessful,
+                }
+            };
+            resourcesClientMock.Setup(f => f.ExecuteDeployment(
+                It.IsAny<PSDeploymentCmdletParameters>()))
+                .Returns(expected)
+                .Callback((PSDeploymentCmdletParameters p) => { actualParameters = p; });
+
+            cmdlet.ResourceGroupName = resourceGroupName;
+            cmdlet.Name = expectedParameters.DeploymentName;
+            cmdlet.TemplateFile = expectedParameters.TemplateFile;
+            cmdlet.RollbackToLastDeployment = true;
+            cmdlet.ExecuteCmdlet();
+
+            Assert.Equal(expectedParameters.DeploymentName, actualParameters.DeploymentName);
+            Assert.Equal(expectedParameters.TemplateFile, actualParameters.TemplateFile);
+            Assert.NotNull(actualParameters.TemplateParameterObject);
+            Assert.NotNull(actualParameters.OnErrorDeployment);
+            Assert.Equal(expectedParameters.OnErrorDeployment.Type, actualParameters.OnErrorDeployment.Type);
+            Assert.Equal(expectedParameters.OnErrorDeployment.DeploymentName, actualParameters.OnErrorDeployment.DeploymentName);
 
             commandRuntimeMock.Verify(f => f.WriteObject(expected), Times.Once());
         }

src/ResourceManager/Resources/Commands.Resources.Test/ResourceGroupDeployments/NewAzureResourceGroupDeploymentCommandTests.cs

@@ -18,6 +18,8 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Update New-AzureRmResourceGroupDeployment with new parameter RollbackAction
+    - Add support for OnErrorDeployment with the new parameter.
 * Support managed identity on policy assignments.
 * Parameters with default values are no longer requred when assigning a policy with `New-AzureRmPolicyAssignment`
 * Add new cmdlet Get-AzureRmPolicyAlias for retrieving policy aliases

src/ResourceManager/Resources/Commands.Resources/ChangeLog.md

@@ -52,5 +52,7 @@ public string OutputsString
         {
             get { return ResourcesExtensions.ConstructDeploymentVariableTable(Outputs); }
         }
+
+        public OnErrorDeploymentExtended OnErrorDeployment { get; set; }
     }
 }

src/ResourceManager/Resources/Commands.Resources/Models.ResourceGroups/PSResourceGroupDeployment.cs

@@ -230,6 +230,7 @@ private static PSResourceGroupDeployment CreatePSResourceGroupDeployment(
                 deploymentObject.ProvisioningState = properties.ProvisioningState;
                 deploymentObject.TemplateLink = properties.TemplateLink;
                 deploymentObject.CorrelationId = properties.CorrelationId;
+                deploymentObject.OnErrorDeployment = properties.OnErrorDeployment;
 
                 if (properties.DebugSetting() != null && !string.IsNullOrEmpty(properties.DebugSetting().DetailLevel()))
                 {