Get-AzureRmAutomationDscNode

NAME Get-AzureRmAutomationDscNode



SYNOPSIS

Gets DSC nodes from Automation.





SYNTAX

Get-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> -ConfigurationName <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]



Get-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>] -Id <Guid>

[<CommonParameters>]



Get-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>] -Name

<String> [-Status {Compliant | NotCompliant | Failed | Pending | Received | Unresponsive}] [<CommonParameters>]



Get-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]

-NodeConfigurationName <String> [-Status {Compliant | NotCompliant | Failed | Pending | Received | Unresponsive}] [<CommonParameters>]



Get-AzureRmAutomationDscNode [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>] [-Status

{Compliant | NotCompliant | Failed | Pending | Received | Unresponsive}] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmAutomationDscNode cmdlet gets APS Desired State Configuration (DSC) nodes from Azure Automation.





PARAMETERS

-AutomationAccountName <String>

Specifies the name of the Automation account that contains the DSC nodes that this cmdlet gets.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ConfigurationName <String>

Specifies the name of a DSC configuration. This cmdlet gets DSC nodes that match the node configurations generated from the configuration that

this parameter specifies.



Required? true

Position? named

Default value None

Accept pipeline input? False

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



-Id <Guid>

Specifies the unique ID of the DSC node that this cmdlet gets.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of a DSC node that this cmdlet gets.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-NodeConfigurationName <String>

Specifies the name of a node configuration that this cmdlet gets.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of a resource group in which this cmdlet gets DSC nodes.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Status <DscNodeStatus>

Specifies the status of the DSC nodes that this cmdlet gets. Valid values are:



- Compliant



- NotCompliant



- Failed



- Pending



- Received



- Unresponsive



Required? false

Position? named

Default value None

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: Get all DSC nodes



PS C:\\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"



This command gets metadata for all DSC nodes in the Automation account named Contoso17.





Example 2: Get all DSC nodes for a DSC configuration



PS C:\\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName

"ContosoConfiguration"



This command gets metadata for all DSC nodes in the Automation account named Contoso17 that are mapped to a DSC node configuration which was

generated by DSC configuration ContosoConfiguration.





Example 3: Get a DSC node by ID



PS C:\\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Id

c0a1718e-d8be-4fa3-91b6-82e1d3a36298



This command gets metadata on a DSC node with the specified ID in the Automation account named Contoso17.





Example 4: Get a DSC node by name



PS C:\\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14"



This command gets metadata on a DSC node with the name Computer14 in the Automation account named Contoso17.





Example 5: Get all DSC nodes mapped to a DSC node configuration



PS C:\\>Get-AzureRmAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeConfigurationName

"ContosoConfiguration.webserver"



This command gets metadata on all DSC nodes in the Automation account named Contoso17 that are mapped to a DSC node configuration named

ContosoConfiguration.webserver.







RELATED LINKS

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

Register-AzureRmAutomationDscNode

Set-AzureRmAutomationDscNode

Unregister-AzureRmAutomationDscNode