This repository contains the module for Windows PowerShell Desired State Configuration to install and configure the Azure Connected Machine Agent.

The files and folders in this repo include:

• AzureConnectedMachineAgentDsc: Used to automate configuration of the Azure Connected Machine Agent including validation of the connection to Azure and the metadata such as the Resource Group and Tags information.

The minimum PowerShell version required is 4.0, which ships in Windows 8.1 or Windows Server 2012R2 (or higher versions). The preferred version is PowerShell 5.0 or higher, which ships with Windows 10 or Windows Server 2016.

To manually install the module, download the source code and unzip the contents of the project directory to the $env:ProgramFiles\WindowsPowerShell\Modules folder.

To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0) run the following command:

Find-Module -Name AzureConnectedMachineDsc -Repository PSGallery | Install-Module

To confirm installation, run the below command and ensure you see the Azure Connected Machine DSC resoures available:

Get-DscResource -Module AzureConnectedMachineDsc

The resources in this module are intended to manage the Azure Connected Machine Agent configuration. A complete example is provided that also uses community resources to download and install the agent, and to verify the state of the agent service.

PowerShell script:

& .\examples\AzureConnectedMachineAgent.ps1

The script parameters include:

• TenantID: The id (guid) of the Azure tenant
• SubscriptionId: The id (guid) of the Azure subscription
• ResourceGroup: The name of the resource group where the connect machine resource should be created
• Location: The Azure location where the connected machine resource should be created
• Tags: String array of tags that should be applied to the connected machine resource
• Credential: A PowerShell credential object with the AppId and Secret used to register machines at scale

The Azure Connected Machine Agent supports connecting through an http proxy service. The proxy details are provided to the agent using envionment variables, which could also be managed by DSC using the ComputeManagementDsc module. For more information on the proxy details, see the documentation for Azure Connect Machine Agent.

This resource can be added to existing DSC configurations to represent an end-to-end configuration for a machine. For example, you might wish to add this resource to a configuration that sets secure operating system settings.

The CompsiteResource module from the PowerShell Gallery can be used to create a composite resource of the example configuration, to further simplify combining configurations.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.