[Doc]: Test-AzDeployment: Return value not specified

[SetTrend]

Description

The documentation on Test-AzDeployment 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.

Thank you for your feedback. This has been routed to the support team for assistance.

[microsoft-github-policy-service]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Azure/deployments-owners.

[o-l-a-v]

Also, current behavior of returning nothing if Test-AzDeployment succeeds, is not consistent with what Azure CLI az deployment sub validate does.