From 1f3542c063531177a523e6832f5a4e26cacf5360 Mon Sep 17 00:00:00 2001 From: shraddhasun <128851887+shraddhasun@users.noreply.github.com> Date: Thu, 26 Mar 2026 18:19:18 -0700 Subject: [PATCH] add breaking change pre-announcements for StackHCIVM SecureString parameter type changes --- src/StackHCIVM/StackHCIVM.Autorest/README.md | 25 +++++++++++++++++++ .../custom/New-AzStackHCIVMImage.ps1 | 1 + .../New-AzStackHCIVMVirtualMachine_New.ps1 | 1 + src/StackHCIVM/StackHCIVM/ChangeLog.md | 1 + 4 files changed, 28 insertions(+) diff --git a/src/StackHCIVM/StackHCIVM.Autorest/README.md b/src/StackHCIVM/StackHCIVM.Autorest/README.md index aed13881388a..df497d70e104 100644 --- a/src/StackHCIVM/StackHCIVM.Autorest/README.md +++ b/src/StackHCIVM/StackHCIVM.Autorest/README.md @@ -76,6 +76,31 @@ flatten-userassignedidentity: false inlining-threshold: 50 resourcegroup-append: true directive: + # Breaking change pre-announcements for parameter type changes + - where: + verb: New + subject: StackHCIVMImage + parameter-name: ImagePath + set: + breaking-change: + old-parameter-type: String + new-parameter-type: SecureString + change-description: The type of parameter ImagePath will be changed from String to SecureString to protect sensitive file path information. + deprecated-by-version: 2.0.0 + deprecated-by-azversion: 16.0.0 + change-effective-date: May 2026 + - where: + verb: New + subject: StackHCIVMVirtualMachine + parameter-name: AdminPassword + set: + breaking-change: + old-parameter-type: String + new-parameter-type: SecureString + change-description: The type of parameter AdminPassword will be changed from String to SecureString to protect sensitive credential information. + deprecated-by-version: 2.0.0 + deprecated-by-azversion: 16.0.0 + change-effective-date: May 2026 - from: swagger-document where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}"].delete.responses transform: >- diff --git a/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMImage.ps1 b/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMImage.ps1 index 960c53248694..5b477e73175f 100644 --- a/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMImage.ps1 +++ b/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMImage.ps1 @@ -101,6 +101,7 @@ function New-AzStackHCIVMImage{ ${CustomLocationId}, [Parameter(ParameterSetName='GalleryImage', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.ParameterBreakingChangeAttribute("ImagePath", "16.0.0", "2.0.0", "May 2026", OldParamaterType="String", NewParameterType="SecureString")] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')] [System.String] # Local path of image that the image should be created from. diff --git a/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMVirtualMachine_New.ps1 b/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMVirtualMachine_New.ps1 index e3a84a995886..a326ee462ae8 100644 --- a/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMVirtualMachine_New.ps1 +++ b/src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMVirtualMachine_New.ps1 @@ -226,6 +226,7 @@ function New-AzStackHCIVMVirtualMachine { ${OSDiskResourceGroup}, [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.ParameterBreakingChangeAttribute("AdminPassword", "16.0.0", "2.0.0", "May 2026", OldParamaterType="String", NewParameterType="SecureString")] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')] [System.String] # AdminPassword - admin password diff --git a/src/StackHCIVM/StackHCIVM/ChangeLog.md b/src/StackHCIVM/StackHCIVM/ChangeLog.md index 7dbbc0993e6a..9f890f8e8569 100644 --- a/src/StackHCIVM/StackHCIVM/ChangeLog.md +++ b/src/StackHCIVM/StackHCIVM/ChangeLog.md @@ -18,6 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release +* Added breaking change announcements for upcoming SecureString parameter type changes in `New-AzStackHCIVMImage` and `New-AzStackHCIVMVirtualMachine` ## Version 1.1.0 * Upgraded nuget package to signed package.