Azure / azure-cli

Azure Command-Line Interface
MIT License
3.96k stars 2.94k forks source link

Customer feedback | az site-recovery protectable-item show | fabric-name required but documentation says not required #29459

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

Describe the bug

This GitHub issue is being moved from azure-docs-cli https://github.com/MicrosoftDocs/azure-docs-cli/issues/4470 as the feedback is on autogenerated reference content controlled by source code.

Suggestion to engineering: Use the long-summary property to provide more information on "parameter pairs" or "this parameter is required when ...".


Type of issue Other (describe below)

Feedback Latest Az CLI documentation states that for az site-recovery protectable-item show, [--fabric-name] is an optional field, but when attempt to run without it, I get an error citing that it is actually required.

image

image

Page URL https://learn.microsoft.com/en-us/cli/azure/site-recovery/protectable-item?view=azure-cli-latest

Content source URL https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/site-recovery/protectable-item.yml


Related command

az site-recovery protectable-item show

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

n/a

Additional context

No response

yonzhan commented 1 month ago

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

microsoft-github-policy-service[bot] commented 1 month ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Sharmistha-Rai.