Merge remote-tracking branch 'other-repo/henrydai/ImplementCRUDforChangeState' into henrydai/implementChangeStateCRUD0901

Henry Dai · Henry Dai · commit 871d9b4af1fd · 2025-12-11T11:05:06.000-08:00
diff --git a/src/azure-changesafety/README.md b/src/azure-changesafety/README.md
@@ -10,20 +10,20 @@ az extension add --name azure-changesafety
 
 ## Commands
 ```bash
-az changesafety changestate create  # Create a ChangeState definition for one or more targets.
-az changesafety changestate update  # Update metadata, rollout configuration, or target definitions.
-az changesafety changestate delete  # Delete a ChangeState resource.
-az changesafety changestate show    # Display details for a ChangeState resource.
+az changesafety changerecord create  # Create a ChangeState definition for one or more targets.
+az changesafety changerecord update  # Update metadata, rollout configuration, or target definitions.
+az changesafety changerecord delete  # Delete a ChangeState resource.
+az changesafety changerecord show    # Display details for a ChangeState resource.
 ```
 
-Run `az changesafety changestate -h` to see full parameter details and examples.
+Run `az changesafety changerecord -h` to see full parameter details and examples.
 
 ## Examples
 Create a ChangeState describing a web app rollout:
 ```bash
-az changesafety changestate create \
+az changesafety changerecord create \
   -g MyResourceGroup \
-  -n webAppRollout01 \
+  -n changerecord-webapp-rollout \
   --change-type AppDeployment \
   --rollout-type Normal \
   --targets "resourceId=/subscriptions/<subId>/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/myApp,operation=create" \
@@ -32,18 +32,18 @@ az changesafety changestate create \
 
 Update the rollout type and add a comment:
 ```bash
-az changesafety changestate update \
+az changesafety changerecord update \
   -g MyResourceGroup \
-  -n webAppRollout01 \
+  -n changerecord-webapp-rollout \
   --rollout-type Emergency \
   --comments "Escalated due to customer impact"
 ```
 
 Delete a ChangeState:
 ```bash
