MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.3k stars 21.48k forks source link

"Azure Policy definition structure basics" JSON example doesn't validate #124854

Closed jpluscplusm closed 3 days ago

jpluscplusm commented 1 week ago

I'm using the page https://learn.microsoft.com/en-gb/azure/governance/policy/concepts/definition-structure-basics to learn about Azure policy definitions.

The page contains an example of a JSON policy definition, directly under the text "For example, the following JSON shows a policy that limits where resources are deployed".

Directly underneath that example JSON, there's a sentence ("For more information, go to the policy definition schema") that links to a JSON Schema describing a "policy definition" (https://schema.management.azure.com/schemas/2020-10-01/policyDefinition.json)

Here's the problem: the example JSON presented on the page is invalid, according to the JSON Schema linked to by the page. I uploaded the schema and the example to an online validator (https://www.jsonschemavalidator.net/s/vKp4ApuY), which points out two high-level errors:

Requested fix: this page should be updated to link to an authoritative schema that can validate the example successfully.

TPavanBalaji commented 1 week ago

@jpluscplusm Thanks for your feedback! We will investigate and update as appropriate.

TPavanBalaji commented 4 days ago

@jpluscplusm Thank you for bringing this to our attention. I've delegated this to content author, who will review it and offer their insightful opinions.

davidsmatlak commented 3 days ago

Thank you for the documentation feedback. I created an internal backlog work item to review the issue. I'm closing the GitHub issue.

davidsmatlak commented 3 days ago

please-close

jpluscplusm commented 2 days ago

Thanks @davidsmatlak. Will this issue receive any updates as this problem gets addressed?