Node Reports - List By Node

Retrieve the Dsc node report list by node id.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports?api-version=2018-01-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports?$filter={$filter}&api-version=2018-01-15

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$

automationAccountName
path True
  • string

The name of the automation account.

nodeId
path True
  • string

The parameters supplied to the list operation.

$filter
query
  • string

The filter to apply on the operation.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Media Types: "application/json", "text/plain"

Other Status Codes

Automation error response describing why the operation failed.

Media Types: "application/json", "text/plain"

Examples

List DSC reports by node id.

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports?api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/903a5ead-140c-11e7-a943-000d3a6140c9",
      "reportId": "903a5ead-140c-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T23:16:27.587+00:00",
      "endTime": "2017-03-28T23:16:27.587+00:00",
      "lastModifiedTime": "2017-03-28T23:16:29.4440401+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/903a5eac-140c-11e7-a943-000d3a6140c9",
      "reportId": "903a5eac-140c-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T23:16:26.015+00:00",
      "endTime": "2017-03-28T23:16:27.015+00:00",
      "lastModifiedTime": "2017-03-28T23:16:28.3813034+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/77c280c2-140a-11e7-a943-000d3a6140c9",
      "reportId": "77c280c2-140a-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T23:01:25.986+00:00",
      "endTime": "2017-03-28T23:01:26.986+00:00",
      "lastModifiedTime": "2017-03-28T23:01:28.216963+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/5f4f5382-1408-11e7-a943-000d3a6140c9",
      "reportId": "5f4f5382-1408-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T22:46:27.668+00:00",
      "endTime": "2017-03-28T22:46:28.668+00:00",
      "lastModifiedTime": "2017-03-28T22:46:29.0439184+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/5f4f5381-1408-11e7-a943-000d3a6140c9",
      "reportId": "5f4f5381-1408-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T22:46:25.957+00:00",
      "endTime": "2017-03-28T22:46:26.957+00:00",
      "lastModifiedTime": "2017-03-28T22:46:27.9498533+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/46d97d6a-1406-11e7-a943-000d3a6140c9",
      "reportId": "46d97d6a-1406-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T22:31:25.941+00:00",
      "endTime": "2017-03-28T22:31:26.941+00:00",
      "lastModifiedTime": "2017-03-28T22:31:27.6825492+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/48c8e301-1404-11e7-a943-000d3a6140c9",
      "reportId": "48c8e301-1404-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T22:17:10.163+00:00",
      "endTime": "2017-03-28T22:17:10.163+00:00",
      "lastModifiedTime": "2017-03-28T22:17:11.0040472+00:00",
      "status": "Failed",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/2e63fdbc-1404-11e7-a943-000d3a6140c9",
      "reportId": "2e63fdbc-1404-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T22:16:25.897+00:00",
      "endTime": "2017-03-28T22:17:09.897+00:00",
      "lastModifiedTime": "2017-03-28T22:16:27.3128731+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/15ee63e4-1402-11e7-a943-000d3a6140c9",
      "reportId": "15ee63e4-1402-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T22:01:25.899+00:00",
      "endTime": "2017-03-28T22:01:27.899+00:00",
      "lastModifiedTime": "2017-03-28T22:01:26.6282252+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/0508f316-1400-11e7-a943-000d3a6140c9",
      "reportId": "0508f316-1400-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T21:46:38.511+00:00",
      "endTime": "2017-03-28T21:46:39.511+00:00",
      "lastModifiedTime": "2017-03-28T21:46:40.577983+00:00",
      "status": "Failed",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/fd799a51-13ff-11e7-a943-000d3a6140c9",
      "reportId": "fd799a51-13ff-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T21:46:25.843+00:00",
      "endTime": "2017-03-28T21:46:37.843+00:00",
      "lastModifiedTime": "2017-03-28T21:46:28.4660077+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/e504ae1b-13fd-11e7-a943-000d3a6140c9",
      "reportId": "e504ae1b-13fd-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T21:31:25.818+00:00",
      "endTime": "2017-03-28T21:31:27.818+00:00",
      "lastModifiedTime": "2017-03-28T21:31:28.1503168+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/cd3ed224-13fb-11e7-a943-000d3a6140c9",
      "reportId": "cd3ed224-13fb-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T21:16:35.538+00:00",
      "endTime": "2017-03-28T21:16:59.538+00:00",
      "lastModifiedTime": "2017-03-28T21:16:37.1768158+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/cd3ed223-13fb-11e7-a943-000d3a6140c9",
      "reportId": "cd3ed223-13fb-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T21:16:26.956+00:00",
      "endTime": "2017-03-28T21:16:34.956+00:00",
      "lastModifiedTime": "2017-03-28T21:16:29.2370664+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/b6915efa-13f9-11e7-a943-000d3a6140c9",
      "reportId": "b6915efa-13f9-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T21:01:29.916+00:00",
      "endTime": "2017-03-28T21:02:02.916+00:00",
      "lastModifiedTime": "2017-03-28T21:01:31.875597+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/a3560dca-13f7-11e7-a943-000d3a6140c9",
      "reportId": "a3560dca-13f7-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T20:46:38.626+00:00",
      "endTime": "2017-03-28T20:46:44.626+00:00",
      "lastModifiedTime": "2017-03-28T20:46:39.749649+00:00",
      "status": "Failed",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/9b9bb016-13f7-11e7-a943-000d3a6140c9",
      "reportId": "9b9bb016-13f7-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T20:46:25.676+00:00",
      "endTime": "2017-03-28T20:46:37.676+00:00",
      "lastModifiedTime": "2017-03-28T20:46:27.2602881+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/833bd89b-13f5-11e7-a943-000d3a6140c9",
      "reportId": "833bd89b-13f5-11e7-a943-000d3a6140c9",
      "type": "Consistency",
      "startTime": "2017-03-28T20:31:25.805+00:00",
      "endTime": "2017-03-28T20:40:24.805+00:00",
      "lastModifiedTime": "2017-03-28T20:31:27.1356547+00:00",
      "status": "Compliant",
      "configurationVersion": "2.0.0",
      "rebootRequested": "False",
      "refreshMode": "Pull",
      "reportFormatVersion": "2.0"
    }
  ]
}

