[AppConfig] az appconfig create/update: Add support to link store with azure front door profile#32767
[AppConfig] az appconfig create/update: Add support to link store with azure front door profile#32767ChristineWanjau wants to merge 10 commits intoAzure:devfrom
az appconfig create/update: Add support to link store with azure front door profile#32767Conversation
ChristineWanjau
requested review from
jsntcy,
yanzhudd and
zhoxing-ms
as code owners
️✔️AzureCLI-FullTest
|
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| appconfig create | cmd appconfig create added parameter azure_front_door_profile |
||
| appconfig update | cmd appconfig update added parameter azure_front_door_profile |
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
requested review from
avanigupta and
yonzhan
microsoft-github-policy-service
bot
added
App Configuration
Auto-Assign
There was a problem hiding this comment.
Pull request overview
Adds support in the appconfig command module to link/unlink an Azure Front Door (AFD) profile to an App Configuration store, leveraging newer App Configuration management-plane capabilities.
Changes:
- Bumps
azure-mgmt-appconfigurationdependency to6.0.0b1to access theazureFrontDoormodel surface. - Adds
--azure-front-door-profiletoaz appconfig create/update, wiring it through to the ARM payload. - Adds a scenario test + recording to validate link/unlink behavior, and updates help/linter exclusions accordingly.
Reviewed changes
Copilot reviewed 11 out of 33 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/azure-cli/setup.py | Updates the pinned azure-mgmt-appconfiguration SDK version. |
| src/azure-cli/requirements.py3.windows.txt | Keeps Windows pinned requirements aligned with the new SDK version. |
| src/azure-cli/requirements.py3.Linux.txt | Keeps Linux pinned requirements aligned with the new SDK version. |
| src/azure-cli/requirements.py3.Darwin.txt | Keeps macOS pinned requirements aligned with the new SDK version. |
| src/azure-cli/azure/cli/command_modules/appconfig/custom.py | Adds request payload support for azureFrontDoor.resourceId on create/update. |
| src/azure-cli/azure/cli/command_modules/appconfig/_params.py | Introduces azure_front_door_profile CLI argument for create/update. |
| src/azure-cli/azure/cli/command_modules/appconfig/_help.py | Documents new usage examples for linking/unlinking an AFD profile. |
| src/azure-cli/azure/cli/command_modules/appconfig/linter_exclusions.yml | Adds linter exclusions for the new parameter (and aligns existing ones). |
| src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_mgmt_commands.py | Adds scenario test coverage for linking/unlinking AFD profile. |
| src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_azure_front_door_profile.yaml | New recording for the AFD link/unlink scenario test. |
| src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_user_token_audience.yaml | Re-recorded interactions reflecting the new RP api-version/shape. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 'azure-mgmt-advisor==9.0.0', | ||
| 'azure-mgmt-apimanagement==4.0.0', | ||
| 'azure-mgmt-appconfiguration==5.0.0', | ||
| 'azure-mgmt-appconfiguration==6.0.0b1', |
There was a problem hiding this comment.
This bumps azure-mgmt-appconfiguration to a beta/preview SDK. That changes the default App Configuration RP api-version used by the module (recordings show a switch to 2025-06-01-preview), which can impact compatibility in sovereign clouds and for other appconfig commands. If the preview api-version is required only for the new Azure Front Door linking feature, consider scoping the preview api-version to only the relevant operations (e.g., create/update when --azure-front-door-profile is used) or explicitly documenting/justifying the global switch in the PR (and verifying cloud support).
| location = 'eastus' | ||
|
|
||
| self.kwargs.update({ | ||
| 'config_store_name': config_store_name, | ||
| 'rg_loc': location, |
There was a problem hiding this comment.
This test overwrites the location argument provided by ResourceGroupPreparer with a hard-coded 'eastus', which makes the scenario less portable and can fail in environments where that region isn't available. Prefer using the injected location (or assign the hard-coded value to a differently named variable like store_location) to avoid shadowing and improve test maintainability.
ChristineWanjau
changed the title
az appconfig create/update: Add support to link azure front door profileaz appconfig create/update: Add support to link store with azure front door profile
|
|
||
| azure_front_door = None | ||
| if azure_front_door_profile is not None: | ||
| azure_front_door = AzureFrontDoorProperties(resource_id=azure_front_door_profile if azure_front_door_profile else None) |
There was a problem hiding this comment.
Is the inline if check needed since line 76 confirms the front door profile is not none?
There was a problem hiding this comment.
The AzureFrontDoorProperties object has resource_id as optional, I'd just remove both if statements. i.e. just have this as line 76. See: https://github.com/Azure/azure-sdk-for-python/blob/2d7c1259d52c5ac41aaedf7581478e2ede32b575/sdk/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/models/_models.py#L68. I'd rather have the None resource_id that is already typed then the extra None properties object.
azure_front_door = AzureFrontDoorProperties(resource_id=azure_front_door_profile)There was a problem hiding this comment.
This makes sense. I have updated accordingly.
Left one check because when user wants to unlink their afd they pass an empty string. The RP doesn't allow an empty string as a valid property, we should be passing None for such a case.
There was a problem hiding this comment.
Just curious for the update scenario. Assuming user has already linked an AFD resource and wants to update a different property, will the linked AFD resource be cleared since they will not be specifying it? And if so, is this behavior consistent with other properties? I ask since it appears that we will always pass AzureFrontDoorProperties(None) when the resource_id is not specified, which might be equivalent payload to unlinking a resource.
Is that the case?
There was a problem hiding this comment.
Yeah thats the case. Just updated the logic
There was a problem hiding this comment.
So I guess the expected behavior is that passing no resource id means no change in update scenario, right? User explicitly passes empty string to unlink.
There was a problem hiding this comment.
@ChristineWanjau I see we have a test for adding and removing the profile. Can we add a test for making sure it's not removed if it isn't included?
There was a problem hiding this comment.
Yes that makes sense to me. I have added a test for such a case.
| 'azure-mgmt-advisor==9.0.0', | ||
| 'azure-mgmt-apimanagement==4.0.0', | ||
| 'azure-mgmt-appconfiguration==5.0.0', | ||
| 'azure-mgmt-appconfiguration==6.0.0b1', |
There was a problem hiding this comment.
Are we planning on releasing this as a beta from main? or are we expecting the ga of 6.0.0 before then? This will block main from GA releases until this GAs.
There was a problem hiding this comment.
Do you mean the CLI release?
I think it's allowed to release using a beta sdk in the CLI. I see multiple beta sdks in the setup.py
azure-cli/src/azure-cli/setup.py
Line 79 in d01027d
I added is_preview tag in the afd argument.
cc: @albertofori thoughts? Is this blocking?
There was a problem hiding this comment.
@ChristineWanjau just to confirm, this beta release should already have Telemetry in the Configuration Store definition, right?
There was a problem hiding this comment.
yes it should
There was a problem hiding this comment.
Got it, then I don't think there should be anything that we anticipate being GA'd soon so this should be fine. @mrm9084, please correct me if I am wrong or missing something
Related command
az appconfig create/update
Description
This PR adds support to link azure front door profile to app configuration store.
Testing Guide
History Notes
[App config]
az appconfig create/update: Add support to link azure front door profileThis 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.