Skip to main content

devices_network_settings

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

Overview

Namedevices_network_settings
TypeResource
Idazure.data_box_edge.devices_network_settings

Fields

The following fields are returned by SELECT queries:

The device network settings.

NameDatatypeDescription
idstringThe path ID that uniquely identifies the object.
namestringThe object name.
propertiesobjectThe properties of network settings of a device.
systemDataobjectMetadata pertaining to creation and last modification of NetworkSettings
typestringThe hierarchical type of the object.

Methods

The following methods are available for this resource:

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

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

SELECT examples

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
;