Skip to content

Commit f2930ab

Browse files
authored
Merge pull request #113517 from ttorble/automation-create-account-template
edit pass: automation-create-account-template
2 parents 36e2357 + c89f928 commit f2930ab

File tree

1 file changed

+37
-33
lines changed

1 file changed

+37
-33
lines changed

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

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Use Azure Resource Manager templates to create Automation account | Microsoft Docs
2+
title: Use Azure Resource Manager templates to create an Automation account | Microsoft Docs
33
description: You can use an Azure Resource Manager template to create an Azure Automation account.
44
ms.service: automation
55
ms.subservice: update-management
@@ -10,18 +10,18 @@ ms.date: 04/24/2020
1010

1111
---
1212

13-
# Create Automation account using Azure Resource Manager template
13+
# Create an Automation account by using an Azure Resource Manager template
1414

15-
You can use [Azure Resource Manager templates](../azure-resource-manager/templates/template-syntax.md) to create an Azure Automation account in your resource group. This article provides a sample template that automates the following:
15+
You can use [Azure Resource Manager templates](../azure-resource-manager/templates/template-syntax.md) to create an Azure Automation account in your resource group. This article provides a sample template that:
1616

17-
* Creation of a Azure Monitor Log Analytics workspace.
18-
* Creation of an Azure Automation account.
17+
* Automates the creation of an Azure Monitor Log Analytics workspace.
18+
* Automates the creation of an Azure Automation account.
1919
* Links the Automation account to the Log Analytics workspace.
2020

21-
The template does not automate the onboarding of one or more Azure or non-Azure VMs, or solutions.
21+
The template doesn't automate the onboarding of Azure or non-Azure virtual machines or solutions.
2222

2323
>[!NOTE]
24-
>Creation of the Automation Run As account is not supported when using an Azure Resource Manager template. To create a Run As account manually from the portal or with PowerShell, see [Manage Run As account](manage-runas-account.md).
24+
>Creation of the Automation Run As account is not supported when you're using an Azure Resource Manager template. To create a Run As account manually from the portal or with PowerShell, see [Manage Run As accounts](manage-runas-account.md).
2525
2626
## API versions
2727

@@ -32,40 +32,40 @@ The following table lists the API version for the resources used in this example
3232
| Workspace | workspaces | 2017-03-15-preview |
3333
| Automation account | automation | 2015-10-31 |
3434

35-
## Before using the template
35+
## Before you use the template
3636

37-
If you choose to install and use PowerShell locally, this article requires the Azure PowerShell Az module. Run `Get-Module -ListAvailable Az` to find the version. If you need to upgrade, see [Install the Azure PowerShell module](/powershell/azure/install-az-ps). If you are running PowerShell locally, you also need to run `Connect-AzAccount` to create a connection with Azure. With Azure PowerShell, deployment uses [New-AzResourceGroupDeployment](/powershell/module/az.resources/new-azresourcegroupdeployment).
37+
If you choose to install and use PowerShell locally, this article requires the Azure PowerShell Az module. Run `Get-Module -ListAvailable Az` to find the version. If you need to upgrade, see [Install the Azure PowerShell module](/powershell/azure/install-az-ps). If you're running PowerShell locally, you also need to run `Connect-AzAccount` to create a connection with Azure. With PowerShell, the deployment uses [New-AzResourceGroupDeployment](/powershell/module/az.resources/new-azresourcegroupdeployment).
3838

