[CosmosDB] Add throughputBucket feature to CosmosDB preview #27971
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… model with help messages
Modified maximum throughput percentages for two buckets in `Test-SqlThroughputCmdlets`. Added assertions to verify updated bucket properties. Removed the test for container throughput buckets and the associated function `Test-SqlThroughputBucketCmdlets`. Adjusted formatting in `Test-ClientEncryptionKeyCmdletsUsingInputObject` for clarity.
Modified the help message for the `MaxThroughputPercentage` parameter in `NewAzCosmosDBThroughputBucketObject.cs` for clarity. Restored two help message constants in `Constants.cs` related to throughput buckets and added a new constant to improve usability in Cosmos DB resource management.
Updated `Test-SqlThroughputCmdlets` in `SqlOperationsTests.ps1` to add assertions for `ThroughputBuckets`. The test now verifies the count of buckets and checks the `Id` and `MaxThroughputPercentage` for each bucket to ensure expected values are set correctly.
Corrected the parameter name from `-Name $AccountName` to `-AccountName $AccountName` in the `Update-AzCosmosDBSqlContainerThroughput` function calls within `SqlOperationsTests.ps1`. This change ensures proper parameter usage and consistency across test cases, including instances with empty `-ThroughputBuckets`.
Refactor throughput handling in Azure Cosmos DB management library. Introduce `PSThroughputBucket` class to replace `ThroughputBucketResource`. Modify `CreateThroughputSettingsObject` to accept an array of `PSThroughputBucket`. Update `ThroughputSettingsGetResults` to ensure consistent usage of the new type, improving type safety and aligning with the updated data model for throughput settings.
Introduced `New-AzCosmosDBThroughputBucketObject` cmdlet to create CosmosDB Throughput Bucket objects, complete with documentation updates for synopsis, syntax, and examples. Enhanced existing CosmosDB cmdlets to support a new `-ThroughputBuckets` parameter, allowing users to specify multiple throughput buckets for better resource management. Updated documentation for all affected cmdlets to reflect these changes.
Enhanced the synopsis and description for the command by replacing placeholder text with a specific description. Added an example to illustrate usage, demonstrating how to create a new throughput bucket object with parameters. The parameters section remains unchanged.
Updated the Azure Cosmos DB PowerShell module to replace all instances of "ThroughputBuckets" with "ThroughputBucketsObject". This change affects test scripts, helper classes, and model definitions, ensuring consistency in the API. Help messages related to these parameters have also been updated for clarity on throughput bucket usage in Cosmos DB operations.
…mmands Renamed `-ThroughputBuckets` to `-ThroughputBucketsObject` across multiple Azure CosmosDB command documentation files. This change clarifies the expected input type, indicating that the parameter accepts an array of `PSThroughputBucket` objects.
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
pjohari-ms
changed the title
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
YanaXu
reviewed
Jun 25, 2025
| "New-AzCosmosDBSqlVectorEmbedding": {}, | ||
| "New-AzCosmosDBSqlVectorEmbeddingPolicy": {}, | ||
| "New-AzCosmosDBSqlVectorIndex": {}, | ||
| "New-AzCosmosDBTable": {}, |
There was a problem hiding this comment.
New command New-AzCosmosDBThroughputBucketObject has been added. This also orders the commands in alphabetical order which were previously not.
There was a problem hiding this comment.
This file is not updated manually. Please remove the change on it.
| @@ -51,7 +51,7 @@ public void TestCassandraMigrateThroughputCmdlets() | |||
| TestRunner.RunTestScript("Test-CassandraMigrateThroughputCmdlets"); | |||
| } | |||
|
|
|||
| [Fact] | |||
There was a problem hiding this comment.
why to skip this test? can we add it back?
There was a problem hiding this comment.
I think this was because 2 tests were failing only for linux and mac and we could not root cause why. The test is not related to changes made in this PR. CC: @pjohari-ms , @vidai-msft
There was a problem hiding this comment.
@YanaXu this test is in private preview, and was failing because the subscription required special features for it to work. Next release we will make it generic after enabling it across a few internal subscriptions.
|
Hi @pjohari-ms,
|
pjohari-ms
changed the title
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
YanaXu
approved these changes
Jun 27, 2025
|
Track the test issue with #28030 and merge this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.