Skip to content

Conversation

iliu816
Copy link
Member

@iliu816 iliu816 commented Oct 1, 2025

Description

Breaking Change for 15.0.0. Removed ReimageByName, ReimageById, and ReimageByObj parameter sets from Set-AzServiceFabricManagedNodeType. Customers are expected to use Invoke-AzServiceFabricReimageManagedNodeType instead. Preannoucement at #28520.

Mandatory Checklist

  • 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

…geByObj` parameter sets from `Set-AzServiceFabricManagedNodeType`
Copy link

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

@isra-fel
Copy link
Member

isra-fel commented Oct 1, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

…arning to description of Invoke-AzServiceFabricReimageManagedNodetype
@isra-fel
Copy link
Member

isra-fel commented Oct 2, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@isra-fel
Copy link
Member

isra-fel commented Oct 2, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@iliu816 iliu816 added this to the Az 15.0.0 (11/18/2025) milestone Oct 6, 2025
@iliu816 iliu816 marked this pull request as ready for review October 13, 2025 17:24
@Copilot Copilot AI review requested due to automatic review settings October 13, 2025 17:24
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR implements a breaking change for Azure PowerShell 15.0.0 by removing the ReimageByName, ReimageById, and ReimageByObj parameter sets from the Set-AzServiceFabricManagedNodeType cmdlet. Users are expected to use the dedicated Invoke-AzServiceFabricReimageManagedNodeType cmdlet instead for reimage operations.

Key changes:

  • Removed reimage-related parameter sets and parameters from Set-AzServiceFabricManagedNodeType
  • Updated help documentation to reflect the cmdlet now only handles node type property updates
  • Added breaking change exceptions to allow the removal
  • Enhanced documentation for the replacement Invoke-AzServiceFabricReimageManagedNodeType cmdlet

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/StaticAnalysis/Exceptions/Az.ServiceFabric/BreakingChangeIssues.csv Added exceptions for the removal of reimage-related parameters and parameter sets
src/ServiceFabric/ServiceFabric/help/Set-AzServiceFabricManagedNodeType.md Updated help documentation to remove reimage functionality and examples
src/ServiceFabric/ServiceFabric/help/Invoke-AzServiceFabricReimageManagedNodeType.md Enhanced documentation with detailed operational guidance
src/ServiceFabric/ServiceFabric/help/Az.ServiceFabric.md Updated module summary to reflect cmdlet purpose changes
src/ServiceFabric/ServiceFabric/Commands/ManagedClusters/NodeTypes/SetAzServiceFabricManagedNodeType.cs Removed reimage parameter sets, parameters, and associated logic
src/ServiceFabric/ServiceFabric/ChangeLog.md Added changelog entry documenting the breaking change

@isra-fel
Copy link
Member

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@isra-fel isra-fel added the Contains Breaking Change This PR contains breaking change label Oct 13, 2025
@Azure Azure deleted a comment from github-actions bot Oct 13, 2025
@isra-fel
Copy link
Member

isra-fel commented Oct 14, 2025

While the changes look good to me, we'll hold on merging until early Nov. At the meantime, could you help authorize a markdown like this for each of the breaking change? We'll need it for publishing migration guides. Just leave a comment in the issue would be fine. Thank you!

## Az.Accounts

### `Get-AzAccessToken`

The default output type is changed from `PSAccessToken` to `PSSecureAccessToken`.That is to change plaintext `PSAccessToken.Token` to `SecureString PSSecureAccessToken.Token`

#### Before
```powershell
$authHeader = @{
    'Content-Type'  = 'application/json'
    'Authorization' = 'Bearer ' + (Get-AccessToken).Token
}
$response = Invoke-RestMethod -Method Get -Headers $authHeader -Uri $uri
```

#### After
```powershell
$secureToken = (Get-AzAccessToken).Token
$ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($secureToken)
try {
     $plaintextToken = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr)
} 
finally {
     [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr) 
}
$authHeader = @{
    'Content-Type'  = 'application/json'
    'Authorization' = 'Bearer ' + $plaintextToken
}
$response = Invoke-RestMethod -Method Get -Headers $authHeader -Uri $uri
```

@iliu816
Copy link
Member Author

iliu816 commented Oct 14, 2025

I seem to be having issues with the markdown below rendering properly on Github, but I think it is formatted correctly otherwise?

## Az.ServiceFabric

### `Set-AzServiceFabricManagedNodeType`

Removed `ReimageByName`, `ReimageById`, and `ReimageByObj` parameter sets from `Set-AzServiceFabricManagedNodeType`. Use `Invoke-AzServiceFabricReimageManagedNodeType` cmdlet instead.

#### Before
```powershell
$rgName = "testRG"
$clusterName = "testCluster"
$nodeTypeName= "nt1"
Set-AzServiceFabricManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName  -Name $nodeTypeName -Reimage -NodeName nt1_0, nt1_3
```

#### After
```powershell
$rgName = "testRG"
$clusterName = "testCluster"
$nodeTypeName = "nt1"
Invoke-AzServiceFabricReimageManagedNodeType -ResourceGroupName $rgName -ClusterName $clusterName  -Name $nodeTypeName -NodeName nt1_0, nt1_3
```

@isra-fel
Copy link
Member

Yeah the trick is to use four tilts ("````") in the outer code block syntax 😁

@dolauli dolauli added Breaking change PR reviewed Add this label after a PR with breaking change has been reviewed and approved. Breaking change PR migration guide provided Add this label after the migration guide is provided by the PR owner labels Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Breaking change PR migration guide provided Add this label after the migration guide is provided by the PR owner Breaking change PR reviewed Add this label after a PR with breaking change has been reviewed and approved. Contains Breaking Change This PR contains breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants