DataBoxEdgeDevice interface

Package:

@azure/arm-databoxedge

The Data Box Edge/Gateway device.

Extends

TrackedResource

Properties

configuredRoleTypes	Type of compute roles configured.
culture	The Data Box Edge/Gateway device culture.
dataBoxEdgeDeviceStatus	The status of the Data Box Edge/Gateway device.
dataResidency	The details of data-residency related properties for this resource
description	The Description of the Data Box Edge/Gateway device.
deviceHcsVersion	The device software version number of the device (eg: 1.2.18105.6).
deviceLocalCapacity	The Data Box Edge/Gateway device local capacity in MB.
deviceModel	The Data Box Edge/Gateway device model.
deviceSoftwareVersion	The Data Box Edge/Gateway device software version.
deviceType	The type of the Data Box Edge/Gateway device.
edgeProfile	The details of Edge Profile for this resource
etag	The etag for the devices.
friendlyName	The Data Box Edge/Gateway device name.
identity	Msi identity of the resource
kind	The kind of the device.
kubernetesWorkloadProfile	Kubernetes Workload Profile
modelDescription	The description of the Data Box Edge/Gateway device model.
nodeCount	The number of nodes in the cluster.
resourceMoveDetails	The details of the move operation on this resource.
serialNumber	The Serial Number of Data Box Edge/Gateway device.
sku	The SKU type.
systemDataPropertiesSystemData	DataBoxEdge Device Properties
timeZone	The Data Box Edge/Gateway device timezone.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

configuredRoleTypes

Type of compute roles configured.

configuredRoleTypes?: string[]

Property Value

string[]

culture

The Data Box Edge/Gateway device culture.

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

DataResidency

description

The Description of the Data Box Edge/Gateway device.

description?: string

Property Value

string

deviceHcsVersion

The device software version number of the device (eg: 1.2.18105.6).

deviceHcsVersion?: string

Property Value

string

deviceLocalCapacity

The Data Box Edge/Gateway device local capacity in MB.

deviceLocalCapacity?: number

Property Value

number

deviceModel

The Data Box Edge/Gateway device model.

deviceModel?: string

Property Value

string

deviceSoftwareVersion

The Data Box Edge/Gateway device software version.

deviceSoftwareVersion?: string

Property Value

string

deviceType

The type of the Data Box Edge/Gateway device.

deviceType?: string

Property Value

string

edgeProfile

The details of Edge Profile for this resource

edgeProfile?: EdgeProfile

Property Value

EdgeProfile

etag

The etag for the devices.

etag?: string

Property Value

string

friendlyName

The Data Box Edge/Gateway device name.

friendlyName?: string

Property Value

string

identity

Msi identity of the resource

identity?: ResourceIdentity

Property Value

ResourceIdentity

kind

The kind of the device.

kind?: string

Property Value

string

kubernetesWorkloadProfile

Kubernetes Workload Profile

kubernetesWorkloadProfile?: string

Property Value

string

modelDescription

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

modelDescription?: string

Property Value

string

nodeCount

The number of nodes in the cluster.

nodeCount?: number

Property Value

number

resourceMoveDetails

The details of the move operation on this resource.

resourceMoveDetails?: ResourceMoveDetails

Property Value

ResourceMoveDetails

serialNumber

The Serial Number of Data Box Edge/Gateway device.

serialNumber?: string

Property Value

string

sku

The SKU type.

sku?: Sku

Property Value

Sku

systemDataPropertiesSystemData

DataBoxEdge Device Properties

systemDataPropertiesSystemData?: SystemData

Property Value

SystemData

timeZone

The Data Box Edge/Gateway device timezone.

timeZone?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type