Definitions

DscMetaConfiguration

Definition of the DSC Meta Configuration.

DscNodeReport

Definition of the dsc node report type.

DscNodeReportListResult

The response model for the list dsc nodes operation.

DscReportError

Definition of the dsc node report error type.

DscReportResource

Definition of the DSC Report Resource.

DscReportResourceNavigation

Navigation for DSC Report Resource.

ErrorResponse

Error response of an operation failure

DscMetaConfiguration

Definition of the DSC Meta Configuration.

Name Type Description
actionAfterReboot
  • string

Gets or sets the ActionAfterReboot value of the meta configuration.

allowModuleOverwrite
  • boolean

Gets or sets the AllowModuleOverwrite value of the meta configuration.

certificateId
  • string

Gets or sets the CertificateId value of the meta configuration.

configurationMode
  • string

Gets or sets the ConfigurationMode value of the meta configuration.

configurationModeFrequencyMins
  • integer

Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration.

rebootNodeIfNeeded
  • boolean

Gets or sets the RebootNodeIfNeeded value of the meta configuration.

refreshFrequencyMins
  • integer

Gets or sets the RefreshFrequencyMins value of the meta configuration.

DscNodeReport

Definition of the dsc node report type.

Name Type Description
configurationVersion
  • string

Gets or sets the configurationVersion of the node report.

endTime
  • string

Gets or sets the end time of the node report.

errors

Gets or sets the errors for the node report.

hostName
  • string

Gets or sets the hostname of the node that sent the report.

iPV4Addresses
  • string[]

Gets or sets the IPv4 address of the node that sent the report.

iPV6Addresses
  • string[]

Gets or sets the IPv6 address of the node that sent the report.

id
  • string

Gets or sets the id.

lastModifiedTime
  • string

Gets or sets the lastModifiedTime of the node report.

metaConfiguration

Gets or sets the metaConfiguration of the node at the time of the report.

numberOfResources
  • integer

Gets or sets the number of resource in the node report.

rawErrors
  • string

Gets or sets the unparsed errors for the node report.

rebootRequested
  • string

Gets or sets the rebootRequested of the node report.

refreshMode
  • string

Gets or sets the refreshMode of the node report.

reportFormatVersion
  • string

Gets or sets the reportFormatVersion of the node report.

reportId
  • string

Gets or sets the id of the node report.

resources

Gets or sets the resource for the node report.

startTime
  • string

Gets or sets the start time of the node report.

status
  • string

Gets or sets the status of the node report.

type
  • string

Gets or sets the type of the node report.

DscNodeReportListResult

The response model for the list dsc nodes operation.

Name Type Description
nextLink
  • string

Gets or sets the next link.

value

Gets or sets a list of dsc node reports.

DscReportError

Definition of the dsc node report error type.

Name Type Description
errorCode
  • string

Gets or sets the error code.

errorDetails
  • string

Gets or sets the error details.

errorMessage
  • string

Gets or sets the error message.

errorSource
  • string

Gets or sets the source of the error.

locale
  • string

Gets or sets the locale of the error.

resourceId
  • string

Gets or sets the resource ID which generated the error.

DscReportResource

Definition of the DSC Report Resource.

Name Type Description
dependsOn

Gets or sets the Resource Navigation values for resources the resource depends on.

durationInSeconds
  • number

Gets or sets the duration in seconds for the resource.

error
  • string

Gets or sets the error of the resource.

moduleName
  • string

Gets or sets the module name of the resource.

moduleVersion
  • string

Gets or sets the module version of the resource.

resourceId
  • string

Gets or sets the ID of the resource.

resourceName
  • string

Gets or sets the name of the resource.

sourceInfo
  • string

Gets or sets the source info of the resource.

startDate
  • string

Gets or sets the start date of the resource.

status
  • string

Gets or sets the status of the resource.

DscReportResourceNavigation

Navigation for DSC Report Resource.

Name Type Description
resourceId
  • string

Gets or sets the ID of the resource to navigate to.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.