Henrydai/implement change state crud0901 #9357

henryzdai · 2025-10-30T00:29:04Z

Support for managing Microsoft.ChangeSafety/ChangeState, including creating, updating, showing, and deleting changeState resources.

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:

My extension description/summary conforms to the Extension Summary Guidelines.

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.

…ngeState' into henrydai/implementChangeStateCRUD0901

azure-client-tools-bot-prd · 2025-10-30T00:29:07Z

Validation for Breaking Change Starting...

Thanks for your contribution!

yonzhan · 2025-10-30T00:29:16Z

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

github-actions · 2025-10-30T00:29:18Z

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 · 2025-10-30T00:30:15Z

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 · 2025-10-30T00:32:00Z

For more info about extension versioning, please refer to Extension version schema

…ngeState' into henrydai/implementChangeStateCRUD0901

Copilot

Pull Request Overview

This PR introduces a new Azure CLI extension for managing ChangeState resources through the ChangeSafety service. The extension provides CRUD operations (create, update, show, delete) for ChangeState resources at both subscription and resource group levels.

Adds Azure CLI extension structure with generated AAZ commands and custom implementations
Implements target parsing with key=value format and supports aliases (e.g., rg for resourceGroupName, operation for httpMethod)
Includes comprehensive unit tests for target parsing and change definition handling

