< Back
Unregister-AzureRmAutomationDscNode
Post
NAME Unregister-AzureRmAutomationDscNode
SYNOPSIS
Removes a DSC node from management by an Automation account.
SYNTAX
Unregister-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
[-Force] -Id <Guid> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Unregister-AzureRmAutomationDscNode cmdlet removes an APS Desired State Configuration (DSC) node from management by an Azure Automation
account.
PARAMETERS
-AutomationAccountName <String>
Specifies the name of the Automation account from which this cmdlet removes a DSC node.
Required? true
Position? 1
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
-Force [<SwitchParameter>]
ps_force
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <Guid>
Specifies the unique ID of the DSC node that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group in which this cmdlet unregisters a DSC node.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
Microsoft.Azure.Commands.Automation.Model.DscNode
NOTES
Example 1: Remove an Azure DSC node from management by an Automation account
PS C:\\>Unregister-AzureRmAutomationDscNode -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... iondscnode
Get-AzureRmAutomationDscNode
Register-AzureRmAutomationDscNode
Set-AzureRmAutomationDscNode
SYNOPSIS
Removes a DSC node from management by an Automation account.
SYNTAX
Unregister-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
[-Force] -Id <Guid> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Unregister-AzureRmAutomationDscNode cmdlet removes an APS Desired State Configuration (DSC) node from management by an Azure Automation
account.
PARAMETERS
-AutomationAccountName <String>
Specifies the name of the Automation account from which this cmdlet removes a DSC node.
Required? true
Position? 1
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
-Force [<SwitchParameter>]
ps_force
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <Guid>
Specifies the unique ID of the DSC node that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group in which this cmdlet unregisters a DSC node.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
Microsoft.Azure.Commands.Automation.Model.DscNode
NOTES
Example 1: Remove an Azure DSC node from management by an Automation account
PS C:\\>Unregister-AzureRmAutomationDscNode -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... iondscnode
Get-AzureRmAutomationDscNode
Register-AzureRmAutomationDscNode
Set-AzureRmAutomationDscNode