{FrontDoor} Upgrade Frontdoor from SDK-based to autorest #28473
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR upgrades the Azure PowerShell FrontDoor module from SDK-based to AutoRest-generated implementation. The upgrade migrates the module to use auto-generated cmdlets and client libraries from OpenAPI specifications rather than hand-written SDK code.
- Removes the SDK-based FrontDoor.Management.Sdk project
- Adds new AutoRest-generated FrontDoor.Autorest project with complete test infrastructure
- Implements comprehensive test suites for FrontDoor operations including WAF policies and rules engines
Reviewed Changes
Copilot reviewed 190 out of 536 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/FrontDoor/FrontDoor.Management.Sdk/FrontDoor.Management.Sdk.csproj | Deleted SDK-based project file |
| src/FrontDoor/FrontDoor.Autorest/utils/Unprotect-SecureString.ps1 | Added utility for converting SecureString to plaintext |
| src/FrontDoor/FrontDoor.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 | Added utility for test-safe subscription ID retrieval |
| src/FrontDoor/FrontDoor.Autorest/test/utils.ps1 | Added comprehensive test utilities and environment setup functions |
| src/FrontDoor/FrontDoor.Autorest/test/loadEnv.ps1 | Added test environment loading script |
| src/FrontDoor/FrontDoor.Autorest/test/env.json | Added test environment configuration |
| src/FrontDoor/FrontDoor.Autorest/test/*.Tests.ps1 | Added test files for FrontDoor operations |
| src/FrontDoor/FrontDoor.Autorest/test/*.Recording.json | Added test recording files for playback |
Comments suppressed due to low confidence (1)
src/FrontDoor/FrontDoor.Autorest/test/loadEnv.ps1:23
- The line contains incorrect path syntax. '.$envFile' should be '..$envFile' to properly reference the parent directory. The current syntax will result in an invalid path like '.\env.json' instead of the intended '../env.json'.
$envFilePath = Join-Path $PSScriptRoot '..\$envFile'
| Import-Module -Name Az.Cdn | ||
|
|
||
| $env.SubscriptionId = (Get-AzContext).Subscription.Id | ||
| $env.Tenant = $res.Tenant.Id |
There was a problem hiding this comment.
The variable '$res' is undefined. This line should likely use '(Get-AzContext).Tenant.Id' similar to line 115, or '$res' should be properly defined before use.
Suggested change
| $env.Tenant = $res.Tenant.Id | |
| $env.Tenant = (Get-AzContext).Tenant.Id |
| function cleanupEnv() { | ||
| # Clean resources you create for testing | ||
| Write-Host -ForegroundColor Green "Clean resources created for testing." | ||
| Remove-AzResourceGroup -Name $env.ResourceGroupName |
There was a problem hiding this comment.
The Remove-AzResourceGroup command should include the -Force parameter to avoid interactive confirmation prompts during automated test cleanup. This ensures reliable test execution in CI/CD environments.
Suggested change
| Remove-AzResourceGroup -Name $env.ResourceGroupName | |
| Remove-AzResourceGroup -Name $env.ResourceGroupName -Force |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
To the author of the pull request, |
Contributor
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
Preannouncement in #28763 |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
dolauli
requested changes
Nov 3, 2025
tools/StaticAnalysis/Exceptions/Az.FrontDoor/SignatureIssues.csv
Outdated
Show resolved
Hide resolved
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
dolauli
approved these changes
Nov 4, 2025
Contributor
|
Hi @Ptnan7, 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
``` |
dolauli
added
Breaking change PR reviewed
Member
Author
Az.FrontDoor
|
dolauli
added
the
Breaking change PR migration guide provided
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.