migrate LoadTesting to autorest v4 #28284

Pan-Qi · 2025-07-28T03:36:02Z

Description

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-07-28T03:36:04Z

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

github-actions · 2025-08-28T13:26:32Z

To the author of the pull request,
This PR was labeled "Breaking Change Release" because it contains breaking changes.

According to our policy, breaking changes can only take place during major release and they must be preannounced.
Please follow our guide on the detailed steps.
Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

Copilot

Pull Request Overview

This PR migrates the LoadTesting module from AutoRest v3 to AutoRest v4, introducing significant changes to the API interface and parameter handling. The migration simplifies managed identity configuration by replacing hashtable-based user identity assignment with string arrays and introduces system-assigned identity toggle parameters.

Key changes include:

Updated parameter interface for managed identity operations with new EnableSystemAssignedIdentity and UserAssignedIdentity parameters
Generated new parameter sets for JSON file and string inputs across all cmdlets
Updated documentation and examples to reflect the new parameter syntax

Reviewed Changes

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

Show a summary per file

File	Description
`tools/StaticAnalysis/Exceptions/Az.LoadTesting/BreakingChangeIssues.csv`	Documents breaking changes from v3 to v4 migration including parameter removals and type changes
`src/LoadTesting/LoadTesting/help/*.md`	Updated help documentation with new parameter sets and simplified identity management syntax
`src/LoadTesting/LoadTesting/ChangeLog.md`	Documents the AutoRest v4 upgrade and breaking changes to identity parameters
`src/LoadTesting/LoadTesting.Autorest/custom/*.ps1`	Updated cmdlet implementations with new identity parameter handling logic
`src/LoadTesting/LoadTesting.Autorest/test/*`	Updated test files with new parameter syntax and test environment configurations
`src/LoadTesting/LoadTesting.Autorest/README.md`	Updated AutoRest configuration to disable identity type transforms and add new directives

Copilot · 2025-08-28T13:28:23Z

src/LoadTesting/LoadTesting.Autorest/custom/Update-AzLoad.ps1

+
+                # calculate IdentityType
+                $supportsSystemAssignedIdentity = $EnableSystemAssignedIdentity -or (($null -eq $EnableSystemAssignedIdentity) -and ($loadTestingObject.IdentityType.Contains('SystemAssigned')))
+                $supportsUserAssignedIdentity = ($PSBoundParameters.ContainsKey('UserAssignedIdentity') -and $UserAssignedIdentity.Length -gt 0) -or ((-not $PSBoundParameters.ContainsKey('UserAssignedIdentity')) -and ($loadTestingObject.IdentityType.Contains('UserAssigned')));


This complex boolean logic should be simplified for better readability. Consider breaking it into multiple variables or using helper functions to make the condition more understandable.

Suggested change

$supportsUserAssignedIdentity = ($PSBoundParameters.ContainsKey('UserAssignedIdentity') -and $UserAssignedIdentity.Length -gt 0) -or ((-not $PSBoundParameters.ContainsKey('UserAssignedIdentity')) -and ($loadTestingObject.IdentityType.Contains('UserAssigned')));

$hasUserAssignedIdentityParameter = $PSBoundParameters.ContainsKey('UserAssignedIdentity')

$userAssignedIdentityParameterNotEmpty = $hasUserAssignedIdentityParameter -and ($UserAssignedIdentity.Length -gt 0)

$userAssignedIdentityParameterMissing = -not $hasUserAssignedIdentityParameter

$objectHasUserAssignedIdentity = $loadTestingObject.IdentityType.Contains('UserAssigned')

$supportsUserAssignedIdentity = $userAssignedIdentityParameterNotEmpty -or ($userAssignedIdentityParameterMissing -and $objectHasUserAssignedIdentity)

Copilot · 2025-08-28T13:28:24Z

src/LoadTesting/LoadTesting.Autorest/custom/New-AzLoad.ps1

