[Compute] `az vmss lifecycle-hook/ lifecycle-hook-event`: Add new command groups to support vmss lifecycle hooks by william051200 · Pull Request #33758 · Azure/azure-cli

william051200 · 2026-07-21T05:53:00Z

Related command

az vmss lifecycle-hook add/list/remove/show/update
az vmss lifecycle-hook-event approve/list/reject/show/update

Description

Resolve #33652

aaz Azure/aaz#1046

Testing Guide

Refer to azure-cli\src\azure-cli\azure\cli\command_modules\vm\tests\latest\test_vm_commands.py:

test_vmss_lifecycle_hook
test_vmss_lifecycle_hook_event

az vmss lifecycle-hook-event approve/reject/update are not included in the test cases as they required live platform-generated event. Service team will be helping with the test locally.

History Notes

[Compute] az vmss lifecycle-hook/ lifecycle-hook-event: Add new command groups to support vmss lifecycle hooks

This checklist is used to make sure that common guidelines for a pull request are followed.

The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.

🤖 PR Validation — ⚠️ Review suggested

Breaking Changes	Tests
⚠️ None	️✔️ 130/130

⚠️AzureCLI-BreakingChangeTest

⚠️vm

rule cmd_name rule_message suggest_message

⚠️ 1011 - SubgroupAdd vmss lifecycle-hook sub group vmss lifecycle-hook added

⚠️ 1011 - SubgroupAdd vmss lifecycle-hook-event sub group vmss lifecycle-hook-event added

azure-client-tools-bot-prd · 2026-07-21T05:53:03Z

Hi @william051200,
Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

azure-pipelines · 2026-07-21T05:53:09Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

Copilot

Pull request overview

This PR adds new preview command groups under the vmss command module to manage VM Scale Set lifecycle hooks and to interact with platform-generated lifecycle hook events, along with scenario tests and recordings.

Changes:

Add az vmss lifecycle-hook commands (add/update/remove/show/list) backed by new custom implementations.
Add az vmss lifecycle-hook-event commands, including AAZ-generated list/show/update and custom wrappers for update/approve/reject with client-side validation.
Add scenario tests and a recording to validate core command behaviors.

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/azure-cli/azure/cli/command_modules/vm/tests/latest/test_vm_commands.py	Adds scenario tests for lifecycle-hook and lifecycle-hook-event command groups.
src/azure-cli/azure/cli/command_modules/vm/tests/latest/recordings/test_vmss_lifecycle_hook_event.yaml	Adds recording for lifecycle-hook-event list scenario.
src/azure-cli/azure/cli/command_modules/vm/custom.py	Implements lifecycle hook CRUD and lifecycle hook event update/approve/reject helpers.
src/azure-cli/azure/cli/command_modules/vm/commands.py	Registers new command groups and wires validators.
src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vmss/lifecycle_hook_event/_update.py	Adds AAZ-generated `vmss lifecycle-hook-event update`.
src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vmss/lifecycle_hook_event/_show.py	Adds AAZ-generated `vmss lifecycle-hook-event show`.
src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vmss/lifecycle_hook_event/_list.py	Adds AAZ-generated `vmss lifecycle-hook-event list`.
src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vmss/lifecycle_hook_event/init.py	Exposes lifecycle_hook_event AAZ commands for loading.
src/azure-cli/azure/cli/command_modules/vm/aaz/latest/vmss/lifecycle_hook_event/__cmd_group.py	Registers the AAZ command group for lifecycle hook events.
src/azure-cli/azure/cli/command_modules/vm/_validators.py	Adds validators for hook removal and lifecycle-hook-event update/action behaviors.
src/azure-cli/azure/cli/command_modules/vm/_params.py	Adds argument definitions/enums for lifecycle hook and lifecycle hook event commands.
src/azure-cli/azure/cli/command_modules/vm/_help.py	Adds help content for the new command groups/commands.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

 # AZURE CLI VM TEST DEFINITIONS
 import json
 import os
+import datetime


+def _commit_vmss_lifecycle_hooks(cmd, resource_group_name, vmss_name, hooks, no_wait):
+    from .operations.vmss import VMSSCreate, convert_show_result_to_snake_case
+    vmss = get_vmss_modified_by_aaz(cmd, resource_group_name, vmss_name)
+    vmss = convert_show_result_to_snake_case(vmss)
+    vmss["lifecycle_hooks_profile"] = {"lifecycle_hooks": hooks}
+    vmss["resource_group"] = resource_group_name
+    vmss["vm_scale_set_name"] = vmss_name
+    vmss["no_wait"] = no_wait
+    return VMSSCreate(cli_ctx=cmd.cli_ctx)(command_args=vmss)


+helps['vmss lifecycle-hook-event'] = """
+type: group
+short-summary: Manage virtual machine scale set lifecycle hook events.
+"""


yonzhan · 2026-07-21T06:26:32Z

Compute

william051200 · 2026-07-21T06:44:52Z

/azp run

azure-pipelines · 2026-07-21T06:45:10Z

Azure Pipelines: Successfully started running 3 pipeline(s).

