ARM template resource definition
The logicalNetworks resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AzureStackHCI/logicalNetworks resource, add the following JSON to your template.
{
"type": "Microsoft.AzureStackHCI/logicalNetworks",
"apiVersion": "2023-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"extendedLocation": {
"name": "string",
"type": "CustomLocation"
},
"properties": {
"dhcpOptions": {
"dnsServers": [ "string" ]
},
"subnets": [
{
"name": "string",
"properties": {
"addressPrefix": "string",
"addressPrefixes": [ "string" ],
"ipAllocationMethod": "string",
"ipConfigurationReferences": [
{
"ID": "string"
}
],
"ipPools": [
{
"end": "string",
"info": {},
"ipPoolType": "string",
"name": "string",
"start": "string"
}
],
"routeTable": {
"properties": {
"routes": [
{
"name": "string",
"properties": {
"addressPrefix": "string",
"nextHopIpAddress": "string"
}
}
]
}
},
"vlan": "int"
}
}
],
"vmSwitchName": "string"
}
}
Property values
logicalNetworks
Name |
Description |
Value |
type |
The resource type |
'Microsoft.AzureStackHCI/logicalNetworks' |
apiVersion |
The resource api version |
'2023-09-01-preview' |
name |
The resource name |
string (required) |
location |
The geo-location where the resource lives |
string (required) |
tags |
Resource tags. |
Dictionary of tag names and values. See Tags in templates |
extendedLocation |
The extendedLocation of the resource. |
ExtendedLocation |
properties |
Properties under the logical network resource |
LogicalNetworkProperties |
ExtendedLocation
Name |
Description |
Value |
name |
The name of the extended location. |
string |
type |
The type of the extended location. |
'CustomLocation' |
LogicalNetworkProperties
Name |
Description |
Value |
dhcpOptions |
DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. |
LogicalNetworkPropertiesDhcpOptions |
subnets |
Subnet - list of subnets under the logical network |
Subnet[] |
vmSwitchName |
name of the network switch to be used for VMs |
string |
LogicalNetworkPropertiesDhcpOptions
Name |
Description |
Value |
dnsServers |
The list of DNS servers IP addresses. |
string[] |
Subnet
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 |
Properties of the subnet. |
SubnetPropertiesFormat |
Name |
Description |
Value |
addressPrefix |
The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. |
string |
addressPrefixes |
List of address prefixes for the subnet. |
string[] |
ipAllocationMethod |
IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' |
'Dynamic' 'Static' |
ipConfigurationReferences |
IPConfigurationReferences - list of IPConfigurationReferences |
SubnetPropertiesFormatIpConfigurationReferencesItem[] |
ipPools |
network associated pool of IP Addresses |
IPPool[] |
routeTable |
Route table resource. |
RouteTable |
vlan |
Vlan to use for the subnet |
int |
Name |
Description |
Value |
ID |
IPConfigurationID |
string |
IPPool
Name |
Description |
Value |
end |
End of the IP address pool |
string |
info |
|
IPPoolInfo |
ipPoolType |
Type of the IP Pool [vm, vippool] |
'vippool' 'vm' |
name |
Name of the IP-Pool |
string |
start |
Start of the IP address pool |
string |
IPPoolInfo
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
RouteTable
Name |
Description |
Value |
routes |
Collection of routes contained within a route table. |
Route[] |
Route
Name |
Description |
Value |
name |
Name - name of the subnet |
string
Constraints: Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$ |
properties |
Properties of the route. |
RoutePropertiesFormat |
Name |
Description |
Value |
addressPrefix |
The destination CIDR to which the route applies. |
string |
nextHopIpAddress |
The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. |
string |