+                $supportsUserAssignedIdentity = $PSBoundParameters.ContainsKey("UserAssignedIdentity") -and $UserAssignedIdentity.Length -gt 0
+
+                # calculate IdentityType
+                if (($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity)) {


[nitpick] The parentheses around the first condition are unnecessary and create inconsistent formatting with the subsequent else-if conditions.

Suggested change

if (($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity)) {

if ($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity) {

Copilot · 2025-08-28T13:28:24Z

src/LoadTesting/LoadTesting.Autorest/custom/Update-AzLoad.ps1

+                # calculate IdentityType
+                $supportsSystemAssignedIdentity = $EnableSystemAssignedIdentity -or (($null -eq $EnableSystemAssignedIdentity) -and ($loadTestingObject.IdentityType.Contains('SystemAssigned')))
+                $supportsUserAssignedIdentity = ($PSBoundParameters.ContainsKey('UserAssignedIdentity') -and $UserAssignedIdentity.Length -gt 0) -or ((-not $PSBoundParameters.ContainsKey('UserAssignedIdentity')) -and ($loadTestingObject.IdentityType.Contains('UserAssigned')));
+                if (($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity)) {


[nitpick] The parentheses around the first condition are unnecessary and create inconsistent formatting with the subsequent else-if conditions.

Suggested change

if (($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity)) {

if ($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity) {

Copilot · 2025-08-28T13:28:24Z

src/LoadTesting/LoadTesting/help/Update-AzLoad.md

 ### Example 2: Update an Azure Load Testing resource to use System-Assigned identity for CMK encryption
 ```powershell
-Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -IdentityType "SystemAssigned" -EncryptionIdentity "SystemAssigned" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde"
+Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -EnableSystemAssignedIdentity $true -EncryptionIdentity "SystemAssigned" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde"


Using $true with the EnableSystemAssignedIdentity parameter is redundant since it's a Boolean parameter. The parameter should be used as a switch: -EnableSystemAssignedIdentity instead of -EnableSystemAssignedIdentity $true.

Suggested change

Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -EnableSystemAssignedIdentity $true -EncryptionIdentity "SystemAssigned" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde"

Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -EnableSystemAssignedIdentity -EncryptionIdentity "SystemAssigned" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde"

Copilot · 2025-08-28T13:28:25Z

src/LoadTesting/LoadTesting.Autorest/custom/Update-AzLoad.ps1

+                        $loadTestingObject.IdentityUserAssignedIdentity.Keys | ForEach-Object {
+                            if (-NOT($_ -in $UserAssignedIdentity)) {
+                            $PSBoundParameters.IdentityUserAssignedIdentity.Add($_, $null)


Consider using a more efficient approach than piping to ForEach-Object for iterating over dictionary keys, such as using a foreach loop which would be faster for this operation.

Suggested change

$loadTestingObject.IdentityUserAssignedIdentity.Keys | ForEach-Object {

if (-NOT($_ -in $UserAssignedIdentity)) {

$PSBoundParameters.IdentityUserAssignedIdentity.Add($_, $null)

foreach ($key in $loadTestingObject.IdentityUserAssignedIdentity.Keys) {

if (-NOT($key -in $UserAssignedIdentity)) {

$PSBoundParameters.IdentityUserAssignedIdentity.Add($key, $null)

isra-fel · 2025-10-24T03:38:54Z

/azp run

azure-pipelines · 2025-10-24T03:39:01Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

Pan-Qi force-pushed the bernard-migrate-LoadTesting-to-autorest-v4 branch 2 times, most recently from 8e2e91f to 6b1ebc1 Compare August 13, 2025 09:01

Pan-Qi added the Contains Breaking Change This PR contains breaking change label Aug 28, 2025

Pan-Qi marked this pull request as ready for review August 28, 2025 13:26

Copilot AI review requested due to automatic review settings August 28, 2025 13:26

Copilot AI reviewed Aug 28, 2025

View reviewed changes

venkatr21 self-requested a review September 3, 2025 13:31

isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 2, 2025

venkatr21 approved these changes Oct 6, 2025

View reviewed changes

Pan-Qi requested review from DanielMicrosoft, NoriZC, VeryEarly, YanaXu, dolauli, isra-fel, notyashhh, vidai-msft and wyunchi-ms as code owners October 24, 2025 03:25

Pan-Qi force-pushed the bernard-migrate-LoadTesting-to-autorest-v4 branch from eac4f6f to 0ea9d89 Compare October 24, 2025 03:55

Pan-Qi removed request for NoriZC, VeryEarly, YanaXu, dolauli, notyashhh, vidai-msft and wyunchi-ms October 24, 2025 04:06

Pan-Qi removed the request for review from DanielMicrosoft October 24, 2025 04:06

Pan-Qi added 8 commits October 24, 2025 15:11

migrate LoadTesting to autorest v4

f32126b

Update custom code

56a55e0

Update example

06ad50e

Suppress breaking change

c7ed9b7

Record test

da31422

Custom to GET+PATCH api

1fc0673

Add change log

d3126cf

Suppress breaking change

5c8cfbf

Pan-Qi force-pushed the bernard-migrate-LoadTesting-to-autorest-v4 branch from 0ea9d89 to 5c8cfbf Compare October 24, 2025 04:15

rebuild

0b47236

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

migrate LoadTesting to autorest v4 #28284

migrate LoadTesting to autorest v4 #28284

Uh oh!

Pan-Qi commented Jul 28, 2025

Uh oh!

azure-client-tools-bot-prd bot commented Jul 28, 2025

Uh oh!

github-actions bot commented Aug 28, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

isra-fel commented Oct 24, 2025

Uh oh!

azure-pipelines bot commented Oct 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-                $supportsUserAssignedIdentity = ($PSBoundParameters.ContainsKey('UserAssignedIdentity') -and $UserAssignedIdentity.Length -gt 0) -or ((-not $PSBoundParameters.ContainsKey('UserAssignedIdentity')) -and ($loadTestingObject.IdentityType.Contains('UserAssigned')));
+                $hasUserAssignedIdentityParameter = $PSBoundParameters.ContainsKey('UserAssignedIdentity')
+                $userAssignedIdentityParameterNotEmpty = $hasUserAssignedIdentityParameter -and ($UserAssignedIdentity.Length -gt 0)
+                $userAssignedIdentityParameterMissing = -not $hasUserAssignedIdentityParameter
+                $objectHasUserAssignedIdentity = $loadTestingObject.IdentityType.Contains('UserAssigned')
+                $supportsUserAssignedIdentity = $userAssignedIdentityParameterNotEmpty -or ($userAssignedIdentityParameterMissing -and $objectHasUserAssignedIdentity)

	if (($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity)) {
	if ($supportsSystemAssignedIdentity -and $supportsUserAssignedIdentity) {

	Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -EnableSystemAssignedIdentity $true -EncryptionIdentity "SystemAssigned" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde"
	Update-AzLoad -Name sampleres -ResourceGroupName sample-rg -EnableSystemAssignedIdentity -EncryptionIdentity "SystemAssigned" -EncryptionKey "https://sample-akv.vault.azure.net/keys/cmk/2d1ccd5c50234ea2a0858fe148b69cde"

Uh oh!

migrate LoadTesting to autorest v4 #28284

Are you sure you want to change the base?

migrate LoadTesting to autorest v4 #28284

Uh oh!

Conversation

Pan-Qi commented Jul 28, 2025

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Jul 28, 2025

Uh oh!

github-actions bot commented Aug 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

isra-fel commented Oct 24, 2025

Uh oh!

azure-pipelines bot commented Oct 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants