Merge pull request #5223 from maddieclayton/AsJobStorage

Add -AsJob parameter to Storage cmdlets

Author: markcowl

src/ResourceManager/Storage/ChangeLog.md

@@ -24,6 +24,8 @@
     - Set-AzureRmStorageAccount
 * Added Location Completer to -Location parameters allowing tab completion through valid Locations
 * Added ResourceGroup Completer to -ResourceGroup parameters allowing tab completion through resource groups in current subscription
+* Added -AsJob support for long-running Storage cmdlets. Allows selected cmdlets to run in the background and return a job to track and control progress.
+    - Affected cmdlets are New-, Remove-, Add-, and Update- for Storage Account and Storage Account Network Rule.
 ## Version 4.0.1
 * Fixed assembly loading issue that caused some cmdlets to fail when executing
 
@@ -80,4 +82,4 @@
 
 ## Version 2.4.0
 
-## Version 2.3.0
+## Version 2.3.0

src/ResourceManager/Storage/Commands.Management.Storage.Test/ScenarioTests/StorageAccountTests.ps1

@@ -37,7 +37,8 @@ function Test-StorageAccount
 
         New-AzureRmResourceGroup -Name $rgname -Location $loc;
 
-        New-AzureRmStorageAccount -ResourceGroupName $rgname -Name $stoname -Location $loc -Type $stotype -Kind $kind -AccessTier $accessTier -EnableEncryptionService $encryptionServiceBF;
+        $job = New-AzureRmStorageAccount -ResourceGroupName $rgname -Name $stoname -Location $loc -Type $stotype -Kind $kind -AccessTier $accessTier -EnableEncryptionService $encryptionServiceBF -AsJob
+		$job | Wait-Job
         $stos = Get-AzureRmStorageAccount -ResourceGroupName $rgname;
 
         $stotype = 'StandardGRS';
@@ -565,22 +566,25 @@ function Test-NetworkRule
         Assert-AreEqual $stoacl.IpRules[1].IPAddressOrRange $ip4;
         Assert-AreEqual $stoacl.VirtualNetworkRules $null
 
-		Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName $rgname -Name $stoname -IPAddressOrRange "$ip3"
+		$job = Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName $rgname -Name $stoname -IPAddressOrRange "$ip3" -AsJob
+		$job | Wait-Job
         $stoacl = Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName $rgname -Name $stoname
         Assert-AreEqual $stoacl.Bypass 6;
         Assert-AreEqual $stoacl.DefaultAction Allow;
         Assert-AreEqual $stoacl.IpRules.Count 1
         Assert-AreEqual $stoacl.IpRules[0].IPAddressOrRange $ip4;
         Assert-AreEqual $stoacl.VirtualNetworkRules $null
 
-		Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName $rgname -Name $stoname -IpRule @() -DefaultAction Deny -Bypass None
+		$job = Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName $rgname -Name $stoname -IpRule @() -DefaultAction Deny -Bypass None -AsJob
+		$job | Wait-Job
         $stoacl = Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName $rgname -Name $stoname
         Assert-AreEqual $stoacl.Bypass 0;
         Assert-AreEqual $stoacl.DefaultAction Deny;
         Assert-AreEqual $stoacl.IpRules $null
         Assert-AreEqual $stoacl.VirtualNetworkRules $null
 
-		$stoacliprule | Add-AzureRmStorageAccountNetworkRule -ResourceGroupName $rgname -Name $stoname
+		$job = $stoacliprule | Add-AzureRmStorageAccountNetworkRule -ResourceGroupName $rgname -Name $stoname -AsJob
+		$job | Wait-Job
         $stoacl = Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName $rgname -Name $stoname
         Assert-AreEqual $stoacl.Bypass 0;
         Assert-AreEqual $stoacl.DefaultAction Deny;
@@ -589,10 +593,11 @@ function Test-NetworkRule
         Assert-AreEqual $stoacl.IpRules[1].IPAddressOrRange $ip4;
         Assert-AreEqual $stoacl.VirtualNetworkRules $null
 
