dsc_configuration

Creates, updates, deletes, gets or lists a dsc_configuration resource.

Overview

Name	dsc_configuration
Type	Resource
Id	azure.automation.dsc_configuration

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Gets or sets the creation time.
description	string	Gets or sets the description.
etag	string	Gets or sets the etag of the resource.
jobCount	integer	Gets or sets the job count of the configuration.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
location	string	The geo-location where the resource lives. Required.
logVerbose	boolean	Gets or sets verbose log option.
nodeConfigurationCount	integer	Gets the number of compiled node configurations.
parameters	object	Gets or sets the configuration parameters.
provisioningState	string	Gets or sets the provisioning state of the configuration. Default value is "Succeeded".
source	object	Gets or sets the source.
state	string	Gets or sets the state of the configuration. Known values are: "New", "Edit", and "Published". (New, Edit, Published)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_automation_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Gets or sets the creation time.
description	string	Gets or sets the description.
etag	string	Gets or sets the etag of the resource.
jobCount	integer	Gets or sets the job count of the configuration.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
location	string	The geo-location where the resource lives. Required.
logVerbose	boolean	Gets or sets verbose log option.
nodeConfigurationCount	integer	Gets the number of compiled node configurations.
parameters	object	Gets or sets the configuration parameters.
provisioningState	string	Gets or sets the provisioning state of the configuration. Default value is "Succeeded".
source	object	Gets or sets the source.
state	string	Gets or sets the state of the configuration. Known values are: "New", "Edit", and "Published". (New, Edit, Published)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, automation_account_name, configuration_name, subscription_id		Retrieve the configuration identified by configuration name.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id	$filter, $skip, $top, $inlinecount	Retrieve a list of configurations.
create_or_update	insert	resource_group_name, automation_account_name, configuration_name, subscription_id, properties		Create the configuration identified by configuration name.
update	update	resource_group_name, automation_account_name, configuration_name, subscription_id		Create the configuration identified by configuration name.
create_or_update	replace	resource_group_name, automation_account_name, configuration_name, subscription_id, properties		Create the configuration identified by configuration name.
delete	delete	resource_group_name, automation_account_name, configuration_name, subscription_id		Delete the dsc configuration identified by configuration name.
get_content	exec	resource_group_name, automation_account_name, configuration_name, subscription_id		Retrieve the configuration script identified by configuration name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
automation_account_name	string	The name of the automation account. Required.
configuration_name	string	The configuration name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Default value is None.
$inlinecount	string	Return total rows. Default value is None.
$skip	integer	The number of rows to skip. Default value is None.
$top	integer	The number of rows to take. Default value is None.

SELECT examples

get

Retrieve the configuration identified by configuration name.

SELECT
id,
name,
creationTime,
description,
etag,
jobCount,
lastModifiedTime,
location,
logVerbose,
nodeConfigurationCount,
parameters,
provisioningState,
source,
state,
systemData,
tags,
type
FROM azure.automation.dsc_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of configurations.

SELECT
id,
name,
creationTime,
description,
etag,
jobCount,
lastModifiedTime,
location,
logVerbose,
nodeConfigurationCount,
parameters,
provisioningState,
source,
state,
systemData,
tags,
type
FROM azure.automation.dsc_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
AND $inlinecount = '{{ $inlinecount }}'
;

INSERT examples

create_or_update

Create the configuration identified by configuration name.

INSERT INTO azure.automation.dsc_configuration (
properties,
name,
location,
tags,
resource_group_name,
automation_account_name,
configuration_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dsc_configuration
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dsc_configuration resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the dsc_configuration resource.
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the dsc_configuration resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dsc_configuration resource.
  - name: properties
    description: |
      Gets or sets configuration create or update properties. Required.
    value:
      logVerbose: {{ logVerbose }}
      logProgress: {{ logProgress }}
      source:
        hash:
          algorithm: "{{ algorithm }}"
          value: "{{ value }}"
        type: "{{ type }}"
        value: "{{ value }}"
        version: "{{ version }}"
      parameters: "{{ parameters }}"
      description: "{{ description }}"
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets name of the resource.
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the tags attached to the resource.

UPDATE examples

update

Create the configuration identified by configuration name.

UPDATE azure.automation.dsc_configuration
SET 
properties = '{{ properties }}',
name = '{{ name }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create the configuration identified by configuration name.

REPLACE azure.automation.dsc_configuration
SET 
properties = '{{ properties }}',
name = '{{ name }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the dsc configuration identified by configuration name.

DELETE FROM azure.automation.dsc_configuration
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_content

Retrieve the configuration script identified by configuration name.

EXEC azure.automation.dsc_configuration.get_content 
@resource_group_name='{{ resource_group_name }}' --required, 
@automation_account_name='{{ automation_account_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;