Unregister-AzAutomationDscNode

  • Reference
Module:
Az.Automation

Removes a DSC node from management by an Automation account.

Syntax

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

Description

The Unregister-AzAutomationDscNode cmdlet removes an APS Desired State Configuration (DSC) node from management by an Azure Automation account.

Examples

Example 1: Remove an Azure DSC node from management by an Automation account

Unregister-AzAutomationDscNode -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -Id 064a8929-c98b-25e4-80hh-111ca86067j8

This command removes the DSC node that has the specified GUID from management by the Automation account named Contoso17.

Example 2: Remove an Azure DSC node from management by an Automation account by specifying the DSC node name

$dscNodeNameToRemove = "MyMachine1"
$automationAccountName = "Contoso17"
$resourceGroupName = "ResourceGroup01"
$nodeToRemove = Get-AzAutomationDscNode -Name $dscNodeNameToRemove -AutomationAccountName $automationAccountName -ResourceGroupName $resourceGroupName
$nodeToRemove | Unregister-AzAutomationDscNode -AutomationAccountName $automationAccountName -ResourceGroupName $resourceGroupName

This command removes the DSC node that has the name "MyMachine1" from management by the Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of the Automation account from which this cmdlet removes a DSC node.

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

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 that this cmdlet removes.

Type:Guid
Aliases:NodeId
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 unregisters a DSC node.

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

Guid

String

Outputs

DscNode