Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for parameter strongType #57

Open
BernieWhite opened this issue Mar 11, 2021 · 1 comment
Open

Add support for parameter strongType #57

BernieWhite opened this issue Mar 11, 2021 · 1 comment
Labels
feature: documents Issues that affect Document definitions

Comments

@BernieWhite
Copy link
Contributor

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 BernieWhite added the feature: documents Issues that affect Document definitions label Mar 11, 2021
@muhammad-shameem
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature: documents Issues that affect Document definitions
Projects
None yet
Development

No branches or pull requests

2 participants