dsc_configurations

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

Overview

Name	dsc_configurations
Type	Resource
Id	azure.automation.dsc_configurations

Fields

vw_dsc_configurations

Name	Datatype	Description
description	text	field from the properties object
automationAccountName	text	field from the properties object
configurationName	text	field from the properties object
creation_time	text	field from the properties object
etag	text	Gets or sets the etag of the resource.
job_count	text	field from the properties object
last_modified_time	text	field from the properties object
location	text	The geo-location where the resource lives
log_verbose	text	field from the properties object
node_configuration_count	text	field from the properties object
parameters	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
source	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

dsc_configurations

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
location	string	The geo-location where the resource lives
properties	object	Definition of the configuration property type.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	automationAccountName, configurationName, resourceGroupName, subscriptionId	Retrieve the configuration identified by configuration name.
list_by_automation_account	SELECT	automationAccountName, resourceGroupName, subscriptionId	Retrieve a list of configurations.
create_or_update	INSERT	automationAccountName, configurationName, resourceGroupName, subscriptionId, data__properties	Create the configuration identified by configuration name.
delete	DELETE	automationAccountName, configurationName, resourceGroupName, subscriptionId	Delete the dsc configuration identified by configuration name.
update	UPDATE	automationAccountName, configurationName, resourceGroupName, subscriptionId	Create the configuration identified by configuration name.

SELECT examples

Retrieve a list of configurations.

vw_dsc_configurations

SELECT
description,
automationAccountName,
configurationName,
creation_time,
etag,
job_count,
last_modified_time,
location,
log_verbose,
node_configuration_count,
parameters,
provisioning_state,
resourceGroupName,
source,
state,
subscriptionId,
tags
FROM azure.automation.vw_dsc_configurations
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

dsc_configurations

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

INSERT example

Use the following StackQL query and manifest file to create a new dsc_configurations resource.

All Properties

/*+ create */
INSERT INTO azure.automation.dsc_configurations (
automationAccountName,
configurationName,
resourceGroupName,
subscriptionId,
data__properties,
properties,
name,
location,
tags
)
SELECT 
'{{ automationAccountName }}',
'{{ configurationName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ name }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: logVerbose
          value: boolean
        - name: logProgress
          value: boolean
        - name: source
          value:
            - name: hash
              value:
                - name: algorithm
                  value: string
                - name: value
                  value: string
            - name: type
              value: string
            - name: value
              value: string
            - name: version
              value: string
        - name: parameters
          value: object
        - name: description
          value: string
    - name: name
      value: string
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a dsc_configurations resource.

/*+ update */
UPDATE azure.automation.dsc_configurations
SET 
properties = '{{ properties }}',
name = '{{ name }}',
tags = '{{ tags }}'
WHERE 
automationAccountName = '{{ automationAccountName }}'
AND configurationName = '{{ configurationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified dsc_configurations resource.

/*+ delete */
DELETE FROM azure.automation.dsc_configurations
WHERE automationAccountName = '{{ automationAccountName }}'
AND configurationName = '{{ configurationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';