Fix custom

Author: Henry Dai

src/azure-changesafety/README.md

@@ -1,5 +1,5 @@
 # Azure CLI Change Safety Extension
-Azure CLI extension for managing Change Safety `ChangeRecord` resources. A ChangeRecord describes a planned change to one or more Azure resources, enabling coordination, tracking, and safe deployment across your environment.
+Azure CLI extension for managing Change Safety resources. This includes `ChangeRecord`, `StageMap`, and `StageProgression` resources for coordinating, tracking, and safely deploying changes across your Azure environment.
 
 ## Installation
 ```bash
@@ -9,16 +9,47 @@ az extension add --name azure-changesafety
 ```
 
 ## Commands
+
+### ChangeRecord
 ```bash
 az changesafety changerecord create  # Create a ChangeRecord for one or more targets.
 az changesafety changerecord update  # Update metadata, rollout configuration, or target definitions.
 az changesafety changerecord delete  # Delete a ChangeRecord resource.
 az changesafety changerecord show    # Display details for a ChangeRecord resource.
+az changesafety changerecord list    # List ChangeRecord resources.
+```
+
+### StageMap
+```bash
+az changesafety stagemap create  # Create a StageMap defining rollout stages.
+az changesafety stagemap update  # Update StageMap stages.
+az changesafety stagemap delete  # Delete a StageMap resource.
+az changesafety stagemap show    # Display details for a StageMap resource.
+az changesafety stagemap list    # List StageMap resources.
+```
+
+### StageProgression
+```bash
+az changesafety stageprogression create  # Create a StageProgression to track stage execution.
+az changesafety stageprogression update  # Update StageProgression status or comments.
+az changesafety stageprogression delete  # Delete a StageProgression resource.
+az changesafety stageprogression show    # Display details for a StageProgression resource.
+az changesafety stageprogression list    # List StageProgression resources for a ChangeRecord.
 ```
 
-Run `az changesafety changerecord -h` to see full parameter details and examples.
+Run `az changesafety -h` to see full command groups and examples.
 
 ## Examples
+
+### StageMap Examples
+Create a two-stage StageMap for rollout:
+```bash
+az changesafety stagemap create \
+  --stage-map-name rolloutStageMap \
+  --stages "[{name:Canary,sequence:1},{name:Production,sequence:2}]"
+```
+
+### ChangeRecord Examples
 Create a ChangeRecord for a manual touch operation (e.g., delete a Traffic Manager profile):
 ```bash
 az changesafety changerecord create \
@@ -38,7 +69,7 @@ az changesafety changerecord create \
   --change-type AppDeployment \
   --rollout-type Normal \
   --targets "resourceId=/subscriptions/<subId>/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/myApp,operation=PUT" \
-  --stage-map "{resource-id:/subscriptions/<subId>/resourceGroups/MyResourceGroup/providers/Microsoft.ChangeSafety/stageMaps/rolloutStageMap}" \
+  --stagemap-name rolloutStageMap \
   --links name=Runbook uri=https://contoso.com/runbook
 ```
 
@@ -51,11 +82,25 @@ az changesafety changerecord update \
   --comments "Escalated due to customer impact"
 ```
 
-Delete a ChangeRecord:
+### StageProgression Examples
+Create a StageProgression for the Canary stage:
+```bash
+az changesafety stageprogression create \
+  --change-record-name changerecord-webapp-rollout \
+  -n canary-progression \
+  --stage-reference Canary \
+  --status InProgress
+```
+
+Update StageProgression to mark stage as completed:
 ```bash
