Skip to content

Latest commit

 

History

History
183 lines (145 loc) · 3.15 KB

AzureConnectedMachine.adoc

File metadata and controls

183 lines (145 loc) · 3.15 KB

DSC Resource 'AzureConnectedMachine'

AzureConnectedMachine downloads and installs the Azure Connected Machine Agent und connects it to your Tenant. A proxy for the download is supported.

Source

DSC Resource

Documentation

Table 1. Attributes of category 'AzureConnectedMachine'
Parameter Attribute DataType Description Allowed Values

TenantId

Mandatory

String

The ID of your Tenant.

SubscriptionId

Mandatory

String

The ID of your Subscription.

ResourceGroup

Mandatory

String

Name of your Resource Group.

Location

Mandatory

String

Specifies the Azure Location in which your Tenant is located.

Credential

PSCredential

Credentials for your Tenant. ServicePrincipalID/ServicePrincipalSecret

Tags

String

Add Tags for your Server e.g. Location

DownloadURL

String

If you want to use a different URL, e.g. an internal Server, to download the ACMA msi

Default: Microsoft Source

DownloadProxy

string

Define your proxy for ACMA download

DownloadPath

string

Define where the Setup should be downloaded to

Default: C:\DSCData\ACMA

To configure Azure Connected Machine Settings:

Parameter Attribute DataType Description Allowed Values

IsSingleInstance

String

Defines if it is a Single Instance or not. Due to the DSC Ressource it has to be the following way

  • Yes (default)

  • No

incomingconnections_ports

string[]

Define incomming connection ports

proxy_url

string

Define your proxy

extensions_allowlist

string[]

extensions_blocklist

string[]

proxy_bypass

string[]

guestconfiguration_enabled

boolean

  • true

  • false

Example
AzureConnectedMachine:
  TenantId: 1234567-ABC-DEFG-1234-ABCDEFGHIJKL
  SubscriptionId: 00000000-0000-0000-0000-000000000000
  ResourceGroup: myAzureConnectedMachineRG
  Location: germanywestcentral
  Credential: '[ENC=PE9ianMgVmVyc2lvbj...=]'
  Tags: Berlin_Office
Example for Configuration
AzureConnectedMachine:
  proxy_url: https://your-proxy.com:1234
Example for download with proxy
AzureConnectedMachine:
  DownloadProxy: https://yourdownload-proxy.com:1234
Recommended Lookup Options in Datum.yml (Excerpt)
lookup_options:

  AzureConnectedMachine:
    merge_hash: deep