[Az.ServiceFabric] Updating SDK After Typespec Migration #28169

iliu816 · 2025-07-10T18:11:30Z

Description

Service fabric managed clusters specification was migrated to Typespec in March 2025 (Azure/azure-rest-api-specs#32790).

Complications with SDK generation and release delayed work on Powershell cmdlets. This PR brings the autorest generated SDK in-line with the latest servicefabricmanagedclusters spec (Azure/azure-rest-api-specs#35603) as a basis for further development work. There have been no service side changes for the existing cmdlets.

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-10T18:11:33Z

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

Copilot

Pull Request Overview

This PR updates the Service Fabric managed clusters SDK to match the latest Typespec-based REST spec, adjusts cmdlet implementations accordingly, and refreshes scenario tests to use dynamic values.

Renamed VM-related properties from camelCase (VmInstanceCount, DataDiskSizeGB, etc.) to PascalCase (VMInstanceCount, DataDiskSizeGb, etc.).
Swapped exception types from ErrorModelException/ErrorModel to ErrorResponseException/ErrorResponse and added typed overloads for long-running operation polling with enhanced progress reporting.
Updated cmdlets to use named parameters for clarity and adjusted tests to generate random passwords, include tags, and supply PackageUrl where required.

Reviewed Changes

Copilot reviewed 15 out of 200 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
PSManagedNodeType.cs	Corrected casing on VM properties to match generated model.
ServiceFabricCommonCmdletBase.cs	Replaced `ErrorModelException` with `ErrorResponseException` and `ErrorModel` with `ErrorResponse`.
SetAzServiceFabricManagedClusterService.cs	Updated `PollLongRunningOperation` call to use new generic overload.
ServiceFabricManagedCmdletBase.cs	Swapped management client type, added three overloads of `PollLongRunningOperation` with enhanced polling logic.
SetAzServiceFabricManagedNodeType.cs & related cmdlets	Adjusted all VM property references (`Vm` → `VM`).
ManagedApplicationCmdletBase.cs & SetAzServiceFabricManagedClusterApplicationType.cs	Switched to named parameters for `CreateOrUpdateWithHttpMessagesAsync`.
ServiceFabric.Test.csproj	Added PEM files to test output.
ScenarioTests/*.ps1 & Common.ps1	Refactored tests to use random secure strings, tags, and updated package URLs.

Copilot · 2025-07-10T18:13:21Z

src/ServiceFabric/ServiceFabric/Commands/ManagedClusters/ServiceFabricManagedCmdletBase.cs

@@ -71,15 +71,15 @@ protected void PollLongRunningOperation(Rest.Azure.AzureOperationResponse beginR
            this.PollLongRunningOperation(response2);
        }

-        protected T PollLongRunningOperation<T>(AzureOperationResponse<T> beginRequestResponse) where T : class
+        protected TBody PollLongRunningOperation<TBody>(AzureOperationResponse<TBody> beginRequestResponse) where TBody : class


[nitpick] The three overloads of PollLongRunningOperation share nearly identical polling logic; consider refactoring common code into a helper method to reduce duplication.

a-santamaria · 2025-07-10T21:02:10Z

src/ServiceFabric/ServiceFabric/Commands/ManagedClusters/ServiceFabricManagedCmdletBase.cs

@@ -157,6 +157,180 @@ protected T PollLongRunningOperation<T>(AzureOperationResponse<T> beginRequestRe
            return result?.Body;
        }

+        protected void PollLongRunningOperation<THeader>(AzureOperationHeaderResponse<THeader> beginRequestResponse) where THeader : class


was this copied over from somewhere else?

There used to be just one T PollLongRunningOperation<T>(AzureOperationHeaderResponse<T> beginRequestResponse), but it wouldn't accept inputs of type AzureOperationHeaderResponse<TBody, THeader> or AzureOperationHeaderResponse<THeader>. There is probably a far more elegant way to do refactor the overloads, but Copilot wasn't helpful, and I didn't come across anything too similar in the other modules. Was hoping for suggestions

YanaXu · 2025-07-11T01:24:41Z

/azp run

azure-pipelines · 2025-07-11T01:24:57Z

Azure Pipelines successfully started running 3 pipeline(s).

YanaXu · 2025-07-11T07:12:22Z

Please update the ChangeLog.
Please check the CI errors. There are breaking changes of property type and failed to generate the SDK. Please confirm if the type properties do change.

iliu816 · 2025-07-11T16:22:26Z

@YanaXu Updated the change log, let me know if there are other details I need to add.

The type property changes do change, the capitalization from the generated code from updated spec is different from previous version. I'm not sure why, since the casing in the spec hasn't changed.

VmManagedIdentity
VmSecrets
VmExtensions
DataDiskSizeGB
VmInstanceCount
VmSize
VmImagePublisher
VmImageOffer
VmImageSku
VmImageVersion

2025-03-01-preview: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2025-03-01-preview/servicefabricmanagedclusters.json

2023-11-01-preview: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json

But the type references have been updated appropriately in the code.

iliu816 · 2025-07-11T16:30:25Z

/azp run

azure-pipelines · 2025-07-11T16:30:32Z

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

YanaXu · 2025-07-14T01:43:15Z

/azp run

azure-pipelines · 2025-07-14T01:43:30Z

Azure Pipelines successfully started running 3 pipeline(s).

YanaXu · 2025-07-14T02:16:35Z

src/ServiceFabric/ServiceFabric/ChangeLog.md

@@ -19,6 +19,9 @@
 -->
 ## Upcoming Release

+## Version 3.6.0


Remove line 21 and 22. Don't bump the version in ChangeLog. It'll be done automatically in the release.

YanaXu · 2025-07-14T05:54:00Z

Hi @iliu816, regarding the properties detected by CI as changed, if these properties only differ in case, please suppress them.
And please don't update the source code auto-generated or the CI will fail too.

iliu816 · 2025-07-14T17:33:36Z

Hi @iliu816, regarding the properties detected by CI as changed, if these properties only differ in case, please suppress them. And please don't update the source code auto-generated or the CI will fail too.

Hi @YanaXu, do you have an example of how suppression works for the powershell repo CI? A search for "suppress" in the repo isn't returning documentation for me, and I clicked through a few modules and couldn't find examples.

YanaXu · 2025-07-15T01:56:40Z

/azp run

azure-pipelines · 2025-07-15T01:56:56Z

Azure Pipelines successfully started running 3 pipeline(s).

YanaXu · 2025-07-15T05:41:20Z

/azp run

azure-pipelines · 2025-07-15T05:41:39Z

Azure Pipelines successfully started running 3 pipeline(s).

src/ServiceFabric/ServiceFabricManagedClusters.Management.Sdk/README.md

… instructed

YanaXu · 2025-07-16T01:39:55Z

/azp run

azure-pipelines · 2025-07-16T01:40:11Z

Azure Pipelines successfully started running 3 pipeline(s).

YanaXu · 2025-07-16T02:38:50Z

/azp run

azure-pipelines · 2025-07-16T02:39:06Z

Azure Pipelines successfully started running 3 pipeline(s).

YanaXu · 2025-07-16T05:32:57Z

/azp run

azure-pipelines · 2025-07-16T05:33:14Z

Azure Pipelines successfully started running 3 pipeline(s).

YanaXu · 2025-07-16T06:15:06Z

Build failed. Please fix it.

YanaXu · 2025-07-16T06:28:51Z

/azp run

azure-pipelines · 2025-07-16T06:29:09Z

Azure Pipelines successfully started running 3 pipeline(s).

iliu816 added 2 commits July 10, 2025 10:55

sdk after typespec migration

b3fa9bc

*Cmdlet fixes, text fixes, updated recordings

4e05a74

Copilot AI review requested due to automatic review settings July 10, 2025 18:11

Copilot AI reviewed Jul 10, 2025

View reviewed changes

a-santamaria approved these changes Jul 10, 2025

View reviewed changes

update changelog

ca3e58e

YanaXu reviewed Jul 14, 2025

View reviewed changes

move update description in changelog under Upcoming Releases

0943ce8

add suppression for case changes

9472e2e

iliu816 changed the title ~~[ServiceFabric] Updating SDK After Typespec Migration~~ [Az.ServiceFabric] Updating SDK After Typespec Migration Jul 15, 2025

YanaXu reviewed Jul 15, 2025

View reviewed changes

src/ServiceFabric/ServiceFabricManagedClusters.Management.Sdk/README.md Show resolved Hide resolved

Replacing src/ServiceFabric/ServiceFabric.Management.Sdk/README.md as…

e0e3590

… instructed

updated readme.md and reran autorest commands

1fb52f1

remove accidental hypen

3595312

casing fixes for VM in ServiceFabric

86e7789

[Az.ServiceFabric] Updating SDK After Typespec Migration #28169

Are you sure you want to change the base?

[Az.ServiceFabric] Updating SDK After Typespec Migration #28169

Uh oh!

Conversation

iliu816 commented Jul 10, 2025

Description

Mandatory Checklist

Uh oh!

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

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

a-santamaria Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

iliu816 Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

YanaXu commented Jul 11, 2025

Uh oh!

azure-pipelines bot commented Jul 11, 2025

Uh oh!

YanaXu commented Jul 11, 2025

Uh oh!

iliu816 commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iliu816 commented Jul 11, 2025

Uh oh!

azure-pipelines bot commented Jul 11, 2025

Uh oh!

YanaXu commented Jul 14, 2025

Uh oh!

azure-pipelines bot commented Jul 14, 2025

Uh oh!

YanaXu Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

YanaXu commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iliu816 commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

YanaXu commented Jul 15, 2025

Uh oh!

azure-pipelines bot commented Jul 15, 2025

Uh oh!

YanaXu commented Jul 15, 2025

Uh oh!

azure-pipelines bot commented Jul 15, 2025

Uh oh!

Uh oh!

YanaXu commented Jul 16, 2025

Uh oh!

azure-pipelines bot commented Jul 16, 2025

Uh oh!

YanaXu commented Jul 16, 2025

Uh oh!

azure-pipelines bot commented Jul 16, 2025

Uh oh!

YanaXu commented Jul 16, 2025

Uh oh!

azure-pipelines bot commented Jul 16, 2025

Uh oh!

YanaXu commented Jul 16, 2025

Uh oh!

YanaXu commented Jul 16, 2025

Uh oh!

azure-pipelines bot commented Jul 16, 2025

Uh oh!

Uh oh!

iliu816 Jul 10, 2025 •

edited

Loading

iliu816 commented Jul 11, 2025 •

edited

Loading

YanaXu commented Jul 14, 2025 •

edited

Loading

iliu816 commented Jul 14, 2025 •

edited

Loading