< Back

Register-AzureRmAutomationDscNode

Tue Jan 29, 2019 9:32 pm

NAME Register-AzureRmAutomationDscNode



SYNOPSIS

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





SYNTAX

Register-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-ActionAfterReboot {ContinueConfiguration |

StopConfiguration}] [-AllowModuleOverwrite <Boolean>] [-AzureVMLocation <String>] -AzureVMName <String> [-AzureVMResourceGroup <String>]

[-ConfigurationMode {ApplyAndMonitor | ApplyAndAutocorrect | ApplyOnly}] [-ConfigurationModeFrequencyMins <Int32>] [-DefaultProfile

<IAzureContextContainer>] [-NodeConfigurationName <String>] [-RebootNodeIfNeeded <Boolean>] [-RefreshFrequencyMins <Int32>] [<CommonParameters>]





DESCRIPTION

The Register-AzureRmAutomationDscNode cmdlet registers an Azure virtual machine as an APS Desired State Configuration (DSC) node in an Azure

Automation account.





PARAMETERS

-ActionAfterReboot <String>

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



- ContinueConfiguration



- StopConfiguration



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-AllowModuleOverwrite <Boolean>

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.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-AutomationAccountName <String>

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



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-AzureVMLocation <String>

Specifies the location in which this cmdlet registers a virtual machine. To obtain valid locations, use the Get-AzureRMLocation cmdlet.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-AzureVMName <String>

Specifies the name of the Azure virtual machine that this cmdlet registers for management.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-AzureVMResourceGroup <String>

Specifies the name of the resource group of the Azure virtual machine that this cmdlet registers.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ConfigurationMode <String>

Specifies the DSC configuration mode. Valid values are:



- ApplyAndMonitor



- ApplyAndAutocorrect



- ApplyOnly



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ConfigurationModeFrequencyMins <Int32>

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

node.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-NodeConfigurationName <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RebootNodeIfNeeded <Boolean>

Specifies whether to restart the virtual machine, if needed.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RefreshFrequencyMins <Int32>

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

latest node configuration.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

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.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS



NOTES









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



PS C:\\>Register-AzureRmAutomationDscNode -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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... iondscnode

Get-AzureRmAutomationDscNode

Set-AzureRmAutomationDscNode

Unregister-AzureRmAutomationDscNode