Add Microsoft.DocumentDB/mongoClusters API verison 2025-04-01-preview #34580
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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
|
AzureRestAPISpecReview
added
ARMReview
new-api-version
resource-manager
TypeSpec
github-actions
bot
added
ARMAutoSignedOff
ARMSignedOff
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
This was referenced May 10, 2025
AzureRestAPISpecReview
added
the
ReadyForApiTest
github-actions
bot
removed
ARMAutoSignedOff
ARMSignedOff
AzureRestAPISpecReview
added
the
WaitForARMFeedback
|
/azp run |
|
You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list. |
github-actions
bot
added
ARMAutoSignedOff
ARMSignedOff
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
sjimenezcr
reviewed
May 14, 2025
...ter/DocumentDB.MongoCluster.Management/examples/2025-04-01-preview/MongoClusters_Create.json
Show resolved
Hide resolved
sjimenezcr
reviewed
May 14, 2025
...ter/DocumentDB.MongoCluster.Management/examples/2025-04-01-preview/MongoClusters_Update.json
Show resolved
Hide resolved
sjimenezcr
reviewed
May 14, 2025
...r/DocumentDB.MongoCluster.Management/examples/2025-04-01-preview/MongoClusters_UserList.json
Outdated
Show resolved
Hide resolved
sjimenezcr
reviewed
May 14, 2025
...manager/Microsoft.DocumentDB/preview/2025-04-01-preview/examples/MongoClusters_UserList.json
Outdated
Show resolved
Hide resolved
11 tasks
openapi-pipeline-app
bot
added
PipelineBotTrigger
and removed
PipelineBotTrigger
labels
AlexanderSehr
added a commit
to Azure/bicep-registry-modules
that referenced
this pull request
May 16, 2025
…crosoft Entra `user` entities (#5260) ## Description I'm adding a new `user` submodule to `avm/res/document-db/mongo-cluster` so we can build Azure Developer CLI templates that support Microsoft Entra authentication end-to-end. Here's the relevant documentation: <https://learn.microsoft.com/azure/cosmos-db/mongodb/vcore/how-to-configure-entra-authentication> Unfortunately, this module was using an older RP, so this caused a few "domino" changes: - The `api-version` needed to be updated to at least `2025-04-01-preview` to support Microsoft Entra authentication - The `nodeType` property no longer exists in the last API version - The `highAvailabilityMode` property is now a string with multiple allowed values And in keeping with best practices, I just made these minor changes: - I updated most unit tests to deploy minimal single-node resources to minimize the amount of churn and extra resources deployed for each CI run - I updated the WAF-aligned unit test to deploy triplicate nodes that are zone-redundant (no redundancy in the initial version) - I updated the metadata to correctly reference *"Azure Cosmos DB for MongoDB (vCore)"* - The WAF-aligned unit test needed tags to suppress a warning from PSRule I did notice this behavior, but I didn't fix it in this PR: - The `max.*` unit test has transient failures. I couldn't pin down what was causing it, but it was due to the test not being able to "find" the nested dependencies. I don't have enough information to diagnose if it was a race condition or a naming collision. Finally, I didn't suppress the Bicep linter warning for the `api-version`. That API version is supported in the REST API, but it's not documented in the specs yet. This PR depends on this other change to remove linter warnings: - Azure/azure-rest-api-specs#34580 > [!NOTE] > I tried my best to scope my changes to the minimal necessary to add this submodule and Entra authentication support. ## Pipeline Reference | Pipeline | | --- | | [](https://github.com/seesharprun/bicep-registry-modules/actions/workflows/avm.res.document-db.mongo-cluster.yml) | ## Type of Change - [ ] Update to CI Environment or utilities (Non-module affecting changes) - [x] Azure Verified Module updates: - [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in `version.json`: - [ ] Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description. - [ ] The bug was found by the module author, and no one has opened an issue to report it yet. - [x] Feature update backwards compatible feature updates, and I have bumped the MINOR version in `version.json`. - [x] Breaking changes and I have bumped the MAJOR version in `version.json`. - [x] Update to documentation ## Checklist - [x] I'm sure there are no other open Pull Requests for the same update/change - [x] I have run `Set-AVMModule` locally to generate the supporting module files. - [x] My corresponding pipelines / checks run clean and green without any errors or warnings --------- Co-authored-by: Alexander Sehr <[email protected]>
](https://github.com/seesharprun/bicep-registry-modules/actions/workflows/avm.res.document-db.mongo-cluster.yml){kind=link}
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.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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!
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:
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 ApiViewcomment 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
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.