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

[FEATURE] Detect help links from exported policies #2665

Open
BernieWhite opened this issue Jan 30, 2024 · 0 comments
Open

[FEATURE] Detect help links from exported policies #2665

BernieWhite opened this issue Jan 30, 2024 · 0 comments
Labels
enhancement New feature or request feature: policy-as-rules Issues that related to exporting policy as rules. help wanted Extra attention is needed .NET Pull requests that update .net code

Comments

@BernieWhite
Copy link
Collaborator

BernieWhite commented Jan 30, 2024

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:

  1. If a policy definition has a link metadata property with a https:// URL then include this as the help link.
  2. If a policy definition has a https:// URL at the end of the description property include this as the help link.
  3. If a policy initiative has a link metadata property with a https:// URL then include this as the help link.
  4. If a policy initiative has a https:// URL at the end of the description property include this as the help link.
  5. If no links are found use configuration from the AZURE_POLICY_DEFAULT_URL option.

Alternatives

None available.

Additional context

Related to #2482

@BernieWhite BernieWhite added enhancement New feature or request feature: policy-as-rules Issues that related to exporting policy as rules. labels Jan 30, 2024
@BernieWhite BernieWhite added the help wanted Extra attention is needed label Mar 2, 2024
@BernieWhite BernieWhite added the .NET Pull requests that update .net code label May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature: policy-as-rules Issues that related to exporting policy as rules. help wanted Extra attention is needed .NET Pull requests that update .net code
Projects
None yet
Development

No branches or pull requests

1 participant