Dsc Node Configuration - Get

Retrieve the Dsc node configurations by node configuration.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}?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.

nodeConfigurationName
path True
  • string

The Dsc node configuration name.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Automation error response describing why the operation failed.

Examples

Get a DSC node configuration

Sample Request

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

Sample Response

{
  "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
  }
}

Definitions

DscConfigurationAssociationProperty

The Dsc configuration property associated with the entity.

DscNodeConfiguration

Definition of the dsc node configuration.

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.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.