Node Reports - Get
Retrieve the Dsc node report data by node id and report id.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}?api-version=2019-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
automation
|
path | True |
string |
The name of the automation account. |
node
|
path | True |
string |
The Dsc node id. |
report
|
path | True |
string |
The report id. |
resource
|
path | True |
string |
Name of an Azure Resource group. Regex pattern: |
subscription
|
path | True |
string |
Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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" |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get Dsc node report data by node id and report id.
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/903a5ead-140c-11e7-a943-000d3a6140c9?api-version=2019-06-01
Sample Response
{
"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",
"refreshMode": "Pull",
"rebootRequested": "False",
"reportFormatVersion": "2.0",
"configurationVersion": "2.0.0",
"errors": [],
"resources": [
{
"resourceId": "[WindowsFeature]IIS",
"sourceInfo": "::4::32::WindowsFeature",
"dependsOn": [],
"moduleName": "PsDesiredStateConfiguration",
"moduleVersion": "1.1",
"resourceName": "WindowsFeature",
"error": null,
"status": "Compliant",
"durationInSeconds": 0.25,
"startDate": "2017-03-28T23:16:28.181+00:00"
}
],
"metaConfiguration": {
"configurationModeFrequencyMins": 15,
"rebootNodeIfNeeded": false,
"configurationMode": "ApplyAndMonitor",
"actionAfterReboot": "ContinueConfiguration",
"certificateId": "certId",
"refreshFrequencyMins": 30,
"allowModuleOverwrite": false
},
"hostName": "DSCCOMP",
"iPV4Addresses": [
"172.16.2.5",
"127.0.0.1"
],
"iPV6Addresses": [
"fe80::4c51:9518:aa3c:256a%5",
"::2000:0:0:0",
"::1",
"::2000:0:0:0",
"2001:0:9d38:78cf:106b:130a:53ef:fdfa",
"fe80::106b:130a:53ef:fdfa%7"
],
"numberOfResources": 1,
"rawErrors": null
}
Definitions
Name | Description |
---|---|
Dsc |
Definition of the DSC Meta Configuration. |
Dsc |
Definition of the dsc node report type. |
Dsc |
Definition of the dsc node report error type. |
Dsc |
Definition of the DSC Report Resource. |
Dsc |
Navigation for DSC Report Resource. |
Error |
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. |
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. |