Dsc Node - List By Automation Account

Retrieve a list of dsc nodes.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes?api-version=2018-01-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes?$filter={$filter}&$skip={$skip}&$top={$top}&$inlinecount={$inlinecount}&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.

$filter
query
  • string

The filter to apply on the operation.

$skip
query
  • integer

The number of rows to skip.

$top
query
  • integer

The the number of rows to take.

$inlinecount
query
  • string

Return total rows.

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 nodes by Automation Account
List Paged DSC nodes by Automation Account where Node Configurations are not assigned filter
List Paged DSC nodes by Automation Account with name filter
List Paged DSC nodes by Automation Account with no filters
List Paged DSC nodes by Automation Account with Node Configuration Custom filter
List Paged DSC nodes by Automation Account with node status filter
List Paged DSC nodes by Automation Account with version filter
List Paged DSC nodes with filters separated by 'and'

List DSC nodes by Automation Account

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId",
      "name": "DSCCOMP",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "nodeId",
        "status": "Pending",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId2",
      "name": "DSCCOMP2",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "nodeId2",
        "status": "Pending",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    }
  ]
}

List Paged DSC nodes by Automation Account where Node Configurations are not assigned filter

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes?$filter=properties/nodeConfiguration/name eq ''&$skip=0&$top=20&$inlinecount=allpages&api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node60",
      "name": "Node60",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "477F9596-92F3-479A-82F2-9EE149F2C6B0",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": ""
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node61",
      "name": "Node61",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "E5D5D0B5-400D-48F7-A791-612945DAC5EB",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": ""
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    }
  ],
  "totalCount": 2
}

List Paged DSC nodes by Automation Account with name filter

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes?$filter=contains('DSCCOMP',name)&$skip=0&$top=6&$inlinecount=allpages&api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/DSCCOMP",
      "name": "DSCCOMP",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "708D250A-2169-4B54-89FF-76F5F71C252A",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/DSCCOMP2",
      "name": "DSCCOMP2",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "3B4BB31A-5132-4669-A15F-A17E234D1634",
        "status": "Failed",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    }
  ],
  "totalCount": 2
}

List Paged DSC nodes by Automation Account with no filters

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes?$skip=0&$top=2&$inlinecount=allpages&api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId",
      "name": "DSCCOMP",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "FCC20208-E781-41C4-A757-17AA0429B3A4",
        "status": "Pending",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId2",
      "name": "DSCCOMP2",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "A63C781C-0C50-4825-B295-B7F8ECFD0DBC",
        "status": "Pending",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    }
  ],
  "totalCount": 152
}

List Paged DSC nodes by Automation Account with Node Configuration Custom filter

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes?$filter=contains(properties/nodeConfiguration/name,'SetupServer.localhost,SetupClient.localhost,$$Not$$Configured$$')&$skip=0&$top=4&$inlinecount=allpages&api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node32",
      "name": "Node32",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "477F9596-92F3-479A-82F2-9EE149F2C6B0",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": ""
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node33",
      "name": "Node33",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "E5D5D0B5-400D-48F7-A791-612945DAC5EB",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node34",
      "name": "Node34",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "Node34",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupClient.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node35",
      "name": "Node35",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "Node35",
        "status": "NotCompliant",
        "nodeConfiguration": {
          "name": "SetupClient.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    }
  ],
  "totalCount": 12
}

List Paged DSC nodes by Automation Account with node status filter

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes?$filter=contains(properties/status,'Compliant,NotCompliant')&$skip=0&$top=4&$inlinecount=allpages&api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node12",
      "name": "Node12",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "01D64CDE-85DD-4C9B-B8F1-2F725348FDEC",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node13",
      "name": "Node13",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "E13076D7-A959-4067-B02F-4F014AAD22D7",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node14",
      "name": "Node14",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "4289B441-B9A0-4309-93FC-0C5100CFBE46",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node15",
      "name": "Node15",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "CBD2212B-8F4C-4049-98E7-1DBCBED7343B",
        "status": "NotCompliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.75.0.0"
          }
        ]
      }
    }
  ],
  "totalCount": 67
}

List Paged DSC nodes by Automation Account with version filter

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes?$filter=properties/extensionHandler/any(eh: eh/version le '2.70')&$skip=0&$top=4&$inlinecount=allpages&api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node62",
      "name": "Node62",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "01D64CDE-85DD-4C9B-B8F1-2F725348FDEC",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": null
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node63",
      "name": "Node63",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "E13076D7-A959-4067-B02F-4F014AAD22D7",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.70.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node64",
      "name": "Node64",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "4289B441-B9A0-4309-93FC-0C5100CFBE46",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.70.0.0"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node65",
      "name": "Node65",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "CBD2212B-8F4C-4049-98E7-1DBCBED7343B",
        "status": "NotCompliant",
        "nodeConfiguration": {
          "name": "SetupServer.localhost"
        },
        "extensionHandler": null
      }
    }
  ],
  "totalCount": 7
}

List Paged DSC nodes with filters separated by 'and'

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes?$filter=properties/extensionHandler/any(eh: eh/version gt '2.70') and contains(name,'sql') and contains(properties/nodeConfiguration/name,'$$Not$$Configured$$')&$skip=0&$top=10&$inlinecount=allpages&api-version=2018-01-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Sql1",
      "name": "Sql1",
      "type": "Microsoft.Automation/AutomationAccounts/Nodes",
      "properties": {
        "lastSeen": "2018-03-22T22:25:39.0963773+00:00",
        "registrationTime": "2018-03-10T00:51:12.5393083+00:00",
        "ip": "ip",
        "nodeId": "01D64CDE-85DD-4C9B-B8F1-2F725348FDEC",
        "status": "Compliant",
        "nodeConfiguration": {
          "name": "SetupSqlServer.localhost"
        },
        "extensionHandler": [
          {
            "name": "Microsoft.Powershell.DSC",
            "version": "2.70.0.1"
          }
        ]
      }
    }
  ],
  "totalCount": 1
}

Definitions

DscNode

Definition of a DscNode

DscNodeExtensionHandlerAssociationProperty

The dsc extensionHandler property associated with the node

DscNodeListResult

The response model for the list dsc nodes operation.

ErrorResponse

Error response of an operation failure

DscNode

Definition of a DscNode

Name Type Description
id
  • string

Fully qualified resource Id for the resource

name
  • string

The name of the resource

properties.accountId
  • string

Gets or sets the account id of the node.

properties.etag
  • string

Gets or sets the etag of the resource.

properties.extensionHandler

Gets or sets the list of extensionHandler properties for a Node.

properties.ip
  • string

Gets or sets the ip of the node.

properties.lastSeen
  • string

Gets or sets the last seen time of the node.

properties.nodeConfiguration.name
  • string

Gets or sets the name of the dsc nodeconfiguration.

properties.nodeId
  • string

Gets or sets the node id.

properties.registrationTime
  • string

Gets or sets the registration time of the node.

properties.status
  • string

Gets or sets the status of the node.

properties.totalCount
  • integer

Gets the total number of records matching filter criteria.

type
  • string

The type of the resource.

DscNodeExtensionHandlerAssociationProperty

The dsc extensionHandler property associated with the node

Name Type Description
name
  • string

Gets or sets the name of the extension handler.

version
  • string

Gets or sets the version of the extension handler.

DscNodeListResult

The response model for the list dsc nodes operation.

Name Type Description
nextLink
  • string

Gets or sets the next link.

totalCount
  • integer

Gets the total number of nodes matching filter criteria.

value

Gets or sets a list of dsc nodes.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.