Feedback Edit

DataBoxEdgeDevice Class

  • Reference

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 Azure.

Inheritance
ARMBaseModel
DataBoxEdgeDevice

Constructor

DataBoxEdgeDevice(*, location: str, tags=None, sku=None, etag: Optional[str] = None, data_box_edge_device_status=None, description: Optional[str] = None, model_description: Optional[str] = None, friendly_name: Optional[str] = None, **kwargs)

Parameters

location
str
Required

Required. 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.

tags
dict[str, str]
Required

The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

sku
Sku
Required

The SKU type.

etag
str
Required

The etag for the devices.

data_box_edge_device_status
str or DataBoxEdgeDeviceStatus
Required

The status of the Data Box Edge/Gateway device. Possible values include: 'ReadyToSetup', 'Online', 'Offline', 'NeedsAttention', 'Disconnected', 'PartiallyDisconnected'

description
str
Required

The Description of the Data Box Edge/Gateway device.

model_description
str
Required

The description of the Data Box Edge/Gateway device model.

friendly_name
str
Required

The Data Box Edge/Gateway device name.

Variables

id
str

The path ID that uniquely identifies the object.

name
str

The object name.

type
str

The hierarchical type of the object.

serial_number
str

The Serial Number of Data Box Edge/Gateway device.

device_type
str or DeviceType

The type of the Data Box Edge/Gateway device. Possible values include: 'DataBoxEdgeDevice'

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
<xref:long>

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.