Skip to content

Commit 61b0b6a

Browse files
Merge pull request #111523 from BethWilke/branch118
Fixing task 1707213
2 parents d28d858 + 0344a4d commit 61b0b6a

13 files changed

+253
-221
lines changed

articles/automation/automation-connections.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.topic: conceptual
1111

1212
An Automation connection asset contains the information required to connect to an external service or application from a runbook or DSC configuration. This may include information required for authentication such as a username and password in addition to connection information such as a URL or a port. The value of a connection is keeping all of the properties for connecting to a particular application in one asset as opposed to creating multiple variables. The user can edit the values for a connection in one place, and you can pass the name of a connection to a runbook or DSC configuration in a single parameter. The properties for a connection can be accessed in the runbook or DSC configuration with the `Get-AutomationConnection` activity.
1313

14-
When you create a connection, you must specify a *connection type*. The connection type is a template that defines a set of properties. The connection defines values for each property defined in its connection type. Connection types are added to Azure Automation in integration modules or created with the [Azure Automation API](/previous-versions/azure/reference/mt163818(v=azure.100)) if the integration module includes a connection type and is imported into your Automation account. Otherwise, you must create a metadata file to specify an Automation connection type. For more information regarding this, see [Integration Modules](automation-integration-modules.md).
14+
When you create a connection, you must specify a connection type. The connection type is a template that defines a set of properties. The connection defines values for each property defined in its connection type. Connection types are added to Azure Automation in integration modules or created with the [Azure Automation API](/previous-versions/azure/reference/mt163818(v=azure.100)) if the integration module includes a connection type and is imported into your Automation account. Otherwise, you must create a metadata file to specify an Automation connection type. For more information regarding this, see [Integration Modules](automation-integration-modules.md).
1515

1616
>[!NOTE]
1717
>Secure assets in Azure Automation include credentials, certificates, connections, and encrypted variables. These assets are encrypted and stored in Azure Automation using a unique key that is generated for each Automation account. This key is stored in a system managed Key Vault. Before storing a secure asset, the key is loaded from Key Vault and then used to encrypt the asset. This process is managed by Azure Automation.

articles/automation/automation-dsc-onboarding.md

Lines changed: 107 additions & 109 deletions
Large diffs are not rendered by default.
Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
11
---
22
title: Azure Automation State Configuration overview
3-
description: This article is an overview of Azure Automation State Configuration (DSC), its terms, and its known issues.
3+
description: An overview of Azure Automation State Configuration (DSC), its terms, and known issues
44
keywords: powershell dsc, desired state configuration, powershell dsc azure
55
services: automation
66
ms.service: automation
77
ms.subservice: dsc
88
author: mgoedtel
99
ms.author: magoedte
10-
ms.date: 04/15/2020
10+
ms.date: 11/06/2018
1111
ms.topic: conceptual
1212
manager: carmonm
1313
---
14-
1514
# State Configuration overview
1615

17-
Azure Automation State Configuration is an Azure service that allows you to write, manage, and compile PowerShell Desired State Configuration (DSC) [configurations](/powershell/scripting/dsc/configurations/configurations). The service also imports [DSC resources](/powershell/scripting/dsc/resources/resources) and assigns configurations to target nodes, all in the cloud.
16+
Azure Automation State Configuration is an Azure service that allows you to write, manage, and
17+
compile PowerShell Desired State Configuration (DSC)
18+
[configurations](/powershell/scripting/dsc/configurations/configurations). The service also imports [DSC Resources](/powershell/scripting/dsc/resources/resources), and assigns configurations to target nodes, all in the cloud.
1819

19-
## Why use Azure Automation State Configuration?
20+
## Why use Azure Automation State Configuration
2021

2122
Azure Automation State Configuration provides several advantages over using DSC outside of Azure.
2223

2324
### Built-in pull server
2425

25-
Azure Automation State Configuration provides a DSC pull server similar to the [Windows Feature DSC-Service](/powershell/scripting/dsc/pull-server/pullserver). Target nodes can automatically receive configurations, conform to the desired state, and report on their compliance. The built-in pull server in Azure Automation eliminates the need to set up and maintain your own pull server. Azure Automation can target virtual or physical Windows or Linux machines, in the cloud or on-premises.
26+
Azure Automation State Configuration provides a DSC pull server similar to the [Windows Feature DSC-Service](/powershell/scripting/dsc/pull-server/pullserver). Target nodes can automatically receive
27+
configurations, conform to the desired state, and report on their compliance. The built-in pull server in Azure Automation eliminates the need to set up and maintain your own pull server. Azure
28+
Automation can target virtual or physical Windows or Linux machines, in the cloud or on-premises.
2629

