Repository navigation
[Service Connector] az connection preview-configuration: Add help examples - #34247
Open
Matt Van Horn (mvanhorn) wants to merge 2 commits into
Open
Matt Van Horn (mvanhorn) wants to merge 2 commits into
Matt Van Horn (mvanhorn) wants to merge 2 commits into
Conversation
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. The filtered example is labeled service principal when that option is service-principal secret and secret otherwise, and it includes the parameters for that auth type. User-account examples pass object-id, and the MySQL flexible example also passes mysql-identity-id. The Confluent Cloud entry now has an unfiltered preview plus a second example that passes its first client type and the parameters of its first auth type, worded as secret authentication. Fixes Azure#29663
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
microsoft-github-policy-service
Bot
added
the
customer-reported
Contributor
|
Thank you for your contribution Matt Van Horn (@mvanhorn)! We will review the pull request and get back to you soon. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The examples match supported arguments and existing preview behavior, with no unresolved findings.
No open issues 🎉
What changed in this PR
Adds help and reference examples for az connection preview-configuration, addressing issue #29663.
Changes:
- Adds plain previews and client-type/authentication examples for local targets.
- Adds two examples for Confluent Cloud.
| File | Description |
|---|---|
src/azure-cli/azure/cli/command_modules/serviceconnector/_help.py |
Generates target-specific preview examples using supported client and authentication options. |
Review effort: Balanced
x-engineering-agent
Bot
added this to the
November 2026 (2026-11-16)❗ Breaking change release ❗ milestone
Contributor
|
Hi Matt Van Horn (@mvanhorn), |
Collaborator
|
/azp run |
|
Azure Pipelines: Successfully started running 3 pipeline(s). |
Matt Van Horn (mvanhorn)
changed the title
az connection preview-configuration: Add help examples
This branch has not been deployed
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.
🤖 PR Validation — ️✔️ All clear
Motivation
Help and the published reference for az connection preview-configuration show each target command with only a short summary. There is no sample of a plain preview and no sample that passes a client type or authentication options.
Those help entries were defined with only a command type and a short summary. The loop that writes help for the local targets never included an examples section, and the separate Confluent Cloud entry was written the same way, so reference generation had no examples to render.
What this changes
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. The filtered example is labeled service principal when that option is service-principal secret and secret otherwise, and it includes the parameters for that auth type. User-account examples pass object-id, and the MySQL flexible example also passes mysql-identity-id. The Confluent Cloud entry now has an unfiltered preview plus a second example that passes its first client type and the parameters of its first auth type, worded as secret authentication.
How it was tested
No local test run is recorded for the azure-cli change to
src/azure-cli/azure/cli/command_modules/serviceconnector/_help.py.Fixes #29663