dsc_node_configuration

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

Overview

Name	dsc_node_configuration
Type	Resource
Id	azure.automation.dsc_node_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.
configuration	object	Gets or sets the configuration of the node.
creationTime	string (date-time)	Gets or sets creation time.
incrementNodeConfigurationBuild	boolean	If a new build version of NodeConfiguration is required.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
nodeCount	integer	Number of nodes with this node configuration assigned.
source	string	Source of node configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
configuration	object	Gets or sets the configuration of the node.
creationTime	string (date-time)	Gets or sets creation time.
incrementNodeConfigurationBuild	boolean	If a new build version of NodeConfiguration is required.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
nodeCount	integer	Number of nodes with this node configuration assigned.
source	string	Source of node configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, node_configuration_name, subscription_id		Retrieve the Dsc node configurations by node configuration.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id	$filter, $skip, $top, $inlinecount	Retrieve a list of dsc node configurations.
create_or_update	insert	resource_group_name, automation_account_name, node_configuration_name, subscription_id		Create the node configuration identified by node configuration name.
create_or_update	replace	resource_group_name, automation_account_name, node_configuration_name, subscription_id		Create the node configuration identified by node configuration name.
delete	delete	resource_group_name, automation_account_name, node_configuration_name, subscription_id		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
automation_account_name	string	The name of the automation account. Required.
node_configuration_name	string	The Dsc node 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 Dsc node configurations by node configuration.

SELECT
id,
name,
configuration,
creationTime,
incrementNodeConfigurationBuild,
lastModifiedTime,
nodeCount,
source,
systemData,
type
FROM azure.automation.dsc_node_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND node_configuration_name = '{{ node_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of dsc node configurations.

SELECT
id,
name,
configuration,
creationTime,
incrementNodeConfigurationBuild,
lastModifiedTime,
nodeCount,
source,
systemData,
type
FROM azure.automation.dsc_node_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 node configuration identified by node configuration name.

INSERT INTO azure.automation.dsc_node_configuration (
properties,
name,
tags,
resource_group_name,
automation_account_name,
node_configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ node_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dsc_node_configuration
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dsc_node_configuration resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the dsc_node_configuration resource.
  - name: node_configuration_name
    value: "{{ node_configuration_name }}"
    description: Required parameter for the dsc_node_configuration resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dsc_node_configuration resource.
  - name: properties
    description: |
      Node configuration properties.
    value:
      source:
        hash:
          algorithm: "{{ algorithm }}"
          value: "{{ value }}"
        type: "{{ type }}"
        value: "{{ value }}"
        version: "{{ version }}"
      configuration:
        name: "{{ name }}"
      incrementNodeConfigurationBuild: {{ incrementNodeConfigurationBuild }}
  - name: name
    value: "{{ name }}"
    description: |
      Name of the node configuration.
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the tags attached to the resource.

REPLACE examples

create_or_update

Create the node configuration identified by node configuration name.

REPLACE azure.automation.dsc_node_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 node_configuration_name = '{{ node_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the Dsc node configurations by node configuration.

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