Azure / Azure/azure-powershell
RuleId referenced in text, but not in command parameters - this is confusing
- Dominant language
- C#
- Stars
- 4.8k
- Forks
- 4.3k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 51
Description
### Type of issue
Other (describe below)
### Feedback
> To use the cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database, and the **RuleId parameter** to specify which rule this cmdlet returns. If you do not provide RuleId, all the data masking rules for that Azure SQL database are returned.
but `RuleId` appears neither in the command/parameter description nor in the examples at any point.
### Page URL
https://learn.microsoft.com/en-us/powershell/module/az.sql/get-azsqldatabasedatamaskingrule?view=azps-12.3.0
### Content source URL
https://github.com/Azure/azure-powershell/blob/main/src/Sql/Sql/help/Get-AzSqlDatabaseDataMaskingRule.md
### Author
@mikefrobbins
### Document Id
00fb6f5c-c99c-59b2-72f4-bbe66ee246bd
Contributor guide
Research direction
Open src/Sql/Sql/help/Get-AzSqlDatabaseDataMaskingRule.md and compare the RuleId reference with the cmdlet's parameter description and examples. Update the help content so RuleId is documented consistently wherever the issue says it is missing, then verify the rendered Get-AzSqlDatabaseDataMaskingRule page no longer references an undocumented parameter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, powershell
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100