dsc_node_configurations

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

Overview

Name	dsc_node_configurations
Type	Resource
Id	azure.automation.dsc_node_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Gets or sets the configuration properties.

list_by_automation_account

Name	Datatype	Description
properties	object	Gets or sets the configuration properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, automationAccountName, nodeConfigurationName		Retrieve the Dsc node configurations by node configuration.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter, $skip, $top, $inlinecount	Retrieve a list of dsc node configurations.
create_or_update	insert	resourceGroupName, automationAccountName, nodeConfigurationName, subscriptionId		Create the node configuration identified by node configuration name.
delete	delete	subscriptionId, resourceGroupName, automationAccountName, nodeConfigurationName		Delete the Dsc node configurations by node configuration.

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.
nodeConfigurationName	string	The Dsc node 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 Dsc node configurations by node configuration.

SELECT
properties
FROM azure.automation.dsc_node_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND nodeConfigurationName = '{{ nodeConfigurationName }}' -- required
;

list_by_automation_account

Retrieve a list of dsc node configurations.

SELECT
properties
FROM azure.automation.dsc_node_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 node configuration identified by node configuration name.

INSERT INTO azure.automation.dsc_node_configurations (
data__properties,
data__name,
data__tags,
resourceGroupName,
automationAccountName,
nodeConfigurationName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ nodeConfigurationName }}',
'{{ subscriptionId }}'
;

Manifest

# Description fields are for documentation purposes
- name: dsc_node_configurations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the dsc_node_configurations resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the dsc_node_configurations resource.
    - name: nodeConfigurationName
      value: string
      description: Required parameter for the dsc_node_configurations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the dsc_node_configurations resource.
    - name: properties
      value: object
      description: |
        Node configuration properties
    - name: name
      value: string
      description: |
        Name of the node configuration.
    - name: tags
      value: object
      description: |
        Gets or sets the tags attached to the resource.

DELETE examples

delete

Delete the Dsc node configurations by node configuration.

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