Skip to content

Commit 2fc5c5c

Browse files
Merge pull request #111632 from BethWilke/branch120
Fixing documentation task 1707215
2 parents 37a17f8 + 51540ab commit 2fc5c5c

10 files changed

+79
-76
lines changed

articles/automation/automation-onboard-solutions-from-browse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ When onboarding multiple machines, there may be machines that show as `Cannot en
107107

108108
**Cause**: This error shows that the VM that you are trying to onboard reports to another workspace.
109109

110-
**Solution**: Click **Use as configuration** to change the targeted Automation Account and Log Analytics workspace.
110+
**Solution**: Click **Use as configuration** to change the targeted Automation account and Log Analytics workspace.
111111

112112
### VM reports to a workspace that is not available in this subscription
113113

articles/automation/automation-onboard-solutions-from-vm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ First, enable one or all three of the solutions on your VM:
2121

2222
1. In the [Azure portal](https://portal.azure.com), select **Virtual machines** or search for and select **Virtual machines** from the Home page.
2323
2. Select the VM for which you want to enable a solution.
24-
3. On the VM page, under **Operations**, select **Update management**, **Inventory**, or **Change tracking**. The virtual machine can exist in any region, no matter the location of your Automation account. When onboarding a solution from a VM, you need to have the `Microsoft.OperationalInsights/workspaces/read` permission to determine if the VM is onboarded to a workspace. To learn about additional permissions that are required, see [permissions needed to onboard machines](automation-role-based-access-control.md#onboarding). To learn how to onboard multiple machines at once, see [Onboard Update Management, Change Tracking, and Inventory solutions](automation-onboard-solutions-from-automation-account.md).
24+
3. On the VM page, under **Operations**, select **Update management**, **Inventory**, or **Change tracking**. The virtual machine can exist in any region, no matter the location of your Automation account. When onboarding a solution from a VM, you need to have the `Microsoft.OperationalInsights/workspaces/read` permission to determine if the VM is onboarded to a workspace. To learn about additional permissions that are required, see [permissions needed to onboard machines](automation-role-based-access-control.md#onboarding-permissions). To learn how to onboard multiple machines at once, see [Onboard Update Management, Change Tracking, and Inventory solutions](automation-onboard-solutions-from-automation-account.md).
2525

2626
4. Select the Azure Log Analytics workspace and Automation account, and then click **Enable** to enable the solution. The solution takes up to 15 minutes to enable.
2727

articles/automation/automation-quickstart-create-account.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This quickstart guides you in creating an Automation account and running a runbo
2525
> [!NOTE]
2626
> You can't change the account name once it has been entered in the user interface.
2727
28-
2. Click the **Create a resource** button found on the upper left corner of Azure portal.
28+
2. Click the **Create a resource** button found in the upper left corner of Azure portal.
2929

3030
3. Select **IT & Management Tools**, and then select **Automation**.
3131

@@ -46,19 +46,19 @@ This quickstart guides you in creating an Automation account and running a runbo
4646

4747
Run one of the tutorial runbooks.
4848

49-
1. Click **Runbooks** under **PROCESS AUTOMATION**. The list of runbooks is displayed. By default several tutorial runbooks are enabled in the account.
49+
1. Click **Runbooks** under **Process Automation**. The list of runbooks is displayed. By default, several tutorial runbooks are enabled in the account.
5050

5151
![Automation account runbooks list](./media/automation-quickstart-create-account/automation-runbooks-overview.png)
5252

5353
1. Select the **AzureAutomationTutorialScript** runbook. This action opens the runbook overview page.
5454

5555
![Runbook overview](./media/automation-quickstart-create-account/automation-tutorial-script-runbook-overview.png)
5656

57-
1. Click **Start**, and on the **Start Runbook** page, click **OK** to start the runbook.
57+
1. Click **Start**, and on the Start Runbook page, click **OK** to start the runbook.
5858

5959
![Runbook job page](./media/automation-quickstart-create-account/automation-tutorial-script-job.png)
6060

61-
1. After the **Job status** becomes **Running**, click **Output** or **All Logs** to view the runbook job output. For this tutorial runbook, the output is a list of your Azure resources.
61+
1. After the job status becomes `Running`, click **Output** or **All Logs** to view the runbook job output. For this tutorial runbook, the output is a list of your Azure resources.
6262

6363
## Next steps
6464

articles/automation/automation-quickstart-create-runbook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you don't have an Azure subscription, create a [free Azure account](https://a
1818

1919
Sign in to Azure at https://portal.azure.com.
2020

21-
## Create runbook
21+
## Create the runbook
2222

2323
First, create a runbook. The sample runbook created in this quickstart outputs `Hello World` by default.
2424

@@ -80,7 +80,7 @@ Once the runbook is published, the overview page is shown.
8080

8181
![Runbook test job](./media/automation-quickstart-create-runbook/automation-job-page.png)
8282

83-
1. When the **Job status** is set to **Running** or **Completed**, click **Output** to open the Output pane and view the runbook output.
83+
1. When the job status is `Running` or `Completed`, click **Output** to open the Output pane and view the runbook output.
8484

8585
![Runbook test job](./media/automation-quickstart-create-runbook/automation-hello-world-runbook-job-output.png)
8686

articles/automation/automation-role-based-access-control.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ ms.topic: conceptual
1111

1212
Role-based access control (RBAC) enables access management for Azure resources. Using [RBAC](../role-based-access-control/overview.md), you can segregate duties within your team and grant only the amount of access to users, groups, and applications that they need to perform their jobs. You can grant role-based access to users using the Azure portal, Azure Command-Line tools, or Azure Management APIs.
1313

14+
>[!NOTE]
15+
>This article has been updated to use the new Azure PowerShell Az module. You can still use the AzureRM module, which will continue to receive bug fixes until at least December 2020. To learn more about the new Az module and AzureRM compatibility, see [Introducing the new Azure PowerShell Az module](https://docs.microsoft.com/powershell/azure/new-azureps-module-az?view=azps-3.5.0). For Az module installation instructions on your Hybrid Runbook Worker, see [Install the Azure PowerShell Module](https://docs.microsoft.com/powershell/azure/install-az-ps?view=azps-3.5.0). For your Automation account, you can update your modules to the latest version using [How to update Azure PowerShell modules in Azure Automation](automation-update-azure-modules.md).
16+
1417
## Roles in Automation accounts
1518

1619
In Azure Automation, access is granted by assigning the appropriate RBAC role to users, groups, and applications at the Automation account scope. Following are the built-in roles supported by an Automation account:
@@ -198,11 +201,11 @@ A User Access Administrator can manage user access to Azure resources. The follo
198201
|Microsoft.Authorization/*|Manage authorization|
199202
|Microsoft.Support/*|Create and manage support tickets|
200203

201-
## Onboarding
204+
## Onboarding permissions
202205

203-
The following tables show the minimum required permissions needed for onboarding virtual machines for the change tracking or update management solutions.
206+
The following sections describe the minimum required permissions needed for onboarding virtual machines for the change tracking or update management solutions.
204207

205-
### Onboarding from a virtual machine
208+
### Permissions for onboarding from a VM
206209

207210
|**Action** |**Permission** |**Minimum scope** |
208211
|---------|---------|---------|
@@ -224,7 +227,7 @@ The following tables show the minimum required permissions needed for onboarding
224227

225228
<sup>1</sup> This permission is needed to onboard through the VM portal experience.
226229

227-
### Onboarding from Automation account
230+
### Permissions for onboarding from Automation account
228231

229232
|**Action** |**Permission** |**Minimum Scope** |
230233
|---------|---------|---------|
@@ -244,7 +247,7 @@ The following tables show the minimum required permissions needed for onboarding
244247
|Create / edit saved search | Microsoft.OperationalInsights/workspaces/write | Workspace |
245248
|Create / edit scope config | Microsoft.OperationalInsights/workspaces/write | Workspace|
246249

247-
## Update management
250+
## Update management permissions
248251

249252
Update management reaches across multiple services to provide its service. The following table shows the permissions needed to manage update management deployments:
250253

@@ -259,12 +262,12 @@ Update management reaches across multiple services to provide its service. The f
259262

260263
## Configure RBAC for your Automation account
261264

262-
The following section shows you how to configure RBAC on your Automation account through the [portal](#configure-rbac-using-the-azure-portal) and [PowerShell](#configure-rbac-using-powershell).
265+
The following section shows you how to configure RBAC on your Automation account through the [Azure portal](#configure-rbac-using-the-azure-portal) and [PowerShell](#configure-rbac-using-powershell).
263266

264267
### Configure RBAC using the Azure portal
265268

266269
1. Log in to the [Azure portal](https://portal.azure.com/) and open your Automation account from the Automation Accounts page.
267-
2. Click on the **Access control (IAM)** control at the top left corner to open the Access control (IAM) page. You can use this page to add new users, groups, and applications to manage your Automation account and view existing roles that are configurable for the Automation account.
270+
2. Click on **Access control (IAM)** to open the Access control (IAM) page. You can use this page to add new users, groups, and applications to manage your Automation account and view existing roles that are configurable for the Automation account.
268271
3. Click the **Role assignments** tab.
269272

270273
![Access button](media/automation-role-based-access-control/automation-01-access-button.png)
@@ -275,7 +278,7 @@ The following section shows you how to configure RBAC on your Automation account
275278

276279
2. Select a role from the list of available roles. You can choose any of the available built-in roles that an Automation account supports or any custom role you may have defined.
277280

278-
3. Type the username of the user that you want to give permissions to in the **Select** field. Choose the user from the list and click **Save**.
281+
3. Type the name of the user that you want to give permissions to in the **Select** field. Choose the user from the list and click **Save**.
279282

280283
![Add users](media/automation-role-based-access-control/automation-04-add-users.png)
281284

@@ -305,10 +308,10 @@ You can remove the access permission for a user who is not managing the Automati
305308

306309
You can also configure role-based access to an Automation account using the following [Azure PowerShell cmdlets](../role-based-access-control/role-assignments-powershell.md):
307310

308-
[Get-AzureRmRoleDefinition](/previous-versions/azure/mt603792(v=azure.100)) lists all RBAC roles that are available in Azure Active Directory. You can use this cmdlet with the *Name* parameter to list all the actions that a specific role can perform.
311+
[Get-AzRoleDefinition](https://docs.microsoft.com/powershell/module/Az.Resources/Get-AzRoleDefinition?view=azps-3.7.0) lists all RBAC roles that are available in Azure Active Directory. You can use this cmdlet with the `Name` parameter to list all the actions that a specific role can perform.
309312

310313
```azurepowershell-interactive
311-
Get-AzureRmRoleDefinition -Name 'Automation Operator'
314+
Get-AzRoleDefinition -Name 'Automation Operator'
312315
```
313316

314317
The following is the example output:
@@ -324,12 +327,12 @@ NotActions : {}
324327
AssignableScopes : {/}
325328
```
326329

