Skip to content

Commit 000d3cc

Browse files
committed
[BULK] DocuTune - Fix formatting issues
1 parent 323e02d commit 000d3cc

9 files changed

+313
-316
lines changed

articles/automation/learn/automation-tutorial-runbook-textual.md

Lines changed: 47 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: This tutorial teaches you to create, test, and publish a PowerShell
44
services: automation
55
ms.subservice: process-automation
66
ms.date: 10/16/2022
7-
ms.topic: tutorial
7+
ms.topic: tutorial
88
ms.custom:
99
#Customer intent: As a developer, I want use workflow runbooks so that I can automate the parallel starting of VMs.
1010
---
@@ -46,7 +46,7 @@ Assign permissions to the appropriate [managed identity](../automation-security-
4646

4747
:::image type="content" source="../media/automation-tutorial-runbook-textual/system-assigned-role-assignments-portal.png" alt-text="Selecting Azure role assignments in portal.":::
4848

49-
1. Select **+ Add role assignment (Preview)** to open the **Add role assignment (Preview)** page.
49+
1. Select **+ Add role assignment (Preview)** to open the **Add role assignment (Preview)** page.
5050

5151
:::image type="content" source="../media/automation-tutorial-runbook-textual/system-assigned-add-role-assignment-portal.png" alt-text="Add role assignments in portal.":::
5252

@@ -71,7 +71,7 @@ Assign permissions to the appropriate [managed identity](../automation-security-
7171

7272
:::image type="content" source="../media/automation-tutorial-runbook-textual/managed-identity-client-id-portal.png" alt-text="Showing Client ID for managed identity in portal":::
7373

74-
1. From the left menu, select **Azure role assignments** and then **+ Add role assignment (Preview)** to open the **Add role assignment (Preview)** page.
74+
1. From the left menu, select **Azure role assignments** and then **+ Add role assignment (Preview)** to open the **Add role assignment (Preview)** page.
7575

7676
:::image type="content" source="../media/automation-tutorial-runbook-textual/user-assigned-add-role-assignment-portal.png" alt-text="Add role assignments in portal for user-assigned identity.":::
7777

@@ -91,7 +91,7 @@ Assign permissions to the appropriate [managed identity](../automation-security-
9191
Start by creating a simple [PowerShell Workflow runbook](../automation-runbook-types.md#powershell-workflow-runbooks). One advantage of Windows PowerShell Workflows is the ability to perform a set of commands in parallel instead of sequentially as with a typical script.
9292

9393
>[!NOTE]
94-
> With release runbook creation has a new experience in the Azure portal. When you select **Runbooks** blade > **Create a runbook**, a new page **Create a runbook** opens with applicable options.
94+
> With release runbook creation has a new experience in the Azure portal. When you select **Runbooks** blade > **Create a runbook**, a new page **Create a runbook** opens with applicable options.
9595
9696
1. From your open Automation account page, under **Process Automation**, select **Runbooks**
9797

@@ -103,9 +103,9 @@ Start by creating a simple [PowerShell Workflow runbook](../automation-runbook-t
103103
1. From the **Runtime version** drop-down, select **5.1**.
104104
1. Enter applicable **Description**.
105105
1. Select **Create**.
106-
106+
107107
:::image type="content" source="../media/automation-tutorial-runbook-textual/create-powershell-workflow-runbook-options.png" alt-text="PowerShell workflow runbook options from portal":::
108-
108+
109109

110110
## Add code to the runbook
111111

@@ -133,7 +133,7 @@ Workflow MyFirstRunbook-Workflow
133133
Write-Output "Non-Parallel"
134134
Get-Date
135135
Start-Sleep -s 3
136-
Get-Date
136+
Get-Date
137137
```
138138

139139
1. Save the runbook by selecting **Save**.
@@ -152,7 +152,7 @@ Before you publish the runbook to make it available in production, you should te
152152

153153
:::image type="content" source="../media/automation-tutorial-runbook-textual/workflow-runbook-parallel-output.png" alt-text="PowerShell workflow runbook parallel output":::
154154

155-
Review the output. Everything in the `Parallel` block, including the `Start-Sleep` command, executed at the same time. The same commands outside the `Parallel` block ran sequentially, as shown by the different date time stamps.
155+
Review the output. Everything in the `Parallel` block, including the `Start-Sleep` command, executed at the same time. The same commands outside the `Parallel` block ran sequentially, as shown by the different date time stamps.
156156

157157
1. Close the **Test** page to return to the canvas.
158158

@@ -190,15 +190,15 @@ You've tested and published your runbook, but so far it doesn't do anything usef
190190
workflow MyFirstRunbook-Workflow
191191
{
192192
$resourceGroup = "resourceGroupName"
193-
193+
194194
# Ensures you do not inherit an AzContext in your runbook
195195
Disable-AzContextAutosave -Scope Process
196-
196+
197197
# Connect to Azure with system-assigned managed identity
198198
Connect-AzAccount -Identity
199-
199+
200200
# set and store context
201-
$AzureContext = Set-AzContext –SubscriptionId "<SubscriptionID>"
201+
$AzureContext = Set-AzContext –SubscriptionId "<SubscriptionID>"
202202
}
203203
```
204204

@@ -219,9 +219,9 @@ You've tested and published your runbook, but so far it doesn't do anything usef
219219

220220
## Add code to start a virtual machine
221221

222-
Now that your runbook is authenticating to the Azure subscription, you can manage resources. Add a command to start a virtual machine. You can pick any VM in your Azure subscription, and for now you're hardcoding that name in the runbook.
222+
Now that your runbook is authenticating to the Azure subscription, you can manage resources. Add a command to start a virtual machine. You can pick any VM in your Azure subscription, and for now you're hardcoding that name in the runbook.
223223

224-
1. Add the code below as the last line immediately before the closing brace. Replace `VMName` with the actual name of a VM.
224+
1. Add the code below as the last line immediately before the closing brace. Replace `VMName` with the actual name of a VM.
225225

226226
```powershell
227227
Start-AzVM -Name "VMName" -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
@@ -262,43 +262,42 @@ You can use the `ForEach -Parallel` construct to process commands for each item
262262
```powershell
263263
workflow MyFirstRunbook-Workflow
264264
{
265-
Param(
266-
[string]$resourceGroup,
267-
[string[]]$VMs,
268-
[string]$action
269-
)
270-
271-
# Ensures you do not inherit an AzContext in your runbook
272-
Disable-AzContextAutosave -Scope Process
273-
274-
# Connect to Azure with system-assigned managed identity
275-
Connect-AzAccount -Identity
276-
277-
# set and store context
278-
$AzureContext = Set-AzContext –SubscriptionId "<SubscriptionID>"
279-
280-
# Start or stop VMs in parallel
281-
if($action -eq "Start")
282-
{
283-
ForEach -Parallel ($vm in $VMs)
284-
{
285-
Start-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
286-
}
287-
}
288-
elseif ($action -eq "Stop")
289-
{
290-
ForEach -Parallel ($vm in $VMs)
291-
{
292-
Stop-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext -Force
293-
}
294-
}
295-
else {
296-
Write-Output "`r`n Action not allowed. Please enter 'stop' or 'start'."
297-
}
298-
}
265+
Param(
266+
[string]$resourceGroup,
267+
[string[]]$VMs,
268+
[string]$action
269+
)
270+
271+
# Ensures you do not inherit an AzContext in your runbook
272+
Disable-AzContextAutosave -Scope Process
273+
274+
# Connect to Azure with system-assigned managed identity
275+
Connect-AzAccount -Identity
276+
277+
# set and store context
278+
$AzureContext = Set-AzContext –SubscriptionId "<SubscriptionID>"
279+
280+
# Start or stop VMs in parallel
281+
if ($action -eq "Start") {
282+
ForEach -Parallel ($vm in $VMs)
283+
{
284+
Start-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext
285+
}
286+
}
287+
elseif ($action -eq "Stop") {
288+
ForEach -Parallel ($vm in $VMs)
289+
{
290+
Stop-AzVM -Name $vm -ResourceGroupName $resourceGroup -DefaultProfile $AzureContext -Force
291+
}
292+
}
293+
else {
294+
Write-Output "`r`n Action not allowed. Please enter 'stop' or 'start'."
295+
}
296+
}
299297
```
300298
301299
1. If you want the runbook to execute with the system-assigned managed identity, leave the code as-is. If you prefer to use a user-assigned managed identity, then:
300+
302301
1. From line 9, remove `Connect-AzAccount -Identity`,
303302
1. Replace it with `Connect-AzAccount -Identity -AccountId <ClientId>`, and
304303
1. Enter the Client ID you obtained earlier.

articles/automation/update-management/enable-from-template.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services: automation
55
ms.subservice: update-management
66
ms.custom: devx-track-arm-template
77
ms.topic: conceptual
8-
ms.date: 09/18/2020
8+
ms.date: 09/18/2020
99
---
1010

1111
# Enable Update Management using Azure Resource Manager template
@@ -178,25 +178,25 @@ If you're new to Azure Automation and Azure Monitor, it's important that you und
178178
}
179179
}
180180
},
181-
{
182-
"apiVersion": "2015-11-01-preview",
183-
"location": "[parameters('location')]",
184-
"name": "[variables('Updates').name]",
185-
"type": "Microsoft.OperationsManagement/solutions",
186-
"id": "[concat('/subscriptions/', subscription().subscriptionId, '/resourceGroups/', resourceGroup().name, '/providers/Microsoft.OperationsManagement/solutions/', variables('Updates').name)]",
187-
"dependsOn": [
188-
"[concat('Microsoft.OperationalInsights/workspaces/', parameters('workspaceName'))]"
189-
],
190-
"properties": {
191-
"workspaceResourceId": "[resourceId('Microsoft.OperationalInsights/workspaces/', parameters('workspaceName'))]"
192-
},
193-
"plan": {
194-
"name": "[variables('Updates').name]",
195-
"publisher": "Microsoft",
196-
"promotionCode": "",
197-
"product": "[concat('OMSGallery/', variables('Updates').galleryName)]"
198-
}
199-
},
181+
{
182+
"apiVersion": "2015-11-01-preview",
183+
"location": "[parameters('location')]",
184+
"name": "[variables('Updates').name]",
185+
"type": "Microsoft.OperationsManagement/solutions",
186+
"id": "[concat('/subscriptions/', subscription().subscriptionId, '/resourceGroups/', resourceGroup().name, '/providers/Microsoft.OperationsManagement/solutions/', variables('Updates').name)]",
187+
"dependsOn": [
188+
"[concat('Microsoft.OperationalInsights/workspaces/', parameters('workspaceName'))]"
189+
],
190+
"properties": {
191+
"workspaceResourceId": "[resourceId('Microsoft.OperationalInsights/workspaces/', parameters('workspaceName'))]"
192+
},
193+
"plan": {
194+
"name": "[variables('Updates').name]",
195+
"publisher": "Microsoft",
196+
"promotionCode": "",
197+
"product": "[concat('OMSGallery/', variables('Updates').galleryName)]"
198+
}
199+
},
200200
{
201201
"type": "Microsoft.Automation/automationAccounts",
202202
"apiVersion": "2020-01-13-preview",

articles/azure-arc/data/includes/upgrade-rollback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ When the desired version is set to a specific version, the bootstrapper job will
2222
```
2323
1. To get a list of the containers in the pods, run
2424

25-
```console
25+
```console
2626
kubectl get pods <pod name> --namespace <namespace> -o jsonpath='{.spec.containers[*].name}*'
2727
```
2828
1. To get the logs for a container, run

articles/azure-monitor/agents/azure-monitor-agent-migration-tools.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -56,35 +56,35 @@ To install DCR Config Generator:
5656

5757
1. Run the script:
5858

59-
Option 1: Outputs **ready-to-deploy ARM template files** only, which creates the generated DCR in the specified subscription and resource group, when deployed.
60-
61-
```powershell
62-
.\WorkspaceConfigToDCRMigrationTool.ps1 -SubscriptionId $subId -ResourceGroupName $rgName -WorkspaceName $workspaceName -DCRName $dcrName -Location $location -FolderPath $folderPath
63-
```
64-
Option 2: Outputs **ready-to-deploy ARM template files** and **the DCR JSON files** separately for you to deploy via other means. You need to set the `GetDcrPayload` parameter.
65-
66-
```powershell
67-
.\WorkspaceConfigToDCRMigrationTool.ps1 -SubscriptionId $subId -ResourceGroupName $rgName -WorkspaceName $workspaceName -DCRName $dcrName -Location $location -FolderPath $folderPath -GetDcrPayload
68-
```
69-
70-
**Parameters**
71-
72-
| Parameter | Required? | Description |
73-
|------|------|------|
74-
| `SubscriptionId` | Yes | ID of the subscription that contains the target workspace. |
75-
| `ResourceGroupName` | Yes | Resource group that contains the target workspace. |
76-
| `WorkspaceName` | Yes | Name of the target workspace. |
77-
| `DCRName` | Yes | Name of the new DCR. |
78-
| `Location` | Yes | Region location for the new DCR. |
79-
| `GetDcrPayload` | No | When set, it generates additional DCR JSON files
80-
| `FolderPath` | No | Path in which to save the ARM template files and JSON files (optional). By default, Azure Monitor uses the current directory. |
81-
59+
Option 1: Outputs **ready-to-deploy ARM template files** only, which creates the generated DCR in the specified subscription and resource group, when deployed.
60+
61+
```powershell
62+
.\WorkspaceConfigToDCRMigrationTool.ps1 -SubscriptionId $subId -ResourceGroupName $rgName -WorkspaceName $workspaceName -DCRName $dcrName -Location $location -FolderPath $folderPath
63+
```
64+
Option 2: Outputs **ready-to-deploy ARM template files** and **the DCR JSON files** separately for you to deploy via other means. You need to set the `GetDcrPayload` parameter.
65+
66+
```powershell
67+
.\WorkspaceConfigToDCRMigrationTool.ps1 -SubscriptionId $subId -ResourceGroupName $rgName -WorkspaceName $workspaceName -DCRName $dcrName -Location $location -FolderPath $folderPath -GetDcrPayload
68+
```
69+
70+
**Parameters**
71+
72+
| Parameter | Required? | Description |
73+
|------|------|------|
74+
| `SubscriptionId` | Yes | ID of the subscription that contains the target workspace. |
75+
| `ResourceGroupName` | Yes | Resource group that contains the target workspace. |
76+
| `WorkspaceName` | Yes | Name of the target workspace. |
77+
| `DCRName` | Yes | Name of the new DCR. |
78+
| `Location` | Yes | Region location for the new DCR. |
79+
| `GetDcrPayload` | No | When set, it generates additional DCR JSON files
80+
| `FolderPath` | No | Path in which to save the ARM template files and JSON files (optional). By default, Azure Monitor uses the current directory. |
81+
8282
1. Review the output ARM template files. The script can produce two types of ARM template files, depending on the agent configuration in the target workspace:
8383
84-
- Windows ARM template and parameter files - if the target workspace contains Windows performance counters or Windows events.
85-
- Linux ARM template and parameter files - if the target workspace contains Linux performance counters or Linux Syslog events.
86-
87-
If the Log Analytics workspace wasn't [configured to collect data](./log-analytics-agent.md#data-collected) from connected agents, the generated files will be empty. This is a scenario in which the agent was connected to a Log Analytics workspace, but wasn't configured to send any data from the host machine.
84+
- Windows ARM template and parameter files - if the target workspace contains Windows performance counters or Windows events.
85+
- Linux ARM template and parameter files - if the target workspace contains Linux performance counters or Linux Syslog events.
86+
87+
If the Log Analytics workspace wasn't [configured to collect data](./log-analytics-agent.md#data-collected) from connected agents, the generated files will be empty. This is a scenario in which the agent was connected to a Log Analytics workspace, but wasn't configured to send any data from the host machine.
8888
8989
1. Deploy the generated ARM templates:
9090

articles/azure-monitor/agents/azure-monitor-agent-troubleshoot-linux-vm-rsyslog.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Overview of Azure Monitor Agent for Linux Syslog collection and supported RFC st
1919
- Azure Monitor Agent ingests Syslog events via the previously mentioned socket and filters them based on facility or severity combination from data collection rule (DCR) configuration in `/etc/opt/microsoft/azuremonitoragent/config-cache/configchunks/`. Any `facility` or `severity` not present in the DCR is dropped.
2020
- Azure Monitor Agent attempts to parse events in accordance with **RFC3164** and **RFC5424**. It also knows how to parse the message formats listed on [this website](./azure-monitor-agent-overview.md#data-sources-and-destinations).
2121
- Azure Monitor Agent identifies the destination endpoint for Syslog events from the DCR configuration and attempts to upload the events.
22-
> [!NOTE]
23-
> Azure Monitor Agent uses local persistency by default. All events received from `rsyslog` or `syslog-ng` are queued in `/var/opt/microsoft/azuremonitoragent/events` if they fail to be uploaded.
22+
> [!NOTE]
23+
> Azure Monitor Agent uses local persistency by default. All events received from `rsyslog` or `syslog-ng` are queued in `/var/opt/microsoft/azuremonitoragent/events` if they fail to be uploaded.
2424
2525
## Issues
2626

@@ -92,15 +92,15 @@ If you're sending a high log volume through rsyslog and your system is set up to
9292

9393
1. For example, to remove `local4` events from being logged at `/var/log/syslog` or `/var/log/messages`, change this line in `/etc/rsyslog.d/50-default.conf` from this snippet:
9494

95-
```config
96-
*.*;auth,authpriv.none -/var/log/syslog
97-
```
95+
```config
96+
*.*;auth,authpriv.none -/var/log/syslog
97+
```
9898
99-
To this snippet (add `local4.none;`):
99+
To this snippet (add `local4.none;`):
100100
101-
```config
102-
*.*;local4.none;auth,authpriv.none -/var/log/syslog
103-
```
101+
```config
102+
*.*;local4.none;auth,authpriv.none -/var/log/syslog
103+
```
104104
105105
1. `sudo systemctl restart rsyslog`
106106

0 commit comments

Comments
 (0)