39-
If you choose to install and use the CLI locally, this article requires that you are running the Azure CLI version 2.1.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest). With Azure CLI, this deployment uses [az group deployment create](https://docs.microsoft.com/cli/azure/group/deployment?view=azure-cli-latest#az-group-deployment-create).
39+
If you choose to install and use the Azure CLI locally, this article requires that you're running version 2.1.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install the Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest). With the Azure CLI, this deployment uses [az group deployment create](https://docs.microsoft.com/cli/azure/group/deployment?view=azure-cli-latest#az-group-deployment-create).
4040

4141
The JSON template is configured to prompt you for:
4242

43-
* The name of the workspace
44-
* The region to create the workspace in
45-
* The name of the Automation account
46-
* The region to create the account in
43+
* The name of the workspace.
44+
* The region to create the workspace in.
45+
* The name of the Automation account.
46+
* The region to create the account in.
4747

4848
The following parameters in the template are set with a default value for the Log Analytics workspace:
4949

50-
* sku - defaults to the new Per-GB pricing tier released in the April 2018 pricing model
51-
* data retention - defaults to thirty days
52-
* capacity reservation - defaults to 100 GB
50+
* *sku* defaults to the per GB pricing tier released in the April 2018 pricing model.
51+
* *dataRetention* defaults to 30 days.
52+
* *capacityReservationLevel* defaults to 100 GB.
5353

5454
>[!WARNING]
55-
>If creating or configuring a Log Analytics workspace in a subscription that has opted into the new April 2018 pricing model, the only valid Log Analytics pricing tier is **PerGB2018**.
55+
>If you want to create or configure a Log Analytics workspace in a subscription that has opted into the April 2018 pricing model, the only valid Log Analytics pricing tier is *PerGB2018*.
5656
>
5757
58-
The JSON template specifies a default value for the other parameters that would likely be used as a standard configuration in your environment. You can store the template in an Azure storage account for shared access in your organization. For further information about working with templates, see [Deploy resources with Resource Manager templates and Azure CLI](../azure-resource-manager/templates/deploy-cli.md).
58+
The JSON template specifies a default value for the other parameters that would likely be used as a standard configuration in your environment. You can store the template in an Azure storage account for shared access in your organization. For more information about working with templates, see [Deploy resources with Resource Manager templates and the Azure CLI](../azure-resource-manager/templates/deploy-cli.md).
5959

60-
It is important to understand the following configuration details if you are new to Azure Automation and Azure Monitor, in order to avoid errors when attempting to create, configure, and use a Log Analytics workspace linked to your new Automation account.
60+
If you're new to Azure Automation and Azure Monitor, it's important that you understand the following configuration details. They can help you avoid errors when you try to create, configure, and use a Log Analytics workspace linked to your new Automation account.
6161

62-
* Review [Additional details](../azure-monitor/platform/template-workspace-configuration.md#create-a-log-analytics-workspace) to fully understand workspace configuration options, such as access control mode, pricing tier, retention, and capacity reservation level.
62+
* Review [additional details](../azure-monitor/platform/template-workspace-configuration.md#create-a-log-analytics-workspace) to fully understand workspace configuration options, such as access control mode, pricing tier, retention, and capacity reservation level.
6363

64-
* Because only certain regions are supported for linking a Log Analytics workspace and an Automation account in your subscription, review [Workspace mappings](how-to/region-mappings.md) to specify the supported regions inline or in a parameters file.
64+
* Review [workspace mappings](how-to/region-mappings.md) to specify the supported regions inline or in a parameter file. Only certain regions are supported for linking a Log Analytics workspace and an Automation account in your subscription.
6565

66-
* If you are new to Azure Monitor logs and have not deployed a workspace already, you should review the [workspace design](../azure-monitor/platform/design-logs-deployment.md) guidance to learn about access control, and understand the design implementation strategies we recommend for your organization.
66+
* If you're new to Azure Monitor logs and have not deployed a workspace already, you should review the [workspace design guidance](../azure-monitor/platform/design-logs-deployment.md). It will help you to learn about access control, and understand the design implementation strategies we recommend for your organization.
6767

68-
## Deploy template
68+
## Deploy the template
6969

7070
1. Copy and paste the following JSON syntax into your file:
7171

@@ -92,7 +92,7 @@ It is important to understand the following configuration details if you are new
9292
],
9393
"defaultValue": "pergb2018",
9494
"metadata": {
95-
"description": "Pricing tier: perGB2018 or legacy tiers (Free, Standalone, PerNode, Standard or Premium) which are not available to all customers."
95+
"description": "Pricing tier: perGB2018 or legacy tiers (Free, Standalone, PerNode, Standard or Premium), which are not available to all customers."
9696
}
9797
},
9898
"dataRetention": {
@@ -101,14 +101,14 @@ It is important to understand the following configuration details if you are new
101101
"minValue": 7,
102102
"maxValue": 730,
103103
"metadata": {
104-
"description": "Number of days of retention. Workspaces in the legacy Free pricing tier can only have 7 days."
104+
"description": "Number of days of retention. Workspaces in the legacy Free pricing tier can have only 7 days."
105105
}
106106
},
107107
"immediatePurgeDataOn30Days": {
108108
"type": "bool",
109109
"defaultValue": "[bool('false')]",
110110
"metadata": {
111-
"description": "If set to true when changing retention to 30 days, older data will be immediately deleted. Use this with extreme caution. This only applies when retention is being set to 30 days."
111+
"description": "If set to true when changing retention to 30 days, older data will be immediately deleted. Use this with extreme caution. This applies only when retention is being set to 30 days."
112112
}
113113
},
114114
"location": {
@@ -135,7 +135,7 @@ It is important to understand the following configuration details if you are new
135135
},
136136
"sampleGraphicalRunbookDescription": {
137137
"type": "String",
138-
"defaultValue": " An example runbook which gets all the ARM resources using the Run As Account (Service Principal)."
138+
"defaultValue": " An example runbook that gets all the Resource Manager resources by using the Run As account (service principal)."
139139
},
140140
"sampleGraphicalRunbookContentUri": {
141141
"type": "String",
@@ -147,7 +147,7 @@ It is important to understand the following configuration details if you are new
147147
},
148148
"samplePowerShellRunbookDescription": {
149149
"type": "String",
150-
"defaultValue": " An example runbook which gets all the ARM resources using the Run As Account (Service Principal)."
150+
"defaultValue": " An example runbook that gets all the Resource Manager resources by using the Run As account (service principal)."
151151
},
152152
"samplePowerShellRunbookContentUri": {
153153
"type": "String",
@@ -159,7 +159,7 @@ It is important to understand the following configuration details if you are new
159159
},
160160
"samplePython2RunbookDescription": {
161161
"type": "String",
162-
"defaultValue": " An example runbook which gets all the ARM resources using the Run As Account (Service Principal)."
162+
"defaultValue": " An example runbook that gets all the Resource Manager resources by using the Run As account (service principal)."
163163
},
164164
"samplePython2RunbookContentUri": {
165165
"type": "String",
@@ -282,11 +282,11 @@ It is important to understand the following configuration details if you are new
282282
}
283283
```
284284

285-
2. Edit the template to meet your requirements. Consider creating a [Resource Manager parameters file](../azure-resource-manager/templates/parameter-files.md) instead of passing parameters as inline values.
285+
2. Edit the template to meet your requirements. Consider creating a [Resource Manager parameter file](../azure-resource-manager/templates/parameter-files.md) instead of passing parameters as inline values.
286286

287287
3. Save this file as deployAzAutomationAccttemplate.json to a local folder.
288288

289-
4. You are ready to deploy this template. You can use either PowerShell or the Azure CLI. When you're prompted for a workspace and Automation account name, provide a name that is globally unique across all Azure subscriptions.
289+
4. You're ready to deploy this template. You can use either PowerShell or the Azure CLI. When you're prompted for a workspace and Automation account name, provide a name that's globally unique across all your Azure subscriptions.
290290

291291
**PowerShell**
292292

@@ -300,10 +300,14 @@ It is important to understand the following configuration details if you are new
300300
az group deployment create --resource-group <my-resource-group> --name <my-deployment-name> --template-file deployAzAutomationAccttemplate.json
301301
```
302302

303-
The deployment can take a few minutes to complete. When it finishes, you see a message similar to the following that includes the result:
303+
The deployment can take a few minutes to finish. When it does, you'll see a message like the following that includes the result.
304304

305305
![Example result when deployment is complete](media/automation-create-account-template/template-output.png)
306306

307307
## Next steps
308308

309309
Now that you have an Automation account, you can create runbooks and automate manual processes.
310+
311+
* To get started with PowerShell runbooks, see [Create a PowerShell runbook](automation-first-runbook-textual-powershell.md).
312+
* To get started with PowerShell workflow runbooks, see [Create a PowerShell Workflow runbook](automation-first-runbook-textual.md).
313+
* To get started with Python 2 runbooks, see [Create a Python runbook](automation-first-runbook-textual-python2.md).

0 commit comments

Comments
 (0)