Share via

Microsoft.DataBoxEdge dataBoxEdgeDevices 2019-03-01

Bicep resource definition

The dataBoxEdgeDevices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-03-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    dataBoxEdgeDeviceStatus: 'string'
    description: 'string'
    friendlyName: 'string'
    modelDescription: 'string'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices

Name Description Value
etag The etag for the devices. 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. string (required)
name The resource name string (required)
properties The properties of the Data Box Edge/Gateway device. DataBoxEdgeDeviceProperties
sku The SKU type. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

DataBoxEdgeDeviceProperties

Name Description Value
dataBoxEdgeDeviceStatus The status of the Data Box Edge/Gateway device. 'Disconnected'
'NeedsAttention'
'Offline'
'Online'
'PartiallyDisconnected'
'ReadyToSetup'
description The Description of the Data Box Edge/Gateway device. string
friendlyName The Data Box Edge/Gateway device name. string
modelDescription The description of the Data Box Edge/Gateway device model. string

DataBoxEdgeDeviceTags

Name Description Value

Sku

Name Description Value
name SKU name. 'Edge'
'Gateway'
tier The SKU tier. This is based on the SKU name. 'Standard'

ARM template resource definition

The dataBoxEdgeDevices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices resource, add the following JSON to your template.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices",
  "apiVersion": "2019-03-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "dataBoxEdgeDeviceStatus": "string",
    "description": "string",
    "friendlyName": "string",
    "modelDescription": "string"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices

Name Description Value
apiVersion The api version '2019-03-01'
etag The etag for the devices. 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. string (required)
name The resource name string (required)
properties The properties of the Data Box Edge/Gateway device. DataBoxEdgeDeviceProperties
sku The SKU type. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DataBoxEdge/dataBoxEdgeDevices'

DataBoxEdgeDeviceProperties

Name Description Value
dataBoxEdgeDeviceStatus The status of the Data Box Edge/Gateway device. 'Disconnected'
'NeedsAttention'
'Offline'
'Online'
'PartiallyDisconnected'
'ReadyToSetup'
description The Description of the Data Box Edge/Gateway device. string
friendlyName The Data Box Edge/Gateway device name. string
modelDescription The description of the Data Box Edge/Gateway device model. string

DataBoxEdgeDeviceTags

Name Description Value

Sku

Name Description Value
name SKU name. 'Edge'
'Gateway'
tier The SKU tier. This is based on the SKU name. 'Standard'

Usage Examples

Terraform (AzAPI provider) resource definition

The dataBoxEdgeDevices resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      dataBoxEdgeDeviceStatus = "string"
      description = "string"
      friendlyName = "string"
      modelDescription = "string"
    }
    sku = {
      name = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices

Name Description Value
etag The etag for the devices. 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. string (required)
name The resource name string (required)
properties The properties of the Data Box Edge/Gateway device. DataBoxEdgeDeviceProperties
sku The SKU type. Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-03-01"

DataBoxEdgeDeviceProperties

Name Description Value
dataBoxEdgeDeviceStatus The status of the Data Box Edge/Gateway device. 'Disconnected'
'NeedsAttention'
'Offline'
'Online'
'PartiallyDisconnected'
'ReadyToSetup'
description The Description of the Data Box Edge/Gateway device. string
friendlyName The Data Box Edge/Gateway device name. string
modelDescription The description of the Data Box Edge/Gateway device model. string

DataBoxEdgeDeviceTags

Name Description Value

Sku

Name Description Value
name SKU name. 'Edge'
'Gateway'
tier The SKU tier. This is based on the SKU name. 'Standard'