Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Unregister-AzAutomationDscNode
- Module:
- Az.Automation Module
Removes a DSC node from management by an Automation account.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-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
-Force
ps_force
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
Specifies the unique ID of the DSC node that this cmdlet removes.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | NodeId |
Parameter sets
-ResourceGroupName
Specifies the name of a resource group in which this cmdlet unregisters a DSC node.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
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
Guid
String
Outputs
DscNode
Related Links
Azure PowerShell
Feedback
Was this page helpful?