Skip to content

[CosmosDB] Add breaking change notification for list connection string output change #24108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 7, 2024
Merged

[CosmosDB] Add breaking change notification for list connection string output change #24108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d7ef3d
add breaking change notification for list connection string changes
cjmsft Feb 5, 2024
1f2ee5b
use GenericBreakingChangeWithVersionAttribute
cjmsft Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/CosmosDB/CosmosDB/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
-->

## Upcoming Release
* Added breaking change message for ListConnectionStrings changes

## Version 1.14.0
* Introduced Restore-AzCosmosDBSqlDatabase, Restore-AzCosmosDBSqlContainer to restore deleted database and containers in the same account for SQL.
Expand Down
2 changes: 2 additions & 0 deletions src/CosmosDB/CosmosDB/CosmosDBAccount/GetAzCosmosDBAccountKey.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@
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
{
[GenericBreakingChangeWithVersionAttribute("Output type for -Type ConnectionStrings will be changed to List<DatabaseAccountConnectionString> in next major version.", Constants.DeprecateByAzVersion12, Constants.DeprecateByVersion2)]
[Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CosmosDBAccountKey", DefaultParameterSetName = NameParameterSet), OutputType(typeof(Hashtable))]
public class GetAzCosmosDBAccountKey : AzureCosmosDBCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/CosmosDB/CosmosDB/Helpers/Constants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ namespace Microsoft.Azure.Commands.CosmosDB.Helpers
{
internal static class Constants
{

public const string DeprecateByAzVersion12 = "12.0.0";
public const string DeprecateByVersion2 = "2.0.0";

public const string ResourceGroupNameHelpMessage = "Name of resource group.";
public const string ResourceIdHelpMessage = "ResourceId of the resource.";

Expand Down