Edit

Share via

Set-AzAutomationDscNode

  • Reference
Module:
Az.Automation

Modifies the node configuration that a DSC node is mapped to.

Syntax

PowerShell 
Set-AzAutomationDscNode
   -Id <Guid>
   -NodeConfigurationName <String>
   [-Force]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzAutomationDscNode cmdlet modifies an APS Desired State Configuration (DSC) node configuration. Azure Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document.

Examples

Example 1: Modify node configuration mapping

PowerShell 
Set-AzAutomationDscNode -NodeConfigurationName "Contoso.NodeConfiguration01" -ResourceGroupName "ResourceGroup01" -Id 064a8929-c98b-25e4-80hh-111c8a6067j8

This command assigns the node configuration named Contoso.NodeConfiguration01 to the node that has the specified GUID.

Parameters

-AutomationAccountName

Specifies the name of the Automation account that contains the DSC node for which this cmdlet modifies the configuration.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ps_force the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the unique ID of the DSC node for which this cmdlet modifies the configuration.

Type:Guid
Aliases:NodeId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NodeConfigurationName

Specifies the name of the node configuration to which this cmdlet maps the node.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group in which this cmdlet modifies a DSC node configuration.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Outputs