Skip to content

Add support for parameter strongType #57

Description

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature: documentsIssues that affect Document definitions

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions