Azure / Azure/azure-powershell
Cmdlet reference doc - New-AzDataCollectionEndpoint - Required parameter conflict
- Dominant language
- C#
- Stars
- 4.8k
- Forks
- 4.3k
- Avg merge
- 3d 14h
- Merged PRs (30d)
- 54
Description
### Type of issue
Other (describe below)
### Feedback
Under the Parameters heading, the parameter NetworkAclsPublicNetworkAccess is listed as not being required. The Syntax area also doesn't indicate it is required. However, both examples shown include a value for that parameter. And when trying to use the cmdlet without that parameter resulted in an error message "Invalid resource payload: 'properties' are missing". Running the same set of parameters with the addition of "Enabled" for the NetworkAclsPublicNetworkAccess parameter resulted in success.
This would indicate the NetworkAclsPublicNetworkAccess parameter is required. The Required field in it's parameter table should be updated to True.
### Page URL
https://learn.microsoft.com/en-us/powershell/module/az.monitor/new-azdatacollectionendpoint?view=azps-11.5.0
### Content source URL
https://github.com/Azure/azure-powershell/blob/main/src/Monitor/Monitor/help/New-AzDataCollectionEndpoint.md
### Author
@mikefrobbins
### Document Id
02f95826-d824-38cc-7bff-9b2592ce7fed
Contributor guide
Research direction
Open src/Monitor/Monitor/help/New-AzDataCollectionEndpoint.md and inspect the NetworkAclsPublicNetworkAccess entry under Parameters, along with the Syntax and examples. Confirm that omitting the parameter produces the reported error and that supplying Enabled succeeds. Done means the parameter table marks Required as True and the reference is consistent with the observed behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100