-        Set-AzureRmStorageAccount -ResourceGroupName $rgname -Name $stoname  -NetworkRuleSet (@{bypass="AzureServices";
+        $job = Set-AzureRmStorageAccount -ResourceGroupName $rgname -Name $stoname -AsJob -NetworkRuleSet (@{bypass="AzureServices";
 			ipRules=(@{IPAddressOrRange="$ip1";Action="allow"},
             @{IPAddressOrRange="$ip2";Action="allow"});
 			defaultAction="Allow"}) 
+		$job | Wait-Job
 
 		$stoacl = Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName $rgname -Name $stoname
         Assert-AreEqual $stoacl.Bypass 4;
@@ -602,7 +607,8 @@ function Test-NetworkRule
         Assert-AreEqual $stoacl.IpRules[1].IPAddressOrRange $ip2;
         Assert-AreEqual $stoacl.VirtualNetworkRules $null
 
-        Remove-AzureRmStorageAccount -Force -ResourceGroupName $rgname -Name $stoname;
+        $job = Remove-AzureRmStorageAccount -Force -ResourceGroupName $rgname -Name $stoname -AsJob
+		$job | Wait-Job
     }
     finally
     {

src/ResourceManager/Storage/Commands.Management.Storage/StorageAccount/AddAzureStorageAccountNetworkRule.cs

@@ -92,6 +92,9 @@ public class AddAzureStorageAccountNetworkRuleCommand : StorageAccountBaseCmdlet
         [Alias("SubnetId", "VirtualNetworkId")]
         public string[] VirtualNetworkResourceId { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
+        public SwitchParameter AsJob { get; set; }
+
 
         public override void ExecuteCmdlet()
         {

src/ResourceManager/Storage/Commands.Management.Storage/StorageAccount/NewAzureStorageAccount.cs

@@ -138,6 +138,9 @@ public PSNetworkRuleSet NetworkRuleSet
             get; set;
         }
 
+        [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
+        public SwitchParameter AsJob { get; set; }
+
         public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();

src/ResourceManager/Storage/Commands.Management.Storage/StorageAccount/RemoveAzureStorageAccount.cs

@@ -43,20 +43,18 @@ public class RemoveAzureStorageAccountCommand : StorageAccountBaseCmdlet
         public string Name { get; set; }
 
         [Parameter(HelpMessage = "Force to Delete the Storage Account")]
-        public SwitchParameter Force
-        {
-            get { return force; }
-            set { force = value; }
-        }
-        private bool force = false;
+        public SwitchParameter Force { get; set; }
+
+        [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
+        public SwitchParameter AsJob { get; set; }
 
         public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();
 
             if (ShouldProcess(this.Name, "Remove Storage Account"))
             {
-                if (this.force || ShouldContinue(string.Format("Remove Storage Account '{0}' and all content in it", this.Name), ""))
+                if (this.Force || ShouldContinue(string.Format("Remove Storage Account '{0}' and all content in it", this.Name), ""))
                 {
                     this.StorageClient.StorageAccounts.Delete(
                     this.ResourceGroupName,

src/ResourceManager/Storage/Commands.Management.Storage/StorageAccount/RemoveAzureStorageAccountNetworkRule.cs

@@ -93,6 +93,9 @@ public class RemoveAzureStorageAccountNetworkRuleCommand : StorageAccountBaseCmd
         [Alias("SubnetId", "VirtualNetworkId")]
         public string[] VirtualNetworkResourceId { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
+        public SwitchParameter AsJob { get; set; }
+
         public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();

src/ResourceManager/Storage/Commands.Management.Storage/StorageAccount/SetAzureStorageAccount.cs

@@ -193,6 +193,9 @@ public PSNetworkRuleSet NetworkRuleSet
             HelpMessage = "Upgrade Storage Account Kind to StorageV2.")]
         public SwitchParameter UpgradeToStorageV2 { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
+        public SwitchParameter AsJob { get; set; }
+
         public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();

src/ResourceManager/Storage/Commands.Management.Storage/StorageAccount/UpdateAzureStorageAccountNetworkRuleSet.cs

@@ -118,6 +118,9 @@ public PSVirtualNetworkRule[] VirtualNetworkRule
         private bool isIpRuleSet = false;
         private bool isNetworkRuleSet = false;
 
+        [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
+        public SwitchParameter AsJob { get; set; }
+
 
         public override void ExecuteCmdlet()
         {

src/ResourceManager/Storage/Commands.Management.Storage/help/Add-AzureRmStorageAccountNetworkRule.md

@@ -15,27 +15,27 @@ schema: 2.0.0
 ### NetWorkRuleString (Default)
 ```
 Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String>
- -VirtualNetworkResourceId <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
+ -VirtualNetworkResourceId <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
 ### IpRuleObject
 ```
 Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPRule <PSIpRule[]>
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### NetworkRuleObject
 ```
 Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String>
- -VirtualNetworkRule <PSVirtualNetworkRule[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+ -VirtualNetworkRule <PSVirtualNetworkRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
+ [-Confirm] [<CommonParameters>]
 ```
 
 ### IpRuleString
 ```
 Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String>
- -IPAddressOrRange <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
+ -IPAddressOrRange <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
@@ -76,6 +76,21 @@ This command add several IpRule with IpRule objects, input with JSON.
 
 ## PARAMETERS
 
+### -AsJob
+Run cmdlet in the background
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -DefaultProfile
 The credentials, account, tenant, and subscription used for communication with Azure.
 
@@ -97,7 +112,7 @@ The Array of IpAddressOrRange, add IpRules with the input IpAddressOrRange and d
 ```yaml
 Type: String[]
 Parameter Sets: IpRuleString
-Aliases:
+Aliases: 
 
 Required: True
 Position: Named
@@ -112,7 +127,7 @@ The Array of IpRule objects to add to the NetworkRule Property.
 ```yaml
 Type: PSIpRule[]
 Parameter Sets: IpRuleObject
-Aliases:
+Aliases: 
 
 Required: True
 Position: Named
@@ -142,7 +157,7 @@ Specifies the name of the resource group contains the Storage account.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: 
 
 Required: True
 Position: 0
@@ -172,7 +187,7 @@ The Array of VirtualNetworkRule objects to add to the NetworkRule Property.
 ```yaml
 Type: PSVirtualNetworkRule[]
 Parameter Sets: NetworkRuleObject
-Aliases:
+Aliases: 
 
 Required: True
 Position: Named
@@ -229,3 +244,4 @@ Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule
 ## NOTES
 
 ## RELATED LINKS
+

src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccount.md

@@ -89,7 +89,7 @@ Specifies the name of the resource group that contains the Storage account to ge
 ```yaml
 Type: String
 Parameter Sets: ResourceGroupParameterSet
-Aliases:
+Aliases: 
 
 Required: False
 Position: 0
@@ -101,7 +101,7 @@ Accept wildcard characters: False
 ```yaml
 Type: String
 Parameter Sets: AccountNameParameterSet
-Aliases:
+Aliases: 
 
 Required: True
 Position: 0

src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountKey.md

@@ -77,7 +77,7 @@ Specifies the name of the resource group that contains the Storage account.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: 
 
 Required: True
 Position: 0

src/ResourceManager/Storage/Commands.Management.Storage/help/Get-AzureRmStorageAccountNetworkRuleSet.md

@@ -67,7 +67,7 @@ Specifies the name of the resource group contains the Storage account.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: 
 
 Required: True
 Position: 0
@@ -90,3 +90,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+