ResourceModules icon indicating copy to clipboard operation
ResourceModules copied to clipboard

Module Readmes - Reevaluate how to provide better predictability on outputs

Open MariusStorhaug opened this issue 3 years ago • 1 comments

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 Microsoft.Network/virtualNetworks - Actions | GitHub (Azure/ResourceModules)

MariusStorhaug avatar Apr 12 '22 04:04 MariusStorhaug

So, do we still want to do this - given the eventual implementation of the 'azurerm'-resource output?

AlexanderSehr avatar Jul 21 '23 18:07 AlexanderSehr