dsc_nodes

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

Overview

Name	dsc_nodes
Type	Resource
Id	azure.automation.dsc_nodes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a DscNode.

list_by_automation_account

Name	Datatype	Description
properties	object	The properties of a DscNode.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, nodeId, subscriptionId		Retrieve the dsc node identified by node id.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter, $skip, $top, $inlinecount	Retrieve a list of dsc nodes.
update	update	resourceGroupName, automationAccountName, nodeId, subscriptionId		Update the dsc node.
delete	delete	resourceGroupName, automationAccountName, nodeId, subscriptionId		Delete the dsc node identified by node id.

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.
nodeId	string	The node id.
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 identified by node id.

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

list_by_automation_account

Retrieve a list of dsc nodes.

SELECT
properties
FROM azure.automation.dsc_nodes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
AND $inlinecount = '{{ $inlinecount }}'
;

UPDATE examples

update

Update the dsc node.

UPDATE azure.automation.dsc_nodes
SET 
data__nodeId = '{{ nodeId }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND nodeId = '{{ nodeId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the dsc node identified by node id.

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