Share via

Microsoft.AzureStackHCI networkInterfaces

  • Article
Choose a deployment language

Bicep resource definition

The networkInterfaces 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.AzureStackHCI/networkInterfaces resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureStackHCI/networkInterfaces@2025-04-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    createFromLocal: bool
    dnsSettings: {
      dnsServers: [
        'string'
      ]
    }
    ipConfigurations: [
      {
        name: 'string'
        properties: {
          privateIPAddress: 'string'
          subnet: {
            id: 'string'
          }
        }
      }
    ]
    macAddress: 'string'
    networkSecurityGroup: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

InterfaceDNSSettings

Name Description Value
dnsServers List of DNS server IP Addresses for the interface string[]

IPConfiguration

Name Description Value
name Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$
properties InterfaceIPConfigurationPropertiesFormat properties of IP configuration. IPConfigurationProperties

IPConfigurationProperties

Name Description Value
privateIPAddress PrivateIPAddress - Private IP address of the IP configuration. string
subnet Subnet - Name of Subnet bound to the IP configuration. LogicalNetworkArmReference

LogicalNetworkArmReference

Name Description Value
id The ARM ID for a Logical Network. string

Microsoft.AzureStackHCI/networkInterfaces

Name Description Value
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$ (required)
properties The resource-specific properties for this resource. NetworkInterfaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

NetworkInterfaceProperties

Name Description Value
createFromLocal Boolean indicating whether this is a existing local network interface or if one should be created. bool
dnsSettings DNS Settings for the interface InterfaceDNSSettings
ipConfigurations IPConfigurations - A list of IPConfigurations of the network interface. IPConfiguration[]
macAddress MacAddress - The MAC address of the network interface. string
networkSecurityGroup NetworkSecurityGroup - Network Security Group attached to the network interface. NetworkSecurityGroupArmReference

NetworkSecurityGroupArmReference

Name Description Value
id The ARM ID for a Network Security Group. string

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create a Linux VM from a gallery image on Azure Stack HCI This template creates a simple Linux VM from the referenced custom image on Azure Stack HCI version 23H2+
Create a VM from the referenced image on Azure Stack HCI This template creates a simple Windows VM from the referenced Azure Marketplace image on Azure Stack HCI version 23H2+

ARM template resource definition

The networkInterfaces 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.AzureStackHCI/networkInterfaces resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureStackHCI/networkInterfaces",
  "apiVersion": "2025-04-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "createFromLocal": "bool",
    "dnsSettings": {
      "dnsServers": [ "string" ]
    },
    "ipConfigurations": [
      {
        "name": "string",
        "properties": {
          "privateIPAddress": "string",
          "subnet": {
            "id": "string"
          }
        }
      }
    ],
    "macAddress": "string",
    "networkSecurityGroup": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

InterfaceDNSSettings

Name Description Value
dnsServers List of DNS server IP Addresses for the interface string[]

IPConfiguration

Name Description Value
name Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$
properties InterfaceIPConfigurationPropertiesFormat properties of IP configuration. IPConfigurationProperties

IPConfigurationProperties

Name Description Value
privateIPAddress PrivateIPAddress - Private IP address of the IP configuration. string
subnet Subnet - Name of Subnet bound to the IP configuration. LogicalNetworkArmReference

LogicalNetworkArmReference

Name Description Value
id The ARM ID for a Logical Network. string

Microsoft.AzureStackHCI/networkInterfaces

Name Description Value
apiVersion The api version '2025-04-01-preview'
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$ (required)
properties The resource-specific properties for this resource. NetworkInterfaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.AzureStackHCI/networkInterfaces'

NetworkInterfaceProperties

Name Description Value
createFromLocal Boolean indicating whether this is a existing local network interface or if one should be created. bool
dnsSettings DNS Settings for the interface InterfaceDNSSettings
ipConfigurations IPConfigurations - A list of IPConfigurations of the network interface. IPConfiguration[]
macAddress MacAddress - The MAC address of the network interface. string
networkSecurityGroup NetworkSecurityGroup - Network Security Group attached to the network interface. NetworkSecurityGroupArmReference

NetworkSecurityGroupArmReference

Name Description Value
id The ARM ID for a Network Security Group. string

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create a Linux VM from a gallery image on Azure Stack HCI

Deploy to Azure		 This template creates a simple Linux VM from the referenced custom image on Azure Stack HCI version 23H2+
Create a VM from the referenced image on Azure Stack HCI

Deploy to Azure		 This template creates a simple Windows VM from the referenced Azure Marketplace image on Azure Stack HCI version 23H2+

Terraform (AzAPI provider) resource definition

The networkInterfaces 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.AzureStackHCI/networkInterfaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureStackHCI/networkInterfaces@2025-04-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      createFromLocal = bool
      dnsSettings = {
        dnsServers = [
          "string"
        ]
      }
      ipConfigurations = [
        {
          name = "string"
          properties = {
            privateIPAddress = "string"
            subnet = {
              id = "string"
            }
          }
        }
      ]
      macAddress = "string"
      networkSecurityGroup = {
        id = "string"
      }
    }
  }
}

Property Values

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

InterfaceDNSSettings

Name Description Value
dnsServers List of DNS server IP Addresses for the interface string[]

IPConfiguration

Name Description Value
name Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$
properties InterfaceIPConfigurationPropertiesFormat properties of IP configuration. IPConfigurationProperties

IPConfigurationProperties

Name Description Value
privateIPAddress PrivateIPAddress - Private IP address of the IP configuration. string
subnet Subnet - Name of Subnet bound to the IP configuration. LogicalNetworkArmReference

LogicalNetworkArmReference

Name Description Value
id The ARM ID for a Logical Network. string

Microsoft.AzureStackHCI/networkInterfaces

Name Description Value
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$ (required)
properties The resource-specific properties for this resource. NetworkInterfaceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.AzureStackHCI/networkInterfaces@2025-04-01-preview"

NetworkInterfaceProperties

Name Description Value
createFromLocal Boolean indicating whether this is a existing local network interface or if one should be created. bool
dnsSettings DNS Settings for the interface InterfaceDNSSettings
ipConfigurations IPConfigurations - A list of IPConfigurations of the network interface. IPConfiguration[]
macAddress MacAddress - The MAC address of the network interface. string
networkSecurityGroup NetworkSecurityGroup - Network Security Group attached to the network interface. NetworkSecurityGroupArmReference

NetworkSecurityGroupArmReference

Name Description Value
id The ARM ID for a Network Security Group. string

TrackedResourceTags

Name Description Value