dsc_node

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

Overview

Name	dsc_node
Type	Resource
Id	azure.automation.dsc_node

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.
accountId	string	Gets or sets the account id of the node.
etag	string	Gets or sets the etag of the resource.
extensionHandler	array	Gets or sets the list of extensionHandler properties for a Node.
ip	string	Gets or sets the ip of the node.
lastSeen	string (date-time)	Gets or sets the last seen time of the node.
nodeConfiguration	object	Gets or sets the configuration of the node.
nodeId	string	Gets or sets the node id.
registrationTime	string (date-time)	Gets or sets the registration time of the node.
status	string	Gets or sets the status of the node.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalCount	integer	Gets the total number of records matching filter criteria.
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.
accountId	string	Gets or sets the account id of the node.
etag	string	Gets or sets the etag of the resource.
extensionHandler	array	Gets or sets the list of extensionHandler properties for a Node.
ip	string	Gets or sets the ip of the node.
lastSeen	string (date-time)	Gets or sets the last seen time of the node.
nodeConfiguration	object	Gets or sets the configuration of the node.
nodeId	string	Gets or sets the node id.
registrationTime	string (date-time)	Gets or sets the registration time of the node.
status	string	Gets or sets the status of the node.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalCount	integer	Gets the total number of records matching filter criteria.
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_id, subscription_id		Retrieve the dsc node identified by node id.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id	$filter, $skip, $top, $inlinecount	Retrieve a list of dsc nodes.
update	update	resource_group_name, automation_account_name, node_id, subscription_id		Update the dsc node.
delete	delete	resource_group_name, automation_account_name, node_id, subscription_id		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
automation_account_name	string	The name of the automation account. Required.
node_id	string	The node id. 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 identified by node id.

SELECT
id,
name,
accountId,
etag,
extensionHandler,
ip,
lastSeen,
nodeConfiguration,
nodeId,
registrationTime,
status,
systemData,
totalCount,
type
FROM azure.automation.dsc_node
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND node_id = '{{ node_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of dsc nodes.

SELECT
id,
name,
accountId,
etag,
extensionHandler,
ip,
lastSeen,
nodeConfiguration,
nodeId,
registrationTime,
status,
systemData,
totalCount,
type
FROM azure.automation.dsc_node
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 }}'
;

UPDATE examples

update

Update the dsc node.

UPDATE azure.automation.dsc_node
SET 
nodeId = '{{ nodeId }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND node_id = '{{ node_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the dsc node identified by node id.

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