Repository navigation
az connection preview-configuration | no examples given in reference content #29663
Description
Describe the bug
Bug category:
Missing information
Request:
The Azure CLI reference guidelines specifiy at least two examples for each command. Please review the Azure CLI reference guidelines for examples and parameters and add missing content to your source code.
If a parameter accepts JSON content, provide a JSON example in the parameter long or short summary, or in a separate code block.
Command list without examples:
Related command
az connection preview-configuration
Errors
n/a
Issue script & Debug output
n/a
Expected behavior
n/a
Environment Summary
Azure CLI 2.63.0
Additional context
No response
Activity
yonzhan commentedon Aug 6, 2024
Thank you for opening this issue, we will look into it.
x-engineering-agent commentedon Oct 17, 2026
X Engineering Agent Bug Analysis
Below is my analysis of this issue:
Summary
Classification: documentation defect, not an established runtime bug. Ownership: Azure CLI serviceconnector; CODEOWNERS assigns @Azure/act-codegen-extensibility-squad. Recommended priority: P3, because missing usage guidance has no reported execution failure; this repository has no configured priority-field support. All 24 reported children still lack examples in current dev source. No implementation job has been queued.
Likely root cause
The handwritten help definitions omit examples in both the shared target loop and the separate confluent-cloud entry. Each defines only command type and short summary, supplying no usage examples to inline help/reference generation. This confirms a current source gap, not an already-fixed source discrepancy; current published reference content was not independently inspected.
Affected code
src/azure-cli/azure/cli/command_modules/serviceconnector/_help.py›helps(line 773)src/azure-cli/azure/cli/command_modules/serviceconnector/commands.py›load_command_table(line 108)src/azure-cli/azure/cli/command_modules/serviceconnector/_params.py›add_auth_block(line 113)src/azure-cli/azure/cli/command_modules/serviceconnector/custom.py›connection_preview_configuration(line 204)Ruled out
Proposed change
Add at least two distinct valid examples for every reported child in serviceconnector/_help.py: a common preview and a supported client/authentication-filtered preview. Update both the shared template and separate confluent-cloud entry with target-specific supported values. Cover exposed parameters; provide JSON examples only where an input actually accepts JSON, rather than assuming variadic authentication options do. Preserve command behavior.
Technical details
Evidence
Test plan
During implementation, validate rendered help for all 24 children, example counts, command names, supported client/authentication combinations, and applicable parameter/JSON guidance using existing help/example checks. Review generated reference output. Source-only help validation needs no live Azure execution or recordings; no local tests were run for this analysis.
Generated code: Handwritten code. The defect is in ordinary serviceconnector/_help.py templates, outside generated directories. Building help entries in a Python loop does not make this source generator-owned.
Posted by x-engineering-agent (Fixer)
x-engineering-agent commentedon Oct 19, 2026
⏳ Queued — X Engineering Agent picked up this request and will post its findings here.
mvanhorn commentedon Oct 20, 2026
Those help entries were defined with only a command type and a short summary.
The shared help template now adds examples for every local preview-configuration target: an unfiltered preview, a preview filtered by the first supported client type and the first non-user-account auth option, and one further example for each remaining auth type on that target.
#34247