DataBoxEdgeDevice interface
The Data Box Edge/Gateway device.
- Extends
Properties
configured |
Type of compute roles configured. NOTE: This property will not be serialized. It can only be populated by the server. |
culture | The Data Box Edge/Gateway device culture. NOTE: This property will not be serialized. It can only be populated by the server. |
data |
The status of the Data Box Edge/Gateway device. |
data |
The details of data-residency related properties for this resource |
description | The Description of the Data Box Edge/Gateway device. NOTE: This property will not be serialized. It can only be populated by the server. |
device |
The device software version number of the device (eg: 1.2.18105.6). NOTE: This property will not be serialized. It can only be populated by the server. |
device |
The Data Box Edge/Gateway device local capacity in MB. NOTE: This property will not be serialized. It can only be populated by the server. |
device |
The Data Box Edge/Gateway device model. NOTE: This property will not be serialized. It can only be populated by the server. |
device |
The Data Box Edge/Gateway device software version. NOTE: This property will not be serialized. It can only be populated by the server. |
device |
The type of the Data Box Edge/Gateway device. NOTE: This property will not be serialized. It can only be populated by the server. |
edge |
The details of Edge Profile for this resource NOTE: This property will not be serialized. It can only be populated by the server. |
etag | The etag for the devices. |
friendly |
The Data Box Edge/Gateway device name. NOTE: This property will not be serialized. It can only be populated by the server. |
identity | Msi identity of the resource |
kind | The kind of the device. |
location | 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. |
model |
The description of the Data Box Edge/Gateway device model. NOTE: This property will not be serialized. It can only be populated by the server. |
node |
The number of nodes in the cluster. NOTE: This property will not be serialized. It can only be populated by the server. |
resource |
The details of the move operation on this resource. NOTE: This property will not be serialized. It can only be populated by the server. |
serial |
The Serial Number of Data Box Edge/Gateway device. NOTE: This property will not be serialized. It can only be populated by the server. |
sku | The SKU type. |
system |
DataBoxEdge Resource NOTE: This property will not be serialized. It can only be populated by the server. |
system |
DataBoxEdge Device Properties NOTE: This property will not be serialized. It can only be populated by the server. |
tags | The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). |
time |
The Data Box Edge/Gateway device timezone. NOTE: This property will not be serialized. It can only be populated by the server. |
Inherited Properties
id | The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server. |
name | The object name. NOTE: This property will not be serialized. It can only be populated by the server. |
type | The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
configuredRoleTypes
Type of compute roles configured. NOTE: This property will not be serialized. It can only be populated by the server.
configuredRoleTypes?: string[]
Property Value
string[]
culture
The Data Box Edge/Gateway device culture. NOTE: This property will not be serialized. It can only be populated by the server.
culture?: string
Property Value
string
dataBoxEdgeDeviceStatus
The status of the Data Box Edge/Gateway device.
dataBoxEdgeDeviceStatus?: string
Property Value
string
dataResidency
The details of data-residency related properties for this resource
dataResidency?: DataResidency
Property Value
description
The Description of the Data Box Edge/Gateway device. NOTE: This property will not be serialized. It can only be populated by the server.
description?: string
Property Value
string
deviceHcsVersion
The device software version number of the device (eg: 1.2.18105.6). NOTE: This property will not be serialized. It can only be populated by the server.
deviceHcsVersion?: string
Property Value
string
deviceLocalCapacity
The Data Box Edge/Gateway device local capacity in MB. NOTE: This property will not be serialized. It can only be populated by the server.
deviceLocalCapacity?: number
Property Value
number
deviceModel
The Data Box Edge/Gateway device model. NOTE: This property will not be serialized. It can only be populated by the server.
deviceModel?: string
Property Value
string
deviceSoftwareVersion
The Data Box Edge/Gateway device software version. NOTE: This property will not be serialized. It can only be populated by the server.
deviceSoftwareVersion?: string
Property Value
string
deviceType
The type of the Data Box Edge/Gateway device. NOTE: This property will not be serialized. It can only be populated by the server.
deviceType?: string
Property Value
string
edgeProfile
The details of Edge Profile for this resource NOTE: This property will not be serialized. It can only be populated by the server.
edgeProfile?: EdgeProfile
Property Value
etag
The etag for the devices.
etag?: string
Property Value
string
friendlyName
The Data Box Edge/Gateway device name. NOTE: This property will not be serialized. It can only be populated by the server.
friendlyName?: string
Property Value
string
identity
kind
The kind of the device.
kind?: string
Property Value
string
location
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.
location: string
Property Value
string
modelDescription
The description of the Data Box Edge/Gateway device model. NOTE: This property will not be serialized. It can only be populated by the server.
modelDescription?: string
Property Value
string
nodeCount
The number of nodes in the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
nodeCount?: number
Property Value
number
resourceMoveDetails
The details of the move operation on this resource. NOTE: This property will not be serialized. It can only be populated by the server.
resourceMoveDetails?: ResourceMoveDetails
Property Value
serialNumber
The Serial Number of Data Box Edge/Gateway device. NOTE: This property will not be serialized. It can only be populated by the server.
serialNumber?: string
Property Value
string
sku
systemData
DataBoxEdge Resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
systemDataPropertiesSystemData
DataBoxEdge Device Properties NOTE: This property will not be serialized. It can only be populated by the server.
systemDataPropertiesSystemData?: SystemData
Property Value
tags
The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
timeZone
The Data Box Edge/Gateway device timezone. NOTE: This property will not be serialized. It can only be populated by the server.
timeZone?: string
Property Value
string
Inherited Property Details
id
The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ARMBaseModel.id
name
The object name. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ARMBaseModel.name
type
The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ARMBaseModel.type