Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The dataBoxEdgeDevices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2023-07-01' = {
etag: 'string'
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
dataResidency: {
type: '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 |
| identity | Msi identity of the resource | ResourceIdentity |
| 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 |
|---|---|---|
| dataResidency | The details of data-residency related properties for this resource | DataResidency |
DataBoxEdgeDeviceTags
| Name | Description | Value |
|---|
DataResidency
| Name | Description | Value |
|---|---|---|
| type | DataResidencyType enum | 'GeoZoneReplication' 'ZoneReplication' |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Identity type | 'None' 'SystemAssigned' 'UserAssigned' |
Sku
| Name | Description | Value |
|---|---|---|
| name | SKU name. | 'Edge' 'EdgeMR_Mini' 'EdgeMR_TCP' 'EdgePR_Base' 'EdgePR_Base_UPS' 'EdgeP_Base' 'EdgeP_High' 'EP2_128_1T4_Mx1_W' 'EP2_128_GPU1_Mx1_W' 'EP2_256_2T4_W' 'EP2_256_GPU2_Mx1' 'EP2_64_1VPU_W' 'EP2_64_Mx1_W' 'Gateway' 'GPU' 'Management' 'RCA_Large' 'RCA_Small' 'RDC' 'TCA_Large' 'TCA_Small' 'TDC' 'TEA_1Node' 'TEA_1Node_Heater' 'TEA_1Node_UPS' 'TEA_1Node_UPS_Heater' 'TEA_4Node_Heater' 'TEA_4Node_UPS_Heater' 'TMA' |
| 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:
- Resource groups - See resource group deployment commands
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": "2023-07-01",
"name": "string",
"etag": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"dataResidency": {
"type": "string"
}
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-07-01' |
| etag | The etag for the devices. | string |
| identity | Msi identity of the resource | ResourceIdentity |
| 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 |
|---|---|---|
| dataResidency | The details of data-residency related properties for this resource | DataResidency |
DataBoxEdgeDeviceTags
| Name | Description | Value |
|---|
DataResidency
| Name | Description | Value |
|---|---|---|
| type | DataResidencyType enum | 'GeoZoneReplication' 'ZoneReplication' |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Identity type | 'None' 'SystemAssigned' 'UserAssigned' |
Sku
| Name | Description | Value |
|---|---|---|
| name | SKU name. | 'Edge' 'EdgeMR_Mini' 'EdgeMR_TCP' 'EdgePR_Base' 'EdgePR_Base_UPS' 'EdgeP_Base' 'EdgeP_High' 'EP2_128_1T4_Mx1_W' 'EP2_128_GPU1_Mx1_W' 'EP2_256_2T4_W' 'EP2_256_GPU2_Mx1' 'EP2_64_1VPU_W' 'EP2_64_Mx1_W' 'Gateway' 'GPU' 'Management' 'RCA_Large' 'RCA_Small' 'RDC' 'TCA_Large' 'TCA_Small' 'TDC' 'TEA_1Node' 'TEA_1Node_Heater' 'TEA_1Node_UPS' 'TEA_1Node_UPS_Heater' 'TEA_4Node_Heater' 'TEA_4Node_UPS_Heater' 'TMA' |
| 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@2023-07-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
dataResidency = {
type = "string"
}
}
sku = {
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices
| Name | Description | Value |
|---|---|---|
| etag | The etag for the devices. | string |
| identity | Msi identity of the resource | ResourceIdentity |
| 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@2023-07-01" |
DataBoxEdgeDeviceProperties
| Name | Description | Value |
|---|---|---|
| dataResidency | The details of data-residency related properties for this resource | DataResidency |
DataBoxEdgeDeviceTags
| Name | Description | Value |
|---|
DataResidency
| Name | Description | Value |
|---|---|---|
| type | DataResidencyType enum | 'GeoZoneReplication' 'ZoneReplication' |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Identity type | 'None' 'SystemAssigned' 'UserAssigned' |
Sku
| Name | Description | Value |
|---|---|---|
| name | SKU name. | 'Edge' 'EdgeMR_Mini' 'EdgeMR_TCP' 'EdgePR_Base' 'EdgePR_Base_UPS' 'EdgeP_Base' 'EdgeP_High' 'EP2_128_1T4_Mx1_W' 'EP2_128_GPU1_Mx1_W' 'EP2_256_2T4_W' 'EP2_256_GPU2_Mx1' 'EP2_64_1VPU_W' 'EP2_64_Mx1_W' 'Gateway' 'GPU' 'Management' 'RCA_Large' 'RCA_Small' 'RDC' 'TCA_Large' 'TCA_Small' 'TDC' 'TEA_1Node' 'TEA_1Node_Heater' 'TEA_1Node_UPS' 'TEA_1Node_UPS_Heater' 'TEA_4Node_Heater' 'TEA_4Node_UPS_Heater' 'TMA' |
| tier | The SKU tier. This is based on the SKU name. | 'Standard' |