Skip to content

Commit f4aca37

Browse files
authored
Merge pull request #102970 from BethWilke/task1665808d
Fixing typos
2 parents 09b8347 + 2b197ba commit f4aca37

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

articles/automation/troubleshoot/runbooks.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ When you have errors executing runbooks in Azure Automation, you can use the fol
2424

2525
2. **Investigate runbook** [error streams](https://docs.microsoft.com/azure/automation/automation-runbook-output-and-messages#runbook-output) for specific messages and compare them to the errors below.
2626

27-
3. **Ensure your Nodes and Automation workspace have the required modules:** If your runbook imports any modules, ensure they are available to your Automation account using the steps listed in [Import Modules](../shared-resources/modules.md#import-modules). Update your modules to the latest version by following the instructions at [Update Azure modules in Azure Automation](..//automation-update-azure-modules.md). For more troubleshooting information, see [Troubleshoot Modules](shared-resources.md#modules).
27+
3. **Ensure your Nodes and Automation workspace have the required modules:** If your runbook imports any modules, ensure they are available to your Automation Account using the steps listed in [Import Modules](../shared-resources/modules.md#import-modules). Update your modules to the latest version by following the instructions at [Update Azure modules in Azure Automation](..//automation-update-azure-modules.md). For more troubleshooting information, see [Troubleshoot Modules](shared-resources.md#modules).
2828

2929
If your Runbook is suspended or unexpectedly failed:
3030

@@ -44,7 +44,7 @@ Run Login-AzureRMAccount to login.
4444

4545
### Cause
4646

47-
This error can occur when you are not using a RunAs account or the RunAs account has expired. See [Manage Azure Automation RunAs accounts](https://docs.microsoft.com/azure/automation/manage-runas-account).
47+
This error can occur when you are not using a Run As account or the Run As account has expired. See [Manage Azure Automation Run As accounts](https://docs.microsoft.com/azure/automation/manage-runas-account).
4848

4949
This error has two primary causes:
5050

@@ -57,7 +57,7 @@ If you receive this error after updating one AzureRM module, you should update a
5757

5858
If you're trying to access resources in another subscription, you can follow the steps below to configure permissions.
5959

60-
1. Go to the Automation RunAs account and copy the Application ID and thumbprint.
60+
1. Go to the Automation Run As account and copy the Application ID and thumbprint.
6161
![Copy Application ID and Thumbprint](../media/troubleshoot-runbooks/collect-app-id.png)
6262
1. Go to the subscription's Access Control where the Automation Account is NOT hosted, and add a new role assignment.
6363
![Access control](../media/troubleshoot-runbooks/access-control.png)
@@ -203,7 +203,7 @@ When working with multiple subscriptions, the subscription context might be lost
203203
# Ensures that any credentials apply only to the execution of this runbook
204204
Disable-AzureRmContextAutosave –Scope Process
205205
206-
# Connect to Azure with RunAs account
206+
# Connect to Azure with Run As account
207207
$ServicePrincipalConnection = Get-AutomationConnection -Name 'AzureRunAsConnection'
208208
209209
Add-AzureRmAccount `
@@ -238,24 +238,24 @@ The term 'Connect-AzureRmAccount' is not recognized as the name of a cmdlet, fun
238238

239239
### Cause
240240

241-
This error can happen based on one the following reasons:
241+
This error can happen because of the following reasons:
242242

243-
* The module containing the cmdlet isn't imported into the automation account
244-
* The module containing the cmdlet is imported but is out of date
243+
* The module containing the cmdlet isn't imported into the Automation Account.
244+
* The module containing the cmdlet is imported but is out of date.
245245

246246
### Resolution
247247

248248
This error can be resolved by completing one of the following tasks:
249249

250-
If the module is an Azure module, see [How to update Azure PowerShell modules in Azure Automation](../automation-update-azure-modules.md) to learn how to update your modules in your automation account.
250+
If the module is an Azure module, see [How to update Azure PowerShell modules in Azure Automation](../automation-update-azure-modules.md) to learn how to update your modules in your Automation Account.
251251

252252
If it's a separate module, make sure the module in imported in your Automation Account.
253253

254-
## <a name="job-attempted-3-times"></a>Scenario: The runbook job start was attempted three times, but it failed to start each time
254+
## <a name="job-attempted-3-times"></a>Scenario: The runbook job start was attempted three times, but failed to start each time
255255

256256
### Issue
257257

258-
Your runbook fails with the error:
258+
Your runbook fails with the following error.
259259

260260
```error
261261
The job was tried three times but it failed
@@ -265,7 +265,7 @@ The job was tried three times but it failed
265265

266266
This error occurs due to one of the following issues.
267267

268-
* Memory Limit. The documented limits on memory allocated to a sandbox are found at [Automation service limits](../../azure-resource-manager/management/azure-subscription-service-limits.md#automation-limits). A job may fail if it's using more than 400 MB of memory.
268+
* Memory Limit. A job might fail if it's using more than 400 MB of memory. The documented limits on memory allocated to a sandbox are found at [Automation service limits](../../azure-resource-manager/management/azure-subscription-service-limits.md#automation-limits).
269269

270270
* Network Sockets. Azure sandboxes are limited to 1000 concurrent network sockets. See [Automation service limits](../../azure-resource-manager/management/azure-subscription-service-limits.md#automation-limits).
271271

@@ -277,17 +277,17 @@ This error occurs due to one of the following issues.
277277

278278
### Resolution
279279

280-
* Memory Limit, Network Sockets. Suggested ways work within the memory limit are to split the workload among multiple runbooks, process less data in memory, avoid writing unnecessary output from your runbooks, and consider how many checkpoints are written into your PowerShell Workflow runbooks. You can use the clear method, such as `$myVar.clear`, to clear out variables and use `[GC]::Collect` to run garbage collection immediately. These actions reduce the memory footprint of your runbook during runtime.
280+
* Memory Limit, Network Sockets. Suggested ways to work within the memory limits are to split the workload among multiple runbooks, process less data in memory, avoid writing unnecessary output from your runbooks, and consider how many checkpoints are written into your PowerShell workflow runbooks. Use the clear method, such as `$myVar.clear`, to clear out variables and use `[GC]::Collect` to run garbage collection immediately. These actions reduce the memory footprint of your runbook during runtime.
281281

282282
* Module Incompatible. Update your Azure modules by following the steps in [How to update Azure PowerShell modules in Azure Automation](../automation-update-azure-modules.md).
283283

284-
* No Authentication with ADAL for Sandbox. When authenticating to Azure AD with a runbook, ensure that the Azure AD module is available in your Automation account. Be sure to grant the Automation RunAs account the necessary permissions to perform the tasks that the runbook automates.
284+
* No Authentication with ADAL for Sandbox. When authenticating to Azure AD with a runbook, ensure that the Azure AD module is available in your Automation Account. Be sure to grant the Run As account the necessary permissions to perform the tasks that the runbook automates.
285285

286286
If your runbook can't call an executable or subprocess running in an Azure sandbox, use the runbook on a [Hybrid Runbook Worker](../automation-hrw-run-runbooks.md). Hybrid workers aren't limited by the memory and network limits that Azure sandboxes have.
287287

288-
* Too Much Exception Data. There is a 1-MB limit on the job output stream. Ensure that your runbook encloses calls to an executable or subprocess in a try/catch block. If the operations throw an exception, have the code write the message from the exception into an Automation variable. This technique prevents the message from being written into the job output stream.
288+
* Too Much Exception Data. There is a 1MB limit on the job output stream. Ensure that your runbook encloses calls to an executable or subprocess in a try/catch block. If the operations throw an exception, have the code write the message from the exception into an Automation variable. This technique prevents the message from being written into the job output stream.
289289

290-
## <a name="sign-in-failed"></a>Scenario: Sign in to Azure Account failed
290+
## <a name="sign-in-failed"></a>Scenario: Sign-in to Azure Account failed
291291

292292
### Issue
293293

@@ -346,7 +346,7 @@ To determine what's wrong, take the following steps:
346346
}
347347
```
348348

349-
## <a name="child-runbook-object"></a>Object reference not set to an instance of object
349+
## <a name="child-runbook-object"></a>Scenario: Object reference not set to an instance of an object
350350

351351
### Issue
352352

@@ -358,7 +358,7 @@ Object reference not set to an instance of an object
358358

359359
### Cause
360360

361-
There is a known issue where the Start-AzureRmAutomationRunbook does not handles the output stream correctly if it contains objects.
361+
There is a known issue where the Start-AzureRmAutomationRunbook does not handle the output stream correctly if it contains objects.
362362

363363
### Resolution
364364

@@ -410,7 +410,7 @@ Any of the following three solutions fix this problem:
410410
* Pass the name or value that you need from the complex object instead of passing the entire object.
411411
* Use a PowerShell runbook instead of a PowerShell Workflow runbook.
412412

413-
## <a name="quota-exceeded"></a>Scenario: Runbook job failed because the allocated quota exceeded
413+
## <a name="quota-exceeded"></a>Scenario: Runbook job fails because allocated quota exceeded
414414

415415
### Issue
416416

@@ -428,9 +428,9 @@ This error occurs when the job execution exceeds the 500-minute free quota for y
428428

429429
If you want to use more than 500 minutes of processing per month, you need to change your subscription from the Free tier to the Basic tier. You can upgrade to the Basic tier by taking the following steps:
430430

431-
1. Sign in to your Azure subscription
432-
2. Select the Automation account you wish to upgrade
433-
3. Click **Settings** > **Pricing**.
431+
1. Sign in to your Azure subscription.
432+
2. Select the Automation Account to upgrade.
433+
3. Click **Settings**, then **Pricing**.
434434
4. Click **Enable** on page bottom to upgrade your account to the **Basic** tier.
435435

436436
## <a name="cmdlet-not-recognized"></a>Scenario: Cmdlet not recognized when executing a runbook
@@ -452,11 +452,11 @@ This error is caused when the PowerShell engine can't find the cmdlet you're usi
452452
Any of the following solutions fix the problem:
453453

454454
* Check that you've entered the cmdlet name correctly.
455-
* Make sure the cmdlet exists in your Automation account and that there are no conflicts. To verify if the cmdlet is present, open a runbook in edit mode and search for the cmdlet you want to find in the library or run `Get-Command <CommandName>`. Once you've validated that the cmdlet is available to the account, and that there are no name conflicts with other cmdlets or runbooks, add it to the canvas and make sure that you're using a valid parameter set in your runbook.
455+
* Make sure the cmdlet exists in your Automation Account and that there are no conflicts. To verify if the cmdlet is present, open a runbook in edit mode and search for the cmdlet you want to find in the library or run `Get-Command <CommandName>`. Once you've validated that the cmdlet is available to the account, and that there are no name conflicts with other cmdlets or runbooks, add it to the canvas and make sure that you're using a valid parameter set in your runbook.
456456
* If you do have a name conflict and the cmdlet is available in two different modules, you can resolve this issue by using the fully qualified name for the cmdlet. For example, you can use **ModuleName\CmdletName**.
457457
* If you're executing the runbook on-premises in a hybrid worker group, then make sure that the module and cmdlet is installed on the machine that hosts the hybrid worker.
458458

459-
## <a name="long-running-runbook"></a>Scenario: A long running runbook fails to complete
459+
## <a name="long-running-runbook"></a>Scenario: A long-running runbook fails to complete
460460

461461
### Issue
462462

@@ -558,33 +558,33 @@ If you are running jobs using a hybrid worker instead of in Azure Automation, yo
558558

559559
## Runbook fails with "No permission" or some variation
560560

561-
RunAs accounts may not have the same permissions against Azure resources as your current account. Ensure your RunAs account [has permissions to access any resources](https://docs.microsoft.com/azure/role-based-access-control/role-assignments-portal) used in your script.
561+
Run As accounts might not have the same permissions against Azure resources as your current account. Ensure that your Run As account has [permissions to access any resources](https://docs.microsoft.com/azure/role-based-access-control/role-assignments-portal) used in your script.
562562

563563
## Runbooks were working, but suddenly stopped
564564

565-
* If runbooks were previously executing but stopped, [ensure the RunAs account has not expired](https://docs.microsoft.com/azure/automation/manage-runas-account#cert-renewal).
566-
* If you are using webhooks to start runbooks, [ensure the webhook has not expired](https://docs.microsoft.com/azure/automation/automation-webhooks#renew-webhook).
565+
* If runbooks were previously executing but stopped, ensure that the [Run As account](https://docs.microsoft.com/azure/automation/manage-runas-account#cert-renewal) has not expired.
566+
* If you are using webhooks to start runbooks, ensure that a [webhook](https://docs.microsoft.com/azure/automation/automation-webhooks#renew-webhook) has not expired.
567567

568-
## Issues Passing parameters into webhooks
568+
## Issues passing parameters into webhooks
569569

570570
For help with passing parameters into webhooks, see [Start a runbook from a webhook](https://docs.microsoft.com/azure/automation/automation-webhooks#parameters).
571571

572-
## Issues Using Az modules
572+
## Issues using Az modules
573573

574-
Using Az modules and AzureRM modules in the same Automation Account is not supported. Please see [Az modules in runbooks](https://docs.microsoft.com/azure/automation/az-modules) for more details.
574+
Using Az modules and AzureRM modules in the same Automation Account is not supported. For more information, see [Az modules in runbooks](https://docs.microsoft.com/azure/automation/az-modules) for more details.
575575

576576
## Inconsistent behavior in runbooks
577577

578-
Follow the guidance in [Runbook Execution](https://docs.microsoft.com/azure/automation/automation-runbook-execution#runbook-behavior) to avoid issues with concurrent jobs, resources getting created multiple times, or other timing-sensitive logic in runbooks.
578+
Follow the guidance in [Runbook execution](https://docs.microsoft.com/azure/automation/automation-runbook-execution#runbook-behavior) to avoid issues with concurrent jobs, resources getting created multiple times, or other timing-sensitive logic in runbooks.
579579

580-
## Runbook fails with the errors: No permission, Forbidden, 403, or some variation
580+
## Runbook fails with the error No permission, Forbidden (403), or some variation
581581

582-
RunAs accounts may not have the same permissions against Azure resources as your current account. Ensure your RunAs account has [permissions to access any resources](https://docs.microsoft.com/azure/role-based-access-control/role-assignments-portal) used in your script.
582+
Run As accounts might not have the same permissions against Azure resources as your current account. Ensure that your Run As account has [permissions to access any resources](https://docs.microsoft.com/azure/role-based-access-control/role-assignments-portal) used in your script.
583583

584584
## Runbooks were working, but suddenly stopped
585585

586-
* If runbooks were previously executing but stopped, ensure that the RunAs account [has not expired](https://docs.microsoft.com/azure/automation/manage-runas-account#cert-renewal).
587-
* If you are using webhooks to start runbooks, ensure the webhook [has not expired](https://docs.microsoft.com/azure/automation/automation-webhooks#renew-webhook).
586+
* If runbooks were previously executing but stopped, ensure that the Run As account has not expired. See [certification renewal](https://docs.microsoft.com/azure/automation/manage-runas-account#cert-renewal).
587+
* If you are using webhooks to start runbooks, ensure that the webhook [has not expired](https://docs.microsoft.com/azure/automation/automation-webhooks#renew-webhook).
588588

589589
## Passing parameters into webhooks
590590

@@ -594,14 +594,14 @@ For help with passing parameters into webhooks, see [Start a runbook from a webh
594594

595595
Using Az modules and AzureRM modules in the same Automation Account is not supported. See [Az modules in runbooks](https://docs.microsoft.com/azure/automation/az-modules).
596596

597-
## Using Self-Signed Certificates
597+
## Using self-signed certificates
598598

599-
To use Self-Signed certificates, see [Creating a New Certificate](https://docs.microsoft.com/azure/automation/shared-resources/certificates#creating-a-new-certificate).
599+
To use Self-Signed certificates, see [Creating a new certificate](https://docs.microsoft.com/azure/automation/shared-resources/certificates#creating-a-new-certificate).
600600

601601
## Recommended Documents
602602

603-
* [Starting a Runbook in Azure Automation](https://docs.microsoft.com/azure/automation/automation-starting-a-runbook)
604-
* [Runbook Execution in Azure Automation](https://docs.microsoft.com/azure/automation/automation-runbook-execution)
603+
* [Starting a runbook in Azure Automation](https://docs.microsoft.com/azure/automation/automation-starting-a-runbook)
604+
* [Runbook execution in Azure Automation](https://docs.microsoft.com/azure/automation/automation-runbook-execution)
605605

606606
## Next steps
607607

0 commit comments

Comments
 (0)