Added mongocluster api version 2025-05-01-preview

[joelpineiro]

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.
• A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

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.
• For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

[openapi-pipeline-app]

Next Steps to Merge

Next steps that must be taken to merge this PR:

• ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
  This PR is not ready for ARM review (label: NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of this Next Steps to Merge comment for details.
  Once the blocking problems are addressed, add to the PR a comment with contents /azp run. Automation will re-evaluate this PR and if everything looks good, it will add WaitForARMFeedback label which will put this PR on the ARM review queue.
  For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  
• ❌ This PR is NotReadyForARMReview because it has the VersioningReviewRequired label.
  
• ❌ This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired).
  To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch.
• ❌ The required check named TypeSpec Validation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

[openapi-pipeline-app]

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

[Copilot]

Pull Request Overview

This PR introduces the new Mongo Cluster ARM API version 2025-05-01-preview. It updates the global readme tag, adds a corresponding TypeSpec version enum, defines a basic end-to-end scenario, and supplies a full set of OpenAPI examples for the new preview release.

• Update ARM readme to include package-2025-05-01-preview
• Register v2025_05_01_preview in TypeSpec Versions enum
• Add basic API scenario and dozens of new example JSONs under the preview folder

Reviewed Changes

Copilot reviewed 78 out of 79 changed files in this pull request and generated no comments.

File	Description
specification/mongocluster/resource-manager/readme.md	Bumped ARM tag to 2025-05-01-preview and added its conditional input-file block
specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2025-05-01-preview/scenarios/basic.yaml	Added the “basic” API scenario covering create/read/update/delete flows
specification/mongocluster/DocumentDB.MongoCluster.Management/main.tsp	Introduced v2025_05_01_preview into the Versions enum
specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2025-05-01-preview/examples/...	Added full set of operation examples for the new preview version

Comments suppressed due to low confidence (3)

specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2025-05-01-preview/scenarios/basic.yaml:89

• The JSON path here does not match the ResetPassword example—there is no administratorLoginPassword property under /properties/properties. It should target /properties/properties/administrator/password (or include the resource segment if needed) to update the administrator’s password correctly.

          - replace: /properties/properties/administratorLoginPassword

specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2025-05-01-preview/examples/MongoClusters_PrivateEndpointConnectionPut.json:14

• [nitpick] The request example uses "description": "Auto-Approved", but the corresponding response shows "Auto-approved" (lowercase "a") and "Approved by admin". Consider standardizing the case and phrasing to avoid confusion.

          "description": "Auto-Approved"

specification/mongocluster/resource-manager/Microsoft.DocumentDB/preview/2025-05-01-preview/scenarios/basic.yaml:124

• [nitpick] Using _2 in the step name is not descriptive. Consider renaming to something like MongoClusters_ForcePromotePrimary or MongoClusters_DemoteOldReplica to clarify its intent.

      - step: MongoClusters_ForcePromoteReplica_2

[github-actions]

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
Swagger	Microsoft.DocumentDB
TypeSpec	Microsoft.DocumentDB
Go	sdk/resourcemanager/mongocluster/armmongocluster
JavaScript	@azure/arm-mongocluster
Java	com.azure.resourcemanager:azure-resourcemanager-mongocluster
C#	Azure.ResourceManager.MongoCluster
Python	azure-mgmt-mongocluster

[joelpineiro]

@joelpineiro please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

[joelpineiro]

@microsoft-github-policy-service agree company="Microsoft"

[olivertowers]

Superseded by #35802 which adds CMK support in 2025-07-01-preview. We will not be releasing 2025-05-01-preview.