Copilot/az compute update galleryimage feature by purbch · Pull Request #29368 · Azure/azure-powershell

purbch · 2026-04-03T07:24:57Z

Description

Adding the changes to support UpdateImage feature which has a new property called startsAtVersion to define the image version onwards the updated image feature is supported and allowUpdateImage to separate it from the Create request for the image feature
Design: https://github.com/Azure/azure-powershell-cmdlet-review-pr/issues/1541

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

…eDefinition cmdlet Agent-Logs-Url: https://github.com/Azure/azure-powershell/sessions/44ef71fe-10fa-4071-b5f0-ce5b458f2586 Co-authored-by: audreyttt <225061541+audreyttt@users.noreply.github.com>

azure-client-tools-bot-prd · 2026-04-03T07:25:02Z

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copilot

Pull request overview

This PR extends the Az.Compute gallery image definition update surface to support updating gallery image features (including StartsAtVersion) and the accompanying AllowUpdateImage flag, with documentation and scenario test coverage.

Changes:

Added -Feature and -AllowUpdateImage parameters to Update-AzGalleryImageDefinition (generated cmdlet implementation).
Extended PSGalleryImage to expose AllowUpdateImage on outputs.
Updated cmdlet help + Compute ChangeLog.md, and added a new gallery scenario test.

Reviewed changes

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

Show a summary per file

File	Description
src/Compute/Compute/help/Update-AzGalleryImageDefinition.md	Documents the new `-Feature` / `-AllowUpdateImage` parameters and provides an example.
src/Compute/Compute/Generated/Models/PSGalleryImage.cs	Adds `AllowUpdateImage` to the PowerShell model returned for gallery image definitions.
src/Compute/Compute/Generated/GalleryImage/GalleryImageCreateOrUpdateMethod.cs	Implements sending `features` and `allowUpdateImage` on update requests; adds the new parameters.
src/Compute/Compute/ChangeLog.md	Release notes for the new update capability.
src/Compute/Compute.Test/ScenarioTests/GalleryTests.ps1	Adds scenario coverage for updating features with `StartsAtVersion` and `AllowUpdateImage`.
src/Compute/Compute.Test/ScenarioTests/GalleryTests.cs	Registers the new scenario test for check-in runs.

src/Compute/Compute.Test/ScenarioTests/GalleryTests.ps1

src/Compute/Compute/Generated/GalleryImage/GalleryImageCreateOrUpdateMethod.cs

src/Compute/Compute/ChangeLog.md

VeryEarly · 2026-04-03T07:38:56Z

/azp run

azure-pipelines · 2026-04-03T07:39:13Z

Azure Pipelines successfully started running 3 pipeline(s).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

VeryEarly · 2026-04-06T21:12:13Z

/azp run

azure-pipelines · 2026-04-06T21:12:29Z

Azure Pipelines successfully started running 3 pipeline(s).

…rding - Set StartsAtVersion during gallery image definition creation instead of update, as the Azure API does not allow changing this property post-creation - Remove AllowUpdateImage assertion as the property is not populated in the PSGalleryImage response model - Add session recording file for Playback mode in CI Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

VeryEarly · 2026-04-07T07:13:54Z

/azp run

azure-pipelines · 2026-04-07T07:14:12Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 4 out of 7 changed files in this pull request and generated 1 comment.

src/Compute/Compute/Generated/GalleryImage/GalleryImageCreateOrUpdateMethod.cs

VeryEarly · 2026-04-08T05:21:28Z

Hi @purbch ,
Please follow the CLA instruction in comment

audreyttt

Overall looks good, minor test change needed

audreyttt · 2026-04-08T17:27:18Z

