Microsoft.HybridContainerService virtualNetworks

• Latest
• 2026-04-01-preview
• 2024-01-01
• 2023-11-15-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.HybridContainerService/virtualNetworks@2026-04-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    dnsServers: [
      'string'
    ]
    gateway: 'string'
    infraVnetProfile: {
      hci: {
        mocGroup: 'string'
        mocLocation: 'string'
        mocVnetName: 'string'
      }
    }
    ipAddressPrefix: 'string'
    vipPool: [
      {
        endIP: 'string'
        startIP: 'string'
      }
    ]
    vlanID: int
    vmipPool: [
      {
        endIP: 'string'
        startIP: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HybridContainerService/virtualNetworks

Name	Description	Value
extendedLocation	Extended location pointing to the underlying infrastructure	VirtualNetworkExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 64 Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties	The resource-specific properties for this resource.	VirtualNetworkProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name	Description	Value

VirtualNetworkExtendedLocation

Name	Description	Value
name	ARM Id of the extended location.	string
type	The extended location type. Allowed value: 'CustomLocation'	'CustomLocation'

VirtualNetworkProperties

Name	Description	Value
dnsServers	List of DNS server IP Addresses associated with the network	string[]
gateway	IP Address of the Gateway associated with the network	string
infraVnetProfile	Infrastructure network profile for HCI platform	VirtualNetworkPropertiesInfraVnetProfile
ipAddressPrefix	IP Address Prefix of the network	string
vipPool	Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer	VirtualNetworkPropertiesVipPoolItem[]
vlanID	VLAN Id used by the network	int
vmipPool	Range of IP Addresses for Kubernetes node VMs	VirtualNetworkPropertiesVmipPoolItem[]

VirtualNetworkPropertiesInfraVnetProfile

Name	Description	Value
hci	Infrastructure network profile for HCI platform	VirtualNetworkPropertiesInfraVnetProfileHci

VirtualNetworkPropertiesInfraVnetProfileHci

Name	Description	Value
mocGroup	Group in MOC(Microsoft On-premises Cloud)	string
mocLocation	Location in MOC(Microsoft On-premises Cloud)	string
mocVnetName	Virtual Network name in MOC(Microsoft On-premises Cloud)	string

VirtualNetworkPropertiesVipPoolItem

Name	Description	Value
endIP	Ending IP address for the IP Pool	string
startIP	Starting IP address for the IP Pool	string

VirtualNetworkPropertiesVmipPoolItem

Name	Description	Value
endIP	Ending IP address for the IP Pool	string
startIP	Starting IP address for the IP Pool	string

ARM template resource definition

The virtualNetworks 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.

Usage Examples

Resource format

To create a Microsoft.HybridContainerService/virtualNetworks resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridContainerService/virtualNetworks",
  "apiVersion": "2026-04-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "dnsServers": [ "string" ],
    "gateway": "string",
    "infraVnetProfile": {
      "hci": {
        "mocGroup": "string",
        "mocLocation": "string",
        "mocVnetName": "string"
      }
    },
    "ipAddressPrefix": "string",
    "vipPool": [
      {
        "endIP": "string",
        "startIP": "string"
      }
    ],
    "vlanID": "int",
    "vmipPool": [
      {
        "endIP": "string",
        "startIP": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HybridContainerService/virtualNetworks

Name	Description	Value
apiVersion	The api version	'2026-04-01-preview'
extendedLocation	Extended location pointing to the underlying infrastructure	VirtualNetworkExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 64 Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties	The resource-specific properties for this resource.	VirtualNetworkProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.HybridContainerService/virtualNetworks'

TrackedResourceTags

Name	Description	Value

VirtualNetworkExtendedLocation

Name	Description	Value
name	ARM Id of the extended location.	string
type	The extended location type. Allowed value: 'CustomLocation'	'CustomLocation'

VirtualNetworkProperties

Name	Description	Value
dnsServers	List of DNS server IP Addresses associated with the network	string[]
gateway	IP Address of the Gateway associated with the network	string
infraVnetProfile	Infrastructure network profile for HCI platform	VirtualNetworkPropertiesInfraVnetProfile
ipAddressPrefix	IP Address Prefix of the network	string
vipPool	Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer	VirtualNetworkPropertiesVipPoolItem[]
vlanID	VLAN Id used by the network	int
vmipPool	Range of IP Addresses for Kubernetes node VMs	VirtualNetworkPropertiesVmipPoolItem[]

VirtualNetworkPropertiesInfraVnetProfile

Name	Description	Value
hci	Infrastructure network profile for HCI platform	VirtualNetworkPropertiesInfraVnetProfileHci

VirtualNetworkPropertiesInfraVnetProfileHci

Name	Description	Value
mocGroup	Group in MOC(Microsoft On-premises Cloud)	string
mocLocation	Location in MOC(Microsoft On-premises Cloud)	string
mocVnetName	Virtual Network name in MOC(Microsoft On-premises Cloud)	string

VirtualNetworkPropertiesVipPoolItem

Name	Description	Value
endIP	Ending IP address for the IP Pool	string
startIP	Starting IP address for the IP Pool	string

VirtualNetworkPropertiesVmipPoolItem

Name	Description	Value
endIP	Ending IP address for the IP Pool	string
startIP	Starting IP address for the IP Pool	string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridContainerService/virtualNetworks@2026-04-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      dnsServers = [
        "string"
      ]
      gateway = "string"
      infraVnetProfile = {
        hci = {
          mocGroup = "string"
          mocLocation = "string"
          mocVnetName = "string"
        }
      }
      ipAddressPrefix = "string"
      vipPool = [
        {
          endIP = "string"
          startIP = "string"
        }
      ]
      vlanID = int
      vmipPool = [
        {
          endIP = "string"
          startIP = "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.HybridContainerService/virtualNetworks

Name	Description	Value
extendedLocation	Extended location pointing to the underlying infrastructure	VirtualNetworkExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 64 Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required)
properties	The resource-specific properties for this resource.	VirtualNetworkProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.HybridContainerService/virtualNetworks@2026-04-01-preview"

TrackedResourceTags

Name	Description	Value

VirtualNetworkExtendedLocation

Name	Description	Value
name	ARM Id of the extended location.	string
type	The extended location type. Allowed value: 'CustomLocation'	'CustomLocation'

VirtualNetworkProperties

Name	Description	Value
dnsServers	List of DNS server IP Addresses associated with the network	string[]
gateway	IP Address of the Gateway associated with the network	string
infraVnetProfile	Infrastructure network profile for HCI platform	VirtualNetworkPropertiesInfraVnetProfile
ipAddressPrefix	IP Address Prefix of the network	string
vipPool	Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer	VirtualNetworkPropertiesVipPoolItem[]
vlanID	VLAN Id used by the network	int
vmipPool	Range of IP Addresses for Kubernetes node VMs	VirtualNetworkPropertiesVmipPoolItem[]

VirtualNetworkPropertiesInfraVnetProfile

Name	Description	Value
hci	Infrastructure network profile for HCI platform	VirtualNetworkPropertiesInfraVnetProfileHci

VirtualNetworkPropertiesInfraVnetProfileHci

Name	Description	Value
mocGroup	Group in MOC(Microsoft On-premises Cloud)	string
mocLocation	Location in MOC(Microsoft On-premises Cloud)	string
mocVnetName	Virtual Network name in MOC(Microsoft On-premises Cloud)	string

VirtualNetworkPropertiesVipPoolItem

Name	Description	Value
endIP	Ending IP address for the IP Pool	string
startIP	Starting IP address for the IP Pool	string

VirtualNetworkPropertiesVmipPoolItem

Name	Description	Value
endIP	Ending IP address for the IP Pool	string
startIP	Starting IP address for the IP Pool	string