Update summarized-gateway-prefixes property for Virtual Network docs

[arjun-d-patel]

Describe the bug

Related command
az network vnet

In the vnet create docs: https://learn.microsoft.com/en-us/cli/azure/network/vnet?view=azure-cli-latest#az-network-vnet-create, there is a reference to using summarized-gateway-prefixes with ipam-pool-prefix-allocations property. The summarized-gateway-prefixes doesn't currently work with ipam-pool-prefix-allocations. So can we update the docs to remove the reference?

Related command

az network vnet

Errors

Using summarized-gateway-prefixes with ipam-pool-prefix-allocations property is not supported yet. The summarized-gateway-prefixes doesn't currently work with ipam-pool-prefix-allocations.

Issue script & Debug output

docs: https://learn.microsoft.com/en-us/cli/azure/network/vnet?view=azure-cli-latest#az-network-vnet-create

Expected behavior

Docs shouldn't reference using it.

Environment Summary

az-cli: 2.89.0

Additional context

No response

[yonzhan]

Thank you for opening this issue, we will look into it.

[azure-client-tools-agent]

Bug Analysis

The az network vnet create help/docs reference using summarized-gateway-prefixes together with ipam-pool-prefix-allocations, but this combination is not currently supported by the command. The docs at https://learn.microsoft.com/en-us/cli/azure/network/vnet?view=azure-cli-latest#az-network-vnet-create should be updated to remove this unsupported reference so users aren't misled into trying an unsupported combination.

Affected area: network module — az network vnet create help text / parameter docs for --ipam-pool-prefix-allocations and --summarized-gateway-prefixes (likely in src/azure-cli/azure/cli/command_modules/network/_help.py and/or the related _params.py validators/help strings).

Expected fix: Update the help text (and any inline validation messages) for az network vnet create so it no longer implies summarized-gateway-prefixes works together with ipam-pool-prefix-allocations. If there's a validator that should raise a clear error when both are combined, consider adding one; otherwise just correct the documentation/help string.

Use this EXACT PR title: [Network] Fix #33923: az network vnet create: Remove unsupported summarized-gateway-prefixeswithipam-pool-prefix-allocations reference from help text

PR title & description format (required)

This repo enforces a PR format (guide). Please author the PR exactly as follows or CI's Check the Format of Pull Request Title and Content will fail.

Use this EXACT PR title (copy verbatim, do not reword):

[Network] Fix #33923: `az network vnet create`: Remove unsupported `summarized-gateway-prefixes` with `ipam-pool-prefix-allocations` reference from help text

Keep the backticks around the command and the Fix #33923: prefix. You may only adjust the wording after the command (the final summary) if the fix changes; the [Network] prefix, issue link, and backticked command must stay.

Description — follow the PR template and fill in:

• Link the issue — start the Description with a closing keyword so the PR auto-links and closes it: Fixes #33923.
• Related command — the az ... command this affects.
• Description (mandatory) — why the bug happens, what you changed, and the resulting behavior.
• Testing Guide — example command(s) showing the fix works.
• History Notes — leave the title to drive the history note, or add extra lines in the same format (component in brackets + the command in backticks), e.g. [Network] `az <command>`: <note>.
• Keep the template checklist and tick the items you've satisfied.

---

Posted by agent-assist (autonomous bug-fix pipeline).