Skip to content

Conversation

@am-lim
Copy link
Member

@am-lim am-lim commented Jun 22, 2025

Description

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

@azure-client-tools-bot-prd
Copy link

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

@VeryEarly
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@VeryEarly
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@github-actions
Copy link

To the author of the pull request,
This PR was labeled "Contains Breaking Change" because breaking changes have been detected by the static analysis pipeline.

  • According to our policy, breaking changes can only take place during major release and they must be preannounced.
  • Please follow our guide on the detailed steps.
  • Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

@isra-fel
Copy link
Member

Hi @am-lim you might want to get back to work on this pull request as we are approaching the breaking change window

@isra-fel
Copy link
Member

isra-fel commented Nov 3, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@isra-fel
Copy link
Member

isra-fel commented Nov 3, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@am-lim am-lim marked this pull request as ready for review November 3, 2025 23:27
Copilot AI review requested due to automatic review settings November 3, 2025 23:27
Copy link
Contributor

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 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

@isra-fel
Copy link
Member

isra-fel commented Nov 3, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@isra-fel
Copy link
Member

isra-fel commented Nov 4, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@dolauli dolauli self-assigned this Nov 4, 2025
@isra-fel
Copy link
Member

isra-fel commented Nov 4, 2025

/azp run

@azure-pipelines
Copy link
Contributor

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.

@dolauli
Copy link
Contributor

dolauli commented Nov 4, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@isra-fel
Copy link
Member

isra-fel commented Nov 4, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@isra-fel
Copy link
Member

isra-fel commented Nov 4, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@dolauli dolauli added the Breaking change PR reviewed Add this label after a PR with breaking change has been reviewed and approved. label Nov 5, 2025
@dolauli
Copy link
Contributor

dolauli commented Nov 5, 2025

@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
```

@am-lim am-lim changed the title [devcenter] Control plane 2025-04-01-preview [devcenter] Update control plane and data plane cmdlets for 2025-04-01-preview Nov 6, 2025
@isra-fel
Copy link
Member

isra-fel commented Nov 6, 2025

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@am-lim
Copy link
Member Author

am-lim commented Nov 7, 2025

Breaking changes markdown:
DevCenterBreakingChanges2025-04-01-preview.md

@dolauli dolauli added the Breaking change PR migration guide provided Add this label after the migration guide is provided by the PR owner label Nov 7, 2025
@dolauli dolauli merged commit c38db06 into Azure:main Nov 7, 2025
13 checks passed
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.

4 participants