Azure / Azure/azure-powershell
[Doc]: New-AzDiagnosticSetting documentation incomplete
- Dominant language
- C#
- Stars
- 4.8k
- Forks
- 4.3k
- Avg merge
- 3d 14h
- Merged PRs (30d)
- 54
Description
### Type of issue
Missing information
### Feedback
The documentation references a NOTES section under the [Log](https://learn.microsoft.com/en-us/powershell/module/az.monitor/new-azdiagnosticsetting?view=azps-13.1.0#-log) and [Metric](https://learn.microsoft.com/en-us/powershell/module/az.monitor/new-azdiagnosticsetting?view=azps-13.1.0#-metric) parameters, but there is no such section in this documentation, nor are there any references to the commands that can create these values - [New-AzDiagnosticSettingLogSettingsObject](https://learn.microsoft.com/en-us/powershell/module/az.monitor/new-azdiagnosticsettinglogsettingsobject?view=azps-13.1.0) and [New-AzDiagnosticSettingMetricSettingsObject](https://learn.microsoft.com/en-us/powershell/module/az.monitor/new-azdiagnosticsettingmetricsettingsobject?view=azps-13.0.0) respectively.
This makes finding this information incredibly difficult and can lead to hours of searching before inevitably finding the [Create diagnostic settings in Azure Monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/create-diagnostic-settings?tabs=powershell) guide.
It would be tremendously helpful if this section existed, or at the very least references to the necessary commands were included somewhere in this documentation.
### Page URL
https://learn.microsoft.com/en-us/powershell/module/az.monitor/new-azdiagnosticsetting?view=azps-13.1.0
### Content source URL
https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDiagnosticSetting.md
### Author
@mikefrobbins
### Document Id
88739869-81cb-7178-e0cd-7a1acc9721d4
Contributor guide
Research direction
Open src/Monitor/Monitor/help/New-AzDiagnosticSetting.md and compare its Log and Metric parameter documentation with the linked settings-object cmdlets. Add the missing NOTES information or direct command references, then verify the rendered page links users to the commands needed to create the values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100