-
Notifications
You must be signed in to change notification settings - Fork 4.1k
[devcenter] Update control plane and data plane cmdlets for 2025-04-01-preview #27998
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
Conversation
| 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). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
To the author of the pull request, |
|
Hi @am-lim you might want to get back to work on this pull request as we are approaching the breaking change window |
|
/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 updates the Azure DevCenter PowerShell module to a new API version (2025-04-01-preview from 2024-05-01-preview). The changes include:
- Removal of deprecated Plan and PlanMember cmdlets and their associated functionality
- Introduction of new ProjectPolicy cmdlets to replace the removed Plan functionality
- Addition of new image definition build management cmdlets
- Updates to existing cmdlets with new parameters for enhanced functionality (active hours configuration, DevBox tunnel settings, workspace storage modes, etc.)
- API version updates across all help documentation and test files
- Breaking change exceptions documented for the removed functionality
Reviewed Changes
Copilot reviewed 210 out of 278 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/StaticAnalysis/Exceptions/Az.DevCenter/BreakingChangeIssues.csv | Documents 158 breaking changes related to removed Plan properties and cmdlets |
| src/DevCenter/DevCenter/help/*.md (multiple files) | Updates API version references from 2024-05-01-preview to 2025-04-01-preview across all help documentation |
| src/DevCenter/DevCenter/help/Get-AzDevCenterAdminPlan.md | Removed - Plan cmdlet no longer exists |
| src/DevCenter/DevCenter/help/Get-AzDevCenterAdminProjectPolicy.md | New cmdlet to manage project policies (replacement for Plans) |
| src/DevCenter/DevCenter/help/New-AzDevCenterAdminProjectPolicy.md | New cmdlet for creating project policies |
| src/DevCenter/DevCenter/help/Update-AzDevCenterAdminProjectPolicy.md | New cmdlet for updating project policies |
| src/DevCenter/DevCenter/help/Remove-AzDevCenterAdminProjectPolicy.md | New cmdlet for deleting project policies |
| src/DevCenter/DevCenter/help/Build-AzDevCenterAdminProjectCatalogImageDefinitionImage.md | New cmdlet for building image definitions |
| src/DevCenter/DevCenter/help/Get-AzDevCenterAdminProjectCatalogImageDefinition*.md | New cmdlets for managing image definitions and builds |
| src/DevCenter/DevCenter/Az.DevCenter.psd1 | Updates module manifest with new cmdlets and dependency version bump |
| src/DevCenter/DevCenter.AutoRest/test/*.ps1 | Updates test file references to match new cmdlet names |
| src/DevCenter/DevCenter.AutoRest/test/deploymentTemplates/template.json | Updates ARM template API versions |
src/DevCenter/DevCenter/help/Get-AzDevCenterAdminProjectCatalogImageDefinitionBuild.md
Outdated
Show resolved
Hide resolved
src/DevCenter/DevCenter/help/Get-AzDevCenterAdminProjectCatalogImageDefinitionBuild.md
Outdated
Show resolved
Hide resolved
src/DevCenter/DevCenter/help/Get-AzDevCenterAdminProjectCatalogImageDefinitionBuild.md
Outdated
Show resolved
Hide resolved
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
@am-lim, 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
``` |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
Breaking changes markdown: |
Description
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.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.