nodes

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

Overview

Name	nodes
Type	Resource
Id	azure.data_box_edge.nodes

Fields

The following fields are returned by SELECT queries:

list_by_data_box_edge_device

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
nodeChassisSerialNumber	string	Serial number of the Chassis.
nodeDisplayName	string	Display Name of the individual node.
nodeFriendlySoftwareVersion	string	Friendly software version name that is currently installed on the node.
nodeHcsVersion	string	HCS version that is currently installed on the node.
nodeInstanceId	string	Guid instance id of the node.
nodeSerialNumber	string	Serial number of the individual node.
nodeStatus	string	The current status of the individual node. Known values are: "Unknown", "Up", "Down", "Rebooting", and "ShuttingDown". (Unknown, Up, Down, Rebooting, ShuttingDown)
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_data_box_edge_device	select	device_name, resource_group_name, subscription_id		Gets all the nodes currently configured under this Data Box Edge device.

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
device_name	string	The device name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_by_data_box_edge_device

Gets all the nodes currently configured under this Data Box Edge device.

SELECT
id,
name,
nodeChassisSerialNumber,
nodeDisplayName,
nodeFriendlySoftwareVersion,
nodeHcsVersion,
nodeInstanceId,
nodeSerialNumber,
nodeStatus,
type
FROM azure.data_box_edge.nodes
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;