27-
### Manage all your DSC artifacts
30+
### Management of all your DSC artifacts
2831

2932
Azure Automation State Configuration brings the same management layer to [PowerShell Desired State Configuration](/powershell/scripting/dsc/overview/overview) as it offers for PowerShell scripting. From the Azure portal or from PowerShell, you can manage all your DSC configurations, resources, and target nodes.
3033

3134
![Screenshot of the Azure Automation page](./media/automation-dsc-overview/azure-automation-blade.png)
3235

33-
### Import reporting data into Azure Monitor Logs
36+
### Import of reporting data into Azure Monitor logs
3437

35-
Nodes that are managed with Azure Automation State Configuration send detailed reporting status data to the built-in pull server. You can configure Azure Automation State Configuration to send this data to your Log Analytics workspace. For more information, see [Forward Azure Automation State Configuration reporting data to Azure Monitor Logs](automation-dsc-diagnostics.md).
38+
Nodes that are managed with Azure Automation State Configuration send detailed reporting status data to the built-in pull server. You can configure Azure Automation State Configuration to send
39+
this data to your Log Analytics workspace. See [Forward Azure Automation State Configuration reporting data to Azure Monitor logs](automation-dsc-diagnostics.md).
3640

37-
## Prerequisites
41+
## Prerequisites for using Azure Automation State Configuration
3842

39-
Consider the following requirements when you use Azure Automation State Configuration for DSC.
43+
Please consider the following requirements when using Azure Automation State Configuration for DSC.
4044

4145
### Operating system requirements
4246

@@ -52,17 +56,19 @@ For nodes running Windows, the following versions are supported:
5256
- Windows 7
5357

