Azure / Azure/PSDocs.Azure

Add support for parameter strongType

Open
#57 1 comment 0 reactions 0 assignees View on GitHub
feature: documents
Dominant language
C#
Stars
67
Forks
27
PR merge metrics
No merged PRs in 30d

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:

```json
{
"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.

```json
{
"workspaceId": {
"type": "string",
"defaultValue": "",
"metadata": {
"description": "The workspace to store audit logs.",
"strongType": "Microsoft.OperationalInsights/workspaces"
}
}
}
```

```text
/subscriptions//resourcegroups//providers/microsoft.operationalinsights/workspaces/
```

[Reference](https://docs.microsoft.com/en-us/azure/governance/policy/concepts/definition-structure#strongtype)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.