Register-AzAutomationDscNode

Module:

Az.Automation Module

Registers an Azure virtual machine running Windows OS as a DSC node for an Automation account.

Syntax

Default (Default)

Register-AzAutomationDscNode
    -AzureVMName <String>
    [-NodeConfigurationName <String>]
    [-ConfigurationMode <String>]
    [-ConfigurationModeFrequencyMins <Int32>]
    [-RefreshFrequencyMins <Int32>]
    [-RebootNodeIfNeeded <Boolean>]
    [-ActionAfterReboot <String>]
    [-AllowModuleOverwrite <Boolean>]
    [-AzureVMResourceGroup <String>]
    [-AzureVMLocation <String>]
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Register-AzAutomationDscNode cmdlet registers an Azure virtual machine as an APS Desired State Configuration (DSC) node in an Azure Automation account. This cmdlet will only register VMs running Windows OS as an Automation DSC Node for an account.

If you need to register a node to an automation account in a different subscription, you will need to use an ARM template rather than cmdlets. See the Azure Automation documentation for more details.

Examples

Example 1: Register an Azure virtual machine as an Azure DSC node

Register-AzAutomationDscNode -AutomationAccountName "Contoso17" -AzureVMName "VirtualMachine01" -ResourceGroupName "ResourceGroup01"-NodeConfigurationName "ContosoConfiguration.webserver"

This command registers the Azure virtual machine named VirtualMachine01 as a DSC node in the Automation account named Contoso17.

Parameters

-ActionAfterReboot

Specifies the action that the virtual machine takes after it restarts. Valid values are:

• ContinueConfiguration
• StopConfiguration

Parameter properties

Type:	String
Default value:	None
Accepted values:	ContinueConfiguration, StopConfiguration
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-AllowModuleOverwrite

Specifies whether new configurations that this DSC node downloads from the Azure Automation DSC pull server replace the existing modules already on the target node.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-AutomationAccountName

Specifies the name of an Automation account in which this cmdlet registers a virtual machine.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-AzureVMLocation

The Azure VM location.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-AzureVMName

The name of the Azure virtual machine to register for management with Azure Automation DSC.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-AzureVMResourceGroup

The Azure VM resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ConfigurationMode

Specifies the DSC configuration mode. Valid values are:

• ApplyAndMonitor
• ApplyAndAutocorrect
• ApplyOnly

Parameter properties

Type:	String
Default value:	None
Accepted values:	ApplyAndMonitor, ApplyAndAutocorrect, ApplyOnly
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ConfigurationModeFrequencyMins

Specifies the frequency, in minutes, at which the background application of DSC attempts to implement the current configuration on the target node.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NodeConfigurationName

Specifies the name of the node configuration that this cmdlet configures the virtual machine to pull from Azure Automation DSC.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RebootNodeIfNeeded

Specifies whether to restart the virtual machine, if needed.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RefreshFrequencyMins

Specifies the frequency, in minutes, at which the local Configuration Manager contacts the Azure Automation DSC pull server to download the latest node configuration.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ResourceGroupName

Specifies the name of a resource group. The Automation account with which this cmdlet registers a virtual machine belongs to the resource group that this parameter specifies.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Int32

Boolean

Outputs

Void

Related Links

• Get-AzAutomationDscNode
• Set-AzAutomationDscNode
• Unregister-AzAutomationDscNode