[PS] Add breaking change announcement about migration StackHCI to autorest v4 (#28392)

Author: JoyerJin

src/StackHCI/StackHCI.Autorest/Properties/AssemblyInfo.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the Apache License, Version 2.0 (the ""License"");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an ""AS IS"" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
+// is regenerated.
+
+using System;
+using System.Reflection;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+
+[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
+[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
+[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
+[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - StackHci")]
+[assembly: System.Reflection.AssemblyFileVersionAttribute("2.6.1")]
+[assembly: System.Reflection.AssemblyVersionAttribute("2.6.1")]
+[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
+[assembly: System.CLSCompliantAttribute(false)]

src/StackHCI/StackHCI.Autorest/README.md

@@ -208,4 +208,236 @@ directive:
           - ResourceGroupName
         labels:
           ResourceGroupName: Resource Group
+  - where:
+      verb: Get|New
+      subject: ArcSetting
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - DefaultExtension
+          - PerNodeDetail
+        new-output-properties:
+          - DefaultExtension
+          - PerNodeDetail
+        change-description: The types of the properties DefaultExtension and PerNodeDetail will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Get|New
+      subject: Extension
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - PerNodeExtensionDetail
+        new-output-properties:
+          - PerNodeExtensionDetail
+        change-description: The type of the property PerNodeExtensionDetail will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Get|New|Update
+      subject: Cluster
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - ReportedPropertyNode
+          - LogCollectionPropertyLogCollectionSessionDetail
+          - RemoteSupportPropertyRemoteSupportSessionDetail
+          - RemoteSupportPropertyRemoteSupportNodeSetting
+          - ReportedPropertySupportedCapability
+        new-output-properties:
+          - ReportedPropertyNode
+          - LogCollectionPropertyLogCollectionSessionDetail
+          - RemoteSupportPropertyRemoteSupportSessionDetail
+          - RemoteSupportPropertyRemoteSupportNodeSetting
+          - ReportedPropertySupportedCapability
+        change-description: The types of the properties ReportedPropertyNode, LogCollectionPropertyLogCollectionSessionDetail, RemoteSupportPropertyRemoteSupportSessionDetail, RemoteSupportPropertyRemoteSupportNodeSetting and ReportedPropertySupportedCapability will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Get
+      subject: DeploymentSetting
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - DeploymentStatusStep
+          - ValidationStatusStep
+          - DeploymentConfigurationScaleUnit
+          - ArcNodeResourceId
+        new-output-properties:
+          - DeploymentStatusStep
+          - ValidationStatusStep
+          - DeploymentConfigurationScaleUnit
+          - ArcNodeResourceId
+        change-description: The types of the properties DeploymentStatusStep, ValidationStatusStep, DeploymentConfigurationScaleUnit and ArcNodeResourceId will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: New
+      subject: DeploymentSetting
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - DeploymentStatusStep
+          - ValidationStatusStep
+          - DeploymentConfigurationScaleUnit
+          - ArcNodeResourceId
+          - DeploymentDataSecret
+          - DeploymentDataInfrastructureNetwork
+          - HostNetworkIntent
+          - DeploymentDataPhysicalNode
+          - SbePartnerInfoCredentialList
+          - SbePartnerInfoPartnerProperty
+          - HostNetworkStorageNetwork
+        new-output-properties:
+          - DeploymentStatusStep
+          - ValidationStatusStep
+          - DeploymentConfigurationScaleUnit
+          - ArcNodeResourceId
+          - DeploymentDataSecret
+          - DeploymentDataInfrastructureNetwork
+          - HostNetworkIntent
+          - DeploymentDataPhysicalNode
+          - SbePartnerInfoCredentialList
+          - SbePartnerInfoPartnerProperty
+          - HostNetworkStorageNetwork
+        change-description: The types of the properties DeploymentStatusStep, ValidationStatusStep, DeploymentConfigurationScaleUnit and ArcNodeResourceId will be changed from single object or fixed array to 'List'. The type of property DeploymentDataSecret, DeploymentDataInfrastructureNetwork, HostNetworkIntent, DeploymentDataPhysicalNode, SbePartnerInfoCredentialList, SbePartnerInfoPartnerProperty and HostNetworkStorageNetwork of type ScaleUnits will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Get|Set
+      subject: ^Update$
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - ComponentVersion
+          - HealthCheckResult
+          - Prerequisite
+        new-output-properties:
+          - ComponentVersion
+          - HealthCheckResult
+          - Prerequisite
+        change-description: The types of the properties ComponentVersion, HealthCheckResult and Prerequisite will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Get|Set
+      subject: UpdateRun
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - ProgressStep
+        new-output-properties:
+          - ProgressStep
+        change-description: The type of the property ProgressStep will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Get|Set
+      subject: UpdateSummary
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - PackageVersion
+          - HealthCheckResult
+        new-output-properties:
+          - PackageVersion
+          - HealthCheckResult
+        change-description: The types of the properties PackageVersion and HealthCheckResult will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Test
+      subject: EdgeDevice
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - EdgeDeviceId
+        new-output-properties:
+          - EdgeDeviceId
+        change-description: The type of the property EdgeDeviceId will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Invoke
+      subject: ConsentAndInstallDefaultExtension
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - DefaultExtension
+          - PerNodeDetail
+        new-output-properties:
+          - DefaultExtension
+          - PerNodeDetail
+        change-description: The types of the properties DefaultExtension and PerNodeDetail will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Invoke
+      subject: ExtendClusterSoftwareAssuranceBenefit
+    set:
+      breaking-change:
+        deprecated-output-properties:
+          - ReportedPropertyNode
+          - LogCollectionPropertyLogCollectionSessionDetail
+          - RemoteSupportPropertyRemoteSupportSessionDetail
+          - RemoteSupportPropertyRemoteSupportNodeSetting
+          - ReportedPropertySupportedCapability
+        new-output-properties:
+          - ReportedPropertyNode
+          - LogCollectionPropertyLogCollectionSessionDetail
+          - RemoteSupportPropertyRemoteSupportSessionDetail
+          - RemoteSupportPropertyRemoteSupportNodeSetting
+          - ReportedPropertySupportedCapability
+        change-description: The types of the properties ReportedPropertyNode, LogCollectionPropertyLogCollectionSessionDetail, RemoteSupportPropertyRemoteSupportSessionDetail, RemoteSupportPropertyRemoteSupportNodeSetting and ReportedPropertySupportedCapability will be changed from single object or fixed array to 'List'.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      verb: Invoke
+      subject: ExtendClusterSoftwareAssuranceBenefit
+      variant: Extend|ExtendViaIdentity
+    set:
+      breaking-change:
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      subject: EdgeDevice
+      variant: Validate|ValidateViaIdentity
+    set:
+      breaking-change:
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      parameter-name: IdentityType
+    set:
+      breaking-change:
+        old-parameter-type: string
+        new-parameter-type: boolean
+        change-description: IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system-assigned identities.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
+  - where:
+      parameter-name: UserAssignedIdentity
+    set:
+      breaking-change:
+        old-parameter-type: hashtable
+        new-parameter-type: list
+        change-description: The type of UserAssignedIdentity will be simplified to an array of strings that is used to specify the user's assigned identity.
+        deprecated-by-version: 3.0.0
+        deprecated-by-azversion: 15.0.0
+        change-effective-date: 2025/11
 ```

src/StackHCI/StackHCI.Autorest/custom/stackhci.ps1

@@ -497,6 +497,7 @@ Function Print-FunctionParameters{
 }
 
 function Confirm-UserAcknowledgmentToUpgradeOS {
+    [Microsoft.Azure.PowerShell.Cmdlets.StackHCI.DoNotExportAttribute()]
     [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
     param(
         [Parameter(Mandatory=$true)]
@@ -521,6 +522,7 @@ function Confirm-UserAcknowledgmentToUpgradeOS {
 }
 
 function Confirm-UserAcknowledgmentUpgradeToSolution {
+    [Microsoft.Azure.PowerShell.Cmdlets.StackHCI.DoNotExportAttribute()]
     [CmdletBinding()]
     param(
         [Parameter(Mandatory=$true)]
@@ -4141,7 +4143,7 @@ function New-ClusterWithRetries {
     GraphAccessToken is deprecated.
 
     .PARAMETER AccountId
-    Specifies the AccoundId. Specifying this along with ArmAccessToken will avoid Azure interactive logon.
+    Specifies the AccountId. Specifying this along with ArmAccessToken will avoid Azure interactive logon.
 
     .PARAMETER EnvironmentName
     Specifies the Azure Environment. Default is AzureCloud. Valid values are AzureCloud, AzureChinaCloud, AzurePPE, AzureCanary, AzureUSGovernment

src/StackHCI/StackHCI.Autorest/docs/Az.StackHCI.md

@@ -1,6 +1,6 @@
 ---
 Module Name: Az.StackHCI
-Module Guid: 18e6b2a3-7e2d-4f6e-a8d2-09edaf462fd8
+Module Guid: ecca9195-88b3-4c8f-a865-4fa09629fc69
 Download Help Link: https://learn.microsoft.com/powershell/module/az.stackhci
 Help Version: 1.0.0.0
 Locale: en-US

src/StackHCI/StackHCI.Autorest/generate-info.json

@@ -1,3 +1,3 @@
 {
-  "generate_Id": "41f72a61-c672-4edf-b199-80d10ce7dd2a"
+  "generate_Id": "d2fd8c80-240e-482d-b23b-ae5864a8288a"
 }

src/StackHCI/StackHCI.Autorest/resources/README.md

@@ -0,0 +1,11 @@
+# Resources
+This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder.
+
+## Info
+- Modifiable: yes
+- Generated: no
+- Committed: yes
+- Packaged: no
+
+## Purpose
+Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact.