DataBoxEdgeDevice Class

The Data Box Edge/Gateway device.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

DataBoxEdgeDevice(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, etag: str | None = None, data_box_edge_device_status: str | _models.DataBoxEdgeDeviceStatus | None = None, description: str | None = None, model_description: str | None = None, friendly_name: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. Required.
tags	dict[str, str] The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). Default value: None
sku	Sku The SKU type. Default value: None
etag	str The etag for the devices. Default value: None
data_box_edge_device_status	str or DataBoxEdgeDeviceStatus The status of the Data Box Edge/Gateway device. Known values are: "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected", and "Maintenance". Default value: None
description	str The Description of the Data Box Edge/Gateway device. Default value: None
model_description	str The description of the Data Box Edge/Gateway device model. Default value: None
friendly_name	str The Data Box Edge/Gateway device name. Default value: None

Variables

Name	Description
id	str The path ID that uniquely identifies the object.
name	str The object name.
type	str The hierarchical type of the object.
location	str The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. Required.
tags	dict[str, str] The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
sku	Sku The SKU type.
etag	str The etag for the devices.
data_box_edge_device_status	str or DataBoxEdgeDeviceStatus The status of the Data Box Edge/Gateway device. Known values are: "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected", and "Maintenance".
serial_number	str The Serial Number of Data Box Edge/Gateway device.
description	str The Description of the Data Box Edge/Gateway device.
model_description	str The description of the Data Box Edge/Gateway device model.
device_type	str or DeviceType The type of the Data Box Edge/Gateway device. "DataBoxEdgeDevice"
friendly_name	str The Data Box Edge/Gateway device name.
culture	str The Data Box Edge/Gateway device culture.
device_model	str The Data Box Edge/Gateway device model.
device_software_version	str The Data Box Edge/Gateway device software version.
device_local_capacity	int The Data Box Edge/Gateway device local capacity in MB.
time_zone	str The Data Box Edge/Gateway device timezone.
device_hcs_version	str The device software version number of the device (eg: 1.2.18105.6).
configured_role_types	list[str or RoleTypes] Type of compute roles configured.
node_count	int The number of nodes in the cluster.