5458
>[!NOTE]
55-
>Because the [Microsoft Hyper-V Server](/windows-server/virtualization/hyper-v/hyper-v-server-2016) standalone product SKU doesn't contain an implementation of DSC, it can't be managed by PowerShell DSC or Azure Automation State Configuration.
59+
>The [Microsoft Hyper-V Server](/windows-server/virtualization/hyper-v/hyper-v-server-2016) standalone product SKU does not contain an implementation of DSC. Thus it can't be managed by PowerShell DSC or Azure Automation State Configuration.
5660
5761
For nodes running Linux, the DSC Linux extension supports all the Linux distributions listed under [Supported Linux Distributions](https://github.com/Azure/azure-linux-extensions/tree/master/DSC#4-supported-linux-distributions).
5862

5963
### DSC requirements
6064

6165
For all Windows nodes running in Azure,
62-
[Windows Management Framework 5.1](https://docs.microsoft.com/powershell/scripting/wmf/setup/install-configure)
63-
is installed during onboarding. For nodes running Windows Server 2012 and Windows 7, [WinRM](https://docs.microsoft.com/powershell/scripting/dsc/troubleshooting/troubleshooting#winrm-dependency) is enabled.
66+
[WMF 5.1](https://docs.microsoft.com/powershell/scripting/wmf/setup/install-configure)
67+
is installed during onboarding. For nodes running Windows Server 2012 and Windows 7,
68+
[WinRM](https://docs.microsoft.com/powershell/scripting/dsc/troubleshooting/troubleshooting#winrm-dependency) is enabled.
6469

65-
For all Linux nodes running in Azure, [PowerShell DSC for Linux](https://github.com/Microsoft/PowerShell-DSC-for-Linux)
70+
For all Linux nodes running in Azure,
71+
[PowerShell DSC for Linux](https://github.com/Microsoft/PowerShell-DSC-for-Linux)
6672
is installed during onboarding.
6773

6874
### <a name="network-planning"></a>Configuration of private networks
@@ -74,20 +80,23 @@ If your nodes are located in a private network, the following port and URLs are
7480
* Global URL of US Gov Virginia: ***.azure-automation.us**
7581
* Agent service: **https://\<workspaceId\>.agentsvc.azure-automation.net**
7682

77-
If you are using DSC resources that communicate between nodes, such as the [WaitFor* resources](https://docs.microsoft.com/powershell/scripting/dsc/reference/resources/windows/waitForAllResource), you also need to allow communication between nodes. To understand these network requirements, see the documentation for each DSC resource.
83+
If you are using DSC resources that communicate between nodes,
84+
such as the [WaitFor* resources](https://docs.microsoft.com/powershell/scripting/dsc/reference/resources/windows/waitForAllResource),
85+
you also need to allow traffic between nodes. See the documentation for each DSC resource to understand these network requirements.
7886

7987
#### Proxy support
8088

81-
Proxy support for the DSC agent is available in Windows version 1809 and later. You enable this option by setting the values for `ProxyURL` and `ProxyCredential` in the [metaconfiguration script](automation-dsc-onboarding.md#generate-dsc-metaconfigurations) that's used to register nodes.
89+
Proxy support for the DSC agent is available in Windows version 1809 and later. This option is enabled by setting the values for `ProxyURL` and `ProxyCredential` in the [metaconfiguration script](automation-dsc-onboarding.md#generating-dsc-metaconfigurations)
90+
used to register nodes.
8291

8392
>[!NOTE]
84-
>Azure Automation State Configuration doesn't provide DSC proxy support for earlier versions of Windows.
93+
>Azure Automation State Configuration does not provide DSC proxy support for previous versions of Windows.
8594
86-
For Linux nodes, the DSC agent supports a proxy server and uses the `http_proxy` variable to specify the URL.
95+
For Linux nodes, the DSC agent supports proxy and uses the `http_proxy` variable to determine the URL.
8796

8897
#### Azure Automation State Configuration network ranges and namespace
8998

90-
When you're defining exceptions, we recommend that you use the IP addresses listed in the following table. For IP addresses, you can download the [Microsoft Azure Datacenter IP Ranges](https://www.microsoft.com/download/details.aspx?id=41653) XML file from the Microsoft Download Center. This file contains the currently deployed ranges and any upcoming changes to the IP ranges. It is updated weekly.
99+
It's recommended to use the addresses listed below when defining exceptions. For IP addresses, you can download the [Microsoft Azure Datacenter IP Ranges](https://www.microsoft.com/download/details.aspx?id=41653). This file is updated weekly, and has the currently deployed ranges and any upcoming changes to the IP ranges.
91100

92101
If you have an Automation account that's defined for a specific region, you can restrict communication to that regional datacenter. The following table provides the DNS record for each region:
93102

@@ -107,18 +116,21 @@ If you have an Automation account that's defined for a specific region, you can
107116
| UK South | uks-jobruntimedata-prod-su1.azure-automation.net</br>uks-agentservice-prod-1.azure-automation.net |
108117
| US Gov Virginia | usge-jobruntimedata-prod-su1.azure-automation.us<br>usge-agentservice-prod-1.azure-automation.us |
109118

119+
For a list of region IP addresses instead of region names, download the [Azure Datacenter IP address](https://www.microsoft.com/download/details.aspx?id=41653) XML file from the Microsoft Download Center.
120+
110121
> [!NOTE]
111122
> The Azure Datacenter IP address XML file lists the IP address ranges that are used in the Microsoft Azure datacenters. The file includes compute, SQL, and storage ranges.
112123
>
113-
>An updated file is posted weekly. The file reflects the currently deployed ranges and any upcoming changes to the IP ranges. New ranges that appear in the file aren't used in the datacenters for at least one week. It's a good idea to download a new XML file every week. Then, you can update your site to correctly identify services running in Azure.
124+
>An updated file is posted weekly. The file reflects the currently deployed ranges and any upcoming changes to the IP ranges. New ranges that appear in the file aren't used in the datacenters for at least one week. It's a good idea to download the new XML file every week. Then update your site to correctly identify services running in Azure.
114125
115-
If you're an Azure ExpressRoute user, note that this file is used to update the Border Gateway Protocol (BGP) advertisement of Azure space in the first week of each month.
126+
Azure ExpressRoute users should note that this file is used to update the Border Gateway Protocol (BGP) advertisement of Azure space in the first week of each month.
116127

117128
## Next steps
118129

119-
- To get started using DSC in Azure Automation State Configuration, see [Get started with Azure Automation State Configuration](automation-dsc-getting-started.md).
120-
- To learn how to onboard nodes, see [Onboard machines for management by Azure Automation State Configuration](automation-dsc-onboarding.md).
121-
- To learn about compiling DSC configurations so that you can assign them to target nodes, see [Compile configurations in Azure Automation State Configuration](automation-dsc-compile.md).
122-
- For a PowerShell cmdlet reference, see [Az.Automation](https://docs.microsoft.com/powershell/module/az.automation/?view=azps-3.7.0#automation).
130+
- To get started using DSC in Azure Automation State Configuration, see [Getting started with Azure Automation State Configuration](automation-dsc-getting-started.md).
131+
- To learn how to onboard nodes, see [Onboarding machines for management by Azure Automation State Configuration](automation-dsc-onboarding.md).
132+
- To learn about compiling DSC configurations so that you can assign them to target nodes, see [Compiling configurations in Azure Automation State Configuration](automation-dsc-compile.md).
133+
- For a PowerShell cmdlet reference, see [Az.Automation](https://docs.microsoft.com/powershell/module/az.automation/?view=azps-3.7.0#automation
134+
).
123135
- For pricing information, see [Azure Automation State Configuration pricing](https://azure.microsoft.com/pricing/details/automation/).
124-
- For an example of using Azure Automation State Configuration in a continuous deployment pipeline, see [Continuous deployment to virtual machines using Azure Automation State Configuration and Chocolatey](automation-dsc-cd-chocolatey.md).
136+
- To see an example of using Azure Automation State Configuration in a continuous deployment pipeline, see [Continuous deployment using Azure Automation State Configuration and Chocolatey](automation-dsc-cd-chocolatey.md).

articles/automation/automation-dsc-remediate.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,9 @@ Update-DscConfiguration -Wait -Verbose
4040

4141
Similar functionality isn't currently available for Linux servers.
4242
The only option is to repeat the registration process.
43-
4443
For Azure nodes, you can correct drift from the Azure portal
4544
or using Az module cmdlets. Details about this process are documented in
46-
[Onboarding machines for management by Azure Automation State Configuration](automation-dsc-onboarding.md#onboard-vms-by-using-the-azure-portal).
45+
[Onboarding machines for management by Azure Automation State Configuration](automation-dsc-onboarding.md#onboard-a-vm-using-azure-portal).
4746
For hybrid nodes, you can correct drift using the included Python scripts.
4847
See [PowerShell DSC for Linux repo](https://github.com/Microsoft/PowerShell-DSC-for-Linux#performing-dsc-operations-from-the-linux-computer).
4948

articles/automation/automation-hybrid-runbook-worker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ sudo python onboarding.py --deregister --endpoint="<URL>" --key="<PrimaryAccessK
6262
```
6363

6464
> [!NOTE]
65-
> This code doesn't remove the Microsoft Monitoring Agent from the computer. It only removes the functionality and configuration of the Hybrid Runbook Worker role.
65+
> This code doesn't remove the Log Analytics agent for Linux from the computer. It only removes the functionality and configuration of the Hybrid Runbook Worker role.
6666
6767
## Remove a Hybrid Worker group
6868

@@ -83,7 +83,7 @@ To remove a Hybrid Runbook Worker group, you first need to remove the Hybrid Run
8383

8484
### Hybrid Worker role
8585

86-
For the Hybrid Runbook Worker to connect to and register with Azure Automation, it must have access to the port number and the URLs that are described in this section. This access is on top to the [ports and URLs required for Microsoft Monitoring Agent](../azure-monitor/platform/agent-windows.md) to connect to Azure Monitor logs.
86+
For the Hybrid Runbook Worker to connect to and register with Azure Automation, it must have access to the port number and the URLs that are described in this section. This access is on top to the [ports and URLs required for Log Analytics agent](../azure-monitor/platform/agent-windows.md) to connect to Azure Monitor logs.
8787

8888
[!INCLUDE [azure-monitor-log-analytics-rebrand](../../includes/azure-monitor-log-analytics-rebrand.md)]
8989

articles/automation/automation-linux-hrw-install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Before you proceed, note the Log Analytics workspace that your Automation accoun
7070

7171
1. Enable the Automation Hybrid Worker solution in Azure by using one of the following methods:
7272

73-
* Add the Automation Hybrid Worker solution to your subscription by using the procedure at [Add Azure Monitor logs solutions to your workspace](../log-analytics/log-analytics-add-solutions.md).
73+
* Add the Automation Hybrid Worker solution to your subscription by using the procedure at [Add Azure Monitor log solutions to your workspace](../log-analytics/log-analytics-add-solutions.md).
7474
* Run the following cmdlet:
7575

7676
```azurepowershell-interactive

0 commit comments

Comments
 (0)