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
The collection of all nodes on the device.
| Name | Datatype | Description |
|---|---|---|
id | string | The path ID that uniquely identifies the object. |
name | string | The object name. |
properties | object | The properties of the node |
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 | deviceName, subscriptionId, resourceGroupName | 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 |
|---|---|---|
deviceName | string | The device name. |
resourceGroupName | string | The resource group name. |
subscriptionId | string | The subscription ID. |
SELECT examples
- list_by_data_box_edge_device
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
;