src/Compute/Compute/help/Update-AzGalleryImageDefinition.md

 Accept wildcard characters: False
 ```

+### -Feature


Can you move these so that they follow the alphabetical order of the other parameters?

audreyttt · 2026-04-08T17:32:31Z

src/Compute/Compute.Test/ScenarioTests/GalleryTests.ps1

+
+        $diskControllerUpdated = $updatedDefinition.Features | Where-Object { $_.Name -eq 'DiskControllerTypes' };
+        Assert-NotNull $diskControllerUpdated;
+        Assert-AreEqual $diskControllerUpdated.Value 'SCSI';


The feature values in the updatedDefinition seem to match the initialFeatures, so we should change the test to make sure we are actually checking that new values are set. $features is equal to $initialFeatures so we are not actually updating anything.

- Move -AllowUpdateImage and -Feature parameters to alphabetical order in Update-AzGalleryImageDefinition.md help file - Update test to use different feature values for the update operation so it actually verifies the update works (changed SecurityType, DiskControllerTypes, and StartsAtVersion values) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

purbch · 2026-04-09T23:41:37Z

@purbch please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

@microsoft-github-policy-service agree company="Microsoft"

VeryEarly · 2026-04-09T23:42:55Z

/azp run

azure-pipelines · 2026-04-09T23:43:10Z

Azure Pipelines successfully started running 3 pipeline(s).

audreyttt

Please record the test again and ensure it works in playback mode

- Changed DiskControllerTypes value from SCSI to SCSI, NVMe (valid update) - Kept StartsAtVersion at 4.0.0 (API does not allow changing this) - Re-recorded session recording with updated feature values Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

Copilot · 2026-04-10T19:22:49Z

src/Compute/Compute/help/Update-AzGalleryImageDefinition.md

+$DiskControllerType = @{Name='DiskControllerTypes'; Value='SCSI'; StartsAtVersion='4.0.0'}
+$SecurityType = @{Name='SecurityType'; Value='TrustedLaunch'; StartsAtVersion='4.0.0'}


The example builds -Feature values as hashtables, but the parameter type is Microsoft.Azure.Management.Compute.Models.GalleryImageFeature[]. Unless a custom type converter exists, this example may not work as written. Update the example to construct actual GalleryImageFeature objects (e.g., via New-Object ... -Property @{...} or a strongly-typed cast) to match real usage (and align with the new scenario test).

Suggested change

$DiskControllerType = @{Name='DiskControllerTypes'; Value='SCSI'; StartsAtVersion='4.0.0'}

$SecurityType = @{Name='SecurityType'; Value='TrustedLaunch'; StartsAtVersion='4.0.0'}

$DiskControllerType = New-Object Microsoft.Azure.Management.Compute.Models.GalleryImageFeature -Property @{Name='DiskControllerTypes'; Value='SCSI'; StartsAtVersion='4.0.0'}

$SecurityType = New-Object Microsoft.Azure.Management.Compute.Models.GalleryImageFeature -Property @{Name='SecurityType'; Value='TrustedLaunch'; StartsAtVersion='4.0.0'}

Copilot · 2026-04-10T19:22:49Z

src/Compute/Compute.Test/ScenarioTests/GalleryTests.ps1

+            -Name $definitionName -Feature $features -AllowUpdateImage $true;
+
+        # Verify the updated definition
+        $updatedDefinition = Get-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $galleryName -Name $definitionName;


The test uses Update-AzGalleryImageDefinition and Get-AzGalleryImageDefinition without -ErrorAction Stop. In these scenario tests, non-terminating errors can lead to false positives or harder-to-diagnose failures later in the script. Consider adding -ErrorAction Stop (mandatory for reliability) to the update and subsequent get so the test fails at the real error site.

Suggested change

-Name $definitionName -Feature $features -AllowUpdateImage $true;

# Verify the updated definition

$updatedDefinition = Get-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $galleryName -Name $definitionName;

-Name $definitionName -Feature $features -AllowUpdateImage $true -ErrorAction Stop;

# Verify the updated definition

$updatedDefinition = Get-AzGalleryImageDefinition -ResourceGroupName $rgname -GalleryName $galleryName -Name $definitionName -ErrorAction Stop;

Copilot · 2026-04-10T19:22:50Z

src/Compute/Compute/Generated/GalleryImage/GalleryImageCreateOrUpdateMethod.cs

+                        galleryImage.Features = new List<GalleryImageFeature>();
+                        for (int i = 0; i < this.Feature.Length; i++)
+                        {
+                            galleryImage.Features.Add(this.Feature[i]);
+                        }


This manual copy loop is more verbose than necessary and makes the intent (assigning all provided features) less clear. Prefer constructing the list directly from the array (e.g., via ToList()), which reduces code and the chance of future off-by-one / null-handling issues. This is optional but would improve readability.

Suggested change

galleryImage.Features = new List<GalleryImageFeature>();

for (int i = 0; i < this.Feature.Length; i++)

{

galleryImage.Features.Add(this.Feature[i]);

}

galleryImage.Features = this.Feature.ToList();

VeryEarly · 2026-04-10T19:39:17Z

/azp run

azure-pipelines · 2026-04-10T19:39:34Z

Azure Pipelines successfully started running 3 pipeline(s).

resolved

Copilot AI and others added 2 commits April 2, 2026 20:05

Initial plan

5ab9037

Add -Feature and -AllowUpdateImage parameters to Update-AzGalleryImag…

22f6ead

…eDefinition cmdlet Agent-Logs-Url: https://github.com/Azure/azure-powershell/sessions/44ef71fe-10fa-4071-b5f0-ce5b458f2586 Co-authored-by: audreyttt <225061541+audreyttt@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 3, 2026 07:24

purbch requested review from NoriZC, audreyttt, haagha, ookoka, teresaritorto and yanzhudd as code owners April 3, 2026 07:24

Copilot started reviewing on behalf of purbch April 3, 2026 07:27 View session

Fix formatting in GalleryTests.ps1

3a3a5cc

Copilot AI reviewed Apr 3, 2026

View reviewed changes

VeryEarly self-assigned this Apr 3, 2026

Remove dollar sign from ChangeLog.md to avoid manifest issues

13d2dca

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 7, 2026 07:11

Copilot started reviewing on behalf of purbch April 7, 2026 07:13 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

src/Compute/Compute/Generated/GalleryImage/GalleryImageCreateOrUpdateMethod.cs Show resolved Hide resolved

audreyttt requested changes Apr 8, 2026

View reviewed changes

audreyttt previously requested changes Apr 10, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings April 10, 2026 19:16

Copilot AI reviewed Apr 10, 2026

View reviewed changes

Copilot started reviewing on behalf of purbch April 10, 2026 19:23 View session

VeryEarly approved these changes Apr 13, 2026

View reviewed changes

VeryEarly enabled auto-merge (squash) April 13, 2026 03:15

NoriZC approved these changes Apr 13, 2026

View reviewed changes

VeryEarly merged commit 373ba27 into Azure:main Apr 13, 2026
15 of 16 checks passed

		$DiskControllerType = @{Name='DiskControllerTypes'; Value='SCSI'; StartsAtVersion='4.0.0'}
		$SecurityType = @{Name='SecurityType'; Value='TrustedLaunch'; StartsAtVersion='4.0.0'}

Conversation

purbch commented Apr 3, 2026 • edited by audreyttt Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Apr 3, 2026

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!

VeryEarly commented Apr 3, 2026

Uh oh!

azure-pipelines bot commented Apr 3, 2026

Uh oh!

VeryEarly commented Apr 6, 2026

Uh oh!

azure-pipelines bot commented Apr 6, 2026

Uh oh!

VeryEarly commented Apr 7, 2026

Uh oh!

azure-pipelines bot commented Apr 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

VeryEarly commented Apr 8, 2026

Uh oh!

audreyttt left a comment

Choose a reason for hiding this comment

Uh oh!

audreyttt Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

purbch Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

audreyttt Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

purbch Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

purbch commented Apr 9, 2026

Uh oh!

VeryEarly commented Apr 9, 2026

Uh oh!

azure-pipelines bot commented Apr 9, 2026

Uh oh!

audreyttt left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

VeryEarly commented Apr 10, 2026

Uh oh!

azure-pipelines bot commented Apr 10, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

purbch commented Apr 3, 2026 •

edited by audreyttt

Loading