Skip to main content

nodes

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

Overview

Namenodes
TypeResource
Idazure.data_box_edge.nodes

Fields

The following fields are returned by SELECT queries:

The collection of all nodes on the device.

NameDatatypeDescription
idstringThe path ID that uniquely identifies the object.
namestringThe object name.
propertiesobjectThe properties of the node
typestringThe hierarchical type of the object.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_by_data_box_edge_deviceselectdeviceName, subscriptionId, resourceGroupNameGets 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.

NameDatatypeDescription
deviceNamestringThe device name.
resourceGroupNamestringThe resource group name.
subscriptionIdstringThe subscription ID.

SELECT examples

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

SELECT
id,
name,
properties,
type
FROM azure.data_box_edge.nodes
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;