Skip to content

Graceful error for immutable field updates on deployment template#9849

Merged
wangzelin007 merged 2 commits into
Azure:mainfrom
PratibhaShrivastav18:shrivastavp/dt-update-immutable-error
May 22, 2026
Merged

Graceful error for immutable field updates on deployment template#9849
wangzelin007 merged 2 commits into
Azure:mainfrom
PratibhaShrivastav18:shrivastavp/dt-update-immutable-error

Conversation

@PratibhaShrivastav18
Copy link
Copy Markdown
Member

@PratibhaShrivastav18 PratibhaShrivastav18 commented May 5, 2026 •
edited
Loading

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.

Copilot AI review requested due to automatic review settings May 5, 2026 14:36
@azure-client-tools-bot-prd
Copy link
Copy Markdown

azure-client-tools-bot-prd Bot commented May 5, 2026 •
edited
Loading

️✔️Azure CLI Extensions Breaking Change Test
️✔️Non Breaking Changes

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

azure-client-tools-bot-prd Bot commented May 5, 2026

Hi @PratibhaShrivastav18,
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 May 5, 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

github-actions Bot commented May 5, 2026

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>

Copilot AI reviewed May 5, 2026
View reviewed changes
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 aims to make az ml deployment-template update fail more clearly when callers try to modify immutable deployment-template fields, instead of allowing only metadata updates (description/tags) to proceed silently. It fits into the Azure ML CLI extension’s custom command layer for registry-scoped deployment template management.

Changes:

  • Adds an immutable-field check in _ml_deployment_template_update before applying updates.
  • Restricts in-place updates to description and tags.
  • Simplifies mutable-field assignment by using direct indexed access for present parameters.

Comment thread src/machinelearningservices/azext_mlv2/manual/custom/deployment_template.py
Comment thread src/machinelearningservices/azext_mlv2/manual/custom/deployment_template.py
Comment thread src/machinelearningservices/azext_mlv2/manual/custom/deployment_template.py
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026 •
edited
Loading

Hi @PratibhaShrivastav18

Release Suggestions

Module: machinelearningservices

  • Please log updates into to src/machinelearningservices/HISTORY.rst
  • Update VERSION to 2.43.1 in src/machinelearningservices/setup.py

Notes

@yonzhan yonzhan requested a review from necusjz May 5, 2026 22:17
@PratibhaShrivastav18 PratibhaShrivastav18 changed the title Graceful error for immutable field updates on deployment template Graceful error for immutable field updates on deployment template | display name support May 11, 2026
@PratibhaShrivastav18 PratibhaShrivastav18 force-pushed the shrivastavp/dt-update-immutable-error branch from b7c5e53 to 808488d Compare May 13, 2026 07:03
@PratibhaShrivastav18 PratibhaShrivastav18 changed the title Graceful error for immutable field updates on deployment template | display name support Graceful error for immutable field updates on deployment template May 13, 2026
kshitij-microsoft
kshitij-microsoft approved these changes May 21, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@kshitij-microsoft kshitij-microsoft left a comment

Choose a reason for hiding this comment

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

Please make sure to test this thoroughly, I remember running into some issues while using this notation.

kingernupur
kingernupur previously approved these changes May 21, 2026
View reviewed changes
@wangzelin007
Copy link
Copy Markdown
Member

wangzelin007 commented May 21, 2026

/azp run

wangzelin007
wangzelin007 previously approved these changes May 21, 2026
View reviewed changes
@azure-pipelines
Copy link
Copy Markdown

azure-pipelines Bot commented May 21, 2026

Azure Pipelines successfully started running 2 pipeline(s).

@PratibhaShrivastav18
Fix cassettes: use consistent stage value across GET responses
c590832 
The test cassettes had inconsistent 'stage' field values between the
getter GET (Development) and the setter GET (Archived). This caused
the immutable field validation to falsely detect a user change to the
'stage' field when only tags/description were being updated.
@wangzelin007
Copy link
Copy Markdown
Member

wangzelin007 commented May 22, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown

azure-pipelines Bot commented May 22, 2026

Azure Pipelines successfully started running 2 pipeline(s).

@wangzelin007 wangzelin007 merged commit 9c20f20 into Azure:main May 22, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@wangzelin007 wangzelin007 wangzelin007 approved these changes

@kingernupur kingernupur kingernupur left review comments

@necusjz necusjz Awaiting requested review from necusjz

+1 more reviewer

@kshitij-microsoft kshitij-microsoft kshitij-microsoft approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@necusjz necusjz

Labels

None yet

Projects

None yet

Milestone

June 2026 (2026-06-02)

Development

Successfully merging this pull request may close these issues.

7 participants

@PratibhaShrivastav18 @yonzhan @wangzelin007 @kshitij-microsoft @kingernupur @necusjz