-az changesafety changerecord delete -g MyResourceGroup -n changerecord-webapp-rollout --yes
+az changesafety stageprogression update \
+  --change-record-name changerecord-webapp-rollout \
+  -n canary-progression \
+  --status Completed \
+  --comments "Canary validation passed"
 ```
 
 ## Additional Information
-- View command documentation: `az changesafety changerecord -h`
+- View command documentation: `az changesafety -h`
 - Remove the extension when no longer needed: `az extension remove --name azure-changesafety`

src/azure-changesafety/azext_changesafety/__init__.py

@@ -7,6 +7,8 @@
 
 from azure.cli.core import AzCommandsLoader
 from azext_changesafety._help import helps  # pylint: disable=unused-import
+# Import custom to apply AZ_HELP patches for StageMap commands
+from azext_changesafety import custom as _custom  # pylint: disable=unused-import
 
 
 class ChangeRecordCommandsLoader(AzCommandsLoader):

src/azure-changesafety/azext_changesafety/_help.py

@@ -117,3 +117,74 @@
         text: |-
           az changesafety changerecord show -g MyResourceGroup -n changerecord001
 """
+
+helps['changesafety stagemap'] = """
+    type: group
+    short-summary: Manage StageMap resources that define rollout stages for orchestrated changes.
+"""
+
+helps['changesafety stagemap create'] = """
+    type: command
+    short-summary: Create a StageMap resource.
+    long-summary: >
+        A StageMap defines the stages through which a change progresses during rollout.
+        Each stage has a name and sequence number. Stages are executed in order of their
+        sequence values. StageMap resources can be referenced by ChangeRecord resources
+        to enforce staged rollout patterns.
+    parameters:
+      - name: --stage-map-name
+        short-summary: The name of the StageMap resource to create.
+      - name: --stages
+        short-summary: >
+            Array of stage definitions. Each stage requires a name and sequence number.
+            Use shorthand syntax or JSON format.
+    examples:
+      - name: Create a simple two-stage StageMap
+        text: |-
+          az changesafety stagemap create --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name rolloutStageMap --stages "[{name:Canary,sequence:1},{name:Production,sequence:2}]"
+      - name: Create a StageMap with three stages
+        text: |-
+          az changesafety stagemap create --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name regional-rollout --stages "[{name:WestUS,sequence:1},{name:EastUS,sequence:2},{name:Global,sequence:3}]"
+"""
+
+helps['changesafety stagemap update'] = """
+    type: command
+    short-summary: Update an existing StageMap resource.
+    long-summary: >
+        Modify the stages defined in a StageMap. When updating, provide the complete
+        list of stages as the update replaces the existing stages array.
+    examples:
+      - name: Add a new stage to an existing StageMap
+        text: |-
+          az changesafety stagemap update --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name rolloutStageMap --stages "[{name:Canary,sequence:1},{name:Pilot,sequence:2},{name:Production,sequence:3}]"
+"""
+
+helps['changesafety stagemap show'] = """
+    type: command
+    short-summary: Get details for a StageMap resource.
+    examples:
+      - name: Show a StageMap
+        text: |-
+          az changesafety stagemap show --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name rolloutStageMap
+"""
+
+helps['changesafety stagemap delete'] = """
+    type: command
+    short-summary: Delete a StageMap resource.
+    long-summary: >
+        Delete a StageMap that is no longer needed. Note that StageMap resources
+        that are currently referenced by active ChangeRecord resources cannot be deleted.
+    examples:
+      - name: Delete a StageMap
+        text: |-
+          az changesafety stagemap delete --subscription 00000000-0000-0000-0000-000000000000 --stage-map-name rolloutStageMap --yes
+"""
+
+helps['changesafety stagemap list'] = """
+    type: command
+    short-summary: List StageMap resources in a subscription.
+    examples:
+      - name: List all StageMaps in the subscription
+        text: |-
+          az changesafety stagemap list --subscription 00000000-0000-0000-0000-000000000000
+"""

src/azure-changesafety/azext_changesafety/aaz/latest/changesafety/stageprogression/_create.py

@@ -21,8 +21,8 @@ class Create(AAZCommand):
     _aaz_info = {
         "version": "2026-01-01-preview",
         "resources": [
-            ["mgmt-plane", "/subscriptions/{}/providers/microsoft.changesafety/changestates/{}/stageprogressions/{}", "2026-01-01-preview"],
-            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.changesafety/changestates/{}/stageprogressions/{}", "2026-01-01-preview"],
+            ["mgmt-plane", "/subscriptions/{}/providers/microsoft.changesafety/changerecords/{}/stageprogressions/{}", "2026-01-01-preview"],
+            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.changesafety/changerecords/{}/stageprogressions/{}", "2026-01-01-preview"],
         ]
     }
 
@@ -42,9 +42,9 @@ def _build_arguments_schema(cls, *args, **kwargs):
         # define Arg Group ""
 
         _args_schema = cls._args_schema
-        _args_schema.change_state_name = AAZStrArg(
-            options=["--change-state-name"],
-            help="The name of the ChangeState resource.",
+        _args_schema.change_record_name = AAZStrArg(
+            options=["--change-record-name"],
+            help="The name of the ChangeRecord resource.",
             required=True,
             fmt=AAZStrArgFormat(
                 pattern="^[a-zA-Z0-9-]{3,100}$",
@@ -55,7 +55,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
         _args_schema.resource_group = AAZResourceGroupNameArg()
         _args_schema.stage_progression_name = AAZStrArg(
             options=["-n", "--name", "--stage-progression-name"],
-            help="name of the stageProgression",
+            help="Name of the stageProgression",
             required=True,
             fmt=AAZStrArgFormat(
                 pattern="^[a-zA-Z0-9-|]{3,100}$",
@@ -143,12 +143,12 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
     def _execute_operations(self):
         self.pre_operations()
-        condition_0 = has_value(self.ctx.args.change_state_name) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True
-        condition_1 = has_value(self.ctx.args.change_state_name) and has_value(self.ctx.args.resource_group) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id)
+        condition_0 = has_value(self.ctx.args.change_record_name) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True
+        condition_1 = has_value(self.ctx.args.change_record_name) and has_value(self.ctx.args.resource_group) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id)
         if condition_0:
-            self.StageProgressionsCreateOrUpdateAtSubscriptionLevel(ctx=self.ctx)()
+            self.ChangeRecordStageProgressionsCreateOrUpdateAtSubscriptionLevel(ctx=self.ctx)()
         if condition_1:
-            self.StageProgressionsCreateOrUpdate(ctx=self.ctx)()
+            self.ChangeRecordStageProgressionsCreateOrUpdate(ctx=self.ctx)()
         self.post_operations()
 
     @register_callback
@@ -163,7 +163,7 @@ def _output(self, *args, **kwargs):
         result = self.deserialize_output(self.ctx.vars.instance, client_flatten=True)
         return result
 
-    class StageProgressionsCreateOrUpdateAtSubscriptionLevel(AAZHttpOperation):
+    class ChangeRecordStageProgressionsCreateOrUpdateAtSubscriptionLevel(AAZHttpOperation):
         CLIENT_TYPE = "MgmtClient"
 
         def __call__(self, *args, **kwargs):
@@ -177,7 +177,7 @@ def __call__(self, *args, **kwargs):
         @property
         def url(self):
             return self.client.format_url(
-                "/subscriptions/{subscriptionId}/providers/Microsoft.ChangeSafety/changeStates/{changeStateName}/stageProgressions/{stageProgressionName}",
+                "/subscriptions/{subscriptionId}/providers/Microsoft.ChangeSafety/changeRecords/{changeRecordName}/stageProgressions/{stageProgressionName}",
                 **self.url_parameters
             )
 
@@ -193,7 +193,7 @@ def error_format(self):
         def url_parameters(self):
             parameters = {
                 **self.serialize_url_param(
-                    "changeStateName", self.ctx.args.change_state_name,
+                    "changeRecordName", self.ctx.args.change_record_name,
                     required=True,
                 ),
                 **self.serialize_url_param(
@@ -366,7 +366,7 @@ def _build_schema_on_200_201(cls):
 
             return cls._schema_on_200_201
 
-    class StageProgressionsCreateOrUpdate(AAZHttpOperation):
+    class ChangeRecordStageProgressionsCreateOrUpdate(AAZHttpOperation):
         CLIENT_TYPE = "MgmtClient"
 
         def __call__(self, *args, **kwargs):
@@ -380,7 +380,7 @@ def __call__(self, *args, **kwargs):
         @property
         def url(self):
             return self.client.format_url(
-                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ChangeSafety/changeStates/{changeStateName}/stageProgressions/{stageProgressionName}",
+                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ChangeSafety/changeRecords/{changeRecordName}/stageProgressions/{stageProgressionName}",
                 **self.url_parameters
             )
 
@@ -396,7 +396,7 @@ def error_format(self):
         def url_parameters(self):
             parameters = {
                 **self.serialize_url_param(
-                    "changeStateName", self.ctx.args.change_state_name,
+                    "changeRecordName", self.ctx.args.change_record_name,
                     required=True,
                 ),
                 **self.serialize_url_param(

src/azure-changesafety/azext_changesafety/aaz/latest/changesafety/stageprogression/_delete.py

@@ -22,8 +22,8 @@ class Delete(AAZCommand):
     _aaz_info = {
         "version": "2026-01-01-preview",
         "resources": [
-            ["mgmt-plane", "/subscriptions/{}/providers/microsoft.changesafety/changestates/{}/stageprogressions/{}", "2026-01-01-preview"],
-            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.changesafety/changestates/{}/stageprogressions/{}", "2026-01-01-preview"],
+            ["mgmt-plane", "/subscriptions/{}/providers/microsoft.changesafety/changerecords/{}/stageprogressions/{}", "2026-01-01-preview"],
+            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/microsoft.changesafety/changerecords/{}/stageprogressions/{}", "2026-01-01-preview"],
         ]
     }
 
@@ -43,9 +43,9 @@ def _build_arguments_schema(cls, *args, **kwargs):
         # define Arg Group ""
 
         _args_schema = cls._args_schema
-        _args_schema.change_state_name = AAZStrArg(
-            options=["--change-state-name"],
-            help="The name of the ChangeState resource.",
+        _args_schema.change_record_name = AAZStrArg(
+            options=["--change-record-name"],
+            help="The name of the ChangeRecord resource.",
             required=True,
             id_part="name",
             fmt=AAZStrArgFormat(
@@ -57,7 +57,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
         _args_schema.resource_group = AAZResourceGroupNameArg()
         _args_schema.stage_progression_name = AAZStrArg(
             options=["-n", "--name", "--stage-progression-name"],
-            help="name of the stageProgression",
+            help="Name of the stageProgression",
             required=True,
             id_part="child_name_1",
             fmt=AAZStrArgFormat(
@@ -70,12 +70,12 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
     def _execute_operations(self):
         self.pre_operations()
-        condition_0 = has_value(self.ctx.args.change_state_name) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True
-        condition_1 = has_value(self.ctx.args.change_state_name) and has_value(self.ctx.args.resource_group) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id)
+        condition_0 = has_value(self.ctx.args.change_record_name) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True
+        condition_1 = has_value(self.ctx.args.change_record_name) and has_value(self.ctx.args.resource_group) and has_value(self.ctx.args.stage_progression_name) and has_value(self.ctx.subscription_id)
         if condition_0:
-            self.StageProgressionsDeleteAtSubscriptionLevel(ctx=self.ctx)()
+            self.ChangeRecordStageProgressionsDeleteAtSubscriptionLevel(ctx=self.ctx)()
         if condition_1:
-            self.StageProgressionsDelete(ctx=self.ctx)()
+            self.ChangeRecordStageProgressionsDelete(ctx=self.ctx)()
         self.post_operations()
 
     @register_callback
@@ -86,7 +86,7 @@ def pre_operations(self):
     def post_operations(self):
         pass
 
-    class StageProgressionsDeleteAtSubscriptionLevel(AAZHttpOperation):
+    class ChangeRecordStageProgressionsDeleteAtSubscriptionLevel(AAZHttpOperation):
         CLIENT_TYPE = "MgmtClient"
 
         def __call__(self, *args, **kwargs):
@@ -102,7 +102,7 @@ def __call__(self, *args, **kwargs):
         @property
         def url(self):
             return self.client.format_url(
-                "/subscriptions/{subscriptionId}/providers/Microsoft.ChangeSafety/changeStates/{changeStateName}/stageProgressions/{stageProgressionName}",
+                "/subscriptions/{subscriptionId}/providers/Microsoft.ChangeSafety/changeRecords/{changeRecordName}/stageProgressions/{stageProgressionName}",
                 **self.url_parameters
             )
 
@@ -118,7 +118,7 @@ def error_format(self):
         def url_parameters(self):
             parameters = {
                 **self.serialize_url_param(
-                    "changeStateName", self.ctx.args.change_state_name,
+                    "changeRecordName", self.ctx.args.change_record_name,
                     required=True,
                 ),
                 **self.serialize_url_param(
@@ -148,7 +148,7 @@ def on_200(self, session):
         def on_204(self, session):
             pass
 
-    class StageProgressionsDelete(AAZHttpOperation):
+    class ChangeRecordStageProgressionsDelete(AAZHttpOperation):
         CLIENT_TYPE = "MgmtClient"
 
         def __call__(self, *args, **kwargs):
@@ -164,7 +164,7 @@ def __call__(self, *args, **kwargs):
         @property
         def url(self):
             return self.client.format_url(
-                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ChangeSafety/changeStates/{changeStateName}/stageProgressions/{stageProgressionName}",
+                "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ChangeSafety/changeRecords/{changeRecordName}/stageProgressions/{stageProgressionName}",
                 **self.url_parameters
             )
 
@@ -180,7 +180,7 @@ def error_format(self):
         def url_parameters(self):
             parameters = {
                 **self.serialize_url_param(
-                    "changeStateName", self.ctx.args.change_state_name,
+                    "changeRecordName", self.ctx.args.change_record_name,
                     required=True,
                 ),
                 **self.serialize_url_param(

src/azure-changesafety/azext_changesafety/aaz/latest/changesafety/stageprogression/_list.py

@@ -15,7 +15,7 @@
     "changesafety stageprogression list",
 )
 class List(AAZCommand):
-    """List ChangeRecordStageProgression resources by ChangeRecord
+    """List StageProgression resources by ChangeRecord
     """
 
     _aaz_info = {