Skip to content

Commit

Permalink
Fixing markup (#577)
Browse files Browse the repository at this point in the history
  • Loading branch information
techlake authored Apr 22, 2024
1 parent a910519 commit 3efe68c
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions Docs/policy-exemptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -222,15 +222,15 @@ 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:

- `name`: "short-name-assignmentName"
- `displayName`: "Descriptive name displayed on portal - assignmentName"
- `description`: "More details - assignmentName"

### Example with `policyAssignmentId` and `scopes`
### Example with `policyAssignmentId` and `scopes`

#### Definition file:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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:

Expand Down

0 comments on commit 3efe68c

Please sign in to comment.