Draft
[AppService] Restore appServicePlanId in az webapp show/list output#33733
appServicePlanId in az webapp show/list output#33733Conversation
|
Validation for Azure CLI Full Test Starting...
Thanks for your contribution! |
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
microsoft-github-policy-service
Bot
requested review from
jsntcy,
wangzelin007,
yanzhudd and
yonzhan
July 15, 2026 03:27
microsoft-github-policy-service
Bot
added
Auto-Assign
Copilot
AI
changed the title
[WIP] Fix az webapp show and list returning serverFarmId
[AppService] Restore Jul 15, 2026
appServicePlanId in az webapp show/list output
Live test results —
|
![azure-client-tools-agent[bot]](https://avatars.githubusercontent.com/in/4205534?s=60&v=4){kind=small}
There was a problem hiding this comment.
Automated Review Summary
Live test: ✅ Passed
CI checks: ✅ 1/1 passed, 0 pending, 0 failed
All automated checks are green for this PR at the current head commit. No further action needed from the agent at this time.
Posted by agent-assist (autonomous bug-fix pipeline).
Collaborator
|
AppService |
There was a problem hiding this comment.
CI Failure Summary
The following checks failed on this PR:
❌ Failed Checks
Azure.azure-cli (Test Homebrew Formula)— The Homebrew formula test suite failed.Azure.azure-cli— The overall Azure DevOps pipeline check failed (rolls up the Homebrew failure).
Root Cause Analysis
The PR adds test_rename_server_farm_props_handles_mutable_mapping which sets site['serverFarmId'] = ... directly on a Site model instance from azure.mgmt.web.models. The Homebrew formula test environment pins a specific version of azure-mgmt-web; in that pinned version, Site objects may not support dict-style item assignment (__setitem__), causing either a TypeError on site['serverFarmId'] = ... or causing isinstance(site, MutableMapping) to return False, which would make _rename_server_farm_props fall through to the setattr branch instead of the dict branch — and the test assertion site['appServicePlanId'] would then fail.
Required Fix
-
Decouple the test from the real
SiteSDK model. Replace theSite(location='westus')instance with a plainMutableMappingmock (e.g., a simpledict) so the test exercises_rename_server_farm_propswithout depending on the SDK version installed in the Homebrew formula environment.# Before (SDK-version-dependent) site = Site(location='westus') site['serverFarmId'] = '...' # After (SDK-independent) site = {'serverFarmId': '...', 'location': 'westus'}
-
Remove the now-unused
from azure.mgmt.web.models import Siteimport to eliminate the environment-version risk. -
Verify locally that
python -m pytest --pyargs azure.cli.command_modules.appservicepasses before pushing.
Posted by agent-assist (autonomous bug-fix pipeline).
Member
|
@copilot the automated CI and live-test review on this PR found failures. Please look into the requested changes and push a fix. Posted by agent-assist (autonomous bug-fix pipeline). |
Contributor
Author
Fixed in |
Live test results —
|
Live test results —
|
There was a problem hiding this comment.
Automated Review Summary
Live test (azdev --live): ✅ Passed
CI checks: ✅ All 20 checks passed (0 failed, 0 pending)
No issues found. This PR appears ready for human maintainer review/merge decision.
Posted by agent-assist (autonomous bug-fix pipeline).
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related command
az webapp listaz webapp showDescription
az webapp listandaz webapp showregressed to returningserverFarmIdinstead of the long-standingappServicePlanIdfield after the newer Web SDK model shape was introduced. This change restores the compatibility shim so CLI output keeps the expected contract.Output compatibility
_rename_server_farm_propsto handle newer mutable-mapping SDK models by writingappServicePlanIddirectly into the serialized shape.serverFarmIdfrom that output path soshow/listmatch prior CLI behavior.Legacy path preserved
Regression coverage
Testing Guide
Expected: both commands return
appServicePlanId;serverFarmIdis no longer surfaced in the CLI output contract for these commands.History Notes
[AppService]
az webapp show/list: RestoreappServicePlanIdoutput field compatibilityThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.