[Don't Merge!][SecureString] [SDK-based][Az.Storage] Final Result

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

@@ -83,15 +83,15 @@ function Test-StorageAccount
         New-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname -KeyName key1;
 
         $stokey2 = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname;
-        Assert-AreNotEqual $stokey1[0].Value $stokey2[0].Value;
-        Assert-AreEqual $stokey2[1].Value $stokey1[1].Value;
+        Assert-AreNotEqual ($stokey1[0].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey2[0].ValueSecure | ConvertFrom-SecureString -AsPlainText);
+        Assert-AreEqual ($stokey2[1].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey1[1].ValueSecure | ConvertFrom-SecureString -AsPlainText);
 
         New-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname -KeyName key2;
 
         $stokey3 = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname;
-        Assert-AreNotEqual $stokey1[0].Value $stokey2[0].Value;
-        Assert-AreEqual $stokey3[0].Value $stokey2[0].Value;
-        Assert-AreNotEqual $stokey2[1].Value $stokey3[1].Value;
+        Assert-AreNotEqual ($stokey1[0].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey2[0].ValueSecure | ConvertFrom-SecureString -AsPlainText);
+        Assert-AreEqual ($stokey3[0].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey2[0].ValueSecure | ConvertFrom-SecureString -AsPlainText);
+        Assert-AreNotEqual ($stokey2[1].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey3[1].ValueSecure | ConvertFrom-SecureString -AsPlainText);
 
         Remove-AzStorageAccount -Force -ResourceGroupName $rgname -Name $stoname;
     }
@@ -360,7 +360,7 @@ function Test-GetAzureStorageAccountKey
         New-AzStorageAccount -ResourceGroupName $rgname -Name $stoname -Location $loc -Type $stotype;
 
         Retry-IfException { $global:stokeys = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname; }
-        Assert-AreNotEqual $stokeys[1].Value $stokeys[0].Value;
+        Assert-AreNotEqual ($stokeys[1].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokeys[0].ValueSecure | ConvertFrom-SecureString -AsPlainText);
 
         Remove-AzStorageAccount -Force -ResourceGroupName $rgname -Name $stoname;
     }
@@ -397,15 +397,15 @@ function Test-NewAzureStorageAccountKey
         New-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname -KeyName key1;
 
         $stokey2 = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname;
-        Assert-AreNotEqual $stokey1[0].Value $stokey2[0].Value;
-        Assert-AreEqual $stokey1[1].Value $stokey2[1].Value;
+        Assert-AreNotEqual ($stokey1[0].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey2[0].ValueSecure | ConvertFrom-SecureString -AsPlainText);
+        Assert-AreEqual ($stokey1[1].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey2[1].ValueSecure | ConvertFrom-SecureString -AsPlainText);
 
         New-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname -KeyName key2;
 
         $stokey3 = Get-AzStorageAccountKey -ResourceGroupName $rgname -Name $stoname;
-        Assert-AreNotEqual $stokey1[0].Value $stokey2[0].Value;
-        Assert-AreEqual $stokey2[0].Value $stokey3[0].Value;
-        Assert-AreNotEqual $stokey2[1].Value $stokey3[1].Value;
+        Assert-AreNotEqual ($stokey1[0].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey2[0].ValueSecure | ConvertFrom-SecureString -AsPlainText);
+        Assert-AreEqual ($stokey2[0].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey3[0].ValueSecure | ConvertFrom-SecureString -AsPlainText);
+        Assert-AreNotEqual ($stokey2[1].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokey3[1].ValueSecure | ConvertFrom-SecureString -AsPlainText);
 
         Remove-AzStorageAccount -Force -ResourceGroupName $rgname -Name $stoname;
     }
@@ -438,7 +438,7 @@ function Test-PipingGetAccountToGetKey
         New-AzStorageAccount -ResourceGroupName $rgname -Name $stoname -Location $loc -Type $stotype;
 
         Retry-IfException { $global:stokeys = Get-AzStorageAccount -ResourceGroupName $rgname -Name $stoname | Get-AzStorageAccountKey -ResourceGroupName $rgname; }
-        Assert-AreNotEqual $stokeys[0].Value $stokeys[1].Value;
+        Assert-AreNotEqual ($stokeys[0].ValueSecure | ConvertFrom-SecureString -AsPlainText) ($stokeys[1].ValueSecure | ConvertFrom-SecureString -AsPlainText);
 
         Remove-AzStorageAccount -Force -ResourceGroupName $rgname -Name $stoname;
     }
