CosmosDB RP API 2024-11-15 Version

[pjohari-ms]

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

• New resource provider.
• New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
• Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
• Update existing version to fix OpenAPI spec quality issues in S360.
• Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
• Other, please clarify:
  • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

• I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
• I have reviewed following Resource Provider guidelines, including
  ARM resource provider contract and
  REST guidelines (estimated time: 4 hours).
  I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

• First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
• If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
• To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
• If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
  This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

[openapi-pipeline-app]

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/cosmos/armcosmos	https://apiview.dev/Assemblies/Review/b6c1e0c0f6e54f6b8de67946304e3b9f?revisionId=65a2d721a69a4b6d81cd0ecc8ad9d190
Java	azure-resourcemanager-cosmos-generated	https://apiview.dev/Assemblies/Review/06cb8d7a951f40a8810a0ffbd3cabd77?revisionId=ad5a5809fb8146faae0468a269f720c2
JavaScript	@azure/arm-cosmosdb	https://apiview.dev/Assemblies/Review/06c23e48548143fb8df81695f9f5b2d6?revisionId=f1db420377b3412d9ac993d43e8a035b
Python	azure-mgmt-cosmosdb	https://apiview.dev/Assemblies/Review/e9a6a5209255460ea7fb391114a43d7d?revisionId=1feafa808da94ee58bdf910b31c89d1a
Swagger	Microsoft.DocumentDB	https://apiview.dev/Assemblies/Review/ac373549b7d34a108e5add93e45b3e3f?revisionId=fc21cb8df5584a819ca05da3af279b11

[ramoka178]

    "enablePerRegionPerPartitionAutoscale": {

Standard guidance is: replace boolean/switch properties with a more meaningful enum whenever possible.

A boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].

Note: do NOT define a 'boolean enum' with two values 'True and False'. This might be easier to 'extend' in terms of types, but semantically its cofusing, and no better than a boolean.

---

Refers to: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/cosmos-db.json:7041 in 9bbe7c6. [](commit_id = 9bbe7c6, deletion_comment = False)

[ramoka178]

    "enablePerRegionPerPartitionAutoscale": {

Please use enum as suggested in other comment

---

Refers to: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/cosmos-db.json:7203 in 9bbe7c6. [](commit_id = 9bbe7c6, deletion_comment = False)

[ramoka178]

    "enablePerRegionPerPartitionAutoscale": {

Please use enum as suggested in other comment

---

Refers to: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/cosmos-db.json:7389 in 9bbe7c6. [](commit_id = 9bbe7c6, deletion_comment = False)

[ramoka178]

Please fix Swagger PrettierCheck failure too.

[pjohari-ms]

@raosuhas I have fixed all issues - the avocado check is failing because of APIs not present in an old API version. Is it possible to add a permanent suppression for this?