Skip to content

Graceful error for immutable field updates on deployment template#9849

Open
PratibhaShrivastav18 wants to merge 1 commit intoAzure:mainfrom
PratibhaShrivastav18:shrivastavp/dt-update-immutable-error
Open

Graceful error for immutable field updates on deployment template#9849
PratibhaShrivastav18 wants to merge 1 commit intoAzure:mainfrom
PratibhaShrivastav18:shrivastavp/dt-update-immutable-error

Conversation

@PratibhaShrivastav18
Copy link
Copy Markdown
Member

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

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

Validation for Breaking Change Starting...

Thanks for your contribution!

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

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>

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 on lines +156 to +158
raise ValueError(
f"Field '{key}' is immutable and cannot be updated. "
"Only 'tags' and 'description' can be modified."
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Hi @PratibhaShrivastav18

Release Suggestions

Module: machinelearningservices

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

Notes

@yonzhan yonzhan requested a review from necusjz May 5, 2026 22:17
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.

4 participants