Get-AzAutomationDscNode

Module:

Az.Automation Module

Gets DSC nodes from Automation.

Syntax

ByAll (Default)

Get-AzAutomationDscNode
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-Status <DscNodeStatus>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ById

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

ByName

Get-AzAutomationDscNode
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -Name <String>
    [-Status <DscNodeStatus>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByNodeConfiguration

Get-AzAutomationDscNode
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -NodeConfigurationName <String>
    [-Status <DscNodeStatus>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByConfiguration

Get-AzAutomationDscNode
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    -ConfigurationName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

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

Examples

Example 1: Get all DSC nodes

Get-AzAutomationDscNode -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

Get-AzAutomationDscNode -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

Get-AzAutomationDscNode -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

Get-AzAutomationDscNode -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

Get-AzAutomationDscNode -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.

Parameters

-AutomationAccountName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ConfigurationName

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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByConfiguration

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

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

Parameter properties

Type:	Guid
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	NodeId

Parameter sets

ById

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Name

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	NodeName

Parameter sets

ByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-NodeConfigurationName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByNodeConfiguration

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Status

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

• Compliant
• NotCompliant
• Failed
• Pending
• Received
• Unresponsive

Parameter properties

Type:	DscNodeStatus
Default value:	None
Accepted values:	Compliant, NotCompliant, Failed, Pending, Received, Unresponsive
Supports wildcards:	False
DontShow:	False

Parameter sets

ByAll

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNodeConfiguration

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

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

• Register-AzAutomationDscNode
• Set-AzAutomationDscNode
• Unregister-AzAutomationDscNode