Edit

Share via

Get-AzAutomationDscNodeReport

  • Reference
Module:
Az.Automation

Gets reports sent from a DSC node to Automation.

Syntax

Get-AzAutomationDscNodeReport
   -NodeId <Guid>
   [-StartTime <DateTimeOffset>]
   [-EndTime <DateTimeOffset>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationDscNodeReport
   -NodeId <Guid>
   [-Latest]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationDscNodeReport
   -NodeId <Guid>
   -Id <Guid>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzAutomationDscNodeReport cmdlet gets reports sent from an APS Desired State Configuration (DSC) node to Azure Automation.

Examples

Example 1: Get all reports for a DSC node

$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14"
Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id

The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. The command stores this object in the $Node variable. The second command gets metadata for all reports sent from the DSC node named Computer14 to the Automation account named Contoso17. The command specifies the node by using the Id property of the $Node object.

Example 2: Get a report for a DSC node by report ID

$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14"
Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id -Id c0a1718e-d8be-4fa3-91b6-82e1d3a36298

The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. The command stores this object in the $Node variable. The second command gets metadata for the report identified by the specified ID sent from the DSC node named Computer14 to the Automation account named Contoso17.

Example 3: Get the latest report for a DSC node

$Node = Get-AzAutomationDscNode -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "Computer14"
Get-AzAutomationDscNodeReport -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -NodeId $Node.Id -Latest

The first command gets the DSC node for the computer named Computer14 in the Automation account named Contoso17. The command stores this object in the $Node variable. The second command gets metadata for the latest report sent from the DSC node named Computer14 to the Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of an Automation account. This cmdlet exports reports for a DSC node that belongs to the account that this parameter specifies.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
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

-EndTime

Specifies an end time. This cmdlet gets reports that Automation received before this time.

Type:Nullable<T>[DateTimeOffset]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

Specifies the unique ID of the DSC node report for this cmdlet to get.

Type:Guid
Aliases:ReportId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Latest

Indicates that this cmdlet gets the latest DSC report for the specified node only.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NodeId

Specifies the unique ID of the DSC node for which this cmdlet gets reports.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group that contains the DSC node for which this cmdlet gets reports.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StartTime

Specifies a start time. This cmdlet gets reports that Automation received after this time.

Type:Nullable<T>[DateTimeOffset]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Nullable<T>[[System.DateTimeOffset, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs