From 3efe68cebb2f3b629bdbf8233bab39951db02182 Mon Sep 17 00:00:00 2001 From: Heinrich Gantenbein <6719941+techlake@users.noreply.github.com> Date: Mon, 22 Apr 2024 15:20:39 -0500 Subject: [PATCH] Fixing markup (#577) --- Docs/policy-exemptions.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/Docs/policy-exemptions.md b/Docs/policy-exemptions.md index 4bb8503b..2a216ebe 100644 --- a/Docs/policy-exemptions.md +++ b/Docs/policy-exemptions.md @@ -135,16 +135,16 @@ In CSV files, the `scope` column is still supported for backward compatibility. In JSON files, `scope` is a string and `scopes` is an array of strings. - ## Combining Policy Definitions at multiple Scopes +## Combining Policy Definitions at multiple Scopes - When using **Option A** or **Option C** and/or `scopes`, EPAC needs to generate concatenated values for `name`, `displayName`, and `description` to ensure uniqueness and readability. - - - `name` is generated by concatenating the `name` with a dash `-` and the Assignment `name` (the last part of the `policyAssignmentId`). - - `displayName` and `description` are generated by concatenating the `displayName` and `description` with a a space dash space (` - `), the last part of the scope, or the human readable name before the colon `:` (if using `scopes`). +When using **Option A** or **Option C** and/or `scopes`, EPAC needs to generate concatenated values for `name`, `displayName`, and `description` to ensure uniqueness and readability. + +- `name` is generated by concatenating the `name` with a dash `-` and the Assignment `name` (the last part of the `policyAssignmentId`). +- `displayName` and `description` are generated by concatenating the `displayName` and `description` with a a space dash space (` - `), the last part of the scope, or the human readable name before the colon `:` (if using `scopes`). It is best to explain the details with examples. They are based on JSON files, but the same principles apply to CSV files. - ### Example with `policyDefinition` and `scopes` +### Example with `policyDefinition` and `scopes` #### Definition file: @@ -164,7 +164,7 @@ It is best to explain the details with examples. They are based on JSON files, b } ] } - ``` +``` #### Generated fields for each assignment with the Policy specified: @@ -175,7 +175,7 @@ It is best to explain the details with examples. They are based on JSON files, b - `description`: "More details - resourceGroupName1 - assignmentName" - ### Example with `policyDefinition`, `scopes` and a human readable name +### Example with `policyDefinition`, `scopes` and a human readable name #### Definition file: @@ -195,7 +195,7 @@ It is best to explain the details with examples. They are based on JSON files, b } ] } - ``` +``` #### Generated fields for each assignment with the Policy specified: @@ -205,7 +205,7 @@ It is best to explain the details with examples. They are based on JSON files, b - `description`: "More details - humanReadableName - assignmentName" - `description`: "More details - resourceGroupName1 - assignmentName" - ### Example with `policyDefinition` and a single `scope` +### Example with `policyDefinition` and a single `scope` #### Definition file: @@ -222,7 +222,7 @@ It is best to explain the details with examples. They are based on JSON files, b } ] } - ``` +``` #### Generated fields for the assignment with the Policy specified: @@ -230,7 +230,7 @@ It is best to explain the details with examples. They are based on JSON files, b - `displayName`: "Descriptive name displayed on portal - assignmentName" - `description`: "More details - assignmentName" - ### Example with `policyAssignmentId` and `scopes` +### Example with `policyAssignmentId` and `scopes` #### Definition file: @@ -250,7 +250,7 @@ It is best to explain the details with examples. They are based on JSON files, b } ] } - ``` +``` #### Generated fields for this assignment: @@ -260,7 +260,7 @@ It is best to explain the details with examples. They are based on JSON files, b - `description`: "More details - 11111111-2222-3333-4444-555555555555" - `description`: "More details - resourceGroupName1" - ### Example with `policyAssignmentId`, `scopes` and a human readable name +### Example with `policyAssignmentId`, `scopes` and a human readable name #### Definition file: @@ -280,7 +280,7 @@ It is best to explain the details with examples. They are based on JSON files, b } ] } - ``` +``` #### Generated fields for this assignment: @@ -290,7 +290,7 @@ It is best to explain the details with examples. They are based on JSON files, b - `description`: "More details - humanReadableName" - `description`: "More details - resourceGroupName1" - ### Example with `policyAssignmentId` and a single `scope` +### Example with `policyAssignmentId` and a single `scope` #### Definition file: @@ -307,7 +307,7 @@ It is best to explain the details with examples. They are based on JSON files, b } ] } - ``` +``` #### Generated fields for this assignment: