[Az.ScVmm] Use ErrorAction Stop for Get Machine operations to fix exception being logged on console #28490

hsurana06 · 2025-09-01T18:08:36Z

Description

Use -ErrorAction Stop for Az.ScVmm.internal\Get-AzScVmmMachine operations to fix expected exception being logged on console.
No change in API/Command.

The existing cmdlet works correctly, but the expected exception is printed to the console, which may confuse users into thinking the operation failed.

Before:

After:

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

azure-client-tools-bot-prd · 2025-09-01T18:08:39Z

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

Copilot

Pull Request Overview

This PR improves error handling in the Az.ScVmm module by adding -ErrorAction Stop to Get-AzScVmmMachine operations to prevent expected exceptions from being logged to the console. The changes focus on suppressing unhelpful error messages that confuse users, while maintaining the same functionality.

Added -ErrorAction Stop to all Get-AzScVmmMachine calls to properly handle expected exceptions
Enhanced error messages to include more context about the failure
Fixed minor documentation capitalization issues and typos

Reviewed Changes

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

File	Description
src/ScVmm/ScVmm/ChangeLog.md	Added changelog entry for exception suppression fix
src/ScVmm/ScVmm.Autorest/custom/*.ps1	Enhanced error handling with `-ErrorAction Stop` and improved error messages
src/ScVmm/ScVmm/help/*.md	Fixed capitalization in synopsis and description text
src/ScVmm/ScVmm.Autorest/docs/*.md	Fixed capitalization in synopsis and description text, corrected "MacAdders" typo

Copilot · 2025-09-01T18:09:44Z

src/ScVmm/ScVmm.Autorest/custom/Update-AzScVmmVMNic.ps1

+              if ($null -eq $vmObj) {
                throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"


The variable check is comparing $vmObj but the error message still refers to "Virtual Machine $vmName". The logic checks if $vmObj is null but should check if the VM object retrieval failed, not if $machineObj is null as in the original code.

Suggested change

if ($null -eq $vmObj) {

throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"

throw "Failed to fetch Virtual Machine Object using MachineId '$($machineObj.Id)' for Virtual Machine '$vmName'"

src/ScVmm/ScVmm.Autorest/custom/Update-AzScVmmVMDisk.ps1

Copilot · 2025-09-01T18:09:45Z

src/ScVmm/ScVmm.Autorest/custom/Remove-AzScVmmVMNic.ps1

+              if ($null -eq $vmObj) {
                throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"


The variable check is comparing $vmObj but the error message still refers to "Virtual Machine $vmName". The logic checks if $vmObj is null but should check if the VM object retrieval failed, not if $machineObj is null as in the original code.

Suggested change

if ($null -eq $vmObj) {

throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"

throw "Failed to fetch VM object for VM '$vmName' in Resource Group '$ResourceGroupName' (SubscriptionId '$SubscriptionId')"

src/ScVmm/ScVmm.Autorest/custom/Remove-AzScVmmVMDisk.ps1

Copilot · 2025-09-01T18:09:45Z

src/ScVmm/ScVmm.Autorest/custom/Get-AzScVmmVMDisk.ps1

+        if ($null -eq $vmObj) {
          throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"


The variable check is comparing $vmObj but the error message still refers to "Virtual Machine $vmName". The logic checks if $vmObj is null but should check if the VM object retrieval failed, not if $machineObj is null as in the original code.

Suggested change

if ($null -eq $vmObj) {

throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"

throw "Failed to fetch Virtual Machine Object for MachineId $($machineObj.Id) (VM Name: $vmName)"

Copilot · 2025-09-01T18:09:46Z

src/ScVmm/ScVmm.Autorest/custom/Add-AzScVmmVMNic.ps1

+              if ($null -eq $vmObj) {
                throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"


The variable check is comparing $vmObj but the error message still refers to "Virtual Machine $vmName". The logic checks if $vmObj is null but should check if the VM object retrieval failed, not if $machineObj is null as in the original code.

Suggested change

if ($null -eq $vmObj) {

throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"

throw "Failed to fetch Virtual Machine Object for MachineId $($machineObj.Id) in Resource Group $ResourceGroupName (SubscriptionId $SubscriptionId)"

Copilot · 2025-09-01T18:09:46Z

src/ScVmm/ScVmm.Autorest/custom/Add-AzScVmmVMDisk.ps1

+            if ($null -eq $vmObj) {
              throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"


The variable check is comparing $vmObj but the error message still refers to "Virtual Machine $vmName". The logic checks if $vmObj is null but should check if the VM object retrieval failed, not if $machineObj is null as in the original code.

Suggested change

if ($null -eq $vmObj) {

throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"

throw "Failed to fetch Virtual Machine Object for MachineId $($machineObj.Id) (VM Name: $vmName)"

hsurana06 · 2025-09-01T18:29:23Z

/azp run

azure-pipelines · 2025-09-01T18:29:29Z

Commenter does not have sufficient privileges for PR 28490 in repo Azure/azure-powershell

VeryEarly · 2025-09-02T02:37:40Z

/azp run

azure-pipelines · 2025-09-02T02:37:56Z

Azure Pipelines successfully started running 3 pipeline(s).

VeryEarly · 2025-09-02T02:49:18Z

please run

cd src/ScVmm/ScVmm.autorest
autorest
./build-module.ps1
cd src/ScVmm
git add
git commit -m "${commit-message}"
git push origin head

isra-fel · 2025-09-02T07:31:13Z

/azp run

azure-pipelines · 2025-09-02T07:31:29Z

Azure Pipelines successfully started running 3 pipeline(s).

hsurana06 · 2025-09-03T06:02:06Z

@VeryEarly, @isra-fel - Are there any additional steps required from me regarding the PR, and could you please share the timeline for when it will be rolled out to customers?

VeryEarly · 2025-09-04T08:24:04Z

@VeryEarly, @isra-fel - Are there any additional steps required from me regarding the PR, and could you please share the timeline for when it will be rolled out to customers?

please find timeline: https://github.com/Azure/azure-powershell/milestone/182

hsurana06 added 2 commits September 1, 2025 23:21

Use ErrorAction Stop for Get Machine operations

c3184a4

Update changelog

f46a2f7

Copilot AI review requested due to automatic review settings September 1, 2025 18:08

Copilot AI reviewed Sep 1, 2025

View reviewed changes

Update exception message

cebf3a6

VeryEarly self-assigned this Sep 2, 2025

Build config changes

017e1d3

VeryEarly approved these changes Sep 4, 2025

View reviewed changes

VeryEarly merged commit 7c065fc into Azure:main Sep 4, 2025
12 checks passed

github-actions bot mentioned this pull request Oct 1, 2025

Monthly issue metrics report #28630

Closed

		if ($null -eq $vmObj) {
		throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"

	if ($null -eq $vmObj) {
	throw "Failed to fetch Virtual Machine Object for Virtual Machine $vmName"
	throw "Failed to fetch VM object for VM '$vmName' in Resource Group '$ResourceGroupName' (SubscriptionId '$SubscriptionId')"

[Az.ScVmm] Use ErrorAction Stop for Get Machine operations to fix exception being logged on console #28490

[Az.ScVmm] Use ErrorAction Stop for Get Machine operations to fix exception being logged on console #28490

Uh oh!

Conversation

hsurana06 commented Sep 1, 2025 • edited 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 Sep 1, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

hsurana06 commented Sep 1, 2025

Uh oh!

azure-pipelines bot commented Sep 1, 2025

Uh oh!

VeryEarly commented Sep 2, 2025

Uh oh!

azure-pipelines bot commented Sep 2, 2025

Uh oh!

VeryEarly commented Sep 2, 2025

Uh oh!

isra-fel commented Sep 2, 2025

Uh oh!

azure-pipelines bot commented Sep 2, 2025

Uh oh!

hsurana06 commented Sep 3, 2025

Uh oh!

VeryEarly commented Sep 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hsurana06 commented Sep 1, 2025 •

edited

Loading