Dsc Node Configuration - List By Automation Account

Retrieve a list of dsc node configurations.

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

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.

api-version
query True
  • string

Client Api Version.

$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.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Automation error response describing why the operation failed.

Examples

List DSC node configurations by Automation Account
List Paged DSC node configurations by Automation Account with name filter
List Paged DSC node configurations by Automation Account with no filter

List DSC node configurations by Automation Account

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "SetupServer.localhost",
      "properties": {
        "configuration": {
          "name": "SetupServer"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "source": null,
        "nodeCount": 0,
        "incrementNodeConfigurationBuild": false
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "SetupServer.localhost",
      "properties": {
        "configuration": {
          "name": "SetupServer"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "source": null,
        "nodeCount": 0,
        "incrementNodeConfigurationBuild": false
      }
    }
  ]
}

List Paged DSC node configurations by Automation Account with name filter

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "server.localhost",
      "properties": {
        "configuration": {
          "name": "SetupServer"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "nodeCount": 2
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupClient.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "SetupClient.localhost",
      "properties": {
        "configuration": {
          "name": "SetupClient"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "nodeCount": 6
      }
    }
  ],
  "totalCount": 6
}

List Paged DSC node configurations by Automation Account with no filter

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "server.localhost",
      "properties": {
        "configuration": {
          "name": "SetupServer"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "nodeCount": 2
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupClient.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "SetupClient.localhost",
      "properties": {
        "configuration": {
          "name": "SetupClient"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "nodeCount": 6
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/webServer.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "webServer.localhost",
      "properties": {
        "configuration": {
          "name": "webServer"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "nodeCount": 5
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SqlServer.localhost",
      "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations",
      "name": "SqlServer.localhost",
      "properties": {
        "configuration": {
          "name": "SqlServer"
        },
        "creationTime": "2017-03-28T23:17:06.8901968+00:00",
        "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00",
        "nodeCount": 1
      }
    }
  ],
  "totalCount": 12
}

Definitions

DscConfigurationAssociationProperty

The Dsc configuration property associated with the entity.

DscNodeConfiguration

Definition of the dsc node configuration.

DscNodeConfigurationListResult

The response model for the list job operation.

ErrorResponse

Error response of an operation failure

DscConfigurationAssociationProperty

The Dsc configuration property associated with the entity.

Name Type Description
name
  • string

Gets or sets the name of the Dsc configuration.

DscNodeConfiguration

Definition of the dsc node configuration.

Name Type Description
id
  • string

Fully qualified resource Id for the resource

name
  • string

The name of the resource

properties.configuration

Gets or sets the configuration of the node.

properties.creationTime
  • string

Gets or sets creation time.

properties.incrementNodeConfigurationBuild
  • boolean

If a new build version of NodeConfiguration is required.

properties.lastModifiedTime
  • string

Gets or sets the last modified time.

properties.nodeCount
  • integer

Number of nodes with this nodeconfiguration assigned

properties.source
  • string

Source of node configuration.

type
  • string

The type of the resource.

DscNodeConfigurationListResult

The response model for the list job operation.

Name Type Description
nextLink
  • string

Gets or sets the next link.

totalCount
  • integer

Gets or sets the total rows in query.

value

Gets or sets a list of Dsc node configurations.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.