327-
[Get-AzureRmRoleAssignment](/previous-versions/azure/mt619413(v=azure.100)) lists Azure AD RBAC role assignments at the specified scope. Without any parameters, this cmdlet returns all the role assignments made under the subscription. Use the *ExpandPrincipalGroups* parameter to list access assignments for the specified user, as well as the groups that the user belongs to.
330+
[Get-AzRoleAssignment](https://docs.microsoft.com/powershell/module/az.resources/get-azroleassignment?view=azps-3.7.0) lists Azure AD RBAC role assignments at the specified scope. Without any parameters, this cmdlet returns all the role assignments made under the subscription. Use the `ExpandPrincipalGroups` parameter to list access assignments for the specified user, as well as the groups that the user belongs to.
328331

329332
**Example:** Use the following cmdlet to list all the users and their roles within an Automation account.
330333

331334
```azurepowershell-interactive
332-
Get-AzureRMRoleAssignment -scope '/subscriptions/<SubscriptionID>/resourcegroups/<Resource Group Name>/Providers/Microsoft.Automation/automationAccounts/<Automation account name>'
335+
Get-AzRoleAssignment -Scope '/subscriptions/<SubscriptionID>/resourcegroups/<Resource Group Name>/Providers/Microsoft.Automation/automationAccounts/<Automation account name>'
333336
```
334337

335338
The following is the example output:
@@ -346,12 +349,12 @@ ObjectId : 15f26a47-812d-489a-8197-3d4853558347
346349
ObjectType : User
347350
```
348351

349-
Use [New-AzureRmRoleAssignment](/previous-versions/azure/mt603580(v=azure.100)) to assign access to users, groups, and applications to a particular scope.
352+
Use [New-AzRoleAssignment](https://docs.microsoft.com/powershell/module/Az.Resources/New-AzRoleAssignment?view=azps-3.7.0) to assign access to users, groups, and applications to a particular scope.
350353

351354
**Example:** Use the following command to assign the "Automation Operator" role for a user in the Automation account scope.
352355

353356
```azurepowershell-interactive
354-
New-AzureRmRoleAssignment -SignInName <sign-in Id of a user you wish to grant access> -RoleDefinitionName 'Automation operator' -Scope '/subscriptions/<SubscriptionID>/resourcegroups/<Resource Group Name>/Providers/Microsoft.Automation/automationAccounts/<Automation account name>'
357+
New-AzRoleAssignment -SignInName <sign-in Id of a user you wish to grant access> -RoleDefinitionName 'Automation operator' -Scope '/subscriptions/<SubscriptionID>/resourcegroups/<Resource Group Name>/Providers/Microsoft.Automation/automationAccounts/<Automation account name>'
355358
```
356359

357360
The following is the example output:
@@ -368,25 +371,25 @@ ObjectId : f5ecbe87-1181-43d2-88d5-a8f5e9d8014e
368371
ObjectType : User
369372
```
370373

371-
Use [Remove-AzureRmRoleAssignment](/previous-versions/azure/mt603781(v=azure.100)) to remove access of a specified user, group, or application from a particular scope.
374+
Use [Remove-AzRoleAssignment](https://docs.microsoft.com/powershell/module/Az.Resources/Remove-AzRoleAssignment?view=azps-3.7.0) to remove access of a specified user, group, or application from a particular scope.
372375

373-
**Example:** Use the following command to remove the user from the Automation Operator role in the Automation account scope.
376+
**Example:** Use the following command to remove the user from the Automation Operator role in the Automation account scope.
374377

375378
```azurepowershell-interactive
376-
Remove-AzureRmRoleAssignment -SignInName <sign-in Id of a user you wish to remove> -RoleDefinitionName 'Automation Operator' -Scope '/subscriptions/<SubscriptionID>/resourcegroups/<Resource Group Name>/Providers/Microsoft.Automation/automationAccounts/<Automation account name>'
379+
Remove-AzRoleAssignment -SignInName <sign-in Id of a user you wish to remove> -RoleDefinitionName 'Automation Operator' -Scope '/subscriptions/<SubscriptionID>/resourcegroups/<Resource Group Name>/Providers/Microsoft.Automation/automationAccounts/<Automation account name>'
377380
```
378381

379-
In the preceding examples, replace "sign-in ID of a user you wish to remove", "SubscriptionID", "Resource Group Name", and Automation account name" with your account details. Choose **yes** when prompted to confirm before continuing to remove user role assignments.
382+
In the preceding example, replace `sign-in ID of a user you wish to remove`, `SubscriptionID`, `Resource Group Name`, and `Automation account name` with your account details. Choose **yes** when prompted to confirm before continuing to remove user role assignments.
380383

381-
### User experience for Automation operator role - Automation account
384+
### User experience for Automation Operator role - Automation account
382385

383386
When a user assigned to the Automation Operator role on the Automation account scope views the Automation account to which he/she is assigned, the user can only view the list of runbooks, runbook jobs, and schedules created in the Automation account. This user cannot view the definitions of these items. The user can start, stop, suspend, resume, or schedule the runbook job. However, the user does not have access to other Automation resources, such as configurations, hybrid worker groups, or DSC nodes.
384387

385388
![No access to resources](media/automation-role-based-access-control/automation-10-no-access-to-resources.png)
386389

387390
## Configure RBAC for runbooks
388391

389-
Azure Automation allows you to assign RBAC to specific runbooks. To do this, run the following script to add a user to a specific runbook. An Automation Account Admin or a Tenant Admin can run this script.
392+
Azure Automation allows you to assign RBAC to specific runbooks. To do this, run the following script to add a user to a specific runbook. An Automation Account Administrator or a Tenant Administrator can run this script.
390393

391394
```azurepowershell-interactive
392395
$rgName = "<Resource Group Name>" # Resource Group name for the Automation account
@@ -395,19 +398,19 @@ $rbName = "<Name of Runbook>" # Name of the runbook
395398
$userId = "<User ObjectId>" # Azure Active Directory (AAD) user's ObjectId from the directory
396399
397400
# Gets the Automation account resource
398-
$aa = Get-AzureRmResource -ResourceGroupName $rgName -ResourceType "Microsoft.Automation/automationAccounts" -ResourceName $automationAccountName
401+
$aa = Get-AzResource -ResourceGroupName $rgName -ResourceType "Microsoft.Automation/automationAccounts" -ResourceName $automationAccountName
399402
400403
# Get the Runbook resource
401-
$rb = Get-AzureRmResource -ResourceGroupName $rgName -ResourceType "Microsoft.Automation/automationAccounts/runbooks" -ResourceName "$automationAccountName/$rbName"
404+
$rb = Get-AzResource -ResourceGroupName $rgName -ResourceType "Microsoft.Automation/automationAccounts/runbooks" -ResourceName "$automationAccountName/$rbName"
402405
403406
# The Automation Job Operator role only needs to be run once per user.
404-
New-AzureRmRoleAssignment -ObjectId $userId -RoleDefinitionName "Automation Job Operator" -Scope $aa.ResourceId
407+
New-AzRoleAssignment -ObjectId $userId -RoleDefinitionName "Automation Job Operator" -Scope $aa.ResourceId
405408
406409
# Adds the user to the Automation Runbook Operator role to the Runbook scope
407-
New-AzureRmRoleAssignment -ObjectId $userId -RoleDefinitionName "Automation Runbook Operator" -Scope $rb.ResourceId
410+
New-AzRoleAssignment -ObjectId $userId -RoleDefinitionName "Automation Runbook Operator" -Scope $rb.ResourceId
408411
```
409412

410-
Once the script has run, have the user log in to the Azure portal and view **All Resources**. In the list, the user can see the runbook for which he/she has been added as an Automation Runbook Operator.
413+
Once the script has run, have the user log in to the Azure portal and select **All Resources**. In the list, the user can see the runbook for which he/she has been added as an Automation Runbook Operator.
411414

412415
![Runbook RBAC in the portal](./media/automation-role-based-access-control/runbook-rbac.png)
413416

0 commit comments

Comments
 (0)