{AFD} Add health probe parameters validation for afd origin-group and rewrite doc string#31551
Merged
Conversation
added 2 commits
May 26, 2025 11:44
Ptnan7
requested review from
jsntcy,
kairu-ms,
necusjz and
wangzelin007
as code owners
️✔️AzureCLI-FullTest
|
|
Hi @Ptnan7, |
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
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>
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds validation for health probe parameters in AFD origin groups to address issue 30698.
- Introduces the get_health_probe_settings() function to centralize validation logic.
- Refactors the pre_operations() methods in AFDOriginGroupCreate and AFDOriginGroupUpdate to use the new function.
- Consolidates the health probe parameter checks when setting args.health_probe_settings.
Comments suppressed due to low confidence (1)
src/azure-cli/azure/cli/command_modules/cdn/custom/custom_afdx.py:263
- [nitpick] The error message exceeds the 79-character line limit. Consider breaking the string into multiple concatenated lines to comply with coding style guidelines.
raise InvalidArgumentValueError( 'When --enable-health-probe is set, all of --probe-interval-in-seconds, --probe-path, --probe-protocol and --probe-request-type must be specified.' )
|
|
||
|
|
||
| def get_health_probe_settings(enable_health_probe, probe_interval_in_seconds, probe_path, probe_protocol, probe_request_type): | ||
| params = [probe_interval_in_seconds, probe_path, probe_protocol, probe_request_type] |
There was a problem hiding this comment.
The validation logic for health probe parameters is duplicated across branches. Consider consolidating these checks to improve maintainability and reduce repetition.
Suggested change
| params = [probe_interval_in_seconds, probe_path, probe_protocol, probe_request_type] | |
| params = [probe_interval_in_seconds, probe_path, probe_protocol, probe_request_type] | |
| enable_health_probe = _validate_health_probe_params(enable_health_probe, params) | |
| if not enable_health_probe: | |
| return None | |
| return { | |
| 'probeIntervalInSeconds': probe_interval_in_seconds, | |
| 'probePath': probe_path, | |
| 'probeProtocol': probe_protocol, | |
| 'probeRequestType': probe_request_type | |
| } | |
| def _validate_health_probe_params(enable_health_probe, params): |
Member
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Ptnan7
changed the title
afd origin-groupafd origin-group And issue 30761: rewrite doc string
Member
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
necusjz
changed the title
afd origin-group And issue 30761: rewrite doc stringafd origin-group and rewrite doc string
necusjz
approved these changes
May 27, 2025
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.
#30698
#30761