Skip to content

Commit 64466a8

Browse files
author
carjackson-msft
authored
[CosmosDB] Add breaking change notification for list connection string output change (Azure#24108)
* add breaking change notification for list connection string changes * use GenericBreakingChangeWithVersionAttribute
1 parent c6ecb61 commit 64466a8

File tree

3 files changed

+7
-0
lines changed

3 files changed

+7
-0
lines changed

src/CosmosDB/CosmosDB/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-->
2020

2121
## Upcoming Release
22+
* Added breaking change message for ListConnectionStrings changes
2223

2324
## Version 1.14.0
2425
* Introduced Restore-AzCosmosDBSqlDatabase, Restore-AzCosmosDBSqlContainer to restore deleted database and containers in the same account for SQL.

src/CosmosDB/CosmosDB/CosmosDBAccount/GetAzCosmosDBAccountKey.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@
2020
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
2121
using Microsoft.Azure.Management.CosmosDB.Models;
2222
using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
23+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2324

2425
namespace Microsoft.Azure.Commands.CosmosDB
2526
{
27+
[GenericBreakingChangeWithVersionAttribute("Output type for -Type ConnectionStrings will be changed to List<DatabaseAccountConnectionString> in next major version.", Constants.DeprecateByAzVersion12, Constants.DeprecateByVersion2)]
2628
[Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBAccountKey", DefaultParameterSetName = NameParameterSet), OutputType(typeof(Hashtable))]
2729
public class GetAzCosmosDBAccountKey : AzureCosmosDBCmdletBase
2830
{

src/CosmosDB/CosmosDB/Helpers/Constants.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ namespace Microsoft.Azure.Commands.CosmosDB.Helpers
1616
{
1717
internal static class Constants
1818
{
19+
20+
public const string DeprecateByAzVersion12 = "12.0.0";
21+
public const string DeprecateByVersion2 = "2.0.0";
22+
1923
public const string ResourceGroupNameHelpMessage = "Name of resource group.";
2024
public const string ResourceIdHelpMessage = "ResourceId of the resource.";
2125

0 commit comments

Comments
 (0)