-
Notifications
You must be signed in to change notification settings - Fork 4.1k
[Az.ServiceFabric] Removed ReimageByName
, ReimageById
, and ReimageByObj
parameter sets from Set-AzServiceFabricManagedNodeType
#28633
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…geByObj` parameter sets from `Set-AzServiceFabricManagedNodeType`
Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
…arning to description of Invoke-AzServiceFabricReimageManagedNodetype
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
There was a problem hiding this 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 |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
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
``` |
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
``` |
Yeah the trick is to use four tilts ("````") in the outer code block syntax 😁 |
Description
Breaking Change for 15.0.0. Removed
ReimageByName
,ReimageById
, andReimageByObj
parameter sets fromSet-AzServiceFabricManagedNodeType
. Customers are expected to useInvoke-AzServiceFabricReimageManagedNodeType
instead. Preannoucement at #28520.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.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.md
and reviewed the following information:ChangeLog.md
file(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
.## Upcoming Release
header in the past tense.ChangeLog.md
if no new release is required, such as fixing test case only.