Module Readmes - Reevaluate how to provide better predictability on outputs
- Dominant language
- PowerShell
- Stars
- 737
- Forks
- 436
- Avg merge
- 10d 7h
- Merged PRs (30d)
- 1
Description
## Description
When consuming a module in a solution, there is no way to tell what to expect of the output of a module. This should be detailed in such a way that it shows example values, and for object/arrays there should be an example of the data structure that is returned.
We also need to discuss if there should be arrays or not. Is there a situation where the order of an array would change for any of the returned arrays? If yes, then we should change that to drive consistency for solutions using our modules.
Things that come to mind:
[Virtual Networks - Create Or Update - REST API (Azure Virtual Networks) | Microsoft Docs](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/virtual-networks/create-or-update#create-virtual-network)
[Microsoft.Network/virtualNetworks - Actions | GitHub (Azure/ResourceModules)](https://github.com/Azure/ResourceModules/blob/780c0274c7b136841beeeb2d7477b7f890156484/arm/Microsoft.Network/virtualNetworks/deploy.bicep#L258)
Contributor guide
Assessment
This issue has not been assessed yet.