Microsoft.AzureStackHCI edgeDevices

• Latest
• 2026-03-01-preview
• 2026-02-15-preview
• 2026-02-01
• 2025-12-01-preview
• 2025-11-01-preview
• 2025-10-01
• 2025-09-15-preview
• 2025-02-01-preview
• 2024-12-01-preview
• 2024-09-01-preview
• 2024-04-01
• 2024-02-15-preview
• 2024-01-01
• 2023-11-01-preview
• 2023-08-01-preview

Bicep resource definition

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

• Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* 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.AzureStackHCI/edgeDevices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureStackHCI/edgeDevices@2026-03-01-preview' = {
  name: 'string'
  kind: 'string'
  // For remaining properties, see Microsoft.AzureStackHCI/edgeDevices objects
}

Microsoft.AzureStackHCI/edgeDevices objects

Set the kind property to specify the type of object.

For HCI, use:

{
  kind: 'HCI'
  properties: {
    deviceConfiguration: {
      deviceMetadata: 'string'
      nicDetails: [
        {
          adapterName: 'string'
          componentId: 'string'
          defaultGateway: 'string'
          defaultIsolationId: 'string'
          dnsServers: [
            'string'
          ]
          driverVersion: 'string'
          interfaceDescription: 'string'
          ip4Address: 'string'
          subnetMask: 'string'
        }
      ]
    }
  }
}

Property Values

Microsoft.AzureStackHCI/edgeDevices

Name	Description	Value
kind	Set to 'HCI' for type HciEdgeDevice.	'HCI' (required)
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
scope	Use when creating a resource at a scope that is different than the deployment scope.	Set this property to the symbolic name of a resource to apply the extension resource.

DeviceConfiguration

Name	Description	Value
deviceMetadata	Device metadata details.	string
nicDetails	NIC Details of device	NicDetail[]

HciEdgeDevice

Name	Description	Value
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.	'HCI' (required)
properties	properties for Arc-enabled edge device with HCI OS.	HciEdgeDeviceProperties

HciEdgeDeviceProperties

Name	Description	Value
deviceConfiguration	Device Configuration	DeviceConfiguration

NicDetail

Name	Description	Value
adapterName	Adapter Name of NIC	string
componentId	Component Id of NIC	string
defaultGateway	Default Gateway of NIC	string
defaultIsolationId	Default Isolation of Management NIC	string
dnsServers	DNS Servers for NIC	string[]
driverVersion	Driver Version of NIC	string
interfaceDescription	Interface Description of NIC	string
ip4Address	Subnet Mask of NIC	string
subnetMask	Subnet Mask of NIC	string

ARM template resource definition

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

• Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* 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.AzureStackHCI/edgeDevices resource, add the following JSON to your template.

{
  "name": "string",
  "kind": "string"
  // For remaining properties, see Microsoft.AzureStackHCI/edgeDevices objects
}

Microsoft.AzureStackHCI/edgeDevices objects

Set the kind property to specify the type of object.

For HCI, use:

{
  "kind": "HCI",
  "properties": {
    "deviceConfiguration": {
      "deviceMetadata": "string",
      "nicDetails": [
        {
          "adapterName": "string",
          "componentId": "string",
          "defaultGateway": "string",
          "defaultIsolationId": "string",
          "dnsServers": [ "string" ],
          "driverVersion": "string",
          "interfaceDescription": "string",
          "ip4Address": "string",
          "subnetMask": "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.AzureStackHCI/edgeDevices

Name	Description	Value
apiVersion	The api version	'2026-03-01-preview'
kind	Set to 'HCI' for type HciEdgeDevice.	'HCI' (required)
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
type	The resource type	'Microsoft.AzureStackHCI/edgeDevices'

DeviceConfiguration

Name	Description	Value
deviceMetadata	Device metadata details.	string
nicDetails	NIC Details of device	NicDetail[]

HciEdgeDevice

Name	Description	Value
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.	'HCI' (required)
properties	properties for Arc-enabled edge device with HCI OS.	HciEdgeDeviceProperties

HciEdgeDeviceProperties

Name	Description	Value
deviceConfiguration	Device Configuration	DeviceConfiguration

NicDetail

Name	Description	Value
adapterName	Adapter Name of NIC	string
componentId	Component Id of NIC	string
defaultGateway	Default Gateway of NIC	string
defaultIsolationId	Default Isolation of Management NIC	string
dnsServers	DNS Servers for NIC	string[]
driverVersion	Driver Version of NIC	string
interfaceDescription	Interface Description of NIC	string
ip4Address	Subnet Mask of NIC	string
subnetMask	Subnet Mask of NIC	string

Usage Examples

Terraform (AzAPI provider) resource definition

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

• Tenant* Management groups* Subscription* Resource groups

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

Resource format

To create a Microsoft.AzureStackHCI/edgeDevices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  name = "string"
  kind = "string"
  // For remaining properties, see Microsoft.AzureStackHCI/edgeDevices objects
}

Microsoft.AzureStackHCI/edgeDevices objects

Set the kind property to specify the type of object.

For HCI, use:

{
  kind = "HCI"
  properties = {
    deviceConfiguration = {
      deviceMetadata = "string"
      nicDetails = [
        {
          adapterName = "string"
          componentId = "string"
          defaultGateway = "string"
          defaultIsolationId = "string"
          dnsServers = [
            "string"
          ]
          driverVersion = "string"
          interfaceDescription = "string"
          ip4Address = "string"
          subnetMask = "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.AzureStackHCI/edgeDevices

Name	Description	Value
kind	Set to 'HCI' for type HciEdgeDevice.	'HCI' (required)
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
parent_id	The ID of the resource to apply this extension resource to.	string (required)
type	The resource type	"Microsoft.AzureStackHCI/edgeDevices@2026-03-01-preview"

DeviceConfiguration

Name	Description	Value
deviceMetadata	Device metadata details.	string
nicDetails	NIC Details of device	NicDetail[]

HciEdgeDevice

Name	Description	Value
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.	'HCI' (required)
properties	properties for Arc-enabled edge device with HCI OS.	HciEdgeDeviceProperties

HciEdgeDeviceProperties

Name	Description	Value
deviceConfiguration	Device Configuration	DeviceConfiguration

NicDetail

Name	Description	Value
adapterName	Adapter Name of NIC	string
componentId	Component Id of NIC	string
defaultGateway	Default Gateway of NIC	string
defaultIsolationId	Default Isolation of Management NIC	string
dnsServers	DNS Servers for NIC	string[]
driverVersion	Driver Version of NIC	string
interfaceDescription	Interface Description of NIC	string
ip4Address	Subnet Mask of NIC	string
subnetMask	Subnet Mask of NIC	string