devices_network_settings
Creates, updates, deletes, gets or lists a devices_network_settings resource.
Overview
| Name | devices_network_settings |
| Type | Resource |
| Id | azure.data_box_edge.devices_network_settings |
Fields
The following fields are returned by SELECT queries:
- get
The device network settings.
| Name | Datatype | Description |
|---|---|---|
id | string | The path ID that uniquely identifies the object. |
name | string | The object name. |
properties | object | The properties of network settings of a device. |
systemData | object | Metadata pertaining to creation and last modification of NetworkSettings |
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 |
|---|---|---|---|---|
get | select | deviceName, subscriptionId, resourceGroupName | Gets the network settings of the specified Data Box Edge/Data Box Gateway 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
- get
Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.devices_network_settings
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;