dsc_configurations

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

Overview

Name	dsc_configurations
Type	Resource
Id	azure.automation.dsc_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets or sets the configuration properties.
tags	object	Resource tags.

list_by_automation_account

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets or sets the configuration properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, configurationName, subscriptionId		Retrieve the configuration identified by configuration name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter, $skip, $top, $inlinecount	Retrieve a list of configurations.
create_or_update	insert	resourceGroupName, automationAccountName, configurationName, subscriptionId, data__properties		Create the configuration identified by configuration name.
update	update	resourceGroupName, automationAccountName, configurationName, subscriptionId		Create the configuration identified by configuration name.
delete	delete	resourceGroupName, automationAccountName, configurationName, subscriptionId		Delete the dsc configuration 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
automationAccountName	string	The name of the automation account.
configurationName	string	The configuration name.
resourceGroupName	string	Name of an Azure Resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$filter	string	The filter to apply on the operation.
$inlinecount	string	Return total rows.
$skip	integer	The number of rows to skip.
$top	integer	The number of rows to take.

SELECT examples

get

Retrieve the configuration identified by configuration name.

SELECT
etag,
location,
properties,
tags
FROM azure.automation.dsc_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND configurationName = '{{ configurationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of configurations.

SELECT
etag,
location,
properties,
tags
FROM azure.automation.dsc_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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_configurations (
data__properties,
data__name,
data__location,
data__tags,
resourceGroupName,
automationAccountName,
configurationName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ configurationName }}',
'{{ subscriptionId }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: dsc_configurations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the dsc_configurations resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the dsc_configurations resource.
    - name: configurationName
      value: string
      description: Required parameter for the dsc_configurations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the dsc_configurations resource.
    - name: properties
      value: object
      description: |
        Gets or sets configuration create or update properties.
    - name: name
      value: string
      description: |
        Gets or sets name of the resource.
    - name: location
      value: string
      description: |
        Gets or sets the location of the resource.
    - name: tags
      value: object
      description: |
        Gets or sets the tags attached to the resource.

UPDATE examples

update

Create the configuration identified by configuration name.

UPDATE azure.automation.dsc_configurations
SET 
data__properties = '{{ properties }}',
data__name = '{{ name }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND configurationName = '{{ configurationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
etag,
location,
properties,
tags;

DELETE examples

delete

Delete the dsc configuration identified by configuration name.

DELETE FROM azure.automation.dsc_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND configurationName = '{{ configurationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;