PSDocs.Azure icon indicating copy to clipboard operation
PSDocs.Azure copied to clipboard

Add support for parameter strongType

Open BernieWhite opened this issue 4 years ago • 1 comments

Azure Policy supports the concept of a parameter strong type, while this isn't directly applicable for ARM template the same uses of strongType in policy would help with document generation to provide more meaningful references.

Suggestion that strongType can be added to metadata.

location

When location is used, a reference link to Azure locations can be added to parameter details.

For example:

{
  "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
          "description": "The Azure region to deploy to.",
          "strongType": "location"
      }
  }
}

resource type

When a resource type is used for a strong type a resource Id for that resource can be used in parameter file snippet.

{
    "workspaceId": {
        "type": "string",
        "defaultValue": "",
        "metadata": {
            "description": "The workspace to store audit logs.",
            "strongType": "Microsoft.OperationalInsights/workspaces"
        }
    }
}
/subscriptions/<subscription_id>/resourcegroups/<resource_group_name>/providers/microsoft.operationalinsights/workspaces/<name>

Reference

BernieWhite avatar Mar 11 '21 10:03 BernieWhite

any update on this one yet ! It would be nice to have it

muhammad-shameem avatar Jun 02 '22 13:06 muhammad-shameem