Skip to content

chore: Microsoft.CleanRoom Update API Version to 2026-03-31-preview#9727

Merged
necusjz merged 18 commits intoAzure:mainfrom
kkarmakarMS:chore-cleanroom-rp-update
Mar 26, 2026
Merged

chore: Microsoft.CleanRoom Update API Version to 2026-03-31-preview#9727
necusjz merged 18 commits intoAzure:mainfrom
kkarmakarMS:chore-cleanroom-rp-update

Conversation

@kkarmakarMS
Copy link
Copy Markdown
Contributor

@kkarmakarMS kkarmakarMS commented Mar 26, 2026


This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • My extension version conforms to the Extension version schema

For new extensions:

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

PR Owner Inputs

AAZ repo PR: Azure/aaz#975
Manually tested the scenarios
Ran tests on existing test scripts using azdev
Requesting squash commit merge please.
Breaking changes are fine, this is a brand new service and it is not even released for preview. We do not have customers yet.

@azure-client-tools-bot-prd
Copy link
Copy Markdown

azure-client-tools-bot-prd bot commented Mar 26, 2026

❌Azure CLI Extensions Breaking Change Test
❌managedcleanroom
rule cmd_name rule_message suggest_message
1007 - ParaRemove managedcleanroom collaboration add-collaborator cmd managedcleanroom collaboration add-collaborator removed parameter email please add back parameter email for cmd managedcleanroom collaboration add-collaborator
1007 - ParaRemove managedcleanroom collaboration create cmd managedcleanroom collaboration create removed parameter consortium_type please add back parameter consortium_type for cmd managedcleanroom collaboration create
1007 - ParaRemove managedcleanroom collaboration create cmd managedcleanroom collaboration create removed parameter user_identity please add back parameter user_identity for cmd managedcleanroom collaboration create
1007 - ParaRemove managedcleanroom collaboration update cmd managedcleanroom collaboration update removed parameter consortium_type please add back parameter consortium_type for cmd managedcleanroom collaboration update
1007 - ParaRemove managedcleanroom collaboration update cmd managedcleanroom collaboration update removed parameter user_identity please add back parameter user_identity for cmd managedcleanroom collaboration update
1007 - ParaRemove managedcleanroom consortium create cmd managedcleanroom consortium create removed parameter consortium_type please add back parameter consortium_type for cmd managedcleanroom consortium create
1007 - ParaRemove managedcleanroom consortium update cmd managedcleanroom consortium update removed parameter consortium_type please add back parameter consortium_type for cmd managedcleanroom consortium update
⚠️ 1006 - ParaAdd managedcleanroom collaboration add-collaborator cmd managedcleanroom collaboration add-collaborator added parameter object_id
⚠️ 1006 - ParaAdd managedcleanroom collaboration add-collaborator cmd managedcleanroom collaboration add-collaborator added parameter tenant_id
⚠️ 1006 - ParaAdd managedcleanroom collaboration add-collaborator cmd managedcleanroom collaboration add-collaborator added parameter user_identifier
⚠️ 1006 - ParaAdd managedcleanroom collaboration create cmd managedcleanroom collaboration create added parameter collaborators

@azure-client-tools-bot-prd
Copy link
Copy Markdown

Hi @kkarmakarMS,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented Mar 26, 2026

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link
Copy Markdown
Contributor

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

@github-actions
Copy link
Copy Markdown
Contributor

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

@kkarmakarMS kkarmakarMS marked this pull request as ready for review March 26, 2026 08:11
Copilot AI review requested due to automatic review settings March 26, 2026 08:11
@kkarmakarMS kkarmakarMS marked this pull request as draft March 26, 2026 08:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the managedcleanroom Azure CLI extension to align with the Microsoft.CleanRoom 2026-03-31-preview API version, including regenerated AAZ command surfaces and an extension version bump.

Changes:

  • Bump extension version to 1.0.0b3 and add release notes.
  • Update AAZ command modules to use api-version=2026-03-31-preview.
  • Refresh command schemas/examples to match the new API shape (e.g., collaboration collaborators model, consortium fields, renamed consortium-view certificate flag).

Reviewed changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
src/managedcleanroom/setup.py Bumps extension version to 1.0.0b3.
src/managedcleanroom/HISTORY.rst Adds 1.0.0b3 release notes for the API version update.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/__cmd_group.py Updates command group description text.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/contract/_show.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/contract/_propose_template.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/contract/_list.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/_create.py Updates API version; renames consortium service certificate CLI flag.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/_update.py Updates API version; renames consortium service certificate CLI flag; updates example.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/_show.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/_list.py Updates API version and adds RG-scoped example.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/_delete.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/_wait.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_create.py Updates API version; adjusts request/response schema (removes consortiumType; adds member recoveryRole; adds new read fields).
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_update.py Updates API version; adjusts update schema similarly (removes consortiumType; adds recoveryRole and new read fields).
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_show.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_list.py Updates API version; refreshes read schema fields; adds RG-scoped example.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_delete.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_wait.py Updates mgmt-plane API version to 2026-03-31-preview; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_pause.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_resume.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium/_recover.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_create.py Updates API version; shifts create payload toward collaborators list model; updates example.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_update.py Updates API version; simplifies update args/body (tags-focused); refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_show.py Updates API version; refreshes read schema fields (adds collaborators + collaborationState).
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_list.py Updates API version; refreshes read schema fields; adds RG-scoped example.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_delete.py Updates mgmt-plane API version to 2026-03-31-preview.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_wait.py Updates mgmt-plane API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_pause.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_resume.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_recover.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_enable_workload.py Updates API version; refreshes read schema fields.
src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/collaboration/_add_collaborator.py Updates API version; changes collaborator input model and examples.
Comments suppressed due to low confidence (1)

src/managedcleanroom/azext_managedcleanroom/aaz/latest/managedcleanroom/consortium_view/_create.py:75

  • The CLI option for the service certificate changed from --certificate-pem to --consortium-service-certificate-pem. If existing users/scripts relied on the old flag, this is a breaking CLI change. Consider keeping --certificate-pem as an additional alias in options=[...] (while retaining the new name) to preserve backwards compatibility.
        _args_schema.consortium_service_certificate_pem = AAZStrArg(
            options=["--consortium-service-certificate-pem"],
            arg_group="Properties",
            help="Gets or sets the CCF public service certificate in PEM format.",
            required=True,
        )

@kkarmakarMS kkarmakarMS marked this pull request as ready for review March 26, 2026 09:05
@yonzhan yonzhan requested a review from necusjz March 26, 2026 11:11
@anantshankar17
Copy link
Copy Markdown

@necusjz can you please check this soon ? Need it for an urgent release.

@necusjz necusjz merged commit 2c095e0 into Azure:main Mar 26, 2026
24 checks passed
@azclibot
Copy link
Copy Markdown
Collaborator

[Release] Update index.json for extension [ managedcleanroom-1.0.0b3 ] : https://dev.azure.com/msazure/One/_build/results?buildId=158370425&view=results

@kkarmakarMS kkarmakarMS deleted the chore-cleanroom-rp-update branch March 27, 2026 01:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants