Skip to content

Commit 3400b03

Browse files
(AB#85436) Cleanup formatting for machine config
This change standardizes the formatting for the machine configuration articles to make them easier to maintain in the future. It makes incidental fixes but is focused on the formatting and presentation of the content.
1 parent e81f77f commit 3400b03

14 files changed

+470
-389
lines changed

articles/governance/machine-configuration/agent-notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ ms.topic: conceptual
88

99
[!INCLUDE [Machine config rename banner][00]]
1010

11-
## About the guest configuration agent
11+
## About the machine configuration agent
1212

13-
The guest configuration agent receives improvements on an ongoing basis. To stay up to date with
13+
The machine configuration agent receives improvements on an ongoing basis. To stay up to date with
1414
the most recent developments, this article provides you with information about:
1515

1616
- The latest releases
@@ -39,7 +39,7 @@ For information on release notes for the connected machine agent, please see
3939
In this release, various improvements were made.
4040

4141
- You can now restrict which URLs can be used to download machine configuration packages by setting
42-
the allowedGuestConfigPkgUrls tag on the server resource and providing a comma-separated list of
42+
the `allowedGuestConfigPkgUrls` tag on the server resource and providing a comma-separated list of
4343
URL patterns to allow. If the tag exists, the agent will only allow custom packages to be
4444
downloaded from the specified URLs. Built-in packages are unaffected by this feature.
4545

@@ -49,7 +49,7 @@ In this release, various improvements were made.
4949
- If you're currently running an older version of the AzurePolicyforLinux extension, use the
5050
PowerShell or Azure CLI commands below to update your extension to the latest version.
5151

52-
```powershell
52+
```azurepowershell-interactive
5353
$params = @{
5454
Publisher = 'Microsoft.GuestConfiguration'
5555
Type = 'ConfigurationforLinux'

articles/governance/machine-configuration/machine-configuration-assignments.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.topic: conceptual
88

99
[!INCLUDE [Machine config rename banner](../includes/banner.md)]
1010

11-
When an Azure Policy is assigned, if it's in the category "Guest Configuration" there's metadata
11+
When an Azure Policy is assigned, if it's in the category `Guest Configuration` there's metadata
1212
included to describe a guest assignment.
1313

1414
[A video walk-through of this document is available][01].
@@ -19,19 +19,19 @@ version `1.0.0` to any machines in scope of the policy.
1919

2020
```json
2121
"metadata": {
22-
"category": "Guest Configuration",
23-
"guestConfiguration": {
24-
"name": "AzureWindowsBaseline",
25-
"version": "1.*"
26-
}
22+
"category": "Guest Configuration",
23+
"guestConfiguration": {
24+
"name": "AzureWindowsBaseline",
25+
"version": "1.*"
26+
}
2727
//additional metadata properties exist
2828
}
2929
```
3030

3131
## How Azure Policy uses machine configuration assignments
3232

3333
The metadata information is used by the machine configuration service to automatically create an
34-
audit resource for definitions with either **AuditIfNotExists** or **DeployIfNotExists** policy
34+
audit resource for definitions with either `AuditIfNotExists` or `DeployIfNotExists` policy
3535
effects. The resource type is `Microsoft.GuestConfiguration/guestConfigurationAssignments`. Azure
3636
Policy uses the **complianceStatus** property of the guest assignment resource to report compliance
3737
status. For more information, see [getting compliance data][02].
@@ -80,14 +80,14 @@ An example deployment template:
8080

8181
The following table describes each property of guest assignment resources.
8282

83-
| Property | Description |
84-
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
85-
| name | Name of the configuration inside the content package MOF file. |
86-
| contentUri | HTTPS URI path to the content package (`.zip`). |
87-
| contentHash | A SHA256 hash value of the content package, used to verify it has not changed. |
88-
| version | Version of the content package. Only used for built-in packages and not used for custom content packages. |
89-
| assignmentType | Behavior of the assignment. Allowed values: `Audit`, `ApplyandMonitor`, and `ApplyandAutoCorrect`. |
90-
| configurationParameter | List of DSC resource type, name, and value in the content package MOF file to be overridden after it's downloaded in the machine. |
83+
| Property | Description |
84+
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
85+
| **name** | Name of the configuration inside the content package MOF file. |
86+
| **contentUri** | HTTPS URI path to the content package (`.zip`). |
87+
| **contentHash** | A SHA256 hash value of the content package, used to verify it has not changed. |
88+
| **version** | Version of the content package. Only used for built-in packages and not used for custom content packages. |
89+
| **assignmentType** | Behavior of the assignment. Allowed values: `Audit`, `ApplyandMonitor`, and `ApplyandAutoCorrect`. |
90+
| **configurationParameter** | List of DSC resource type, name, and value in the content package MOF file to be overridden after it's downloaded in the machine. |
9191

9292
### Deletion of manually created machine configuration assignments
9393

@@ -98,7 +98,7 @@ machine or Arc-enabled machine) will also delete the machine configuration assig
9898
To manually delete a machine configuration assignment, use the following example. Make sure to
9999
replace all example strings, indicated by `<>` brackets.
100100

101-
```PowerShell
101+
```azurepowershell-interactive
102102
# First get details about the machine configuration assignment
103103
$resourceDetails = @{
104104
ResourceGroupName = '<resource-group-name>'
@@ -121,7 +121,7 @@ $guestAssignment | Remove-AzResource
121121
- Setup a custom machine configuration package [development environment][04].
122122
- [Create a package artifact][05] for machine configuration.
123123
- [Test the package artifact][06] from your development environment.
124-
- Use the `GuestConfiguration` module to [create an Azure Policy definition][07] for at-scale
124+
- Use the **GuestConfiguration** module to [create an Azure Policy definition][07] for at-scale
125125
management of your environment.
126126
- [Assign your custom policy definition][08] using Azure portal.
127127
- Learn how to view [compliance details for machine configuration][09] policy assignments.

0 commit comments

Comments
 (0)