[CosmosDB] [Breaking Change] Update ListConnectionStrings Response

src/CosmosDB/CosmosDB.Test/ScenarioTests/AccountTests.ps1

@@ -90,8 +90,15 @@ function Test-AccountRelatedCmdlets
   $cosmosDBAccountConnectionStrings = Get-AzCosmosDBAccountKey -Name $cosmosDBAccountName -ResourceGroupName $rgname -Type "ConnectionStrings"
   Assert-NotNull $cosmosDBAccountConnectionStrings
 
+  for (($i = 0); $i -lt $cosmosDBAccountConnectionStrings.Count; $i++) {
+    Assert-NotNull $cosmosDBAccountConnectionStrings[$i].KeyKind
+    Assert-NotNull $cosmosDBAccountConnectionStrings[$i].Type
+  }
+
   $cosmosDBAccountReadOnlyKeys = Get-AzCosmosDBAccountKey -Name $cosmosDBAccountName -ResourceGroupName $rgname -Type "ReadOnlyKeys"
   Assert-NotNull $cosmosDBAccountReadOnlyKeys
+  Assert-NotNull $cosmosDBAccountReadOnlyKeys["PrimaryReadonlyMasterKey"]
+  Assert-NotNull $cosmosDBAccountReadOnlyKeys["SecondaryReadonlyMasterKey"]
 
   $RegeneratedKey = New-AzCosmosDBAccountKey -Name $cosmosDBAccountName -ResourceGroupName $rgname -KeyKind "primary"
   Assert-NotNull $RegeneratedKey 

src/CosmosDB/CosmosDB/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* ListConnectionStrings response now includes keyKind and type properties
 
 ## Version 1.12.0
 * Added PublicNetworkAccess parameter to `Restore-AzCosmosDBAccount`.

src/CosmosDB/CosmosDB/CosmosDBAccount/GetAzCosmosDBAccountKey.cs

@@ -14,16 +14,19 @@
 
 using System;
 using System.Collections;
+using System.Collections.Generic;
 using System.Management.Automation;
 using Microsoft.Azure.Commands.CosmosDB.Helpers;
 using Microsoft.Azure.Commands.CosmosDB.Models;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Management.CosmosDB.Models;
 using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.CosmosDB
 {
-    [Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBAccountKey", DefaultParameterSetName = NameParameterSet), OutputType(typeof(Hashtable))]
+    [GenericBreakingChangeWithVersionAttribute("Output type for -Type ConnectionStrings has been changed to List<DatabaseAccountConnectionString>", Constants.deprecateByAzVersion11, Constants.deprecateByVersion8)]
+    [Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBAccountKey", DefaultParameterSetName = NameParameterSet), OutputType(typeof(Hashtable), typeof(IList<DatabaseAccountConnectionString>))]
     public class GetAzCosmosDBAccountKey : AzureCosmosDBCmdletBase
     {
         [Parameter(Mandatory = true, ParameterSetName = NameParameterSet, HelpMessage = Constants.ResourceGroupNameHelpMessage)]

src/CosmosDB/CosmosDB/Helpers/Constants.cs

@@ -16,6 +16,9 @@ namespace Microsoft.Azure.Commands.CosmosDB.Helpers
 {
     internal static class Constants
     {
+        public const string deprecateByAzVersion11 = "11.0.0";
+        public const string deprecateByVersion8 = "8.0.0";
+
         public const string ResourceGroupNameHelpMessage = "Name of resource group.";
         public const string ResourceIdHelpMessage = "ResourceId of the resource.";
 

src/CosmosDB/CosmosDB/Models/DatabaseAccount/PSDatabaseAccountKeys.cs

@@ -15,6 +15,7 @@
 namespace Microsoft.Azure.Commands.CosmosDB.Models
 {
     using System.Collections;
+    using System.Collections.Generic;
     using Microsoft.Azure.Management.CosmosDB.Models;
 
     public class PSDatabaseAccountListKeys 
@@ -43,7 +44,7 @@ public PSDatabaseAccountListKeys(DatabaseAccountListConnectionStringsResult data
 
             foreach (DatabaseAccountConnectionString connectionString in databaseAccountConnectionString.ConnectionStrings)
             {
-                Keys.Add(connectionString.Description, connectionString.ConnectionString);
+                ConnectionStrings.Add(connectionString);
             }
         }
 
@@ -61,5 +62,7 @@ public PSDatabaseAccountListKeys(DatabaseAccountListKeysResult databaseAccountLi
         }
 
         public Hashtable Keys { get; set; } = new Hashtable();
+
+        public IList<DatabaseAccountConnectionString> ConnectionStrings { get; set; } = new List<DatabaseAccountConnectionString>();
     }
 }

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBAccountKey.md

@@ -49,6 +49,22 @@ SecondaryReadonlyMasterKey     9YRcTABuOHcKyHAKf0lmCeHsrcXu02aeID1g3wjXjlX8SU4s2
 
 Lists the keys for CosmosDB Account. The Key Type can be value from : ConnectionStrings, Keys and ReadOnlyKeys. Default is Keys.
 
+### Example 2
+```powershell
+Get-AzCosmosDBAccountKey -ResourceGroupName rg1 -Name dbname -Type "ConnectionStrings"
+```
+
+```output
+ConnectionString                                                                                                                                                      Description                               KeyKind           Type
+----------------                                                                                                                                                      -----------                               -------           ----
+AccountEndpoint=https://cosmosdbaccount.documents.azure.com:443/;AccountKey=qjw0ISW1WNN0BIVPeaI7Tm3H8uZ1h7ESQjxaUendxHmIUNQowVvcL84fTqeXoC2HFgyu8Zo1mCFEcg0jZJHPjA==; Primary SQL Connection String             Primary           Sql
+AccountEndpoint=https://cosmosdbaccount.documents.azure.com:443/;AccountKey=qjw0ISW1WNN0BIVPeaI7Tm3H8uZ1h7ESQjxaUendxHmIUNQowVvcL84fTqeXoC2HFgyu8Zo1mCFEcg0jZJHPjA==; Secondary SQL Connection String           Secondary         Sql
+AccountEndpoint=https://cosmosdbaccount.documents.azure.com:443/;AccountKey=qjw0ISW1WNN0BIVPeaI7Tm3H8uZ1h7ESQjxaUendxHmIUNQowVvcL84fTqeXoC2HFgyu8Zo1mCFEcg0jZJHPjA==; Primary Read-Only SQL Connection String   PrimaryReadonly   Sql
+AccountEndpoint=https://cosmosdbaccount.documents.azure.com:443/;AccountKey=qjw0ISW1WNN0BIVPeaI7Tm3H8uZ1h7ESQjxaUendxHmIUNQowVvcL84fTqeXoC2HFgyu8Zo1mCFEcg0jZJHPjA==; Secondary Read-Only SQL Connection String SecondaryReadonly Sql
+```
+
+Lists the ConnectionStrings for CosmosDB Account by specifying Key Type ConnectionStrings.
+
 ## PARAMETERS
 
 ### -DefaultProfile