@@ -2276,7 +2276,7 @@ function Test-NewAzStorageContext
         $fileEndpoint = $sto.PrimaryEndpoints.File
         Assert-AreEqual $stoname $sto.StorageAccountName;
 
-        $stokey = (Get-AzStorageAccountKey -ResourceGroupName $rgname -StorageAccountName $sto.StorageAccountName)[0].Value
+        $stokey = (Get-AzStorageAccountKey -ResourceGroupName $rgname -StorageAccountName $sto.StorageAccountName)[0].ValueSecure | ConvertFrom-SecureString -AsPlainText
         # Need sanitize the sharedkey in record file, but New-AzStorageContext assume it's based64 string, so update it to a static based64 string.
         $stokey = "xxxxxxxx"
         $ctxAccountInfo = New-AzStorageContext -StorageAccountName $sto.StorageAccountName -StorageAccountKey $stokey

src/Storage/Storage.Management/Models/PSStorageAccountKey.cs

@@ -0,0 +1,72 @@
+// ----------------------------------------------------------------------------------
+//
+// 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 StorageModels = Microsoft.Azure.Management.Storage.Models;
+using Microsoft.WindowsAzure.Commands.Common;
+
+namespace Microsoft.Azure.Commands.Management.Storage.Models
+{
+    //Wrapper of StorageAccountKey property KeyPermission 
+    [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
+    public enum PSKeyPermission
+    {
+        [System.Runtime.Serialization.EnumMember(Value = "Read")]
+        Read,
+        [System.Runtime.Serialization.EnumMember(Value = "Full")]
+        Full
+    }
+
+    internal static class PSKeyPermissionEnumExtension
+    {
+        internal static PSKeyPermission? ParseKeyPermission(this StorageModels.KeyPermission? keyPermission)
+        {
+            if (keyPermission == null)
+            {
+                return null;
+            }
+            switch (keyPermission)
+            {
+                case StorageModels.KeyPermission.Read:
+                    return PSKeyPermission.Read;
+                case StorageModels.KeyPermission.Full:
+                    return PSKeyPermission.Full;
+            }
+            return null;
+        }
+    }
+
+    //Wrapper of StorageAccountKey  
+    public class PSStorageAccountKey
+    {
+        public PSStorageAccountKey(StorageModels.StorageAccountKey storageAccountKey)
+        {
+            this.KeyName = storageAccountKey.KeyName;
+            this.ValueSecure = storageAccountKey.Value.ConvertToSecureString();
+            this.Permissions = storageAccountKey.Permissions.ParseKeyPermission();
+            this.CreationTime = storageAccountKey.CreationTime;
+        }
+
+        [Newtonsoft.Json.JsonProperty(PropertyName = "keyName")]
+        public string KeyName { get; private set; }
+
+        [Newtonsoft.Json.JsonProperty(PropertyName = "value")]
+        public System.Security.SecureString ValueSecure { get; private set; }
+
+        [Newtonsoft.Json.JsonProperty(PropertyName = "permissions")]
+        public PSKeyPermission? Permissions { get; private set; }
+
+        [Newtonsoft.Json.JsonProperty(PropertyName = "creationTime")]
+        public System.DateTime? CreationTime { get; private set; }
+    }
+}

src/Storage/Storage.Management/StorageAccount/GetAzureStorageAccountKey.cs

@@ -12,14 +12,17 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Microsoft.Azure.Commands.Management.Storage.Models;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Management.Storage;
 using Microsoft.Azure.Management.Storage.Models;
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
+using System.Collections.Generic;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.Management.Storage
 {
-    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountKey"), OutputType(typeof(StorageAccountKey))]
+    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountKey"), OutputType(typeof(PSStorageAccountKey))]
     public class GetAzureStorageAccountKeyCommand : StorageAccountBaseCmdlet
     {
         [Parameter(
@@ -59,7 +62,13 @@ public override void ExecuteCmdlet()
                  this.Name,
                  listkeyExpend).Keys;
 
-            WriteObject(storageKeys, true);
+            WriteStorageAccountKeys(storageKeys);
+        }
+        private void WriteStorageAccountKeys(IList<StorageAccountKey> storageKeys)
+        {
+            List<PSStorageAccountKey> output = new List<PSStorageAccountKey>();
+            storageKeys.ForEach(key => { output.Add(new PSStorageAccountKey(key)); });
+            WriteObject(output, true);
         }
     }
 }

src/Storage/Storage.Management/help/Get-AzStorageAccountKey.md

@@ -144,7 +144,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### Microsoft.Azure.Management.Storage.Models.StorageAccountKey
+### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccountKey
 
 ## NOTES