Azure / Azure/azure-powershell
[Doc]: Test-AzDeployment: Return value not specified
Open
act-identity-squad
ARM - Templates
customer-reported
Doc - Reference
Service Attention
- Dominant language
- C#
- Stars
- 4.8k
- Forks
- 4.3k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 51
Description
### Description
The [documentation on `Test-AzDeployment`](https://docs.microsoft.com/en-us/powershell/module/az.resources/test-azdeployment?view=azps-8.2.0#description
) lacks a clear explanation of what to expect in case of success and what to expect in case of error.
So, one has to try-and-error to get acquainted with the different results. This is not desirable.
A documentation should give full explanation of what to expect from running a Cmdlet. Then, things can be coded without first testing each and every Cmdlet per se.
This issue and improvement request may probably be true for other Azure PowerShell documentation pages, too.
Contributor guide
Assessment
This issue has not been assessed yet.