william051200 · 2026-07-21T23:00:37Z

/azp run

azure-pipelines · 2026-07-21T23:00:54Z

Azure Pipelines: Successfully started running 3 pipeline(s).

AnshulVermaa · 2026-07-23T07:35:29Z

lifecycle-hook-event commands apart from show and list fail with exit code -1 (even though the underlying operation on CRP side succeeds).
lifecycle-hook-event show and list have a resource group field appended at the end of the response.
⁠az vmss lifecycle-hook add: 'TestLCH' is not a valid value for '--type'. Allowed values: UpgradeAutoOSScheduling, UpgradeAutoOSRollingBatchStarting. Is this validation on PS side, and every time we surface new LCH type, would we need PS changes and rollout as well?

AnshulVermaa

Comments added in discussions

william051200 added 10 commits June 29, 2026 13:35

Generated lifecycle hooks aaz code

19cbe88

Add new vmss lifecycle command group

24ea6e9

Update command is_preview flag

93cec6b

Clean up code

481898f

Add new vmss lifecycle event sub command group

ebee1a0

Merge remote-tracking branch 'origin/dev' into lifecycle-hooks

c26dc67

Update code

995d7b0

Merge remote-tracking branch 'origin/dev' into lifecycle-hooks

eb5011f

Update test case and record test case for vmss lifecycle hook

f9d65ff

Update test and record test case for vmss lifecycle hook event

0416e1f

Copilot AI review requested due to automatic review settings July 21, 2026 05:53

william051200 requested a review from a team as a code owner July 21, 2026 05:53

azure-client-tools-bot-prd Bot added this to the September 2026 (2026-09-01) milestone Jul 21, 2026

william051200 changed the title ~~{Compute} az vmss lifecycle-hooks &az vmss lifecycle-hooks-event: Add new command groups to support vmss lifecycle hooks~~ {Compute} az vmss lifecycle-hooks/ lifecycle-hooks-event: Add new command groups to support vmss lifecycle hooks Jul 21, 2026

microsoft-github-policy-service Bot requested review from yanzhudd and yonzhan July 21, 2026 05:53

Copilot started reviewing on behalf of william051200 July 21, 2026 05:53 View session

microsoft-github-policy-service Bot added the Auto-Assign Auto assign by bot label Jul 21, 2026

microsoft-github-policy-service Bot assigned yanzhudd Jul 21, 2026

microsoft-github-policy-service Bot added Compute az vm/vmss/image/disk/snapshot act-observability-squad labels Jul 21, 2026

william051200 changed the title ~~{Compute} az vmss lifecycle-hooks/ lifecycle-hooks-event: Add new command groups to support vmss lifecycle hooks~~ {Compute} az vmss lifecycle-hook/ lifecycle-hook-event: Add new command groups to support vmss lifecycle hooks Jul 21, 2026

Copilot AI reviewed Jul 21, 2026

View reviewed changes

william051200 changed the title ~~{Compute} az vmss lifecycle-hook/ lifecycle-hook-event: Add new command groups to support vmss lifecycle hooks~~ [Compute] az vmss lifecycle-hook/ lifecycle-hook-event: Add new command groups to support vmss lifecycle hooks Jul 21, 2026

william051200 mentioned this pull request Jul 21, 2026

Export lifecycle-hook-event Azure/aaz#1046

Open

william051200 added 2 commits July 21, 2026 14:08

Update code

4e29c89

Remove unused import

ed5ff4c

Update recording

7854b85

AnshulVermaa suggested changes Jul 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Compute] `az vmss lifecycle-hook/ lifecycle-hook-event`: Add new command groups to support vmss lifecycle hooks#33758

[Compute] `az vmss lifecycle-hook/ lifecycle-hook-event`: Add new command groups to support vmss lifecycle hooks#33758
william051200 wants to merge 13 commits into
Azure:devfrom
william051200:lifecycle-hooks

william051200 commented Jul 21, 2026 •

edited by azure-client-tools-agent Bot

Loading

Uh oh!

azure-client-tools-bot-prd Bot commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

yonzhan commented Jul 21, 2026

Uh oh!

william051200 commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

william051200 commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

AnshulVermaa commented Jul 23, 2026

Uh oh!

AnshulVermaa left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rule	cmd_name	rule_message	suggest_message
⚠️ 1011 - SubgroupAdd	vmss lifecycle-hook	sub group `vmss lifecycle-hook` added
⚠️ 1011 - SubgroupAdd	vmss lifecycle-hook-event	sub group `vmss lifecycle-hook-event` added

Uh oh!

Conversation

william051200 commented Jul 21, 2026 • edited by azure-client-tools-agent Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤖 PR Validation — ⚠️ Review suggested

Uh oh!

azure-client-tools-bot-prd Bot commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

yonzhan commented Jul 21, 2026

Uh oh!

william051200 commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

william051200 commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

AnshulVermaa commented Jul 23, 2026

Uh oh!

AnshulVermaa left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

william051200 commented Jul 21, 2026 •

edited by azure-client-tools-agent Bot

Loading