PSRule.Rules.Azure
PSRule.Rules.Azure copied to clipboard
[FEATURE] Detect help links from exported policies
Your suggestion
When exporting policies as rules, currently there is no standard practise or property for providing a help link.
Currently many built-in policy initiatives provide a link to Azure docs as part of their description.
We should implement a pattern that makes it easy for customers to define their policies linking to documentation but also have built-in features just work where they are configured.
We should implement the logic find a help URL by:
- If a policy definition has a
linkmetadata property with ahttps://URL then include this as the help link. - If a policy definition has a
https://URL at the end of thedescriptionproperty include this as the help link. - If a policy initiative has a
linkmetadata property with ahttps://URL then include this as the help link. - If a policy initiative has a
https://URL at the end of thedescriptionproperty include this as the help link. - If no links are found use configuration from the
AZURE_POLICY_DEFAULT_URLoption.
Alternatives
None available.
Additional context
Related to #2482