Dsc Configuration - List By Automation Account

Retrieve a list of configurations.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations?api-version=2015-10-31
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations?api-version=2015-10-31&$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

Media Types: "application/json", "text/plain; charset=utf-8"

Other Status Codes

Automation error response describing why the operation failed.

Media Types: "application/json", "text/plain; charset=utf-8"

Examples

Get DSC Configuration
List Paged DSC Configurations with name filter
List Paged DSC Configurations with no filter

Get DSC Configuration

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations?api-version=2015-10-31

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SetupServer",
      "location": "East US 2",
      "name": "SetupServer",
      "type": "Microsoft.Automation/AutomationAccounts/Configurations",
      "properties": {
        "state": "Published",
        "creationTime": "2017-03-28T18:53:24.997+00:00",
        "lastModifiedTime": "2017-03-28T18:53:24.997+00:00"
      }
    }
  ]
}

List Paged DSC Configurations with name filter

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations?api-version=2015-10-31&$filter=contains(name,'server')&$skip=0&$top=2&$inlinecount=allpages

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerBig",
      "location": "East US 2",
      "name": "SqlServerBig",
      "type": "Microsoft.Automation/AutomationAccounts/Configurations",
      "properties": {
        "state": "Published",
        "creationTime": "2017-03-28T18:53:24.997+00:00",
        "lastModifiedTime": "2017-03-28T18:53:24.997+00:00",
        "nodeConfigurationCount": 1
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerLittle",
      "location": "East US 2",
      "name": "SqlServerLittle",
      "type": "Microsoft.Automation/AutomationAccounts/Configurations",
      "properties": {
        "state": "Published",
        "creationTime": "2017-03-28T18:53:24.997+00:00",
        "lastModifiedTime": "2017-03-28T18:53:24.997+00:00",
        "nodeConfigurationCount": 1
      }
    }
  ],
  "totalCount": 4
}

List Paged DSC Configurations with no filter

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations?api-version=2015-10-31&$skip=0&$top=3&$inlinecount=allpages

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerBig",
      "location": "East US 2",
      "name": "SqlServerBig",
      "type": "Microsoft.Automation/AutomationAccounts/Configurations",
      "properties": {
        "state": "Published",
        "creationTime": "2017-03-28T18:53:24.997+00:00",
        "lastModifiedTime": "2017-03-28T18:53:24.997+00:00",
        "nodeConfigurationCount": 1
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerLittle",
      "location": "East US 2",
      "name": "SqlServerLittle",
      "type": "Microsoft.Automation/AutomationAccounts/Configurations",
      "properties": {
        "state": "Published",
        "creationTime": "2017-03-28T18:53:24.997+00:00",
        "lastModifiedTime": "2017-03-28T18:53:24.997+00:00",
        "nodeConfigurationCount": 1
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SetupServer",
      "location": "East US 2",
      "name": "SetupServer",
      "type": "Microsoft.Automation/AutomationAccounts/Configurations",
      "properties": {
        "state": "Published",
        "creationTime": "2017-03-28T18:53:24.997+00:00",
        "lastModifiedTime": "2017-03-28T18:53:24.997+00:00",
        "nodeConfigurationCount": 1
      }
    }
  ],
  "totalCount": 12
}

Definitions

ContentHash

Definition of the runbook property type.

ContentSource

Definition of the content source.

ContentSourceType

Gets or sets the content source type.

DscConfiguration

Definition of the configuration type.

DscConfigurationListResult

The response model for the list configuration operation.

DscConfigurationParameter

Definition of the configuration parameter type.

DscConfigurationProvisioningState

Gets or sets the provisioning state of the configuration.

DscConfigurationState

Gets or sets the state of the configuration.

ErrorResponse

Error response of an operation failure

ContentHash

Definition of the runbook property type.

Name Type Description
algorithm
  • string

Gets or sets the content hash algorithm used to hash the content.

value
  • string

Gets or sets expected hash value of the content.

ContentSource

Definition of the content source.

Name Type Description
hash

Gets or sets the hash.

type

Gets or sets the content source type.

value
  • string

Gets or sets the value of the content. This is based on the content source type.

version
  • string

Gets or sets the version of the content.

ContentSourceType

Gets or sets the content source type.

Name Type Description
embeddedContent
  • string
uri
  • string

DscConfiguration

Definition of the configuration type.

Name Type Description
etag
  • string

Gets or sets the etag of the resource.

id
  • string

Fully qualified resource Id for the resource

location
  • string

The Azure Region where the resource lives

name
  • string

The name of the resource

properties.creationTime
  • string

Gets or sets the creation time.

properties.description
  • string

Gets or sets the description.

properties.jobCount
  • integer

Gets or sets the job count of the configuration.

properties.lastModifiedTime
  • string

Gets or sets the last modified time.

properties.logVerbose
  • boolean

Gets or sets verbose log option.

properties.nodeConfigurationCount
  • integer

Gets the number of compiled node configurations.

properties.parameters

Gets or sets the configuration parameters.

properties.provisioningState

Gets or sets the provisioning state of the configuration.

properties.source

Gets or sets the source.

properties.state

Gets or sets the state of the configuration.

tags
  • object

Resource tags.

type
  • string

The type of the resource.

DscConfigurationListResult

The response model for the list configuration operation.

Name Type Description
nextLink
  • string

Gets or sets the next link.

totalCount
  • integer

Gets the total number of configurations matching filter criteria.

value

Gets or sets a list of configurations.

DscConfigurationParameter

Definition of the configuration parameter type.

Name Type Description
defaultValue
  • string

Gets or sets the default value of parameter.

isMandatory
  • boolean

Gets or sets a Boolean value to indicate whether the parameter is madatory or not.

position
  • integer

Get or sets the position of the parameter.

type
  • string

Gets or sets the type of the parameter.

DscConfigurationProvisioningState

Gets or sets the provisioning state of the configuration.

Name Type Description
Succeeded
  • string

DscConfigurationState

Gets or sets the state of the configuration.

Name Type Description
Edit
  • string
New
  • string
Published
  • string

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.