Reviewed Changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
setup.py	Package setup configuration for the change-state extension
azext_change_state/custom.py	Custom command implementations with target parsing and change definition injection logic
azext_change_state/commands.py	Command registration logic
azext_change_state/tests/latest/test_change_state.py	Unit tests for custom command functionality
azext_change_state/aaz/latest/change_safety/change_state/*.py	Generated AAZ command implementations for CRUD operations
azext_change_state/init.py	Extension loader implementation
HISTORY.rst	Release history for version 1.0.0b1
README.md	Extension documentation

src/azure-changesafety/HISTORY.rst

src/azure-changesafety/azext_changesafety/custom.py

evelyn-ys · 2025-10-30T04:06:38Z

/azp run

azure-pipelines · 2025-10-30T04:06:51Z

Azure Pipelines successfully started running 2 pipeline(s).

src/change-state/azext_change_state/tests/latest/test_change_state.py

…ngeState' into henrydai/implementChangeStateCRUD0901

evelyn-ys · 2025-11-04T01:49:56Z

/azp run

azure-pipelines · 2025-11-04T01:50:08Z

Azure Pipelines successfully started running 2 pipeline(s).

…ngeState' into henrydai/implementChangeStateCRUD0901

evelyn-ys · 2025-11-04T08:01:26Z

/azp run

azure-pipelines · 2025-11-04T08:01:34Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

evelyn-ys · 2025-11-04T08:02:16Z

/azp run

azure-pipelines · 2025-11-04T08:02:30Z

Azure Pipelines successfully started running 2 pipeline(s).

henryzdai · 2025-11-04T17:23:48Z

/azp run

azure-pipelines · 2025-11-04T17:23:55Z

Commenter does not have sufficient privileges for PR 9357 in repo Azure/azure-cli-extensions

yonzhan · 2025-11-04T23:25:54Z

/azp run

azure-pipelines · 2025-11-04T23:26:08Z

Azure Pipelines successfully started running 2 pipeline(s).

…ngeState' into henrydai/implementChangeStateCRUD0901

ayazmsft · 2025-12-18T14:57:36Z

src/azure-changesafety/README.md

@@ -0,0 +1,49 @@
+# Azure CLI Change Safety Extension
+Azure CLI extension for managing Change Safety `ChangeState` resources used to coordinate operational changes across Azure targets.


Rename ChangeState to ChangeRecord. Also, please use the text from our API spec md file or run it by PMs as it is not very direct and clear.

ayazmsft · 2025-12-18T14:58:16Z

src/azure-changesafety/README.md

+
+## Commands
+```bash
+az changesafety changerecord create  # Create a ChangeState definition for one or more targets.


please fix renaming of ChangeState to ChangeRecord everywhere

ayazmsft · 2025-12-18T15:01:15Z

src/azure-changesafety/README.md

+  --links name=Runbook uri=https://contoso.com/runbook
+```
+
+Update the rollout type and add a comment:


This is not a common scenario or an example we have discussed where the user can update RolloutType. Please use common usage patterns that our existing scenarios require. For example, I would have expected to see the manual touch example as the first one.

ayazmsft · 2025-12-18T15:02:07Z

src/azure-changesafety/README.md

+
+## Examples
+Create a ChangeState describing a web app rollout:
+```bash


AppDeployment example without a stagemap seems odd. Please use examples of the known user scenarios that we understand very well.

ayazmsft · 2025-12-18T15:03:22Z

src/azure-changesafety/README.md

+
+Delete a ChangeState:
+```bash
+az changesafety changerecord delete -g MyResourceGroup -n changerecord-webapp-rollout --yes


What if the user does not specify the resourcegroup, what would be the default scope?

ayazmsft · 2025-12-18T15:04:13Z

src/azure-changesafety/azext_changesafety/__init__.py

+from azext_changesafety._help import helps  # pylint: disable=unused-import
+
+
+class ChangeStateCommandsLoader(AzCommandsLoader):


Is this auto generated from swagger? Can we use ChangeRecord in the code?

ayazmsft · 2025-12-18T15:05:11Z

src/azure-changesafety/azext_changesafety/_help.py

+    long-summary: >
+        Provide at least one target definition to describe which resources or operations the ChangeState
+        will affect. Targets are expressed as comma or semicolon separated key=value pairs such as
+        resourceId=RESOURCE_ID,operation=DELETE. The command is also available through the alias


Is capitalization necessary?

ayazmsft · 2025-12-18T15:08:15Z

src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_delete.py

+
+
+@register_command(
+    "changesafety changestate delete",


Is this text user facing? If so, rename changestate to changerecord

…ngeState' into henrydai/implementChangeStateCRUD0901

ayazmsft · 2025-12-19T14:47:16Z

src/azure-changesafety/README.md

 ## Examples
-Create a ChangeState describing a web app rollout:
+Create a ChangeRecord for a manual touch operation (e.g., VM maintenance):
+```bash


Can we not keep the examples in the cli.md file and here consistent? Also, have you tried these examples to verify that these work? Also, try to keep these examples consistent with the scenarios that we have tested, i.e., DELETE.

Henry Dai added 8 commits October 27, 2025 09:49

Add stub code

06f5f1e

Fix parsing

74a3d0f

Fix parsing

b80cda8

Fix displaying

add68de

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

1f12482

…ngeState' into henrydai/implementChangeStateCRUD0901

Fix commands

aeb58e6

Add tests

1636d5d

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

b9696af

…ngeState' into henrydai/implementChangeStateCRUD0901

Copilot AI review requested due to automatic review settings October 30, 2025 00:29

azure-client-tools-bot-prd bot added this to the November 2025 (2025-11-18) milestone Oct 30, 2025

yonzhan requested review from jsntcy and kairu-ms October 30, 2025 00:31

yonzhan assigned kairu-ms Oct 30, 2025

Henry Dai added 2 commits October 29, 2025 17:32

Fix style

b26a3b2

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

1a9b886

…ngeState' into henrydai/implementChangeStateCRUD0901

henryzdai assigned evelyn-ys and unassigned kairu-ms Oct 30, 2025

Copilot AI reviewed Oct 30, 2025

View reviewed changes

evelyn-ys reviewed Oct 31, 2025

View reviewed changes

src/change-state/azext_change_state/tests/latest/test_change_state.py Outdated Show resolved Hide resolved

Henry Dai added 4 commits November 3, 2025 12:49

Rename cli extension module name

ea95cc0

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

6e4bdaa

…ngeState' into henrydai/implementChangeStateCRUD0901

Fix linter

bdeffae

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

c50dfe8

…ngeState' into henrydai/implementChangeStateCRUD0901

Henry Dai added 4 commits November 3, 2025 13:39

Fix linter

56b725b

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

d03e382

…ngeState' into henrydai/implementChangeStateCRUD0901

Fix module name

964371c

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

34d2514

…ngeState' into henrydai/implementChangeStateCRUD0901

Henry Dai added 4 commits November 3, 2025 23:35

add test scenarios

3f5b4d7

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

f0d9bdc

…ngeState' into henrydai/implementChangeStateCRUD0901

Fix style

1578369

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

7274b10

…ngeState' into henrydai/implementChangeStateCRUD0901

Add service name

6c8d92c

evelyn-ys added the do-not-merge label Nov 5, 2025

Henry Dai added 5 commits November 24, 2025 17:52

Add stageprogression and stagemap

ee776c6

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

aa3b9bd

…ngeState' into henrydai/implementChangeStateCRUD0901

Update alias

8dd8743

Update ChangeRecord name

d02017a

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

871d9b4

…ngeState' into henrydai/implementChangeStateCRUD0901

ayazmsft reviewed Dec 18, 2025

View reviewed changes

ayazmsft suggested changes Dec 18, 2025

View reviewed changes

Henry Dai added 2 commits December 19, 2025 00:21

Address comments

bf2565b

Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforCha…

e52f0b2

…ngeState' into henrydai/implementChangeStateCRUD0901

ayazmsft suggested changes Dec 19, 2025

View reviewed changes

		@@ -0,0 +1,49 @@
		# Azure CLI Change Safety Extension
		Azure CLI extension for managing Change Safety `ChangeState` resources used to coordinate operational changes across Azure targets.

		from azext_changesafety._help import helps # pylint: disable=unused-import


		class ChangeStateCommandsLoader(AzCommandsLoader):

Henrydai/implement change state crud0901 #9357

Are you sure you want to change the base?

Henrydai/implement change state crud0901 #9357

Uh oh!

Conversation

henryzdai commented Oct 30, 2025

Related command

General Guidelines

About Extension Publish

Uh oh!

azure-client-tools-bot-prd bot commented Oct 30, 2025

Uh oh!

yonzhan commented Oct 30, 2025

Uh oh!

github-actions bot commented Oct 30, 2025

Uh oh!

github-actions bot commented Oct 30, 2025

CodeGen Tools Feedback Collection

Uh oh!

github-actions bot commented Oct 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evelyn-ys commented Oct 30, 2025

Uh oh!

azure-pipelines bot commented Oct 30, 2025

Uh oh!

Uh oh!

evelyn-ys commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

evelyn-ys commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

evelyn-ys commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

henryzdai commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

yonzhan commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!