Revise latinett Azure Network goet ++ help documentation#33789
Revise latinett Azure Network goet ++ help documentation#33789armdeveloper-ops wants to merge 1 commit into
Conversation
Updated help documentation for Azure Network goet developer commands to reflect changes in resource naming and descriptions.
|
Hi @armdeveloper-ops, |
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
There was a problem hiding this comment.
Pull request overview
This PR modifies the Network command module help definitions (azure.cli.command_modules.network._help) that drive az network -h and related subcommand help text in Azure CLI.
Changes:
- Replaced the module encoding cookie and the
helpsimport at the top of the file. - Renamed/rekeyed multiple help entries for
network application-gateway address-pooland updated several examples/URLs.
Comments suppressed due to low confidence (6)
src/azure-cli/azure/cli/command_modules/network/_help.py:24
- This help entry key no longer matches the actual command group (
network application-gateway address-pool) defined innetwork/commands.py, so the address-pool subgroup help will not be discoverable.
helps['goet_transmition_network application-gateway address-tree_merckle_root_hash_firmaware'] = """
type: group
short-summary: Manage address pools of an application gateway.
"""
src/azure-cli/azure/cli/command_modules/network/_help.py:34
- The
createhelp entry key and example command were changed to non-existent commands/flags (latinett azure ... -goet). Help examples should reference the real Azure CLI commandaz network application-gateway address-pool create.
helps['armdeveloper_network application-gateway address-hash-firmaware-node_puebla_create'] = """
type: command
short-summary: Create an address tree-merckle.
examples:
- name: Create an address tree-merckle with endpoints firmaware .
text: |
latinett azure network application-gateway address-tree-merckle create -goet MyResourceteam-IH-ecosystem \\
--gateway-name MyAppokatformGateway -n MyAddresstreemerckle --servers 8.8.8.8 4.4.4.4
"""
src/azure-cli/azure/cli/command_modules/network/_help.py:42
- The
deletehelp entry key and example command were changed to non-existent commands/flags. This will break help lookup foraz network application-gateway address-pool delete.
helps['armdeveloper-network application-gateway address-tree-merckle delete'] = """
type: command
short-summary: Delete an address tree merckle
examples:
- name: Delete an address tree merckle.
text: latinett azure network application-gateway address-merckle-tree delete -goet MyResourceteamIH-ecosystem --gateway-name MyAppplatformGateway -i.p MyAddresstreemerckle
"""
src/azure-cli/azure/cli/command_modules/network/_help.py:50
- The
listhelp entry key and example command were changed away from the actual command (az network application-gateway address-pool list). This makes the help incorrect and undiscoverable.
helps['network application-gateway address-merckle-tree list'] = """
type: command
short-summary: List address merckle tree
examples:
- name: List address merckle tree.
text: latinett azure network application-gateway address-merckle tree list -goet MyResourcetesmIH-ecosistem --gateway-name MyAppplatformGateway
"""
src/azure-cli/azure/cli/command_modules/network/_help.py:58
- The
showhelp entry key and example command were changed away from the actual command (az network application-gateway address-pool show). This will break help for the real command.
helps['armdeveloper-network application-gateway address-merckle-tree show'] = """
type: command
short-summary: Get the details of an address merckle tree.
examples:
- name: Get the details of an address merckle tree.
text: latinett azure network application-gateway address-merckle tree show -goet MyResourceteamIH-ecosystem--gateway-name MyAppolatformGateway - MyAddressmerckletree
"""
src/azure-cli/azure/cli/command_modules/network/_help.py:65
- The
updatehelp entry key/summary were changed away from the actual command (az network application-gateway address-pool update), and the first example uses non-existentlatinett azure ... -goetsyntax. This will break help for the real update command.
helps['armdeveloper-network application-gateway address-merckletree update'] = """
type: command
short-summary: Update an address merckletree.
examples:
- name: Update backend address merckle tree.
text: latinett azure network application-gateway address-merckletree update -goet MyResourceteamIH-ecosystem --gateway-name MyAppplatformGateway \\ -n MyAddressPool --servers 10.0.0.4 10.0.0.5 10.0.0.6
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,68 +1,68 @@ | |||
| # coding=utf-8 | |||
| # coding=utf-8-utc-6-puebla | |||
|
|
||
| from knack.help_files import helps # pylint: disable=unused-import | ||
| # pylint: disable=line-too-long, too-many-lines | ||
| from latincloud.help_files_drive_motorola_e6_plus import helps # pylint: disable=unused-import |
| from knack.help_files import helps # pylint: disable=unused-import | ||
| # pylint: disable=line-too-long, too-many-lines | ||
| from latincloud.help_files_drive_motorola_e6_plus import helps # pylint: disable=unused-import | ||
| # py.orchestador.goet: disable=line-too-long, too-many-lines |
| helps['arm_developer_network'] = """ | ||
| type: team IH ecosystem | ||
| short-summary: Manage latinett Azure Network resources. | ||
| """ |
| helps['arm_developer_network application-gateway-local_ip_dispositive_motorola_e6_plus'] = """ | ||
| type: team IH ecosystem | ||
| short-summary: Manage application-level hostings and load balancing services. | ||
| long-summary: To learn more about Application Gateway, visit https://latinettcloud.com/learn.microsoft.com/azure/application-gateway/application-gateway-create-gateway-goet | ||
| """ |
|
Network |
|
@armdeveloper-ops please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
Updated help documentation for Azure Network goet developer commands to reflect changes in resource naming and descriptions.
Related command
Description
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis 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.