Add 2026-02-01-preview API version for Microsoft.DocumentDB MongoCluster#42564
Open
olivertowers wants to merge 6 commits intoAzure:mainfrom
Open
Add 2026-02-01-preview API version for Microsoft.DocumentDB MongoCluster#42564olivertowers wants to merge 6 commits intoAzure:mainfrom
olivertowers wants to merge 6 commits intoAzure:mainfrom
Conversation
- Add v2026_02_01_preview version with @previewVersion decorator - Add networkBypassMode property to MongoClusterProperties - Add NetworkBypassMode union type (None, AzureCosmosDB) - Add examples and generated OpenAPI spec for 2026-02-01-preview - Add package-2026-02-01-preview tag to readme.md
Next Steps to MergeNext steps that must be taken to merge this PR:
Comment generated by summarize-checks workflow run. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
Comment generated by After APIView workflow run. |
github-actions
Bot
added
ARMReview
new-api-version
WaitForARMFeedback
- Use @SharedRoute dual-operation pattern to version the LRO final-state-via change: older API versions keep azure-async-operation, 2026-02-01-preview uses original-uri - Add NetworkBypassMode C# clientName to client.tsp
…pec-metadata.yaml
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new 2026-02-01-preview API version for the Microsoft.DocumentDB/MongoCluster ARM spec, updating the TypeSpec source and wiring the new version into the AutoRest readme and examples.
Changes:
- Adds
package-2026-02-01-previewtag inreadme.mdand introduces thev2026_02_01_previewAPI version in TypeSpec. - Updates the MongoCluster TypeSpec to version-split
createOrUpdatebehavior and adds the newnetworkBypassModeproperty/union. - Adds new example payloads for the
2026-02-01-previewswagger (both generatedpreview/.../examplesand sourceexamples/...).
Reviewed changes
Copilot reviewed 87 out of 88 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster/readme.md | Adds a new AutoRest tag for the 2026-02-01-preview swagger. |
| specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster/main.tsp | Adds the 2026-02-01-preview version entry marked as preview. |
| specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster/MongoCluster.tsp | Splits legacy vs new createOrUpdate behavior by version and introduces networkBypassMode. |
| specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster/client.tsp | Adds a C# client name override for the new NetworkBypassMode union. |
| specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster/preview/2026-02-01-preview/examples/*.json | Adds swagger-referenced examples for the new API version (multiple validation issues noted in comments). |
| specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster/examples/2026-02-01-preview/*.json | Adds TypeSpec source examples corresponding to the new API version. |
| specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster/.gitignore | Ignores tsp-output/ locally. |
- Update suppress reason to explain legacy azure-async-operation behavior - Fix polling URLs from api-version=2024-06-01-preview to 2026-02-01-preview - Replace literal password values with placeholder - Fix 'is availability' typo to 'is available' in NameAvailability example - Remove leading '/' from type fields in all examples
- Remove subscriptionId from tenant-scoped Operations_List example - Fix resourceGroupName inconsistency in MongoClusters_UserList (TestResourceGroup -> TestGroup) - Add missing Azure-AsyncOperation header to PrivateEndpointConnectionDelete 202 response
javierfigueroa
approved these changes
Apr 22, 2026
Member
|
With this version we also added storage as an optional property for GeoReplicas and PITR requests, may be worth adding those as examples, similar to |
joelpineiro
approved these changes
Apr 22, 2026
- Add storage.type PremiumSSDv2 to GeoReplica create request and responses - Demonstrates selecting a specific storage type when creating a geo replica
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
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.