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.
- Latest
- 2026-11-01-preview
- 2026-10-15-preview
- 2026-10-01
- 2026-05-01-preview
- 2026-04-30
- 2026-04-01-preview
- 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@2024-01-01' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
deviceConfiguration: {
deviceMetadata: 'string'
nicDetails: [
{
adapterName: 'string'
componentId: 'string'
defaultGateway: 'string'
defaultIsolationId: 'string'
dnsServers: [
'string'
]
driverVersion: 'string'
interfaceDescription: 'string'
ip4Address: 'string'
subnetMask: 'string'
}
]
}
provisioningState: 'string'
}
}
Property Values
Microsoft.AzureStackHCI/edgeDevices
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | EdgeDeviceProperties |
| 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[] |
EdgeDeviceProperties
| Name | Description | Value |
|---|---|---|
| deviceConfiguration | Device Configuration | DeviceConfiguration |
| provisioningState | Provisioning state of edgeDevice resource | 'Accepted' 'Canceled' 'Connected' 'Creating' 'Deleted' 'Deleting' 'DisableInProgress' 'Disconnected' 'Error' 'Failed' 'InProgress' 'Moving' 'NotSpecified' 'PartiallyConnected' 'PartiallySucceeded' 'Provisioning' 'Succeeded' 'Updating' |
NicDetail
| Name | Description | Value |
|---|---|---|
| adapterName | Adapter Name of NIC | string (required) |
| 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.
Usage Examples
Resource format
To create a Microsoft.AzureStackHCI/edgeDevices resource, add the following JSON to your template.
{
"type": "Microsoft.AzureStackHCI/edgeDevices",
"apiVersion": "2024-01-01",
"name": "string",
"properties": {
"deviceConfiguration": {
"deviceMetadata": "string",
"nicDetails": [
{
"adapterName": "string",
"componentId": "string",
"defaultGateway": "string",
"defaultIsolationId": "string",
"dnsServers": [ "string" ],
"driverVersion": "string",
"interfaceDescription": "string",
"ip4Address": "string",
"subnetMask": "string"
}
]
},
"provisioningState": "string"
}
}
Property Values
Microsoft.AzureStackHCI/edgeDevices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-01-01' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | EdgeDeviceProperties |
| type | The resource type | 'Microsoft.AzureStackHCI/edgeDevices' |
DeviceConfiguration
| Name | Description | Value |
|---|---|---|
| deviceMetadata | device metadata details. | string |
| nicDetails | NIC Details of device | NicDetail[] |
EdgeDeviceProperties
| Name | Description | Value |
|---|---|---|
| deviceConfiguration | Device Configuration | DeviceConfiguration |
| provisioningState | Provisioning state of edgeDevice resource | 'Accepted' 'Canceled' 'Connected' 'Creating' 'Deleted' 'Deleting' 'DisableInProgress' 'Disconnected' 'Error' 'Failed' 'InProgress' 'Moving' 'NotSpecified' 'PartiallyConnected' 'PartiallySucceeded' 'Provisioning' 'Succeeded' 'Updating' |
NicDetail
| Name | Description | Value |
|---|---|---|
| adapterName | Adapter Name of NIC | string (required) |
| 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 |
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" {
type = "Microsoft.AzureStackHCI/edgeDevices@2024-01-01"
name = "string"
parent_id = "string"
body = {
properties = {
deviceConfiguration = {
deviceMetadata = "string"
nicDetails = [
{
adapterName = "string"
componentId = "string"
defaultGateway = "string"
defaultIsolationId = "string"
dnsServers = [
"string"
]
driverVersion = "string"
interfaceDescription = "string"
ip4Address = "string"
subnetMask = "string"
}
]
}
provisioningState = "string"
}
}
}
Property Values
Microsoft.AzureStackHCI/edgeDevices
| Name | Description | Value |
|---|---|---|
| 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) |
| properties | The resource-specific properties for this resource. | EdgeDeviceProperties |
| type | The resource type | "Microsoft.AzureStackHCI/edgeDevices@2024-01-01" |
DeviceConfiguration
| Name | Description | Value |
|---|---|---|
| deviceMetadata | device metadata details. | string |
| nicDetails | NIC Details of device | NicDetail[] |
EdgeDeviceProperties
| Name | Description | Value |
|---|---|---|
| deviceConfiguration | Device Configuration | DeviceConfiguration |
| provisioningState | Provisioning state of edgeDevice resource | 'Accepted' 'Canceled' 'Connected' 'Creating' 'Deleted' 'Deleting' 'DisableInProgress' 'Disconnected' 'Error' 'Failed' 'InProgress' 'Moving' 'NotSpecified' 'PartiallyConnected' 'PartiallySucceeded' 'Provisioning' 'Succeeded' 'Updating' |
NicDetail
| Name | Description | Value |
|---|---|---|
| adapterName | Adapter Name of NIC | string (required) |
| 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 |