Repository navigation
[documentdb] Release 1.1.0 with stable API 2026-09-01 - #10605
amatarritamicrosoft wants to merge 1 commit into
Conversation
Use API 2026-09-01 while preserving existing command contracts. Mark the package and commands Stable, exclude test artifacts from wheels, and replace all 17 scenario recordings with genuine stable-API runs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 46bb57cf-0490-4f99-a750-27ca921e5d89
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
|
xuming-ms Javier Figueroa (@javierfigueroa) Please review this Stable DocumentDB 1.1.0 release and its synchronized model PR Azure/aaz#1174. Update: the required |
|
/azp run |
|
Azure Pipelines: Successfully started running 2 pipeline(s). |
There was a problem hiding this comment.
🔵 Needs a closer look
Maintainer intervention is needed to reconcile the intended 1.1.0 Stable release with the 1.1.0b3/Preview calculation and authorize the still-unverified hosted checks.
No open issues 🎉
What changed in this PR
Prepares the Azure CLI DocumentDB extension for stable release 1.1.0, moving Mongo cluster management to API 2026-09-01 while preserving existing commands, arguments, and custom behavior.
Changes:
- Marks commands, groups, and package metadata as Stable while retaining service-level Preview caveats.
- Updates API references, release documentation, and packaging exclusions for tests.
- Adds request-serialization tests, refreshes scenario recordings, and waits for provisioning completion before final CRUD assertions.
| File | Description |
|---|---|
src/documentdb/setup.py |
Sets stable version and classifier; excludes test packages. |
src/documentdb/README.md |
Documents stable release and API usage. |
src/documentdb/HISTORY.rst |
Adds release notes for 1.1.0. |
src/documentdb/azext_documentdb/tests/latest/test_stable_api.py |
Tests stable-API restore, promotion, and firewall requests. |
src/documentdb/azext_documentdb/tests/latest/test_documentdb.py |
Waits for final provisioning state; updates restore API. |
src/documentdb/azext_documentdb/tests/latest/recordings/test_documentdb_mongocluster_negative.yaml |
Refreshes negative scenarios against the stable API. |
src/documentdb/azext_documentdb/tests/latest/recordings/test_documentdb_mongocluster_cmk.yaml |
Refreshes customer-managed-key scenario recording. |
src/documentdb/azext_documentdb/custom.py |
Updates cluster lookup API and custom command classification. |
src/documentdb/azext_documentdb/azext_metadata.json |
Removes the package Preview flag. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/replica/_promote.py |
Moves replica promotion to stable API and classification. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/replica/_list.py |
Moves replica listing to stable API and classification. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/replica/__cmd_group.py |
Marks the replica group Stable. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/identity/_wait.py |
Uses stable API and classification for identity waiting. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/identity/_show.py |
Uses stable API and classification for identity details. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/identity/_remove.py |
Uses stable API and classification for identity removal. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/identity/_list.py |
Uses stable API and classification for identity listing. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/identity/_assign.py |
Uses stable API and classification for identity assignment. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/identity/__cmd_group.py |
Marks the identity group Stable. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/firewall_rule/_wait.py |
Uses stable API and classification for firewall waiting. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/firewall_rule/_update.py |
Uses stable API and classification for firewall updates. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/firewall_rule/_show.py |
Uses stable API and classification for firewall details. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/firewall_rule/_list.py |
Uses stable API and classification for firewall listing. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/firewall_rule/_delete.py |
Uses stable API and classification for firewall deletion. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/firewall_rule/_create.py |
Uses stable API and classification for firewall creation. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/firewall_rule/__cmd_group.py |
Marks the firewall-rule group Stable. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/entra_user/_wait.py |
Uses stable API and classification for Entra-user waiting. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/entra_user/_show.py |
Uses stable API and classification for Entra-user details. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/entra_user/_remove.py |
Uses stable API and classification for Entra-user removal. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/entra_user/_list.py |
Uses stable API and classification for Entra-user listing. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/entra_user/_assign.py |
Uses stable API and classification for Entra-user assignment. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/entra_user/__cmd_group.py |
Marks the Microsoft Entra user group Stable. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_wait.py |
Uses stable API and classification for cluster waiting. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_update.py |
Uses stable API and classification for cluster updates. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_show.py |
Uses stable API and classification for cluster details. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_list.py |
Updates both cluster-listing routes to the stable API. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_list_connection_strings.py |
Moves connection-string retrieval to stable API and classification. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_delete.py |
Uses stable API and classification for cluster deletion. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_create.py |
Uses stable API and classification for cluster creation. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/_check_name_availability.py |
Moves name-availability checks to stable API and classification. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/mongocluster/__cmd_group.py |
Marks the Mongo cluster group Stable. |
src/documentdb/azext_documentdb/aaz/latest/documentdb/__cmd_group.py |
Marks the DocumentDB root group Stable. |
Review effort: Balanced
🤖 PR Validation — ️✔️ All clear
Related command
az documentdb mongoclusterand its firewall-rule, microsoft-entra-user, identity,replica, and restore commands.
Summary
1.1.0as Stable using management API2026-09-01instead of2026-06-15-preview, preserving existing arguments, defaults, and custom behavior.metadata and omit Preview/Experimental metadata keys per the versioning guidelines.
Keep service-level Preview caveats for
--preview-featuresandGeoReplicas.these are not newly introduced features in this release.
CRUD tag assertion, then wait for provisioning completion before asserting final state.
AAZ model PR: Azure/aaz#1174
Validation
responses. API versions and service Date headers were not edited to simulate validation.
attempts and unchanged cassette hashes. All 20 run-owned resource groups were deleted.
python scripts/ci/test_index.py -q: nine tests, seven active passes and two CI-onlychecks skipped locally. This is not a hosted publication/checksum validation.
passed. The wheel contains 46 runtime files, no tests/recordings, and all 29 commands
and six groups load as Stable without package or command Preview warnings.
existing checkout-specific aliases and customizations remain intact.
Existing findings, reproduced against the baseline: the command linter reports the replica
group's missing wait command; explicitly forced lint reports unused scenario fixture
parameters and setup.py's existing codecs.open shadowing. Normal repository style passes.
Management-plane authentication scenarios do not prove data-plane sign-in. Execution on the
minimum CLI version 2.75.0 has not been separately repeated; the required minimum is unchanged.
General Guidelines
azdev style <YOUR_EXT>locally? See the isolated adapter note above.python scripts/ci/test_index.py -qlocally?Extension version schema.
For new extensions: not applicable; this updates an existing extension.
About Extension Publish
The
stablelabel is required for the version calculation from1.1.0b2to1.1.0.The label is applied; version validation must confirm the Stable transition before merge.
This source PR does not modify
src/index.json. Merge, automated wheel publication,and the resulting catalog update still require the normal repository checks and approvals.
The live catalog has not yet been verified to distribute
1.1.0; that check must happenafter publication using the indexed artifact, its checksum, and its actual metadata.
Assisted-By: GitHub Copilot