Updating Elastic API descriptions #8843
Closed
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
️✔️Azure CLI Extensions Breaking Change Test
|
|
Hi @poshett, |
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 improves the descriptions of Elastic monitor and related commands by refining the docstrings to provide clearer, more detailed information about each command’s purpose and behavior.
- Updated command docstrings for clearer descriptions and enhanced consistency across the module.
- Improved guidance on command usage to better support network traffic control and monitoring functionalities.
- Expanded documentation in examples to aid in audit and management of Elastic resources.
Reviewed Changes
Copilot reviewed 50 out of 50 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_list_all_traffic_filter.py | Updated docstring to clarify filter listing functionality. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_list.py | Enhanced description of monitor listing capabilities. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_get_billing_info.py | Refined docstring to detail billing info retrieval. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_detach_traffic_filter.py | Improved docstring for traffic filter detachment. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_detach_and_delete_traffic_filter.py | Updated description for combined detach and delete functionality. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_delete_traffic_filter.py | Clarified functionality for deleting traffic filters. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_delete.py | Enhanced clarity in the description of monitor deletion. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_create_or_update_external_user.py | Provided more details on external user configuration creation/updating. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_create_and_associate_pl_filter.py | Refined instruction for creating and associating PL filters. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_create_and_associate_ip_filter.py | Improved docstring for IP filter association. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_create.py | Updated and expanded description for monitor creation. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/_associate_traffic_filter.py | Clarified association of traffic filters with monitors. |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/__cmd_group.py | Expanded group description for managing Elastic monitors. |
| src/elastic/azext_elastic/aaz/latest/elastic/get/elastic/organization_to_azure/subscription/_mapping.py | Updated to clearly describe the mapping details retrieval. |
| src/elastic/azext_elastic/aaz/latest/elastic/get/elastic/organization_to_azure/subscription/__cmd_group.py | Refined group description for subscription mapping. |
| src/elastic/azext_elastic/aaz/latest/elastic/get/elastic/organization_to_azure/__cmd_group.py | Enhanced clarity of managing organization-to-Azure details. |
| src/elastic/azext_elastic/aaz/latest/elastic/get/elastic/__cmd_group.py | Clarified the command group purpose for retrieving Elastic details. |
| src/elastic/azext_elastic/aaz/latest/elastic/get/__cmd_group.py | Improved description for retrieving detailed Elastic information. |
| src/elastic/azext_elastic/aaz/latest/elastic/elastic_version/__cmd_group.py | Expanded description to detail available Elastic versions. |
| src/elastic/azext_elastic/aaz/latest/elastic/_get_organization_api_key.py | Refined wording for fetching the organization API key. |
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
Hi @poshett Release SuggestionsModule: elastic
Notes
|
Contributor
Author
Contributor
Author
Contributor
Author
|
/azp run |
|
Commenter does not have sufficient privileges for PR 8843 in repo Azure/azure-cli-extensions |
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
Contributor
Author
Contributor
Author
kairu-ms
previously approved these changes
Jun 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.