Add new API version 2024-03-01-preview for Microsoft.DocumentDB mongocluster

[olivertowers]

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.

[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

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

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you, you must follow the breaking changes process.
IMPORTANT This applies even if:

• The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
• You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.

Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

• For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

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

• [ ] New resource provider.
• [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
• [ ] 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.
• [ ] 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:

• [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
• [x] 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.
• 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 PR workflow diagram Step 2 (ARM review), 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[bot]]

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[bot]]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 3 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-2024-03-01-preview	package-2024-03-01-preview(bdea01f)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
:warning: PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'checkmongoclusternameavailability' in:'MongoClusters_CheckNameAvailability'. Consider updating the operationId Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L97
:warning: EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1522
:warning: EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DocumentDB/preview/2024-03-01-preview/mongoCluster.json#L1541

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

️⚠️ azure-sdk-for-python-track2 warning [Detail]

• ⚠️Warning in generating from 158d982eaf234fef833157e6e0a2a89bc1acade2. SDK Automation 14.0.0

  command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
  cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
  cmderr	[automation_init.sh]  notice
  cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
  cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
  cmderr	[automation_init.sh] npm notice Run `npm install -g [email protected]` to update!
  cmderr	[automation_init.sh] npm notice
  warn		specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
  command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

• ️✔️azure-mgmt-mongocluster [Preview SDK Changes]
  • azure_mgmt_mongocluster-1.0.0b1-py3-none-any.whl
  • azure-mgmt-mongocluster-1.0.0b1.zip

  info	[Changelog]   - Initial Release

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

• ️✔️Succeeded in generating from 158d982eaf234fef833157e6e0a2a89bc1acade2. SDK Automation 14.0.0

  command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
  command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

• ️✔️azure-resourcemanager-mongocluster [Preview SDK Changes]
  • pom.xml
  • azure-resourcemanager-mongocluster-1.0.0-beta.1-sources.jar
  • azure-resourcemanager-mongocluster-1.0.0-beta.1.jar

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

• ️✔️Succeeded in generating from 158d982eaf234fef833157e6e0a2a89bc1acade2. SDK Automation 14.0.0

  command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
  warn		specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
  command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

• ️✔️sdk/resourcemanager/mongocluster/armmongocluster [Preview SDK Changes]

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

• ️✔️Succeeded in generating from 158d982eaf234fef833157e6e0a2a89bc1acade2. SDK Automation 14.0.0

  command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
  warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
  command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

• ️✔️@azure/arm-mongocluster [Preview SDK Changes]
  • azure-arm-mongocluster-1.0.0-beta.1.tgz

️❌ azure-resource-manager-schemas failed [Detail]

• ❌Failed in generating from 158d982eaf234fef833157e6e0a2a89bc1acade2. Schema Automation 14.0.0

  command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
  cmderr	[initScript.sh]  notice
  cmderr	[initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
  cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
  cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
  cmderr	[initScript.sh] npm notice
  warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
  command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

• ❌mongocluster/resource-manager [Preview Schema Changes]

️️✔️ azure-powershell succeeded [Detail] [Expand]

• ️✔️Succeeded in generating from 158d982eaf234fef833157e6e0a2a89bc1acade2. SDK Automation 14.0.0

  command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
  warn		specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
  command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

• ️✔️Az.mongocluster.DefaultTag [Preview SDK Changes]
  • Az.MongoCluster.0.1.0.nupkg

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/mongocluster/armmongocluster	https://apiview.dev/Assemblies/Review/b4d2bfc01ecb45d69db8ed292bcdf07d?revisionId=9632dcfe40ee47e59e3209ff98944bbd
Java	azure-resourcemanager-mongocluster	https://apiview.dev/Assemblies/Review/89671bc422414e0f9adb9c49282e7e7f?revisionId=4386ca17fa22416faf380aca9a21f6ce
JavaScript	@azure/arm-mongocluster	https://apiview.dev/Assemblies/Review/95e9252dfc364a5fab7e6ea4e75639a9?revisionId=9e4a697dbf8740a1b0e401f5e6a7d110
TypeSpec	DocumentDB.MongoCluster.Management	https://apiview.dev/Assemblies/Review/48701a7bffad4d8aabeb332cf8f62e79?revisionId=b5cf7002c41b45e98ad6f6959aa72787
Swagger	Microsoft.DocumentDB	https://apiview.dev/Assemblies/Review/ac373549b7d34a108e5add93e45b3e3f?revisionId=770f354d4d3446ecb09eae171a5dd104

[openapi-workflow-bot[bot]]

Hi, @olivertowers, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved. Action Required:

Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.

Paste the issue link that you created in step 1 in this PR

Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

[openapi-workflow-bot[bot]]

Hi @olivertowers This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

[olivertowers]

Adding some context here:

• This is not a new RP namespace, we are adding a new service folder for existing namespace Micrsoft.DocumentDB. This is to allow more agility with our sister teams and de-couple the API releases for resource types that are specific to the Mongo vCore cluster service vs the rest of Cosmos DB.
• The Mongo cluster resources were released as preview APIs under specifications/cosmos-db and this did include preview SDK and Azure CLI releases. We are therefore intending on making a breaking change to preview SDKs, though the cosmosdb Azure CLI preview extension is expected to have no breaking changes.
  • See existing mongoCluster.json spec.
• This plan will include removing the existing mongoCluster.json specs from the cosmos-db service folder with the next API version release for that service - example relsae:
  • cosmos-db release 2024-02-15-preview - last release on cosmos-db with mongoCluster specification.
  • mongocluster release 2024-03-01-preview - first release under new folder structure with mongoCluster.json.
  • cosmos-db release 2024-03-15-preview - first release on cosmos-db without mongoCluster spec.
  • mongocluster release 2024-04-01 (stable) - second release under new folder with first stable version of mongoCluster API.

[lsorber]

@olivertowers May I ask if you have an idea on the timeline for bringing vCore out of preview? The reason I ask is that this is blocking for getting vCore into the AzureRM Terraform provider. Thank you!

[IrfanSyed-PSC]

Same here, we are waiting for vCore terraform deployment and it will not let us use Mongodb vCore in Production.

[mikeharder]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 4 pipeline(s).

[olivertowers]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 4 pipeline(s).

[olivertowers]

/pr RequestMerge

[MaryGao]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 4 pipeline(s).