-az changesafety changestate delete -g MyResourceGroup -n webAppRollout01 --yes
+az changesafety changerecord delete -g MyResourceGroup -n changerecord-webapp-rollout --yes
 ```
 
 ## Additional Information
-- View command documentation: `az changesafety changestate -h`
+- View command documentation: `az changesafety changerecord -h`
 - Remove the extension when no longer needed: `az extension remove --name azure-changesafety`
diff --git a/src/azure-changesafety/azext_changesafety/_help.py b/src/azure-changesafety/azext_changesafety/_help.py
@@ -15,19 +15,19 @@
     short-summary: Manage Change Safety resources.
 """
 
-helps['changesafety changestate'] = """
+helps['changesafety changerecord'] = """
     type: group
     short-summary: Manage ChangeState resources that describe planned changes across targets.
 """
 
-helps['changesafety changestate create'] = """
+helps['changesafety changerecord create'] = """
     type: command
     short-summary: Create a ChangeState resource.
     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
-        `az change-safety change-state`. If you omit scheduling flags, the anticipated start time defaults
+        `az changesafety changerecord`. If you omit scheduling flags, the anticipated start time defaults
         to now and the anticipated end time defaults to eight hours later (UTC).
     parameters:
       - name: --targets
@@ -51,26 +51,26 @@
     examples:
       - name: Create with StageMap reference and status link
         text: |-
-          az changesafety changestate create -g MyResourceGroup -n changestate002 --change-type ManualTouch --rollout-type Normal --stage-map "{resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ChangeSafety/stageMaps/rolloutStageMap}" --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=PATCH" --links "[{name:status,uri:'https://contoso.com/change/rollout-002'}]"
-          az changesafety changestate delete -g MyResourceGroup -n changestate002 --yes
+          az changesafety changerecord create -g MyResourceGroup -n changerecord002 --change-type ManualTouch --rollout-type Normal --stage-map "{resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ChangeSafety/stageMaps/rolloutStageMap}" --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=PATCH" --links "[{name:status,uri:'https://contoso.com/change/rollout-002'}]"
+          az changesafety changerecord delete -g MyResourceGroup -n changerecord002 --yes
       - name: Create a change state for a VM rollout
         text: |-
-          az changesafety changestate create -g MyResourceGroup -n changestate001 --change-type AppDeployment --rollout-type Normal --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=PUT"
+          az changesafety changerecord create -g MyResourceGroup -n changerecord001 --change-type AppDeployment --rollout-type Normal --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=PUT"
       - name: Create with staging rollout configuration
         text: |-
-          az changesafety changestate create -g MyResourceGroup -n opsChange01 --rollout-type Hotfix --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/myApp,operation=POST"
+          az changesafety changerecord create -g MyResourceGroup -n changerecord-ops01 --rollout-type Hotfix --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/myApp,operation=POST"
       - name: Reference a StageMap by name
         text: |-
-          az changesafety changestate create -g MyResourceGroup -n changestate003 --change-type ManualTouch --rollout-type Normal --stagemap-name rolloutStageMap --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=DELETE"
+          az changesafety changerecord create -g MyResourceGroup -n changerecord003 --change-type ManualTouch --rollout-type Normal --stagemap-name rolloutStageMap --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=DELETE"
 """
 
-helps['changesafety changestate update'] = """
+helps['changesafety changerecord update'] = """
     type: command
     short-summary: Update an existing ChangeState resource.
     long-summary: >
         Use this command to modify descriptive metadata, rollout settings, or replace targets for an
         existing ChangeState. When you pass --targets, the supplied definitions overwrite the previous set.
-        This command is also available through the alias `az change-safety change-state`.
+        This command is also available through the alias `az change-safety change-record`.
     parameters:
       - name: --targets
         short-summary: >
@@ -89,29 +89,29 @@
     examples:
       - name: Adjust rollout type and add a comment
         text: |-
-          az changesafety changestate update -g MyResourceGroup -n changestate001 --rollout-type Emergency --comments "Escalated to emergency rollout"
+          az changesafety changerecord update -g MyResourceGroup -n changerecord001 --rollout-type Emergency --comments "Escalated to emergency rollout"
       - name: Update scheduling window
         text: |-
-          az changesafety changestate update -g MyResourceGroup -n changestate001 --anticipated-start-time "2024-09-01T08:00:00Z" --anticipated-end-time "2024-09-01T12:00:00Z"
+          az changesafety changerecord update -g MyResourceGroup -n changerecord001 --anticipated-start-time "2024-09-01T08:00:00Z" --anticipated-end-time "2024-09-01T12:00:00Z"
       - name: Replace the target definition
         text: |-
-          az changesafety changestate update -g MyResourceGroup -n changestate001 --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Sql/servers/myServer,operation=PATCH"
+          az changesafety changerecord update -g MyResourceGroup -n changerecord001 --targets "resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Sql/servers/myServer,operation=PATCH"
 """
 
-helps['changesafety changestate delete'] = """
+helps['changesafety changerecord delete'] = """
     type: command
     short-summary: Delete a ChangeState resource.
     examples:
       - name: Delete a change state without confirmation
         text: |-
-          az changesafety changestate delete -g MyResourceGroup -n changestate001 --yes
+          az changesafety changerecord delete -g MyResourceGroup -n changerecord001 --yes
 """
 
-helps['changesafety changestate show'] = """
+helps['changesafety changerecord show'] = """
     type: command
     short-summary: Show details for a ChangeState resource.
     examples:
       - name: Show a change state
         text: |-
-          az changesafety changestate show -g MyResourceGroup -n changestate001
+          az changesafety changerecord show -g MyResourceGroup -n changerecord001
 """
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_create.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_create.py
@@ -43,7 +43,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["-n", "--name", "--change-state-name"],
+            options=["-n", "--name", "--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             fmt=AAZStrArgFormat(
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_delete.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_delete.py
@@ -43,7 +43,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["-n", "--name", "--change-state-name"],
+            options=["-n", "--name", "--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             id_part="name",
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_show.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_show.py
@@ -43,7 +43,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["-n", "--name", "--change-state-name"],
+            options=["-n", "--name", "--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             id_part="name",
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_update.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/change_state/_update.py
@@ -45,7 +45,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["-n", "--name", "--change-state-name"],
+            options=["-n", "--name", "--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             id_part="name",
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_create.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_create.py
@@ -43,7 +43,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["--change-state-name"],
+            options=["--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             fmt=AAZStrArgFormat(
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_delete.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_delete.py
@@ -44,7 +44,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["--change-state-name"],
+            options=["--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             id_part="name",
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_show.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_show.py
@@ -43,7 +43,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["--change-state-name"],
+            options=["--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             id_part="name",
diff --git a/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_update.py b/src/azure-changesafety/azext_changesafety/aaz/latest/change_safety/stage_progression/_update.py
@@ -45,7 +45,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
 
         _args_schema = cls._args_schema
         _args_schema.change_state_name = AAZStrArg(
-            options=["--change-state-name"],
+            options=["--change-record-name"],
             help="The name of the ChangeState resource.",
             required=True,
             id_part="name",
diff --git a/src/azure-changesafety/azext_changesafety/commands.py b/src/azure-changesafety/azext_changesafety/commands.py
@@ -16,7 +16,7 @@ def load_command_table(self, _):  # pylint: disable=unused-argument
     delete_command = ChangeStateDelete(loader=self)
     show_command = ChangeStateShow(loader=self)
 
-    self.command_table['changesafety changestate create'] = create_command
-    self.command_table['changesafety changestate update'] = update_command
-    self.command_table['changesafety changestate delete'] = delete_command
-    self.command_table['changesafety changestate show'] = show_command
+    self.command_table['changesafety changerecord create'] = create_command
+    self.command_table['changesafety changerecord update'] = update_command
+    self.command_table['changesafety changerecord delete'] = delete_command
+    self.command_table['changesafety changerecord show'] = show_command
diff --git a/src/azure-changesafety/azext_changesafety/custom.py b/src/azure-changesafety/azext_changesafety/custom.py
@@ -659,20 +659,20 @@ class ChangeStateDelete(_ChangeStateDelete):
         {
             "name": "Create with StageMap reference and status link",
             "text": (
-                "az changesafety changestate create -g MyResourceGroup -n changestate002 "
+                "az changesafety changerecord create -g MyResourceGroup -n changerecord002 "
                 "--change-type ManualTouch --rollout-type Normal "
                 "--stage-map \"{resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/"
                 "resourceGroups/MyResourceGroup/providers/Microsoft.ChangeSafety/stageMaps/rolloutStageMap}\" "
                 "--targets \"resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/"
                 "resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=PATCH\" "
                 "--links \"[{name:status,uri:'https://contoso.com/change/rollout-002'}]\"\n"
-                "az changesafety changestate delete -g MyResourceGroup -n changestate002 --yes"
+                "az changesafety changerecord delete -g MyResourceGroup -n changerecord002 --yes"
             ),
         },
         {
             "name": "Create a change state for a VM rollout",
             "text": (
-                "az changesafety changestate create -g MyResourceGroup -n changestate001 "
+                "az changesafety changerecord create -g MyResourceGroup -n changerecord001 "
                 "--change-type AppDeployment --rollout-type Normal "
                 "--targets \"resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/"
                 "resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=PUT\""
@@ -681,7 +681,7 @@ class ChangeStateDelete(_ChangeStateDelete):
         {
             "name": "Create with staging rollout configuration",
             "text": (
-                "az changesafety changestate create -g MyResourceGroup -n opsChange01 "
+                "az changesafety changerecord create -g MyResourceGroup -n changerecord-ops01 "
                 "--rollout-type Hotfix "
                 "--targets \"resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/"
                 "resourceGroups/MyResourceGroup/providers/Microsoft.Web/sites/myApp,operation=POST\""
@@ -690,7 +690,7 @@ class ChangeStateDelete(_ChangeStateDelete):
         {
             "name": "Create with StageMap name and default schedule",
             "text": (
-                "az changesafety changestate create -g MyResourceGroup -n changestate003 "
+                "az changesafety changerecord create -g MyResourceGroup -n changerecord003 "
                 "--change-type ManualTouch --rollout-type Normal --stagemap-name rolloutStageMap "
                 "--targets \"resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/"
                 "resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm,operation=DELETE\""
@@ -705,22 +705,22 @@ class ChangeStateDelete(_ChangeStateDelete):
         {
             "name": "Adjust rollout type and add a comment",
             "text": (
-                "az changesafety changestate update -g MyResourceGroup -n changestate001 "
+                "az changesafety changerecord update -g MyResourceGroup -n changerecord001 "
                 "--rollout-type Emergency --comments \"Escalated to emergency rollout\""
             ),
         },
         {
             "name": "Update scheduling window",
             "text": (
-                "az changesafety changestate update -g MyResourceGroup -n changestate001 "
+                "az changesafety changerecord update -g MyResourceGroup -n changerecord001 "
                 "--anticipated-start-time \"2024-09-01T08:00:00Z\" "
                 "--anticipated-end-time \"2024-09-01T12:00:00Z\""
             ),
         },
         {
             "name": "Replace the target definition",
             "text": (
-                "az changesafety changestate update -g MyResourceGroup -n changestate001 "
+                "az changesafety changerecord update -g MyResourceGroup -n changerecord001 "
                 "--targets \"resourceId=/subscriptions/00000000-0000-0000-0000-000000000000/"
                 "resourceGroups/MyResourceGroup/providers/Microsoft.Sql/servers/myServer,operation=PATCH\""
             ),
@@ -733,7 +733,7 @@ class ChangeStateDelete(_ChangeStateDelete):
     "examples": [
         {
             "name": "Delete a change state without confirmation",
-            "text": "az changesafety changestate delete -g MyResourceGroup -n changestate001 --yes",
+            "text": "az changesafety changerecord delete -g MyResourceGroup -n changerecord001 --yes",
         },
     ],
 }
@@ -743,7 +743,7 @@ class ChangeStateDelete(_ChangeStateDelete):
     "examples": [
         {
             "name": "Show a change state",
-            "text": "az changesafety changestate show -g MyResourceGroup -n changestate001",
+            "text": "az changesafety changerecord show -g MyResourceGroup -n changerecord001",
         },
     ],
 }
diff --git a/src/azure-changesafety/setup.py b/src/azure-changesafety/setup.py
@@ -34,14 +34,14 @@
     HISTORY = f.read()
 
 setup(
-    name='change-state',
+    name='azure-changesafety',
     version=VERSION,
-    description='Microsoft Azure Command-Line Tools ChangeState Extension.',
+    description='Microsoft Azure Command-Line Tools ChangeSafety Extension.',
     long_description=README + '\n\n' + HISTORY,
     license='MIT',
     author='Microsoft Corporation',
     author_email='azpycli@microsoft.com',
-    url='https://github.com/Azure/azure-cli-extensions/tree/main/src/change-state',
+    url='https://github.com/Azure/azure-cli-extensions/tree/main/src/azure-changesafety',
     classifiers=CLASSIFIERS,
     packages=find_packages(exclude=["tests"]),
     package_data={'azext_changesafety': ['azext_metadata.json']},
