Microsoft.Network networkInterfaces

• Latest
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01

Bicep resource definition

The networkInterfaces resource type can be deployed to:

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

resource symbolicname 'Microsoft.Network/networkInterfaces@2022-07-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    auxiliaryMode: 'string'
    disableTcpStateTracking: bool
    dnsSettings: {
      dnsServers: [
        'string'
      ]
      internalDnsNameLabel: 'string'
    }
    enableAcceleratedNetworking: bool
    enableIPForwarding: bool
    ipConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          applicationGatewayBackendAddressPools: [
            {
              id: 'string'
              name: 'string'
              properties: {
                backendAddresses: [
                  {
                    fqdn: 'string'
                    ipAddress: 'string'
                  }
                ]
              }
            }
          ]
          applicationSecurityGroups: [
            {
              id: 'string'
              location: 'string'
              properties: {}
              tags: {}
            }
          ]
          gatewayLoadBalancer: {
            id: 'string'
          }
          loadBalancerBackendAddressPools: [
            {
              id: 'string'
              name: 'string'
              properties: {
                drainPeriodInSeconds: int
                loadBalancerBackendAddresses: [
                  {
                    name: 'string'
                    properties: {
                      adminState: 'string'
                      ipAddress: 'string'
                      loadBalancerFrontendIPConfiguration: {
                        id: 'string'
                      }
                      subnet: {
                        id: 'string'
                      }
                      virtualNetwork: {
                        id: 'string'
                      }
                    }
                  }
                ]
                location: 'string'
                tunnelInterfaces: [
                  {
                    identifier: int
                    port: int
                    protocol: 'string'
                    type: 'string'
                  }
                ]
                virtualNetwork: {
                  id: 'string'
                }
              }
            }
          ]
          loadBalancerInboundNatRules: [
            {
              id: 'string'
              name: 'string'
              properties: {
                backendAddressPool: {
                  id: 'string'
                }
                backendPort: int
                enableFloatingIP: bool
                enableTcpReset: bool
                frontendIPConfiguration: {
                  id: 'string'
                }
                frontendPort: int
                frontendPortRangeEnd: int
                frontendPortRangeStart: int
                idleTimeoutInMinutes: int
                protocol: 'string'
              }
            }
          ]
          primary: bool
          privateIPAddress: 'string'
          privateIPAddressVersion: 'string'
          privateIPAllocationMethod: 'string'
          publicIPAddress: {
            extendedLocation: {
              name: 'string'
              type: 'EdgeZone'
            }
            id: 'string'
            location: 'string'
            properties: {
              ddosSettings: {
                ddosProtectionPlan: {
                  id: 'string'
                }
                protectionMode: 'string'
              }
              deleteOption: 'string'
              dnsSettings: {
                domainNameLabel: 'string'
                fqdn: 'string'
                reverseFqdn: 'string'
              }
              idleTimeoutInMinutes: int
              ipAddress: 'string'
              ipTags: [
                {
                  ipTagType: 'string'
                  tag: 'string'
                }
              ]
              linkedPublicIPAddress: {
                public-ip-address-object
              }
              migrationPhase: 'string'
              natGateway: {
                id: 'string'
                location: 'string'
                properties: {
                  idleTimeoutInMinutes: int
                  publicIpAddresses: [
                    {
                      id: 'string'
                    }
                  ]
                  publicIpPrefixes: [
                    {
                      id: 'string'
                    }
                  ]
                }
                sku: {
                  name: 'Standard'
                }
                tags: {}
                zones: [
                  'string'
                ]
              }
              publicIPAddressVersion: 'string'
              publicIPAllocationMethod: 'string'
              publicIPPrefix: {
                id: 'string'
              }
              servicePublicIPAddress: {
                public-ip-address-object
              }
            }
            sku: {
              name: 'string'
              tier: 'string'
            }
            tags: {}
            zones: [
              'string'
            ]
          }
          subnet: {
            id: 'string'
            name: 'string'
            properties: {
              addressPrefix: 'string'
              addressPrefixes: [
                'string'
              ]
              applicationGatewayIpConfigurations: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    subnet: {
                      id: 'string'
                    }
                  }
                }
              ]
              delegations: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    serviceName: 'string'
                  }
                  type: 'string'
                }
              ]
              ipAllocations: [
                {
                  id: 'string'
                }
              ]
              natGateway: {
                id: 'string'
              }
              networkSecurityGroup: {
                id: 'string'
                location: 'string'
                properties: {
                  flushConnection: bool
                  securityRules: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        access: 'string'
                        description: 'string'
                        destinationAddressPrefix: 'string'
                        destinationAddressPrefixes: [
                          'string'
                        ]
                        destinationApplicationSecurityGroups: [
                          {
                            id: 'string'
                            location: 'string'
                            properties: {}
                            tags: {}
                          }
                        ]
                        destinationPortRange: 'string'
                        destinationPortRanges: [
                          'string'
                        ]
                        direction: 'string'
                        priority: int
                        protocol: 'string'
                        sourceAddressPrefix: 'string'
                        sourceAddressPrefixes: [
                          'string'
                        ]
                        sourceApplicationSecurityGroups: [
                          {
                            id: 'string'
                            location: 'string'
                            properties: {}
                            tags: {}
                          }
                        ]
                        sourcePortRange: 'string'
                        sourcePortRanges: [
                          'string'
                        ]
                      }
                      type: 'string'
                    }
                  ]
                }
                tags: {}
              }
              privateEndpointNetworkPolicies: 'string'
              privateLinkServiceNetworkPolicies: 'string'
              routeTable: {
                id: 'string'
                location: 'string'
                properties: {
                  disableBgpRoutePropagation: bool
                  routes: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        addressPrefix: 'string'
                        hasBgpOverride: bool
                        nextHopIpAddress: 'string'
                        nextHopType: 'string'
                      }
                      type: 'string'
                    }
                  ]
                }
                tags: {}
              }
              serviceEndpointPolicies: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {
                    contextualServiceEndpointPolicies: [
                      'string'
                    ]
                    serviceAlias: 'string'
                    serviceEndpointPolicyDefinitions: [
                      {
                        id: 'string'
                        name: 'string'
                        properties: {
                          description: 'string'
                          service: 'string'
                          serviceResources: [
                            'string'
                          ]
                        }
                        type: 'string'
                      }
                    ]
                  }
                  tags: {}
                }
              ]
              serviceEndpoints: [
                {
                  locations: [
                    'string'
                  ]
                  service: 'string'
                }
              ]
            }
            type: 'string'
          }
          virtualNetworkTaps: [
            {
              id: 'string'
              location: 'string'
              properties: {
                destinationLoadBalancerFrontEndIPConfiguration: {
                  id: 'string'
                  name: 'string'
                  properties: {
                    gatewayLoadBalancer: {
                      id: 'string'
                    }
                    privateIPAddress: 'string'
                    privateIPAddressVersion: 'string'
                    privateIPAllocationMethod: 'string'
                    publicIPAddress: {
                      extendedLocation: {
                        name: 'string'
                        type: 'EdgeZone'
                      }
                      id: 'string'
                      location: 'string'
                      properties: {
                        ddosSettings: {
                          ddosProtectionPlan: {
                            id: 'string'
                          }
                          protectionMode: 'string'
                        }
                        deleteOption: 'string'
                        dnsSettings: {
                          domainNameLabel: 'string'
                          fqdn: 'string'
                          reverseFqdn: 'string'
                        }
                        idleTimeoutInMinutes: int
                        ipAddress: 'string'
                        ipTags: [
                          {
                            ipTagType: 'string'
                            tag: 'string'
                          }
                        ]
                        linkedPublicIPAddress: {
                          public-ip-address-object
                        }
                        migrationPhase: 'string'
                        natGateway: {
                          id: 'string'
                          location: 'string'
                          properties: {
                            idleTimeoutInMinutes: int
                            publicIpAddresses: [
                              {
                                id: 'string'
                              }
                            ]
                            publicIpPrefixes: [
                              {
                                id: 'string'
                              }
                            ]
                          }
                          sku: {
                            name: 'Standard'
                          }
                          tags: {}
                          zones: [
                            'string'
                          ]
                        }
                        publicIPAddressVersion: 'string'
                        publicIPAllocationMethod: 'string'
                        publicIPPrefix: {
                          id: 'string'
                        }
                        servicePublicIPAddress: {
                          public-ip-address-object
                        }
                      }
                      sku: {
                        name: 'string'
                        tier: 'string'
                      }
                      tags: {}
                      zones: [
                        'string'
                      ]
                    }
                    publicIPPrefix: {
                      id: 'string'
                    }
                    subnet: {
                      id: 'string'
                      name: 'string'
                      properties: {
                        addressPrefix: 'string'
                        addressPrefixes: [
                          'string'
                        ]
                        applicationGatewayIpConfigurations: [
                          {
                            id: 'string'
                            name: 'string'
                            properties: {
                              subnet: {
                                id: 'string'
                              }
                            }
                          }
                        ]
                        delegations: [
                          {
                            id: 'string'
                            name: 'string'
                            properties: {
                              serviceName: 'string'
                            }
                            type: 'string'
                          }
                        ]
                        ipAllocations: [
                          {
                            id: 'string'
                          }
                        ]
                        natGateway: {
                          id: 'string'
                        }
                        networkSecurityGroup: {
                          id: 'string'
                          location: 'string'
                          properties: {
                            flushConnection: bool
                            securityRules: [
                              {
                                id: 'string'
                                name: 'string'
                                properties: {
                                  access: 'string'
                                  description: 'string'
                                  destinationAddressPrefix: 'string'
                                  destinationAddressPrefixes: [
                                    'string'
                                  ]
                                  destinationApplicationSecurityGroups: [
                                    {
                                      id: 'string'
                                      location: 'string'
                                      properties: {}
                                      tags: {}
                                    }
                                  ]
                                  destinationPortRange: 'string'
                                  destinationPortRanges: [
                                    'string'
                                  ]
                                  direction: 'string'
                                  priority: int
                                  protocol: 'string'
                                  sourceAddressPrefix: 'string'
                                  sourceAddressPrefixes: [
                                    'string'
                                  ]
                                  sourceApplicationSecurityGroups: [
                                    {
                                      id: 'string'
                                      location: 'string'
                                      properties: {}
                                      tags: {}
                                    }
                                  ]
                                  sourcePortRange: 'string'
                                  sourcePortRanges: [
                                    'string'
                                  ]
                                }
                                type: 'string'
                              }
                            ]
                          }
                          tags: {}
                        }
                        privateEndpointNetworkPolicies: 'string'
                        privateLinkServiceNetworkPolicies: 'string'
                        routeTable: {
                          id: 'string'
                          location: 'string'
                          properties: {
                            disableBgpRoutePropagation: bool
                            routes: [
                              {
                                id: 'string'
                                name: 'string'
                                properties: {
                                  addressPrefix: 'string'
                                  hasBgpOverride: bool
                                  nextHopIpAddress: 'string'
                                  nextHopType: 'string'
                                }
                                type: 'string'
                              }
                            ]
                          }
                          tags: {}
                        }
                        serviceEndpointPolicies: [
                          {
                            id: 'string'
                            location: 'string'
                            properties: {
                              contextualServiceEndpointPolicies: [
                                'string'
                              ]
                              serviceAlias: 'string'
                              serviceEndpointPolicyDefinitions: [
                                {
                                  id: 'string'
                                  name: 'string'
                                  properties: {
                                    description: 'string'
                                    service: 'string'
                                    serviceResources: [
                                      'string'
                                    ]
                                  }
                                  type: 'string'
                                }
                              ]
                            }
                            tags: {}
                          }
                        ]
                        serviceEndpoints: [
                          {
                            locations: [
                              'string'
                            ]
                            service: 'string'
                          }
                        ]
                      }
                      type: 'string'
                    }
                  }
                  zones: [
                    'string'
                  ]
                }
                destinationNetworkInterfaceIPConfiguration: {
                destinationPort: int
              }
              tags: {}
            }
          ]
        }
        type: 'string'
      }
    ]
    migrationPhase: 'string'
    networkSecurityGroup: {
      id: 'string'
      location: 'string'
      properties: {
        flushConnection: bool
        securityRules: [
          {
            id: 'string'
            name: 'string'
            properties: {
              access: 'string'
              description: 'string'
              destinationAddressPrefix: 'string'
              destinationAddressPrefixes: [
                'string'
              ]
              destinationApplicationSecurityGroups: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {}
                  tags: {}
                }
              ]
              destinationPortRange: 'string'
              destinationPortRanges: [
                'string'
              ]
              direction: 'string'
              priority: int
              protocol: 'string'
              sourceAddressPrefix: 'string'
              sourceAddressPrefixes: [
                'string'
              ]
              sourceApplicationSecurityGroups: [
                {
                  id: 'string'
                  location: 'string'
                  properties: {}
                  tags: {}
                }
              ]
              sourcePortRange: 'string'
              sourcePortRanges: [
                'string'
              ]
            }
            type: 'string'
          }
        ]
      }
      tags: {}
    }
    nicType: 'string'
    privateLinkService: {
      extendedLocation: {
        name: 'string'
        type: 'EdgeZone'
      }
      id: 'string'
      location: 'string'
      properties: {
        autoApproval: {
          subscriptions: [
            'string'
          ]
        }
        enableProxyProtocol: bool
        fqdns: [
          'string'
        ]
        ipConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              primary: bool
              privateIPAddress: 'string'
              privateIPAddressVersion: 'string'
              privateIPAllocationMethod: 'string'
              subnet: {
                id: 'string'
                name: 'string'
                properties: {
                  addressPrefix: 'string'
                  addressPrefixes: [
                    'string'
                  ]
                  applicationGatewayIpConfigurations: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        subnet: {
                          id: 'string'
                        }
                      }
                    }
                  ]
                  delegations: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        serviceName: 'string'
                      }
                      type: 'string'
                    }
                  ]
                  ipAllocations: [
                    {
                      id: 'string'
                    }
                  ]
                  natGateway: {
                    id: 'string'
                  }
                  networkSecurityGroup: {
                    id: 'string'
                    location: 'string'
                    properties: {
                      flushConnection: bool
                      securityRules: [
                        {
                          id: 'string'
                          name: 'string'
                          properties: {
                            access: 'string'
                            description: 'string'
                            destinationAddressPrefix: 'string'
                            destinationAddressPrefixes: [
                              'string'
                            ]
                            destinationApplicationSecurityGroups: [
                              {
                                id: 'string'
                                location: 'string'
                                properties: {}
                                tags: {}
                              }
                            ]
                            destinationPortRange: 'string'
                            destinationPortRanges: [
                              'string'
                            ]
                            direction: 'string'
                            priority: int
                            protocol: 'string'
                            sourceAddressPrefix: 'string'
                            sourceAddressPrefixes: [
                              'string'
                            ]
                            sourceApplicationSecurityGroups: [
                              {
                                id: 'string'
                                location: 'string'
                                properties: {}
                                tags: {}
                              }
                            ]
                            sourcePortRange: 'string'
                            sourcePortRanges: [
                              'string'
                            ]
                          }
                          type: 'string'
                        }
                      ]
                    }
                    tags: {}
                  }
                  privateEndpointNetworkPolicies: 'string'
                  privateLinkServiceNetworkPolicies: 'string'
                  routeTable: {
                    id: 'string'
                    location: 'string'
                    properties: {
                      disableBgpRoutePropagation: bool
                      routes: [
                        {
                          id: 'string'
                          name: 'string'
                          properties: {
                            addressPrefix: 'string'
                            hasBgpOverride: bool
                            nextHopIpAddress: 'string'
                            nextHopType: 'string'
                          }
                          type: 'string'
                        }
                      ]
                    }
                    tags: {}
                  }
                  serviceEndpointPolicies: [
                    {
                      id: 'string'
                      location: 'string'
                      properties: {
                        contextualServiceEndpointPolicies: [
                          'string'
                        ]
                        serviceAlias: 'string'
                        serviceEndpointPolicyDefinitions: [
                          {
                            id: 'string'
                            name: 'string'
                            properties: {
                              description: 'string'
                              service: 'string'
                              serviceResources: [
                                'string'
                              ]
                            }
                            type: 'string'
                          }
                        ]
                      }
                      tags: {}
                    }
                  ]
                  serviceEndpoints: [
                    {
                      locations: [
                        'string'
                      ]
                      service: 'string'
                    }
                  ]
                }
                type: 'string'
              }
            }
          }
        ]
        loadBalancerFrontendIpConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              gatewayLoadBalancer: {
                id: 'string'
              }
              privateIPAddress: 'string'
              privateIPAddressVersion: 'string'
              privateIPAllocationMethod: 'string'
              publicIPAddress: {
                extendedLocation: {
                  name: 'string'
                  type: 'EdgeZone'
                }
                id: 'string'
                location: 'string'
                properties: {
                  ddosSettings: {
                    ddosProtectionPlan: {
                      id: 'string'
                    }
                    protectionMode: 'string'
                  }
                  deleteOption: 'string'
                  dnsSettings: {
                    domainNameLabel: 'string'
                    fqdn: 'string'
                    reverseFqdn: 'string'
                  }
                  idleTimeoutInMinutes: int
                  ipAddress: 'string'
                  ipTags: [
                    {
                      ipTagType: 'string'
                      tag: 'string'
                    }
                  ]
                  linkedPublicIPAddress: {
                    public-ip-address-object
                  }
                  migrationPhase: 'string'
                  natGateway: {
                    id: 'string'
                    location: 'string'
                    properties: {
                      idleTimeoutInMinutes: int
                      publicIpAddresses: [
                        {
                          id: 'string'
                        }
                      ]
                      publicIpPrefixes: [
                        {
                          id: 'string'
                        }
                      ]
                    }
                    sku: {
                      name: 'Standard'
                    }
                    tags: {}
                    zones: [
                      'string'
                    ]
                  }
                  publicIPAddressVersion: 'string'
                  publicIPAllocationMethod: 'string'
                  publicIPPrefix: {
                    id: 'string'
                  }
                  servicePublicIPAddress: {
                    public-ip-address-object
                  }
                }
                sku: {
                  name: 'string'
                  tier: 'string'
                }
                tags: {}
                zones: [
                  'string'
                ]
              }
              publicIPPrefix: {
                id: 'string'
              }
              subnet: {
                id: 'string'
                name: 'string'
                properties: {
                  addressPrefix: 'string'
                  addressPrefixes: [
                    'string'
                  ]
                  applicationGatewayIpConfigurations: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        subnet: {
                          id: 'string'
                        }
                      }
                    }
                  ]
                  delegations: [
                    {
                      id: 'string'
                      name: 'string'
                      properties: {
                        serviceName: 'string'
                      }
                      type: 'string'
                    }
                  ]
                  ipAllocations: [
                    {
                      id: 'string'
                    }
                  ]
                  natGateway: {
                    id: 'string'
                  }
                  networkSecurityGroup: {
                    id: 'string'
                    location: 'string'
                    properties: {
                      flushConnection: bool
                      securityRules: [
                        {
                          id: 'string'
                          name: 'string'
                          properties: {
                            access: 'string'
                            description: 'string'
                            destinationAddressPrefix: 'string'
                            destinationAddressPrefixes: [
                              'string'
                            ]
                            destinationApplicationSecurityGroups: [
                              {
                                id: 'string'
                                location: 'string'
                                properties: {}
                                tags: {}
                              }
                            ]
                            destinationPortRange: 'string'
                            destinationPortRanges: [
                              'string'
                            ]
                            direction: 'string'
                            priority: int
                            protocol: 'string'
                            sourceAddressPrefix: 'string'
                            sourceAddressPrefixes: [
                              'string'
                            ]
                            sourceApplicationSecurityGroups: [
                              {
                                id: 'string'
                                location: 'string'
                                properties: {}
                                tags: {}
                              }
                            ]
                            sourcePortRange: 'string'
                            sourcePortRanges: [
                              'string'
                            ]
                          }
                          type: 'string'
                        }
                      ]
                    }
                    tags: {}
                  }
                  privateEndpointNetworkPolicies: 'string'
                  privateLinkServiceNetworkPolicies: 'string'
                  routeTable: {
                    id: 'string'
                    location: 'string'
                    properties: {
                      disableBgpRoutePropagation: bool
                      routes: [
                        {
                          id: 'string'
                          name: 'string'
                          properties: {
                            addressPrefix: 'string'
                            hasBgpOverride: bool
                            nextHopIpAddress: 'string'
                            nextHopType: 'string'
                          }
                          type: 'string'
                        }
                      ]
                    }
                    tags: {}
                  }
                  serviceEndpointPolicies: [
                    {
                      id: 'string'
                      location: 'string'
                      properties: {
                        contextualServiceEndpointPolicies: [
                          'string'
                        ]
                        serviceAlias: 'string'
                        serviceEndpointPolicyDefinitions: [
                          {
                            id: 'string'
                            name: 'string'
                            properties: {
                              description: 'string'
                              service: 'string'
                              serviceResources: [
                                'string'
                              ]
                            }
                            type: 'string'
                          }
                        ]
                      }
                      tags: {}
                    }
                  ]
                  serviceEndpoints: [
                    {
                      locations: [
                        'string'
                      ]
                      service: 'string'
                    }
                  ]
                }
                type: 'string'
              }
            }
            zones: [
              'string'
            ]
          }
        ]
        visibility: {
          subscriptions: [
            'string'
          ]
        }
      }
      tags: {}
    }
    workloadType: 'string'
  }
}

Property values

networkInterfaces

Name	Description	Value
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
extendedLocation	The extended location of the network interface.	ExtendedLocation
properties	Properties of the network interface.	NetworkInterfacePropertiesFormat

ExtendedLocation

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

NetworkInterfacePropertiesFormat

Name	Description	Value
auxiliaryMode	Auxiliary mode of Network Interface resource.	'Floating' 'MaxConnections' 'None'
disableTcpStateTracking	Indicates whether to disable tcp state tracking.	bool
dnsSettings	The DNS settings in network interface.	NetworkInterfaceDnsSettings
enableAcceleratedNetworking	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.	bool
enableIPForwarding	Indicates whether IP forwarding is enabled on this network interface.	bool
ipConfigurations	A list of IPConfigurations of the network interface.	NetworkInterfaceIPConfiguration[]
migrationPhase	Migration phase of Network Interface resource.	'Abort' 'Commit' 'Committed' 'None' 'Prepare'
networkSecurityGroup	The reference to the NetworkSecurityGroup resource.	NetworkSecurityGroup
nicType	Type of Network Interface resource.	'Elastic' 'Standard'
privateLinkService	Privatelinkservice of the network interface resource.	PrivateLinkService
workloadType	WorkloadType of the NetworkInterface for BareMetal resources	string

NetworkInterfaceDnsSettings

Name	Description	Value
dnsServers	List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.	string[]
internalDnsNameLabel	Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.	string

NetworkInterfaceIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Network interface IP configuration properties.	NetworkInterfaceIPConfigurationPropertiesFormat
type	Resource type.	string

NetworkInterfaceIPConfigurationPropertiesFormat

Name	Description	Value
applicationGatewayBackendAddressPools	The reference to ApplicationGatewayBackendAddressPool resource.	ApplicationGatewayBackendAddressPool[]
applicationSecurityGroups	Application security groups in which the IP configuration is included.	ApplicationSecurityGroup[]
gatewayLoadBalancer	The reference to gateway load balancer frontend IP.	SubResource
loadBalancerBackendAddressPools	The reference to LoadBalancerBackendAddressPool resource.	BackendAddressPool[]
loadBalancerInboundNatRules	A list of references of LoadBalancerInboundNatRules.	InboundNatRule[]
primary	Whether this is a primary customer address on the network interface.	bool
privateIPAddress	Private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.	'IPv4' 'IPv6'
privateIPAllocationMethod	The private IP address allocation method.	'Dynamic' 'Static'
publicIPAddress	Public IP address bound to the IP configuration.	PublicIPAddress
subnet	Subnet bound to the IP configuration.	Subnet
virtualNetworkTaps	The reference to Virtual Network Taps.	VirtualNetworkTap[]

ApplicationGatewayBackendAddressPool

Name	Description	Value
id	Resource ID.	string
name	Name of the backend address pool that is unique within an Application Gateway.	string
properties	Properties of the application gateway backend address pool.	ApplicationGatewayBackendAddressPoolPropertiesFormat

ApplicationGatewayBackendAddressPoolPropertiesFormat

Name	Description	Value
backendAddresses	Backend addresses.	ApplicationGatewayBackendAddress[]

ApplicationGatewayBackendAddress

Name	Description	Value
fqdn	Fully qualified domain name (FQDN).	string
ipAddress	IP address.	string

ApplicationSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the application security group.	ApplicationSecurityGroupPropertiesFormat
tags	Resource tags.	object

ApplicationSecurityGroupPropertiesFormat

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

SubResource

Name	Description	Value
id	Resource ID.	string

BackendAddressPool

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.	string
properties	Properties of load balancer backend address pool.	BackendAddressPoolPropertiesFormat

BackendAddressPoolPropertiesFormat

Name	Description	Value
drainPeriodInSeconds	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.	int
loadBalancerBackendAddresses	An array of backend addresses.	LoadBalancerBackendAddress[]
location	The location of the backend address pool.	string
tunnelInterfaces	An array of gateway load balancer tunnel interfaces.	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	A reference to a virtual network.	SubResource

LoadBalancerBackendAddress

Name	Description	Value
name	Name of the backend address.	string
properties	Properties of load balancer backend address pool.	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

Name	Description	Value
adminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.	'Down' 'Drain' 'None' 'Up'
ipAddress	IP Address belonging to the referenced virtual network.	string
loadBalancerFrontendIPConfiguration	Reference to the frontend ip address configuration defined in regional loadbalancer.	SubResource
subnet	Reference to an existing subnet.	SubResource
virtualNetwork	Reference to an existing virtual network.	SubResource

GatewayLoadBalancerTunnelInterface

Name	Description	Value
identifier	Identifier of gateway load balancer tunnel interface.	int
port	Port of gateway load balancer tunnel interface.	int
protocol	Protocol of gateway load balancer tunnel interface.	'Native' 'None' 'VXLAN'
type	Traffic type of gateway load balancer tunnel interface.	'External' 'Internal' 'None'

InboundNatRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.	string
properties	Properties of load balancer inbound NAT rule.	InboundNatRulePropertiesFormat

InboundNatRulePropertiesFormat

Name	Description	Value
backendAddressPool	A reference to backendAddressPool resource.	SubResource
backendPort	The port used for the internal endpoint. Acceptable values range from 1 to 65535.	int
enableFloatingIP	Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.	bool
enableTcpReset	Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.	bool
frontendIPConfiguration	A reference to frontend IP addresses.	SubResource
frontendPort	The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.	int
frontendPortRangeEnd	The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.	int
frontendPortRangeStart	The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.	int
idleTimeoutInMinutes	The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.	int
protocol	The reference to the transport protocol used by the load balancing rule.	'All' 'Tcp' 'Udp'

PublicIPAddress

Name	Description	Value
extendedLocation	The extended location of the public ip address.	ExtendedLocation
id	Resource ID.	string
location	Resource location.	string
properties	Public IP address properties.	PublicIPAddressPropertiesFormat
sku	The public IP address SKU.	PublicIPAddressSku
tags	Resource tags.	object
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.	string[]

PublicIPAddressPropertiesFormat

Name	Description	Value
ddosSettings	The DDoS protection custom policy associated with the public IP address.	DdosSettings
deleteOption	Specify what happens to the public IP address when the VM using it is deleted	'Delete' 'Detach'
dnsSettings	The FQDN of the DNS record associated with the public IP address.	PublicIPAddressDnsSettings
idleTimeoutInMinutes	The idle timeout of the public IP address.	int
ipAddress	The IP address associated with the public IP address resource.	string
ipTags	The list of tags associated with the public IP address.	IpTag[]
linkedPublicIPAddress	The linked public IP address of the public IP address resource.	PublicIPAddress
migrationPhase	Migration phase of Public IP Address.	'Abort' 'Commit' 'Committed' 'None' 'Prepare'
natGateway	The NatGateway for the Public IP address.	NatGateway
publicIPAddressVersion	The public IP address version.	'IPv4' 'IPv6'
publicIPAllocationMethod	The public IP address allocation method.	'Dynamic' 'Static'
publicIPPrefix	The Public IP Prefix this Public IP Address should be allocated from.	SubResource
servicePublicIPAddress	The service public IP address of the public IP address resource.	PublicIPAddress

DdosSettings

Name	Description	Value
ddosProtectionPlan	The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled	SubResource
protectionMode	The DDoS protection mode of the public IP	'Disabled' 'Enabled' 'VirtualNetworkInherited'

PublicIPAddressDnsSettings

Name	Description	Value
domainNameLabel	The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.	string
fqdn	The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.	string
reverseFqdn	The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.	string

IpTag

Name	Description	Value
ipTagType	The IP tag type. Example: FirstPartyUsage.	string
tag	The value of the IP tag associated with the public IP. Example: SQL.	string

NatGateway

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Nat Gateway properties.	NatGatewayPropertiesFormat
sku	The nat gateway SKU.	NatGatewaySku
tags	Resource tags.	object
zones	A list of availability zones denoting the zone in which Nat Gateway should be deployed.	string[]

NatGatewayPropertiesFormat

Name	Description	Value
idleTimeoutInMinutes	The idle timeout of the nat gateway.	int
publicIpAddresses	An array of public ip addresses associated with the nat gateway resource.	SubResource[]
publicIpPrefixes	An array of public ip prefixes associated with the nat gateway resource.	SubResource[]

NatGatewaySku

Name	Description	Value
name	Name of Nat Gateway SKU.	'Standard'

PublicIPAddressSku

Name	Description	Value
name	Name of a public IP address SKU.	'Basic' 'Standard'
tier	Tier of a public IP address SKU.	'Global' 'Regional'

Subnet

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the subnet.	SubnetPropertiesFormat
type	Resource type.	string

SubnetPropertiesFormat

Name	Description	Value
addressPrefix	The address prefix for the subnet.	string
addressPrefixes	List of address prefixes for the subnet.	string[]
applicationGatewayIpConfigurations	Application gateway IP configurations of virtual network resource.	ApplicationGatewayIPConfiguration[]
delegations	An array of references to the delegations on the subnet.	Delegation[]
ipAllocations	Array of IpAllocation which reference this subnet.	SubResource[]
natGateway	Nat gateway associated with this subnet.	SubResource
networkSecurityGroup	The reference to the NetworkSecurityGroup resource.	NetworkSecurityGroup
privateEndpointNetworkPolicies	Enable or Disable apply network policies on private end point in the subnet.	'Disabled' 'Enabled'
privateLinkServiceNetworkPolicies	Enable or Disable apply network policies on private link service in the subnet.	'Disabled' 'Enabled'
routeTable	The reference to the RouteTable resource.	RouteTable
serviceEndpointPolicies	An array of service endpoint policies.	ServiceEndpointPolicy[]
serviceEndpoints	An array of service endpoints.	ServiceEndpointPropertiesFormat[]

ApplicationGatewayIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	Name of the IP configuration that is unique within an Application Gateway.	string
properties	Properties of the application gateway IP configuration.	ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

Name	Description	Value
subnet	Reference to the subnet resource. A subnet from where application gateway gets its private address.	SubResource

Delegation

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a subnet. This name can be used to access the resource.	string
properties	Properties of the subnet.	ServiceDelegationPropertiesFormat
type	Resource type.	string

ServiceDelegationPropertiesFormat

Name	Description	Value
serviceName	The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).	string

NetworkSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the network security group.	NetworkSecurityGroupPropertiesFormat
tags	Resource tags.	object

NetworkSecurityGroupPropertiesFormat

Name	Description	Value
flushConnection	When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation.	bool
securityRules	A collection of security rules of the network security group.	SecurityRule[]

SecurityRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the security rule.	SecurityRulePropertiesFormat
type	The type of the resource.	string

SecurityRulePropertiesFormat

Name	Description	Value
access	The network traffic is allowed or denied.	'Allow' 'Deny' (required)
description	A description for this rule. Restricted to 140 chars.	string
destinationAddressPrefix	The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.	string
destinationAddressPrefixes	The destination address prefixes. CIDR or destination IP ranges.	string[]
destinationApplicationSecurityGroups	The application security group specified as destination.	ApplicationSecurityGroup[]
destinationPortRange	The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
destinationPortRanges	The destination port ranges.	string[]
direction	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.	'Inbound' 'Outbound' (required)
priority	The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.	int
protocol	Network protocol this rule applies to.	'*' 'Ah' 'Esp' 'Icmp' 'Tcp' 'Udp' (required)
sourceAddressPrefix	The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.	string
sourceAddressPrefixes	The CIDR or source IP ranges.	string[]
sourceApplicationSecurityGroups	The application security group specified as source.	ApplicationSecurityGroup[]
sourcePortRange	The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
sourcePortRanges	The source port ranges.	string[]

RouteTable

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the route table.	RouteTablePropertiesFormat
tags	Resource tags.	object

RouteTablePropertiesFormat

Name	Description	Value
disableBgpRoutePropagation	Whether to disable the routes learned by BGP on that route table. True means disable.	bool
routes	Collection of routes contained within a route table.	Route[]

Route

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the route.	RoutePropertiesFormat
type	The type of the resource.	string

RoutePropertiesFormat

Name	Description	Value
addressPrefix	The destination CIDR to which the route applies.	string
hasBgpOverride	A value indicating whether this route overrides overlapping BGP routes regardless of LPM.	bool
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
nextHopType	The type of Azure hop the packet should be sent to.	'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required)

ServiceEndpointPolicy

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the service end point policy.	ServiceEndpointPolicyPropertiesFormat
tags	Resource tags.	object

ServiceEndpointPolicyPropertiesFormat

Name	Description	Value
contextualServiceEndpointPolicies	A collection of contextual service endpoint policy.	string[]
serviceAlias	The alias indicating if the policy belongs to a service	string
serviceEndpointPolicyDefinitions	A collection of service endpoint policy definitions of the service endpoint policy.	ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the service endpoint policy definition.	ServiceEndpointPolicyDefinitionPropertiesFormat
type	The type of the resource.	string

ServiceEndpointPolicyDefinitionPropertiesFormat

Name	Description	Value
description	A description for this rule. Restricted to 140 chars.	string
service	Service endpoint name.	string
serviceResources	A list of service resources.	string[]

ServiceEndpointPropertiesFormat

Name	Description	Value
locations	A list of locations.	string[]
service	The type of the endpoint service.	string

VirtualNetworkTap

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Virtual Network Tap Properties.	VirtualNetworkTapPropertiesFormat
tags	Resource tags.	object

VirtualNetworkTapPropertiesFormat

Name	Description	Value
destinationLoadBalancerFrontEndIPConfiguration	The reference to the private IP address on the internal Load Balancer that will receive the tap.	FrontendIPConfiguration
destinationNetworkInterfaceIPConfiguration	The reference to the private IP Address of the collector nic that will receive the tap.	NetworkInterfaceIPConfiguration
destinationPort	The VXLAN destination port that will receive the tapped traffic.	int

FrontendIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.	string
properties	Properties of the load balancer probe.	FrontendIPConfigurationPropertiesFormat
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.	string[]

FrontendIPConfigurationPropertiesFormat

Name	Description	Value
gatewayLoadBalancer	The reference to gateway load balancer frontend IP.	SubResource
privateIPAddress	The private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.	'IPv4' 'IPv6'
privateIPAllocationMethod	The Private IP allocation method.	'Dynamic' 'Static'
publicIPAddress	The reference to the Public IP resource.	PublicIPAddress
publicIPPrefix	The reference to the Public IP Prefix resource.	SubResource
subnet	The reference to the subnet resource.	Subnet

PrivateLinkService

Name	Description	Value
extendedLocation	The extended location of the load balancer.	ExtendedLocation
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the private link service.	PrivateLinkServiceProperties
tags	Resource tags.	object

PrivateLinkServiceProperties

Name	Description	Value
autoApproval	The auto-approval list of the private link service.	PrivateLinkServicePropertiesAutoApproval
enableProxyProtocol	Whether the private link service is enabled for proxy protocol or not.	bool
fqdns	The list of Fqdn.	string[]
ipConfigurations	An array of private link service IP configurations.	PrivateLinkServiceIpConfiguration[]
loadBalancerFrontendIpConfigurations	An array of references to the load balancer IP configurations.	FrontendIPConfiguration[]
visibility	The visibility list of the private link service.	PrivateLinkServicePropertiesVisibility

PrivateLinkServicePropertiesAutoApproval

Name	Description	Value
subscriptions	The list of subscriptions.	string[]

PrivateLinkServiceIpConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of private link service ip configuration.	string
properties	Properties of the private link service ip configuration.	PrivateLinkServiceIpConfigurationProperties

PrivateLinkServiceIpConfigurationProperties

Name	Description	Value
primary	Whether the ip configuration is primary or not.	bool
privateIPAddress	The private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.	'IPv4' 'IPv6'
privateIPAllocationMethod	The private IP address allocation method.	'Dynamic' 'Static'
subnet	The reference to the subnet resource.	Subnet

PrivateLinkServicePropertiesVisibility

Name	Description	Value
subscriptions	The list of subscriptions.	string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
AKS cluster with the Application Gateway Ingress Controller	This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault
App Gateway with WAF, SSL, IIS and HTTPS redirection	This template deploys an Application Gateway with WAF, end to end SSL and HTTP to HTTPS redirect on the IIS servers.
Application Security Groups	This template shows how to put together the pieces to secure workloads using NSGs with Application Security Groups. It will deploy a Linux VM running NGINX and through the usage of Applicaton Security Groups on Network Security Groups we will allow access to ports 22 and 80 to a VM assigned to Application Security Group called webServersAsg.
Use Azure Firewall as a DNS Proxy in a Hub & Spoke topology	This sample show how to deploy a hub-spoke topology in Azure using the Azure Firewall. The hub virtual network acts as a central point of connectivity to many spoke virtual networks that are connected to hub virtual network via virtual network peering.
Create a Firewall, FirewallPolicy with Explicit Proxy	This template creates an Azure Firewall, FirewalllPolicy with Explicit Proxy and Network Rules with IpGroups. Also, includes a Linux Jumpbox vm setup
Create a Firewall with FirewallPolicy and IpGroups	This template creates an Azure Firewall with FirewalllPolicy referencing Network Rules with IpGroups. Also, includes a Linux Jumpbox vm setup
Create an Azure Firewall with IpGroups	This template creates an Azure Firewall with Application and Network Rules referring to IP Groups. Also, includes a Linux Jumpbox vm setup
Create an Azure Firewall sandbox with forced tunneling	This template creates an Azure Firewall sandbox (Linux) with one firewall force tunneled through another firewall in a peered VNET
Testing environment for Azure Firewall Premium	This template creates an Azure Firewall Premium and Firewall Policy with premium features such as Intrusion Inspection Detection (IDPS), TLS inspection and Web Category filtering
Create a sandbox setup of Azure Firewall with Linux VMs	This template creates a virtual network with 3 subnets (server subnet, jumpbox subet and AzureFirewall subnet), a jumpbox VM with public IP, A server VM, UDR route to point to Azure Firewall for the Server Subnet and an Azure Firewall with 1 or more Public IP addresses, 1 sample application rule, 1 sample network rule and default private ranges
Create a sandbox setup with Firewall Policy	This template creates a virtual network with 3 subnets (server subnet, jumpbox subet and AzureFirewall subnet), a jumpbox VM with public IP, A server VM, UDR route to point to Azure Firewall for the Server Subnet and an Azure Firewall with 1 or more Public IP addresses. Also creates a Firewall policy with 1 sample application rule, 1 sample network rule and default private ranges
Create a sandbox setup of Azure Firewall with Zones	This template creates a virtual network with three subnets (server subnet, jumpbox subnet, and Azure Firewall subnet), a jumpbox VM with public IP, A server VM, UDR route to point to Azure Firewall for the ServerSubnet,an Azure Firewall with one or more Public IP addresses, one sample application rule, and one sample network rule and Azure Firewall in Availability Zones 1, 2, and 3.
Deploy a Bastion host in a hub Virtual Network	This template creates two vNets with peerings, a Bastion host in the Hub vNet and a Linux VM in the spoke vNet
Create an Azure Firewall with multiple IP public addresses	This template creates an Azure Firewall with two public IP addresses and two Windows Server 2019 servers to test.
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
Create a standard internal load balancer	This template creates a standard internal Azure Load Balancer with a rule load-balancing port 80
Create a standard internal load balancer with HA ports	This template creates a standard internal Azure Load Balancer with a HA ports load-balancing rule
Create a cross-region load balancer	This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Standard Load Balancer with Backend Pool by IP Addresses	This template is used to demonstrate how ARM Templates can be used to configure the Backend Pool of a Load Balancer by IP Address as outlined in the Backend Pool management document.
Create a load-balancer with a Public IPv6 address	This template creates an Internet-facing load-balancer with a Public IPv6 address, load balancing rules, and two VMs for the backend pool.
Create a standard load-balancer	This template creates an Internet-facing load-balancer, load balancing rules, and three VMs for the backend pool with each VM in a redundant zone.
Load Balancer with 2 VIPs, each with one LB rule	This template allows you to create a Load Balancer, 2 Public IP addresses for the Load balancer (multivip), Virtual Network, Network Interface in the Virtual Network & a LB Rule in the Load Balancer that is used by the Network Interface.
Load Balancer with Inbound NAT Rule	This template allows you to create a Load Balancer, Public IP address for the Load balancer, Virtual Network, Network Interface in the Virtual Network & a NAT Rule in the Load Balancer that is used by the Network Interface.
Virtual Network NAT with VM	Deploy a NAT gateway and virtual machine
Network Interface with Public IP Address	This template allows you to create a Network Inerface in a Virtual Network referencing a Public IP Address.
Private Link service example	This template shows how to create a private link service
Azure Route Server in BGP peering with Quagga	This template deploys a Router Server and Ubuntu VM with Quagga. Two external BGP sessions are established between the Router Server and Quagga. Installation and configuration of Quagga is executed by Azure custom script extension for linux
Create a Site-to-Site VPN Connection with VM	This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Site-to-Site VPN with active-active VPN Gateways with BGP	This template allows you to deploy a site-to-site VPN between two VNets with VPN Gateways in configuration active-active with BGP. Each Azure VPN Gateway resolves the FQDN of the remote peers to determine the public IP of the remote VPN Gateway. Template runs as expected in Azure regions with availability zones.
Azure Traffic Manager VM example	This template shows how to create an Azure Traffic Manager profile load-balancing across multiple virtual machines.
Azure Traffic Manager VM example with Availability Zones	This template shows how to create an Azure Traffic Manager profile load-balancing across multiple virtual machines placed in Availability Zones.
User defined routes and Appliance	This template deploys a Virtual Network, VMs in respective subnets and routes to direct traffic to the appliance
201-vnet-2subnets-service-endpoints-storage-integration	Creates 2 new VMs with a NIC each, in two different subnets within the same VNet. Sets service endpoint on one of the subnets and secures storage account to that subnet.

ARM template resource definition

The networkInterfaces resource type can be deployed to:

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

{
  "type": "Microsoft.Network/networkInterfaces",
  "apiVersion": "2022-07-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "properties": {
    "auxiliaryMode": "string",
    "disableTcpStateTracking": "bool",
    "dnsSettings": {
      "dnsServers": [ "string" ],
      "internalDnsNameLabel": "string"
    },
    "enableAcceleratedNetworking": "bool",
    "enableIPForwarding": "bool",
    "ipConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "applicationGatewayBackendAddressPools": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "backendAddresses": [
                  {
                    "fqdn": "string",
                    "ipAddress": "string"
                  }
                ]
              }
            }
          ],
          "applicationSecurityGroups": [
            {
              "id": "string",
              "location": "string",
              "properties": {},
              "tags": {}
            }
          ],
          "gatewayLoadBalancer": {
            "id": "string"
          },
          "loadBalancerBackendAddressPools": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "drainPeriodInSeconds": "int",
                "loadBalancerBackendAddresses": [
                  {
                    "name": "string",
                    "properties": {
                      "adminState": "string",
                      "ipAddress": "string",
                      "loadBalancerFrontendIPConfiguration": {
                        "id": "string"
                      },
                      "subnet": {
                        "id": "string"
                      },
                      "virtualNetwork": {
                        "id": "string"
                      }
                    }
                  }
                ],
                "location": "string",
                "tunnelInterfaces": [
                  {
                    "identifier": "int",
                    "port": "int",
                    "protocol": "string",
                    "type": "string"
                  }
                ],
                "virtualNetwork": {
                  "id": "string"
                }
              }
            }
          ],
          "loadBalancerInboundNatRules": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "backendAddressPool": {
                  "id": "string"
                },
                "backendPort": "int",
                "enableFloatingIP": "bool",
                "enableTcpReset": "bool",
                "frontendIPConfiguration": {
                  "id": "string"
                },
                "frontendPort": "int",
                "frontendPortRangeEnd": "int",
                "frontendPortRangeStart": "int",
                "idleTimeoutInMinutes": "int",
                "protocol": "string"
              }
            }
          ],
          "primary": "bool",
          "privateIPAddress": "string",
          "privateIPAddressVersion": "string",
          "privateIPAllocationMethod": "string",
          "publicIPAddress": {
            "extendedLocation": {
              "name": "string",
              "type": "EdgeZone"
            },
            "id": "string",
            "location": "string",
            "properties": {
              "ddosSettings": {
                "ddosProtectionPlan": {
                  "id": "string"
                },
                "protectionMode": "string"
              },
              "deleteOption": "string",
              "dnsSettings": {
                "domainNameLabel": "string",
                "fqdn": "string",
                "reverseFqdn": "string"
              },
              "idleTimeoutInMinutes": "int",
              "ipAddress": "string",
              "ipTags": [
                {
                  "ipTagType": "string",
                  "tag": "string"
                }
              ],
              "linkedPublicIPAddress": { public-ip-address-object },
              "migrationPhase": "string",
              "natGateway": {
                "id": "string",
                "location": "string",
                "properties": {
                  "idleTimeoutInMinutes": "int",
                  "publicIpAddresses": [
                    {
                      "id": "string"
                    }
                  ],
                  "publicIpPrefixes": [
                    {
                      "id": "string"
                    }
                  ]
                },
                "sku": {
                  "name": "Standard"
                },
                "tags": {},
                "zones": [ "string" ]
              },
              "publicIPAddressVersion": "string",
              "publicIPAllocationMethod": "string",
              "publicIPPrefix": {
                "id": "string"
              },
              "servicePublicIPAddress": { public-ip-address-object }
            },
            "sku": {
              "name": "string",
              "tier": "string"
            },
            "tags": {},
            "zones": [ "string" ]
          },
          "subnet": {
            "id": "string",
            "name": "string",
            "properties": {
              "addressPrefix": "string",
              "addressPrefixes": [ "string" ],
              "applicationGatewayIpConfigurations": [
                {
                  "id": "string",
                  "name": "string",
                  "properties": {
                    "subnet": {
                      "id": "string"
                    }
                  }
                }
              ],
              "delegations": [
                {
                  "id": "string",
                  "name": "string",
                  "properties": {
                    "serviceName": "string"
                  },
                  "type": "string"
                }
              ],
              "ipAllocations": [
                {
                  "id": "string"
                }
              ],
              "natGateway": {
                "id": "string"
              },
              "networkSecurityGroup": {
                "id": "string",
                "location": "string",
                "properties": {
                  "flushConnection": "bool",
                  "securityRules": [
                    {
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "access": "string",
                        "description": "string",
                        "destinationAddressPrefix": "string",
                        "destinationAddressPrefixes": [ "string" ],
                        "destinationApplicationSecurityGroups": [
                          {
                            "id": "string",
                            "location": "string",
                            "properties": {},
                            "tags": {}
                          }
                        ],
                        "destinationPortRange": "string",
                        "destinationPortRanges": [ "string" ],
                        "direction": "string",
                        "priority": "int",
                        "protocol": "string",
                        "sourceAddressPrefix": "string",
                        "sourceAddressPrefixes": [ "string" ],
                        "sourceApplicationSecurityGroups": [
                          {
                            "id": "string",
                            "location": "string",
                            "properties": {},
                            "tags": {}
                          }
                        ],
                        "sourcePortRange": "string",
                        "sourcePortRanges": [ "string" ]
                      },
                      "type": "string"
                    }
                  ]
                },
                "tags": {}
              },
              "privateEndpointNetworkPolicies": "string",
              "privateLinkServiceNetworkPolicies": "string",
              "routeTable": {
                "id": "string",
                "location": "string",
                "properties": {
                  "disableBgpRoutePropagation": "bool",
                  "routes": [
                    {
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "addressPrefix": "string",
                        "hasBgpOverride": "bool",
                        "nextHopIpAddress": "string",
                        "nextHopType": "string"
                      },
                      "type": "string"
                    }
                  ]
                },
                "tags": {}
              },
              "serviceEndpointPolicies": [
                {
                  "id": "string",
                  "location": "string",
                  "properties": {
                    "contextualServiceEndpointPolicies": [ "string" ],
                    "serviceAlias": "string",
                    "serviceEndpointPolicyDefinitions": [
                      {
                        "id": "string",
                        "name": "string",
                        "properties": {
                          "description": "string",
                          "service": "string",
                          "serviceResources": [ "string" ]
                        },
                        "type": "string"
                      }
                    ]
                  },
                  "tags": {}
                }
              ],
              "serviceEndpoints": [
                {
                  "locations": [ "string" ],
                  "service": "string"
                }
              ]
            },
            "type": "string"
          },
          "virtualNetworkTaps": [
            {
              "id": "string",
              "location": "string",
              "properties": {
                "destinationLoadBalancerFrontEndIPConfiguration": {
                  "id": "string",
                  "name": "string",
                  "properties": {
                    "gatewayLoadBalancer": {
                      "id": "string"
                    },
                    "privateIPAddress": "string",
                    "privateIPAddressVersion": "string",
                    "privateIPAllocationMethod": "string",
                    "publicIPAddress": {
                      "extendedLocation": {
                        "name": "string",
                        "type": "EdgeZone"
                      },
                      "id": "string",
                      "location": "string",
                      "properties": {
                        "ddosSettings": {
                          "ddosProtectionPlan": {
                            "id": "string"
                          },
                          "protectionMode": "string"
                        },
                        "deleteOption": "string",
                        "dnsSettings": {
                          "domainNameLabel": "string",
                          "fqdn": "string",
                          "reverseFqdn": "string"
                        },
                        "idleTimeoutInMinutes": "int",
                        "ipAddress": "string",
                        "ipTags": [
                          {
                            "ipTagType": "string",
                            "tag": "string"
                          }
                        ],
                        "linkedPublicIPAddress": { public-ip-address-object },
                        "migrationPhase": "string",
                        "natGateway": {
                          "id": "string",
                          "location": "string",
                          "properties": {
                            "idleTimeoutInMinutes": "int",
                            "publicIpAddresses": [
                              {
                                "id": "string"
                              }
                            ],
                            "publicIpPrefixes": [
                              {
                                "id": "string"
                              }
                            ]
                          },
                          "sku": {
                            "name": "Standard"
                          },
                          "tags": {},
                          "zones": [ "string" ]
                        },
                        "publicIPAddressVersion": "string",
                        "publicIPAllocationMethod": "string",
                        "publicIPPrefix": {
                          "id": "string"
                        },
                        "servicePublicIPAddress": { public-ip-address-object }
                      },
                      "sku": {
                        "name": "string",
                        "tier": "string"
                      },
                      "tags": {},
                      "zones": [ "string" ]
                    },
                    "publicIPPrefix": {
                      "id": "string"
                    },
                    "subnet": {
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "addressPrefix": "string",
                        "addressPrefixes": [ "string" ],
                        "applicationGatewayIpConfigurations": [
                          {
                            "id": "string",
                            "name": "string",
                            "properties": {
                              "subnet": {
                                "id": "string"
                              }
                            }
                          }
                        ],
                        "delegations": [
                          {
                            "id": "string",
                            "name": "string",
                            "properties": {
                              "serviceName": "string"
                            },
                            "type": "string"
                          }
                        ],
                        "ipAllocations": [
                          {
                            "id": "string"
                          }
                        ],
                        "natGateway": {
                          "id": "string"
                        },
                        "networkSecurityGroup": {
                          "id": "string",
                          "location": "string",
                          "properties": {
                            "flushConnection": "bool",
                            "securityRules": [
                              {
                                "id": "string",
                                "name": "string",
                                "properties": {
                                  "access": "string",
                                  "description": "string",
                                  "destinationAddressPrefix": "string",
                                  "destinationAddressPrefixes": [ "string" ],
                                  "destinationApplicationSecurityGroups": [
                                    {
                                      "id": "string",
                                      "location": "string",
                                      "properties": {},
                                      "tags": {}
                                    }
                                  ],
                                  "destinationPortRange": "string",
                                  "destinationPortRanges": [ "string" ],
                                  "direction": "string",
                                  "priority": "int",
                                  "protocol": "string",
                                  "sourceAddressPrefix": "string",
                                  "sourceAddressPrefixes": [ "string" ],
                                  "sourceApplicationSecurityGroups": [
                                    {
                                      "id": "string",
                                      "location": "string",
                                      "properties": {},
                                      "tags": {}
                                    }
                                  ],
                                  "sourcePortRange": "string",
                                  "sourcePortRanges": [ "string" ]
                                },
                                "type": "string"
                              }
                            ]
                          },
                          "tags": {}
                        },
                        "privateEndpointNetworkPolicies": "string",
                        "privateLinkServiceNetworkPolicies": "string",
                        "routeTable": {
                          "id": "string",
                          "location": "string",
                          "properties": {
                            "disableBgpRoutePropagation": "bool",
                            "routes": [
                              {
                                "id": "string",
                                "name": "string",
                                "properties": {
                                  "addressPrefix": "string",
                                  "hasBgpOverride": "bool",
                                  "nextHopIpAddress": "string",
                                  "nextHopType": "string"
                                },
                                "type": "string"
                              }
                            ]
                          },
                          "tags": {}
                        },
                        "serviceEndpointPolicies": [
                          {
                            "id": "string",
                            "location": "string",
                            "properties": {
                              "contextualServiceEndpointPolicies": [ "string" ],
                              "serviceAlias": "string",
                              "serviceEndpointPolicyDefinitions": [
                                {
                                  "id": "string",
                                  "name": "string",
                                  "properties": {
                                    "description": "string",
                                    "service": "string",
                                    "serviceResources": [ "string" ]
                                  },
                                  "type": "string"
                                }
                              ]
                            },
                            "tags": {}
                          }
                        ],
                        "serviceEndpoints": [
                          {
                            "locations": [ "string" ],
                            "service": "string"
                          }
                        ]
                      },
                      "type": "string"
                    }
                  },
                  "zones": [ "string" ]
                },
                "destinationNetworkInterfaceIPConfiguration": {
                "destinationPort": "int"
              },
              "tags": {}
            }
          ]
        },
        "type": "string"
      }
    ],
    "migrationPhase": "string",
    "networkSecurityGroup": {
      "id": "string",
      "location": "string",
      "properties": {
        "flushConnection": "bool",
        "securityRules": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "access": "string",
              "description": "string",
              "destinationAddressPrefix": "string",
              "destinationAddressPrefixes": [ "string" ],
              "destinationApplicationSecurityGroups": [
                {
                  "id": "string",
                  "location": "string",
                  "properties": {},
                  "tags": {}
                }
              ],
              "destinationPortRange": "string",
              "destinationPortRanges": [ "string" ],
              "direction": "string",
              "priority": "int",
              "protocol": "string",
              "sourceAddressPrefix": "string",
              "sourceAddressPrefixes": [ "string" ],
              "sourceApplicationSecurityGroups": [
                {
                  "id": "string",
                  "location": "string",
                  "properties": {},
                  "tags": {}
                }
              ],
              "sourcePortRange": "string",
              "sourcePortRanges": [ "string" ]
            },
            "type": "string"
          }
        ]
      },
      "tags": {}
    },
    "nicType": "string",
    "privateLinkService": {
      "extendedLocation": {
        "name": "string",
        "type": "EdgeZone"
      },
      "id": "string",
      "location": "string",
      "properties": {
        "autoApproval": {
          "subscriptions": [ "string" ]
        },
        "enableProxyProtocol": "bool",
        "fqdns": [ "string" ],
        "ipConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "primary": "bool",
              "privateIPAddress": "string",
              "privateIPAddressVersion": "string",
              "privateIPAllocationMethod": "string",
              "subnet": {
                "id": "string",
                "name": "string",
                "properties": {
                  "addressPrefix": "string",
                  "addressPrefixes": [ "string" ],
                  "applicationGatewayIpConfigurations": [
                    {
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "subnet": {
                          "id": "string"
                        }
                      }
                    }
                  ],
                  "delegations": [
                    {
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "serviceName": "string"
                      },
                      "type": "string"
                    }
                  ],
                  "ipAllocations": [
                    {
                      "id": "string"
                    }
                  ],
                  "natGateway": {
                    "id": "string"
                  },
                  "networkSecurityGroup": {
                    "id": "string",
                    "location": "string",
                    "properties": {
                      "flushConnection": "bool",
                      "securityRules": [
                        {
                          "id": "string",
                          "name": "string",
                          "properties": {
                            "access": "string",
                            "description": "string",
                            "destinationAddressPrefix": "string",
                            "destinationAddressPrefixes": [ "string" ],
                            "destinationApplicationSecurityGroups": [
                              {
                                "id": "string",
                                "location": "string",
                                "properties": {},
                                "tags": {}
                              }
                            ],
                            "destinationPortRange": "string",
                            "destinationPortRanges": [ "string" ],
                            "direction": "string",
                            "priority": "int",
                            "protocol": "string",
                            "sourceAddressPrefix": "string",
                            "sourceAddressPrefixes": [ "string" ],
                            "sourceApplicationSecurityGroups": [
                              {
                                "id": "string",
                                "location": "string",
                                "properties": {},
                                "tags": {}
                              }
                            ],
                            "sourcePortRange": "string",
                            "sourcePortRanges": [ "string" ]
                          },
                          "type": "string"
                        }
                      ]
                    },
                    "tags": {}
                  },
                  "privateEndpointNetworkPolicies": "string",
                  "privateLinkServiceNetworkPolicies": "string",
                  "routeTable": {
                    "id": "string",
                    "location": "string",
                    "properties": {
                      "disableBgpRoutePropagation": "bool",
                      "routes": [
                        {
                          "id": "string",
                          "name": "string",
                          "properties": {
                            "addressPrefix": "string",
                            "hasBgpOverride": "bool",
                            "nextHopIpAddress": "string",
                            "nextHopType": "string"
                          },
                          "type": "string"
                        }
                      ]
                    },
                    "tags": {}
                  },
                  "serviceEndpointPolicies": [
                    {
                      "id": "string",
                      "location": "string",
                      "properties": {
                        "contextualServiceEndpointPolicies": [ "string" ],
                        "serviceAlias": "string",
                        "serviceEndpointPolicyDefinitions": [
                          {
                            "id": "string",
                            "name": "string",
                            "properties": {
                              "description": "string",
                              "service": "string",
                              "serviceResources": [ "string" ]
                            },
                            "type": "string"
                          }
                        ]
                      },
                      "tags": {}
                    }
                  ],
                  "serviceEndpoints": [
                    {
                      "locations": [ "string" ],
                      "service": "string"
                    }
                  ]
                },
                "type": "string"
              }
            }
          }
        ],
        "loadBalancerFrontendIpConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "gatewayLoadBalancer": {
                "id": "string"
              },
              "privateIPAddress": "string",
              "privateIPAddressVersion": "string",
              "privateIPAllocationMethod": "string",
              "publicIPAddress": {
                "extendedLocation": {
                  "name": "string",
                  "type": "EdgeZone"
                },
                "id": "string",
                "location": "string",
                "properties": {
                  "ddosSettings": {
                    "ddosProtectionPlan": {
                      "id": "string"
                    },
                    "protectionMode": "string"
                  },
                  "deleteOption": "string",
                  "dnsSettings": {
                    "domainNameLabel": "string",
                    "fqdn": "string",
                    "reverseFqdn": "string"
                  },
                  "idleTimeoutInMinutes": "int",
                  "ipAddress": "string",
                  "ipTags": [
                    {
                      "ipTagType": "string",
                      "tag": "string"
                    }
                  ],
                  "linkedPublicIPAddress": { public-ip-address-object },
                  "migrationPhase": "string",
                  "natGateway": {
                    "id": "string",
                    "location": "string",
                    "properties": {
                      "idleTimeoutInMinutes": "int",
                      "publicIpAddresses": [
                        {
                          "id": "string"
                        }
                      ],
                      "publicIpPrefixes": [
                        {
                          "id": "string"
                        }
                      ]
                    },
                    "sku": {
                      "name": "Standard"
                    },
                    "tags": {},
                    "zones": [ "string" ]
                  },
                  "publicIPAddressVersion": "string",
                  "publicIPAllocationMethod": "string",
                  "publicIPPrefix": {
                    "id": "string"
                  },
                  "servicePublicIPAddress": { public-ip-address-object }
                },
                "sku": {
                  "name": "string",
                  "tier": "string"
                },
                "tags": {},
                "zones": [ "string" ]
              },
              "publicIPPrefix": {
                "id": "string"
              },
              "subnet": {
                "id": "string",
                "name": "string",
                "properties": {
                  "addressPrefix": "string",
                  "addressPrefixes": [ "string" ],
                  "applicationGatewayIpConfigurations": [
                    {
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "subnet": {
                          "id": "string"
                        }
                      }
                    }
                  ],
                  "delegations": [
                    {
                      "id": "string",
                      "name": "string",
                      "properties": {
                        "serviceName": "string"
                      },
                      "type": "string"
                    }
                  ],
                  "ipAllocations": [
                    {
                      "id": "string"
                    }
                  ],
                  "natGateway": {
                    "id": "string"
                  },
                  "networkSecurityGroup": {
                    "id": "string",
                    "location": "string",
                    "properties": {
                      "flushConnection": "bool",
                      "securityRules": [
                        {
                          "id": "string",
                          "name": "string",
                          "properties": {
                            "access": "string",
                            "description": "string",
                            "destinationAddressPrefix": "string",
                            "destinationAddressPrefixes": [ "string" ],
                            "destinationApplicationSecurityGroups": [
                              {
                                "id": "string",
                                "location": "string",
                                "properties": {},
                                "tags": {}
                              }
                            ],
                            "destinationPortRange": "string",
                            "destinationPortRanges": [ "string" ],
                            "direction": "string",
                            "priority": "int",
                            "protocol": "string",
                            "sourceAddressPrefix": "string",
                            "sourceAddressPrefixes": [ "string" ],
                            "sourceApplicationSecurityGroups": [
                              {
                                "id": "string",
                                "location": "string",
                                "properties": {},
                                "tags": {}
                              }
                            ],
                            "sourcePortRange": "string",
                            "sourcePortRanges": [ "string" ]
                          },
                          "type": "string"
                        }
                      ]
                    },
                    "tags": {}
                  },
                  "privateEndpointNetworkPolicies": "string",
                  "privateLinkServiceNetworkPolicies": "string",
                  "routeTable": {
                    "id": "string",
                    "location": "string",
                    "properties": {
                      "disableBgpRoutePropagation": "bool",
                      "routes": [
                        {
                          "id": "string",
                          "name": "string",
                          "properties": {
                            "addressPrefix": "string",
                            "hasBgpOverride": "bool",
                            "nextHopIpAddress": "string",
                            "nextHopType": "string"
                          },
                          "type": "string"
                        }
                      ]
                    },
                    "tags": {}
                  },
                  "serviceEndpointPolicies": [
                    {
                      "id": "string",
                      "location": "string",
                      "properties": {
                        "contextualServiceEndpointPolicies": [ "string" ],
                        "serviceAlias": "string",
                        "serviceEndpointPolicyDefinitions": [
                          {
                            "id": "string",
                            "name": "string",
                            "properties": {
                              "description": "string",
                              "service": "string",
                              "serviceResources": [ "string" ]
                            },
                            "type": "string"
                          }
                        ]
                      },
                      "tags": {}
                    }
                  ],
                  "serviceEndpoints": [
                    {
                      "locations": [ "string" ],
                      "service": "string"
                    }
                  ]
                },
                "type": "string"
              }
            },
            "zones": [ "string" ]
          }
        ],
        "visibility": {
          "subscriptions": [ "string" ]
        }
      },
      "tags": {}
    },
    "workloadType": "string"
  }
}

Property values

networkInterfaces

Name	Description	Value
type	The resource type	'Microsoft.Network/networkInterfaces'
apiVersion	The resource api version	'2022-07-01'
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
extendedLocation	The extended location of the network interface.	ExtendedLocation
properties	Properties of the network interface.	NetworkInterfacePropertiesFormat

ExtendedLocation

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

NetworkInterfacePropertiesFormat

Name	Description	Value
auxiliaryMode	Auxiliary mode of Network Interface resource.	'Floating' 'MaxConnections' 'None'
disableTcpStateTracking	Indicates whether to disable tcp state tracking.	bool
dnsSettings	The DNS settings in network interface.	NetworkInterfaceDnsSettings
enableAcceleratedNetworking	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.	bool
enableIPForwarding	Indicates whether IP forwarding is enabled on this network interface.	bool
ipConfigurations	A list of IPConfigurations of the network interface.	NetworkInterfaceIPConfiguration[]
migrationPhase	Migration phase of Network Interface resource.	'Abort' 'Commit' 'Committed' 'None' 'Prepare'
networkSecurityGroup	The reference to the NetworkSecurityGroup resource.	NetworkSecurityGroup
nicType	Type of Network Interface resource.	'Elastic' 'Standard'
privateLinkService	Privatelinkservice of the network interface resource.	PrivateLinkService
workloadType	WorkloadType of the NetworkInterface for BareMetal resources	string

NetworkInterfaceDnsSettings

Name	Description	Value
dnsServers	List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.	string[]
internalDnsNameLabel	Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.	string

NetworkInterfaceIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Network interface IP configuration properties.	NetworkInterfaceIPConfigurationPropertiesFormat
type	Resource type.	string

NetworkInterfaceIPConfigurationPropertiesFormat

Name	Description	Value
applicationGatewayBackendAddressPools	The reference to ApplicationGatewayBackendAddressPool resource.	ApplicationGatewayBackendAddressPool[]
applicationSecurityGroups	Application security groups in which the IP configuration is included.	ApplicationSecurityGroup[]
gatewayLoadBalancer	The reference to gateway load balancer frontend IP.	SubResource
loadBalancerBackendAddressPools	The reference to LoadBalancerBackendAddressPool resource.	BackendAddressPool[]
loadBalancerInboundNatRules	A list of references of LoadBalancerInboundNatRules.	InboundNatRule[]
primary	Whether this is a primary customer address on the network interface.	bool
privateIPAddress	Private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.	'IPv4' 'IPv6'
privateIPAllocationMethod	The private IP address allocation method.	'Dynamic' 'Static'
publicIPAddress	Public IP address bound to the IP configuration.	PublicIPAddress
subnet	Subnet bound to the IP configuration.	Subnet
virtualNetworkTaps	The reference to Virtual Network Taps.	VirtualNetworkTap[]

ApplicationGatewayBackendAddressPool

Name	Description	Value
id	Resource ID.	string
name	Name of the backend address pool that is unique within an Application Gateway.	string
properties	Properties of the application gateway backend address pool.	ApplicationGatewayBackendAddressPoolPropertiesFormat

ApplicationGatewayBackendAddressPoolPropertiesFormat

Name	Description	Value
backendAddresses	Backend addresses.	ApplicationGatewayBackendAddress[]

ApplicationGatewayBackendAddress

Name	Description	Value
fqdn	Fully qualified domain name (FQDN).	string
ipAddress	IP address.	string

ApplicationSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the application security group.	ApplicationSecurityGroupPropertiesFormat
tags	Resource tags.	object

ApplicationSecurityGroupPropertiesFormat

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

SubResource

Name	Description	Value
id	Resource ID.	string

BackendAddressPool

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.	string
properties	Properties of load balancer backend address pool.	BackendAddressPoolPropertiesFormat

BackendAddressPoolPropertiesFormat

Name	Description	Value
drainPeriodInSeconds	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.	int
loadBalancerBackendAddresses	An array of backend addresses.	LoadBalancerBackendAddress[]
location	The location of the backend address pool.	string
tunnelInterfaces	An array of gateway load balancer tunnel interfaces.	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	A reference to a virtual network.	SubResource

LoadBalancerBackendAddress

Name	Description	Value
name	Name of the backend address.	string
properties	Properties of load balancer backend address pool.	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

Name	Description	Value
adminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.	'Down' 'Drain' 'None' 'Up'
ipAddress	IP Address belonging to the referenced virtual network.	string
loadBalancerFrontendIPConfiguration	Reference to the frontend ip address configuration defined in regional loadbalancer.	SubResource
subnet	Reference to an existing subnet.	SubResource
virtualNetwork	Reference to an existing virtual network.	SubResource

GatewayLoadBalancerTunnelInterface

Name	Description	Value
identifier	Identifier of gateway load balancer tunnel interface.	int
port	Port of gateway load balancer tunnel interface.	int
protocol	Protocol of gateway load balancer tunnel interface.	'Native' 'None' 'VXLAN'
type	Traffic type of gateway load balancer tunnel interface.	'External' 'Internal' 'None'

InboundNatRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.	string
properties	Properties of load balancer inbound NAT rule.	InboundNatRulePropertiesFormat

InboundNatRulePropertiesFormat

Name	Description	Value
backendAddressPool	A reference to backendAddressPool resource.	SubResource
backendPort	The port used for the internal endpoint. Acceptable values range from 1 to 65535.	int
enableFloatingIP	Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.	bool
enableTcpReset	Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.	bool
frontendIPConfiguration	A reference to frontend IP addresses.	SubResource
frontendPort	The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.	int
frontendPortRangeEnd	The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.	int
frontendPortRangeStart	The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.	int
idleTimeoutInMinutes	The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.	int
protocol	The reference to the transport protocol used by the load balancing rule.	'All' 'Tcp' 'Udp'

PublicIPAddress

Name	Description	Value
extendedLocation	The extended location of the public ip address.	ExtendedLocation
id	Resource ID.	string
location	Resource location.	string
properties	Public IP address properties.	PublicIPAddressPropertiesFormat
sku	The public IP address SKU.	PublicIPAddressSku
tags	Resource tags.	object
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.	string[]

PublicIPAddressPropertiesFormat

Name	Description	Value
ddosSettings	The DDoS protection custom policy associated with the public IP address.	DdosSettings
deleteOption	Specify what happens to the public IP address when the VM using it is deleted	'Delete' 'Detach'
dnsSettings	The FQDN of the DNS record associated with the public IP address.	PublicIPAddressDnsSettings
idleTimeoutInMinutes	The idle timeout of the public IP address.	int
ipAddress	The IP address associated with the public IP address resource.	string
ipTags	The list of tags associated with the public IP address.	IpTag[]
linkedPublicIPAddress	The linked public IP address of the public IP address resource.	PublicIPAddress
migrationPhase	Migration phase of Public IP Address.	'Abort' 'Commit' 'Committed' 'None' 'Prepare'
natGateway	The NatGateway for the Public IP address.	NatGateway
publicIPAddressVersion	The public IP address version.	'IPv4' 'IPv6'
publicIPAllocationMethod	The public IP address allocation method.	'Dynamic' 'Static'
publicIPPrefix	The Public IP Prefix this Public IP Address should be allocated from.	SubResource
servicePublicIPAddress	The service public IP address of the public IP address resource.	PublicIPAddress

DdosSettings

Name	Description	Value
ddosProtectionPlan	The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled	SubResource
protectionMode	The DDoS protection mode of the public IP	'Disabled' 'Enabled' 'VirtualNetworkInherited'

PublicIPAddressDnsSettings

Name	Description	Value
domainNameLabel	The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.	string
fqdn	The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.	string
reverseFqdn	The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.	string

IpTag

Name	Description	Value
ipTagType	The IP tag type. Example: FirstPartyUsage.	string
tag	The value of the IP tag associated with the public IP. Example: SQL.	string

NatGateway

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Nat Gateway properties.	NatGatewayPropertiesFormat
sku	The nat gateway SKU.	NatGatewaySku
tags	Resource tags.	object
zones	A list of availability zones denoting the zone in which Nat Gateway should be deployed.	string[]

NatGatewayPropertiesFormat

Name	Description	Value
idleTimeoutInMinutes	The idle timeout of the nat gateway.	int
publicIpAddresses	An array of public ip addresses associated with the nat gateway resource.	SubResource[]
publicIpPrefixes	An array of public ip prefixes associated with the nat gateway resource.	SubResource[]

NatGatewaySku

Name	Description	Value
name	Name of Nat Gateway SKU.	'Standard'

PublicIPAddressSku

Name	Description	Value
name	Name of a public IP address SKU.	'Basic' 'Standard'
tier	Tier of a public IP address SKU.	'Global' 'Regional'

Subnet

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the subnet.	SubnetPropertiesFormat
type	Resource type.	string

SubnetPropertiesFormat

Name	Description	Value
addressPrefix	The address prefix for the subnet.	string
addressPrefixes	List of address prefixes for the subnet.	string[]
applicationGatewayIpConfigurations	Application gateway IP configurations of virtual network resource.	ApplicationGatewayIPConfiguration[]
delegations	An array of references to the delegations on the subnet.	Delegation[]
ipAllocations	Array of IpAllocation which reference this subnet.	SubResource[]
natGateway	Nat gateway associated with this subnet.	SubResource
networkSecurityGroup	The reference to the NetworkSecurityGroup resource.	NetworkSecurityGroup
privateEndpointNetworkPolicies	Enable or Disable apply network policies on private end point in the subnet.	'Disabled' 'Enabled'
privateLinkServiceNetworkPolicies	Enable or Disable apply network policies on private link service in the subnet.	'Disabled' 'Enabled'
routeTable	The reference to the RouteTable resource.	RouteTable
serviceEndpointPolicies	An array of service endpoint policies.	ServiceEndpointPolicy[]
serviceEndpoints	An array of service endpoints.	ServiceEndpointPropertiesFormat[]

ApplicationGatewayIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	Name of the IP configuration that is unique within an Application Gateway.	string
properties	Properties of the application gateway IP configuration.	ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

Name	Description	Value
subnet	Reference to the subnet resource. A subnet from where application gateway gets its private address.	SubResource

Delegation

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a subnet. This name can be used to access the resource.	string
properties	Properties of the subnet.	ServiceDelegationPropertiesFormat
type	Resource type.	string

ServiceDelegationPropertiesFormat

Name	Description	Value
serviceName	The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).	string

NetworkSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the network security group.	NetworkSecurityGroupPropertiesFormat
tags	Resource tags.	object

NetworkSecurityGroupPropertiesFormat

Name	Description	Value
flushConnection	When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation.	bool
securityRules	A collection of security rules of the network security group.	SecurityRule[]

SecurityRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the security rule.	SecurityRulePropertiesFormat
type	The type of the resource.	string

SecurityRulePropertiesFormat

Name	Description	Value
access	The network traffic is allowed or denied.	'Allow' 'Deny' (required)
description	A description for this rule. Restricted to 140 chars.	string
destinationAddressPrefix	The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.	string
destinationAddressPrefixes	The destination address prefixes. CIDR or destination IP ranges.	string[]
destinationApplicationSecurityGroups	The application security group specified as destination.	ApplicationSecurityGroup[]
destinationPortRange	The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
destinationPortRanges	The destination port ranges.	string[]
direction	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.	'Inbound' 'Outbound' (required)
priority	The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.	int
protocol	Network protocol this rule applies to.	'*' 'Ah' 'Esp' 'Icmp' 'Tcp' 'Udp' (required)
sourceAddressPrefix	The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.	string
sourceAddressPrefixes	The CIDR or source IP ranges.	string[]
sourceApplicationSecurityGroups	The application security group specified as source.	ApplicationSecurityGroup[]
sourcePortRange	The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
sourcePortRanges	The source port ranges.	string[]

RouteTable

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the route table.	RouteTablePropertiesFormat
tags	Resource tags.	object

RouteTablePropertiesFormat

Name	Description	Value
disableBgpRoutePropagation	Whether to disable the routes learned by BGP on that route table. True means disable.	bool
routes	Collection of routes contained within a route table.	Route[]

Route

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the route.	RoutePropertiesFormat
type	The type of the resource.	string

RoutePropertiesFormat

Name	Description	Value
addressPrefix	The destination CIDR to which the route applies.	string
hasBgpOverride	A value indicating whether this route overrides overlapping BGP routes regardless of LPM.	bool
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
nextHopType	The type of Azure hop the packet should be sent to.	'Internet' 'None' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required)

ServiceEndpointPolicy

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the service end point policy.	ServiceEndpointPolicyPropertiesFormat
tags	Resource tags.	object

ServiceEndpointPolicyPropertiesFormat

Name	Description	Value
contextualServiceEndpointPolicies	A collection of contextual service endpoint policy.	string[]
serviceAlias	The alias indicating if the policy belongs to a service	string
serviceEndpointPolicyDefinitions	A collection of service endpoint policy definitions of the service endpoint policy.	ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the service endpoint policy definition.	ServiceEndpointPolicyDefinitionPropertiesFormat
type	The type of the resource.	string

ServiceEndpointPolicyDefinitionPropertiesFormat

Name	Description	Value
description	A description for this rule. Restricted to 140 chars.	string
service	Service endpoint name.	string
serviceResources	A list of service resources.	string[]

ServiceEndpointPropertiesFormat

Name	Description	Value
locations	A list of locations.	string[]
service	The type of the endpoint service.	string

VirtualNetworkTap

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Virtual Network Tap Properties.	VirtualNetworkTapPropertiesFormat
tags	Resource tags.	object

VirtualNetworkTapPropertiesFormat

Name	Description	Value
destinationLoadBalancerFrontEndIPConfiguration	The reference to the private IP address on the internal Load Balancer that will receive the tap.	FrontendIPConfiguration
destinationNetworkInterfaceIPConfiguration	The reference to the private IP Address of the collector nic that will receive the tap.	NetworkInterfaceIPConfiguration
destinationPort	The VXLAN destination port that will receive the tapped traffic.	int

FrontendIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.	string
properties	Properties of the load balancer probe.	FrontendIPConfigurationPropertiesFormat
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.	string[]

FrontendIPConfigurationPropertiesFormat

Name	Description	Value
gatewayLoadBalancer	The reference to gateway load balancer frontend IP.	SubResource
privateIPAddress	The private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.	'IPv4' 'IPv6'
privateIPAllocationMethod	The Private IP allocation method.	'Dynamic' 'Static'
publicIPAddress	The reference to the Public IP resource.	PublicIPAddress
publicIPPrefix	The reference to the Public IP Prefix resource.	SubResource
subnet	The reference to the subnet resource.	Subnet

PrivateLinkService

Name	Description	Value
extendedLocation	The extended location of the load balancer.	ExtendedLocation
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the private link service.	PrivateLinkServiceProperties
tags	Resource tags.	object

PrivateLinkServiceProperties

Name	Description	Value
autoApproval	The auto-approval list of the private link service.	PrivateLinkServicePropertiesAutoApproval
enableProxyProtocol	Whether the private link service is enabled for proxy protocol or not.	bool
fqdns	The list of Fqdn.	string[]
ipConfigurations	An array of private link service IP configurations.	PrivateLinkServiceIpConfiguration[]
loadBalancerFrontendIpConfigurations	An array of references to the load balancer IP configurations.	FrontendIPConfiguration[]
visibility	The visibility list of the private link service.	PrivateLinkServicePropertiesVisibility

PrivateLinkServicePropertiesAutoApproval

Name	Description	Value
subscriptions	The list of subscriptions.	string[]

PrivateLinkServiceIpConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of private link service ip configuration.	string
properties	Properties of the private link service ip configuration.	PrivateLinkServiceIpConfigurationProperties

PrivateLinkServiceIpConfigurationProperties

Name	Description	Value
primary	Whether the ip configuration is primary or not.	bool
privateIPAddress	The private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.	'IPv4' 'IPv6'
privateIPAllocationMethod	The private IP address allocation method.	'Dynamic' 'Static'
subnet	The reference to the subnet resource.	Subnet

PrivateLinkServicePropertiesVisibility

Name	Description	Value
subscriptions	The list of subscriptions.	string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
AKS cluster with the Application Gateway Ingress Controller	This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault
App Gateway with WAF, SSL, IIS and HTTPS redirection	This template deploys an Application Gateway with WAF, end to end SSL and HTTP to HTTPS redirect on the IIS servers.
Application Security Groups	This template shows how to put together the pieces to secure workloads using NSGs with Application Security Groups. It will deploy a Linux VM running NGINX and through the usage of Applicaton Security Groups on Network Security Groups we will allow access to ports 22 and 80 to a VM assigned to Application Security Group called webServersAsg.
Use Azure Firewall as a DNS Proxy in a Hub & Spoke topology	This sample show how to deploy a hub-spoke topology in Azure using the Azure Firewall. The hub virtual network acts as a central point of connectivity to many spoke virtual networks that are connected to hub virtual network via virtual network peering.
Create a Firewall, FirewallPolicy with Explicit Proxy	This template creates an Azure Firewall, FirewalllPolicy with Explicit Proxy and Network Rules with IpGroups. Also, includes a Linux Jumpbox vm setup
Create a Firewall with FirewallPolicy and IpGroups	This template creates an Azure Firewall with FirewalllPolicy referencing Network Rules with IpGroups. Also, includes a Linux Jumpbox vm setup
Create an Azure Firewall with IpGroups	This template creates an Azure Firewall with Application and Network Rules referring to IP Groups. Also, includes a Linux Jumpbox vm setup
Create an Azure Firewall sandbox with forced tunneling	This template creates an Azure Firewall sandbox (Linux) with one firewall force tunneled through another firewall in a peered VNET
Testing environment for Azure Firewall Premium	This template creates an Azure Firewall Premium and Firewall Policy with premium features such as Intrusion Inspection Detection (IDPS), TLS inspection and Web Category filtering
Create a sandbox setup of Azure Firewall with Linux VMs	This template creates a virtual network with 3 subnets (server subnet, jumpbox subet and AzureFirewall subnet), a jumpbox VM with public IP, A server VM, UDR route to point to Azure Firewall for the Server Subnet and an Azure Firewall with 1 or more Public IP addresses, 1 sample application rule, 1 sample network rule and default private ranges
Create a sandbox setup with Firewall Policy	This template creates a virtual network with 3 subnets (server subnet, jumpbox subet and AzureFirewall subnet), a jumpbox VM with public IP, A server VM, UDR route to point to Azure Firewall for the Server Subnet and an Azure Firewall with 1 or more Public IP addresses. Also creates a Firewall policy with 1 sample application rule, 1 sample network rule and default private ranges
Create a sandbox setup of Azure Firewall with Zones	This template creates a virtual network with three subnets (server subnet, jumpbox subnet, and Azure Firewall subnet), a jumpbox VM with public IP, A server VM, UDR route to point to Azure Firewall for the ServerSubnet,an Azure Firewall with one or more Public IP addresses, one sample application rule, and one sample network rule and Azure Firewall in Availability Zones 1, 2, and 3.
Deploy a Bastion host in a hub Virtual Network	This template creates two vNets with peerings, a Bastion host in the Hub vNet and a Linux VM in the spoke vNet
Create an Azure Firewall with multiple IP public addresses	This template creates an Azure Firewall with two public IP addresses and two Windows Server 2019 servers to test.
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
Create a standard internal load balancer	This template creates a standard internal Azure Load Balancer with a rule load-balancing port 80
Create a standard internal load balancer with HA ports	This template creates a standard internal Azure Load Balancer with a HA ports load-balancing rule
Create a cross-region load balancer	This template creates a cross-region load balancer with a backend pool containing two regional load balancers. Cross-region load balancer is currently available in limited regions. The regional load balancers behind the cross-region load balancer can be in any region.
Standard Load Balancer with Backend Pool by IP Addresses	This template is used to demonstrate how ARM Templates can be used to configure the Backend Pool of a Load Balancer by IP Address as outlined in the Backend Pool management document.
Create a load-balancer with a Public IPv6 address	This template creates an Internet-facing load-balancer with a Public IPv6 address, load balancing rules, and two VMs for the backend pool.
Create a standard load-balancer	This template creates an Internet-facing load-balancer, load balancing rules, and three VMs for the backend pool with each VM in a redundant zone.
Load Balancer with 2 VIPs, each with one LB rule	This template allows you to create a Load Balancer, 2 Public IP addresses for the Load balancer (multivip), Virtual Network, Network Interface in the Virtual Network & a LB Rule in the Load Balancer that is used by the Network Interface.
Load Balancer with Inbound NAT Rule	This template allows you to create a Load Balancer, Public IP address for the Load balancer, Virtual Network, Network Interface in the Virtual Network & a NAT Rule in the Load Balancer that is used by the Network Interface.
Virtual Network NAT with VM	Deploy a NAT gateway and virtual machine
Network Interface with Public IP Address	This template allows you to create a Network Inerface in a Virtual Network referencing a Public IP Address.
Private Link service example	This template shows how to create a private link service
Azure Route Server in BGP peering with Quagga	This template deploys a Router Server and Ubuntu VM with Quagga. Two external BGP sessions are established between the Router Server and Quagga. Installation and configuration of Quagga is executed by Azure custom script extension for linux
Create a Site-to-Site VPN Connection with VM	This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Site-to-Site VPN with active-active VPN Gateways with BGP	This template allows you to deploy a site-to-site VPN between two VNets with VPN Gateways in configuration active-active with BGP. Each Azure VPN Gateway resolves the FQDN of the remote peers to determine the public IP of the remote VPN Gateway. Template runs as expected in Azure regions with availability zones.
Azure Traffic Manager VM example	This template shows how to create an Azure Traffic Manager profile load-balancing across multiple virtual machines.
Azure Traffic Manager VM example with Availability Zones	This template shows how to create an Azure Traffic Manager profile load-balancing across multiple virtual machines placed in Availability Zones.
User defined routes and Appliance	This template deploys a Virtual Network, VMs in respective subnets and routes to direct traffic to the appliance
201-vnet-2subnets-service-endpoints-storage-integration	Creates 2 new VMs with a NIC each, in two different subnets within the same VNet. Sets service endpoint on one of the subnets and secures storage account to that subnet.

Terraform (AzAPI provider) resource definition

The networkInterfaces resource type can be deployed to:

• Resource groups

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

Resource format

To create a Microsoft.Network/networkInterfaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkInterfaces@2022-07-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      auxiliaryMode = "string"
      disableTcpStateTracking = bool
      dnsSettings = {
        dnsServers = [
          "string"
        ]
        internalDnsNameLabel = "string"
      }
      enableAcceleratedNetworking = bool
      enableIPForwarding = bool
      ipConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            applicationGatewayBackendAddressPools = [
              {
                id = "string"
                name = "string"
                properties = {
                  backendAddresses = [
                    {
                      fqdn = "string"
                      ipAddress = "string"
                    }
                  ]
                }
              }
            ]
            applicationSecurityGroups = [
              {
                id = "string"
                location = "string"
                properties = {}
                tags = {}
              }
            ]
            gatewayLoadBalancer = {
              id = "string"
            }
            loadBalancerBackendAddressPools = [
              {
                id = "string"
                name = "string"
                properties = {
                  drainPeriodInSeconds = int
                  loadBalancerBackendAddresses = [
                    {
                      name = "string"
                      properties = {
                        adminState = "string"
                        ipAddress = "string"
                        loadBalancerFrontendIPConfiguration = {
                          id = "string"
                        }
                        subnet = {
                          id = "string"
                        }
                        virtualNetwork = {
                          id = "string"
                        }
                      }
                    }
                  ]
                  location = "string"
                  tunnelInterfaces = [
                    {
                      identifier = int
                      port = int
                      protocol = "string"
                      type = "string"
                    }
                  ]
                  virtualNetwork = {
                    id = "string"
                  }
                }
              }
            ]
            loadBalancerInboundNatRules = [
              {
                id = "string"
                name = "string"
                properties = {
                  backendAddressPool = {
                    id = "string"
                  }
                  backendPort = int
                  enableFloatingIP = bool
                  enableTcpReset = bool
                  frontendIPConfiguration = {
                    id = "string"
                  }
                  frontendPort = int
                  frontendPortRangeEnd = int
                  frontendPortRangeStart = int
                  idleTimeoutInMinutes = int
                  protocol = "string"
                }
              }
            ]
            primary = bool
            privateIPAddress = "string"
            privateIPAddressVersion = "string"
            privateIPAllocationMethod = "string"
            publicIPAddress = {
              extendedLocation = {
                name = "string"
                type = "EdgeZone"
              }
              id = "string"
              location = "string"
              properties = {
                ddosSettings = {
                  ddosProtectionPlan = {
                    id = "string"
                  }
                  protectionMode = "string"
                }
                deleteOption = "string"
                dnsSettings = {
                  domainNameLabel = "string"
                  fqdn = "string"
                  reverseFqdn = "string"
                }
                idleTimeoutInMinutes = int
                ipAddress = "string"
                ipTags = [
                  {
                    ipTagType = "string"
                    tag = "string"
                  }
                ]
                linkedPublicIPAddress = {
                  public-ip-address-object
                }
                migrationPhase = "string"
                natGateway = {
                  id = "string"
                  location = "string"
                  properties = {
                    idleTimeoutInMinutes = int
                    publicIpAddresses = [
                      {
                        id = "string"
                      }
                    ]
                    publicIpPrefixes = [
                      {
                        id = "string"
                      }
                    ]
                  }
                  sku = {
                    name = "Standard"
                  }
                  tags = {}
                  zones = [
                    "string"
                  ]
                }
                publicIPAddressVersion = "string"
                publicIPAllocationMethod = "string"
                publicIPPrefix = {
                  id = "string"
                }
                servicePublicIPAddress = {
                  public-ip-address-object
                }
              }
              sku = {
                name = "string"
                tier = "string"
              }
              tags = {}
              zones = [
                "string"
              ]
            }
            subnet = {
              id = "string"
              name = "string"
              properties = {
                addressPrefix = "string"
                addressPrefixes = [
                  "string"
                ]
                applicationGatewayIpConfigurations = [
                  {
                    id = "string"
                    name = "string"
                    properties = {
                      subnet = {
                        id = "string"
                      }
                    }
                  }
                ]
                delegations = [
                  {
                    id = "string"
                    name = "string"
                    properties = {
                      serviceName = "string"
                    }
                    type = "string"
                  }
                ]
                ipAllocations = [
                  {
                    id = "string"
                  }
                ]
                natGateway = {
                  id = "string"
                }
                networkSecurityGroup = {
                  id = "string"
                  location = "string"
                  properties = {
                    flushConnection = bool
                    securityRules = [
                      {
                        id = "string"
                        name = "string"
                        properties = {
                          access = "string"
                          description = "string"
                          destinationAddressPrefix = "string"
                          destinationAddressPrefixes = [
                            "string"
                          ]
                          destinationApplicationSecurityGroups = [
                            {
                              id = "string"
                              location = "string"
                              properties = {}
                              tags = {}
                            }
                          ]
                          destinationPortRange = "string"
                          destinationPortRanges = [
                            "string"
                          ]
                          direction = "string"
                          priority = int
                          protocol = "string"
                          sourceAddressPrefix = "string"
                          sourceAddressPrefixes = [
                            "string"
                          ]
                          sourceApplicationSecurityGroups = [
                            {
                              id = "string"
                              location = "string"
                              properties = {}
                              tags = {}
                            }
                          ]
                          sourcePortRange = "string"
                          sourcePortRanges = [
                            "string"
                          ]
                        }
                        type = "string"
                      }
                    ]
                  }
                  tags = {}
                }
                privateEndpointNetworkPolicies = "string"
                privateLinkServiceNetworkPolicies = "string"
                routeTable = {
                  id = "string"
                  location = "string"
                  properties = {
                    disableBgpRoutePropagation = bool
                    routes = [
                      {
                        id = "string"
                        name = "string"
                        properties = {
                          addressPrefix = "string"
                          hasBgpOverride = bool
                          nextHopIpAddress = "string"
                          nextHopType = "string"
                        }
                        type = "string"
                      }
                    ]
                  }
                  tags = {}
                }
                serviceEndpointPolicies = [
                  {
                    id = "string"
                    location = "string"
                    properties = {
                      contextualServiceEndpointPolicies = [
                        "string"
                      ]
                      serviceAlias = "string"
                      serviceEndpointPolicyDefinitions = [
                        {
                          id = "string"
                          name = "string"
                          properties = {
                            description = "string"
                            service = "string"
                            serviceResources = [
                              "string"
                            ]
                          }
                          type = "string"
                        }
                      ]
                    }
                    tags = {}
                  }
                ]
                serviceEndpoints = [
                  {
                    locations = [
                      "string"
                    ]
                    service = "string"
                  }
                ]
              }
              type = "string"
            }
            virtualNetworkTaps = [
              {
                id = "string"
                location = "string"
                properties = {
                  destinationLoadBalancerFrontEndIPConfiguration = {
                    id = "string"
                    name = "string"
                    properties = {
                      gatewayLoadBalancer = {
                        id = "string"
                      }
                      privateIPAddress = "string"
                      privateIPAddressVersion = "string"
                      privateIPAllocationMethod = "string"
                      publicIPAddress = {
                        extendedLocation = {
                          name = "string"
                          type = "EdgeZone"
                        }
                        id = "string"
                        location = "string"
                        properties = {
                          ddosSettings = {
                            ddosProtectionPlan = {
                              id = "string"
                            }
                            protectionMode = "string"
                          }
                          deleteOption = "string"
                          dnsSettings = {
                            domainNameLabel = "string"
                            fqdn = "string"
                            reverseFqdn = "string"
                          }
                          idleTimeoutInMinutes = int
                          ipAddress = "string"
                          ipTags = [
                            {
                              ipTagType = "string"
                              tag = "string"
                            }
                          ]
                          linkedPublicIPAddress = {
                            public-ip-address-object
                          }
                          migrationPhase = "string"
                          natGateway = {
                            id = "string"
                            location = "string"
                            properties = {
                              idleTimeoutInMinutes = int
                              publicIpAddresses = [
                                {
                                  id = "string"
                                }
                              ]
                              publicIpPrefixes = [
                                {
                                  id = "string"
                                }
                              ]
                            }
                            sku = {
                              name = "Standard"
                            }
                            tags = {}
                            zones = [
                              "string"
                            ]
                          }
                          publicIPAddressVersion = "string"
                          publicIPAllocationMethod = "string"
                          publicIPPrefix = {
                            id = "string"
                          }
                          servicePublicIPAddress = {
                            public-ip-address-object
                          }
                        }
                        sku = {
                          name = "string"
                          tier = "string"
                        }
                        tags = {}
                        zones = [
                          "string"
                        ]
                      }
                      publicIPPrefix = {
                        id = "string"
                      }
                      subnet = {
                        id = "string"
                        name = "string"
                        properties = {
                          addressPrefix = "string"
                          addressPrefixes = [
                            "string"
                          ]
                          applicationGatewayIpConfigurations = [
                            {
                              id = "string"
                              name = "string"
                              properties = {
                                subnet = {
                                  id = "string"
                                }
                              }
                            }
                          ]
                          delegations = [
                            {
                              id = "string"
                              name = "string"
                              properties = {
                                serviceName = "string"
                              }
                              type = "string"
                            }
                          ]
                          ipAllocations = [
                            {
                              id = "string"
                            }
                          ]
                          natGateway = {
                            id = "string"
                          }
                          networkSecurityGroup = {
                            id = "string"
                            location = "string"
                            properties = {
                              flushConnection = bool
                              securityRules = [
                                {
                                  id = "string"
                                  name = "string"
                                  properties = {
                                    access = "string"
                                    description = "string"
                                    destinationAddressPrefix = "string"
                                    destinationAddressPrefixes = [
                                      "string"
                                    ]
                                    destinationApplicationSecurityGroups = [
                                      {
                                        id = "string"
                                        location = "string"
                                        properties = {}
                                        tags = {}
                                      }
                                    ]
                                    destinationPortRange = "string"
                                    destinationPortRanges = [
                                      "string"
                                    ]
                                    direction = "string"
                                    priority = int
                                    protocol = "string"
                                    sourceAddressPrefix = "string"
                                    sourceAddressPrefixes = [
                                      "string"
                                    ]
                                    sourceApplicationSecurityGroups = [
                                      {
                                        id = "string"
                                        location = "string"
                                        properties = {}
                                        tags = {}
                                      }
                                    ]
                                    sourcePortRange = "string"
                                    sourcePortRanges = [
                                      "string"
                                    ]
                                  }
                                  type = "string"
                                }
                              ]
                            }
                            tags = {}
                          }
                          privateEndpointNetworkPolicies = "string"
                          privateLinkServiceNetworkPolicies = "string"
                          routeTable = {
                            id = "string"
                            location = "string"
                            properties = {
                              disableBgpRoutePropagation = bool
                              routes = [
                                {
                                  id = "string"
                                  name = "string"
                                  properties = {
                                    addressPrefix = "string"
                                    hasBgpOverride = bool
                                    nextHopIpAddress = "string"
                                    nextHopType = "string"
                                  }
                                  type = "string"
                                }
                              ]
                            }
                            tags = {}
                          }
                          serviceEndpointPolicies = [
                            {
                              id = "string"
                              location = "string"
                              properties = {
                                contextualServiceEndpointPolicies = [
                                  "string"
                                ]
                                serviceAlias = "string"
                                serviceEndpointPolicyDefinitions = [
                                  {
                                    id = "string"
                                    name = "string"
                                    properties = {
                                      description = "string"
                                      service = "string"
                                      serviceResources = [
                                        "string"
                                      ]
                                    }
                                    type = "string"
                                  }
                                ]
                              }
                              tags = {}
                            }
                          ]
                          serviceEndpoints = [
                            {
                              locations = [
                                "string"
                              ]
                              service = "string"
                            }
                          ]
                        }
                        type = "string"
                      }
                    }
                    zones = [
                      "string"
                    ]
                  }
                  destinationNetworkInterfaceIPConfiguration = {
                  destinationPort = int
                }
                tags = {}
              }
            ]
          }
          type = "string"
        }
      ]
      migrationPhase = "string"
      networkSecurityGroup = {
        id = "string"
        location = "string"
        properties = {
          flushConnection = bool
          securityRules = [
            {
              id = "string"
              name = "string"
              properties = {
                access = "string"
                description = "string"
                destinationAddressPrefix = "string"
                destinationAddressPrefixes = [
                  "string"
                ]
                destinationApplicationSecurityGroups = [
                  {
                    id = "string"
                    location = "string"
                    properties = {}
                    tags = {}
                  }
                ]
                destinationPortRange = "string"
                destinationPortRanges = [
                  "string"
                ]
                direction = "string"
                priority = int
                protocol = "string"
                sourceAddressPrefix = "string"
                sourceAddressPrefixes = [
                  "string"
                ]
                sourceApplicationSecurityGroups = [
                  {
                    id = "string"
                    location = "string"
                    properties = {}
                    tags = {}
                  }
                ]
                sourcePortRange = "string"
                sourcePortRanges = [
                  "string"
                ]
              }
              type = "string"
            }
          ]
        }
        tags = {}
      }
      nicType = "string"
      privateLinkService = {
        extendedLocation = {
          name = "string"
          type = "EdgeZone"
        }
        id = "string"
        location = "string"
        properties = {
          autoApproval = {
            subscriptions = [
              "string"
            ]
          }
          enableProxyProtocol = bool
          fqdns = [
            "string"
          ]
          ipConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                primary = bool
                privateIPAddress = "string"
                privateIPAddressVersion = "string"
                privateIPAllocationMethod = "string"
                subnet = {
                  id = "string"
                  name = "string"
                  properties = {
                    addressPrefix = "string"
                    addressPrefixes = [
                      "string"
                    ]
                    applicationGatewayIpConfigurations = [
                      {
                        id = "string"
                        name = "string"
                        properties = {
                          subnet = {
                            id = "string"
                          }
                        }
                      }
                    ]
                    delegations = [
                      {
                        id = "string"
                        name = "string"
                        properties = {
                          serviceName = "string"
                        }
                        type = "string"
                      }
                    ]
                    ipAllocations = [
                      {
                        id = "string"
                      }
                    ]
                    natGateway = {
                      id = "string"
                    }
                    networkSecurityGroup = {
                      id = "string"
                      location = "string"
                      properties = {
                        flushConnection = bool
                        securityRules = [
                          {
                            id = "string"
                            name = "string"
                            properties = {
                              access = "string"
                              description = "string"
                              destinationAddressPrefix = "string"
                              destinationAddressPrefixes = [
                                "string"
                              ]
                              destinationApplicationSecurityGroups = [
                                {
                                  id = "string"
                                  location = "string"
                                  properties = {}
                                  tags = {}
                                }
                              ]
                              destinationPortRange = "string"
                              destinationPortRanges = [
                                "string"
                              ]
                              direction = "string"
                              priority = int
                              protocol = "string"
                              sourceAddressPrefix = "string"
                              sourceAddressPrefixes = [
                                "string"
                              ]
                              sourceApplicationSecurityGroups = [
                                {
                                  id = "string"
                                  location = "string"
                                  properties = {}
                                  tags = {}
                                }
                              ]
                              sourcePortRange = "string"
                              sourcePortRanges = [
                                "string"
                              ]
                            }
                            type = "string"
                          }
                        ]
                      }
                      tags = {}
                    }
                    privateEndpointNetworkPolicies = "string"
                    privateLinkServiceNetworkPolicies = "string"
                    routeTable = {
                      id = "string"
                      location = "string"
                      properties = {
                        disableBgpRoutePropagation = bool
                        routes = [
                          {
                            id = "string"
                            name = "string"
                            properties = {
                              addressPrefix = "string"
                              hasBgpOverride = bool
                              nextHopIpAddress = "string"
                              nextHopType = "string"
                            }
                            type = "string"
                          }
                        ]
                      }
                      tags = {}
                    }
                    serviceEndpointPolicies = [
                      {
                        id = "string"
                        location = "string"
                        properties = {
                          contextualServiceEndpointPolicies = [
                            "string"
                          ]
                          serviceAlias = "string"
                          serviceEndpointPolicyDefinitions = [
                            {
                              id = "string"
                              name = "string"
                              properties = {
                                description = "string"
                                service = "string"
                                serviceResources = [
                                  "string"
                                ]
                              }
                              type = "string"
                            }
                          ]
                        }
                        tags = {}
                      }
                    ]
                    serviceEndpoints = [
                      {
                        locations = [
                          "string"
                        ]
                        service = "string"
                      }
                    ]
                  }
                  type = "string"
                }
              }
            }
          ]
          loadBalancerFrontendIpConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                gatewayLoadBalancer = {
                  id = "string"
                }
                privateIPAddress = "string"
                privateIPAddressVersion = "string"
                privateIPAllocationMethod = "string"
                publicIPAddress = {
                  extendedLocation = {
                    name = "string"
                    type = "EdgeZone"
                  }
                  id = "string"
                  location = "string"
                  properties = {
                    ddosSettings = {
                      ddosProtectionPlan = {
                        id = "string"
                      }
                      protectionMode = "string"
                    }
                    deleteOption = "string"
                    dnsSettings = {
                      domainNameLabel = "string"
                      fqdn = "string"
                      reverseFqdn = "string"
                    }
                    idleTimeoutInMinutes = int
                    ipAddress = "string"
                    ipTags = [
                      {
                        ipTagType = "string"
                        tag = "string"
                      }
                    ]
                    linkedPublicIPAddress = {
                      public-ip-address-object
                    }
                    migrationPhase = "string"
                    natGateway = {
                      id = "string"
                      location = "string"
                      properties = {
                        idleTimeoutInMinutes = int
                        publicIpAddresses = [
                          {
                            id = "string"
                          }
                        ]
                        publicIpPrefixes = [
                          {
                            id = "string"
                          }
                        ]
                      }
                      sku = {
                        name = "Standard"
                      }
                      tags = {}
                      zones = [
                        "string"
                      ]
                    }
                    publicIPAddressVersion = "string"
                    publicIPAllocationMethod = "string"
                    publicIPPrefix = {
                      id = "string"
                    }
                    servicePublicIPAddress = {
                      public-ip-address-object
                    }
                  }
                  sku = {
                    name = "string"
                    tier = "string"
                  }
                  tags = {}
                  zones = [
                    "string"
                  ]
                }
                publicIPPrefix = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                  name = "string"
                  properties = {
                    addressPrefix = "string"
                    addressPrefixes = [
                      "string"
                    ]
                    applicationGatewayIpConfigurations = [
                      {
                        id = "string"
                        name = "string"
                        properties = {
                          subnet = {
                            id = "string"
                          }
                        }
                      }
                    ]
                    delegations = [
                      {
                        id = "string"
                        name = "string"
                        properties = {
                          serviceName = "string"
                        }
                        type = "string"
                      }
                    ]
                    ipAllocations = [
                      {
                        id = "string"
                      }
                    ]
                    natGateway = {
                      id = "string"
                    }
                    networkSecurityGroup = {
                      id = "string"
                      location = "string"
                      properties = {
                        flushConnection = bool
                        securityRules = [
                          {
                            id = "string"
                            name = "string"
                            properties = {
                              access = "string"
                              description = "string"
                              destinationAddressPrefix = "string"
                              destinationAddressPrefixes = [
                                "string"
                              ]
                              destinationApplicationSecurityGroups = [
                                {
                                  id = "string"
                                  location = "string"
                                  properties = {}
                                  tags = {}
                                }
                              ]
                              destinationPortRange = "string"
                              destinationPortRanges = [
                                "string"
                              ]
                              direction = "string"
                              priority = int
                              protocol = "string"
                              sourceAddressPrefix = "string"
                              sourceAddressPrefixes = [
                                "string"
                              ]
                              sourceApplicationSecurityGroups = [
                                {
                                  id = "string"
                                  location = "string"
                                  properties = {}
                                  tags = {}
                                }
                              ]
                              sourcePortRange = "string"
                              sourcePortRanges = [
                                "string"
                              ]
                            }
                            type = "string"
                          }
                        ]
                      }
                      tags = {}
                    }
                    privateEndpointNetworkPolicies = "string"
                    privateLinkServiceNetworkPolicies = "string"
                    routeTable = {
                      id = "string"
                      location = "string"
                      properties = {
                        disableBgpRoutePropagation = bool
                        routes = [
                          {
                            id = "string"
                            name = "string"
                            properties = {
                              addressPrefix = "string"
                              hasBgpOverride = bool
                              nextHopIpAddress = "string"
                              nextHopType = "string"
                            }
                            type = "string"
                          }
                        ]
                      }
                      tags = {}
                    }
                    serviceEndpointPolicies = [
                      {
                        id = "string"
                        location = "string"
                        properties = {
                          contextualServiceEndpointPolicies = [
                            "string"
                          ]
                          serviceAlias = "string"
                          serviceEndpointPolicyDefinitions = [
                            {
                              id = "string"
                              name = "string"
                              properties = {
                                description = "string"
                                service = "string"
                                serviceResources = [
                                  "string"
                                ]
                              }
                              type = "string"
                            }
                          ]
                        }
                        tags = {}
                      }
                    ]
                    serviceEndpoints = [
                      {
                        locations = [
                          "string"
                        ]
                        service = "string"
                      }
                    ]
                  }
                  type = "string"
                }
              }
              zones = [
                "string"
              ]
            }
          ]
          visibility = {
            subscriptions = [
              "string"
            ]
          }
        }
        tags = {}
      }
      workloadType = "string"
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

Property values

networkInterfaces

Name	Description	Value
type	The resource type	"Microsoft.Network/networkInterfaces@2022-07-01"
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
extendedLocation	The extended location of the network interface.	ExtendedLocation
properties	Properties of the network interface.	NetworkInterfacePropertiesFormat

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	"EdgeZone"

NetworkInterfacePropertiesFormat

Name	Description	Value
auxiliaryMode	Auxiliary mode of Network Interface resource.	"Floating" "MaxConnections" "None"
disableTcpStateTracking	Indicates whether to disable tcp state tracking.	bool
dnsSettings	The DNS settings in network interface.	NetworkInterfaceDnsSettings
enableAcceleratedNetworking	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.	bool
enableIPForwarding	Indicates whether IP forwarding is enabled on this network interface.	bool
ipConfigurations	A list of IPConfigurations of the network interface.	NetworkInterfaceIPConfiguration[]
migrationPhase	Migration phase of Network Interface resource.	"Abort" "Commit" "Committed" "None" "Prepare"
networkSecurityGroup	The reference to the NetworkSecurityGroup resource.	NetworkSecurityGroup
nicType	Type of Network Interface resource.	"Elastic" "Standard"
privateLinkService	Privatelinkservice of the network interface resource.	PrivateLinkService
workloadType	WorkloadType of the NetworkInterface for BareMetal resources	string

NetworkInterfaceDnsSettings

Name	Description	Value
dnsServers	List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.	string[]
internalDnsNameLabel	Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.	string

NetworkInterfaceIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Network interface IP configuration properties.	NetworkInterfaceIPConfigurationPropertiesFormat
type	Resource type.	string

NetworkInterfaceIPConfigurationPropertiesFormat

Name	Description	Value
applicationGatewayBackendAddressPools	The reference to ApplicationGatewayBackendAddressPool resource.	ApplicationGatewayBackendAddressPool[]
applicationSecurityGroups	Application security groups in which the IP configuration is included.	ApplicationSecurityGroup[]
gatewayLoadBalancer	The reference to gateway load balancer frontend IP.	SubResource
loadBalancerBackendAddressPools	The reference to LoadBalancerBackendAddressPool resource.	BackendAddressPool[]
loadBalancerInboundNatRules	A list of references of LoadBalancerInboundNatRules.	InboundNatRule[]
primary	Whether this is a primary customer address on the network interface.	bool
privateIPAddress	Private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.	"IPv4" "IPv6"
privateIPAllocationMethod	The private IP address allocation method.	"Dynamic" "Static"
publicIPAddress	Public IP address bound to the IP configuration.	PublicIPAddress
subnet	Subnet bound to the IP configuration.	Subnet
virtualNetworkTaps	The reference to Virtual Network Taps.	VirtualNetworkTap[]

ApplicationGatewayBackendAddressPool

Name	Description	Value
id	Resource ID.	string
name	Name of the backend address pool that is unique within an Application Gateway.	string
properties	Properties of the application gateway backend address pool.	ApplicationGatewayBackendAddressPoolPropertiesFormat

ApplicationGatewayBackendAddressPoolPropertiesFormat

Name	Description	Value
backendAddresses	Backend addresses.	ApplicationGatewayBackendAddress[]

ApplicationGatewayBackendAddress

Name	Description	Value
fqdn	Fully qualified domain name (FQDN).	string
ipAddress	IP address.	string

ApplicationSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the application security group.	ApplicationSecurityGroupPropertiesFormat
tags	Resource tags.	object

ApplicationSecurityGroupPropertiesFormat

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

SubResource

Name	Description	Value
id	Resource ID.	string

BackendAddressPool

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.	string
properties	Properties of load balancer backend address pool.	BackendAddressPoolPropertiesFormat

BackendAddressPoolPropertiesFormat

Name	Description	Value
drainPeriodInSeconds	Amount of seconds Load Balancer waits for before sending RESET to client and backend address.	int
loadBalancerBackendAddresses	An array of backend addresses.	LoadBalancerBackendAddress[]
location	The location of the backend address pool.	string
tunnelInterfaces	An array of gateway load balancer tunnel interfaces.	GatewayLoadBalancerTunnelInterface[]
virtualNetwork	A reference to a virtual network.	SubResource

LoadBalancerBackendAddress

Name	Description	Value
name	Name of the backend address.	string
properties	Properties of load balancer backend address pool.	LoadBalancerBackendAddressPropertiesFormat

LoadBalancerBackendAddressPropertiesFormat

Name	Description	Value
adminState	A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.	"Down" "Drain" "None" "Up"
ipAddress	IP Address belonging to the referenced virtual network.	string
loadBalancerFrontendIPConfiguration	Reference to the frontend ip address configuration defined in regional loadbalancer.	SubResource
subnet	Reference to an existing subnet.	SubResource
virtualNetwork	Reference to an existing virtual network.	SubResource

GatewayLoadBalancerTunnelInterface

Name	Description	Value
identifier	Identifier of gateway load balancer tunnel interface.	int
port	Port of gateway load balancer tunnel interface.	int
protocol	Protocol of gateway load balancer tunnel interface.	"Native" "None" "VXLAN"
type	Traffic type of gateway load balancer tunnel interface.	"External" "Internal" "None"

InboundNatRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.	string
properties	Properties of load balancer inbound NAT rule.	InboundNatRulePropertiesFormat

InboundNatRulePropertiesFormat

Name	Description	Value
backendAddressPool	A reference to backendAddressPool resource.	SubResource
backendPort	The port used for the internal endpoint. Acceptable values range from 1 to 65535.	int
enableFloatingIP	Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.	bool
enableTcpReset	Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.	bool
frontendIPConfiguration	A reference to frontend IP addresses.	SubResource
frontendPort	The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.	int
frontendPortRangeEnd	The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.	int
frontendPortRangeStart	The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.	int
idleTimeoutInMinutes	The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.	int
protocol	The reference to the transport protocol used by the load balancing rule.	"All" "Tcp" "Udp"

PublicIPAddress

Name	Description	Value
extendedLocation	The extended location of the public ip address.	ExtendedLocation
id	Resource ID.	string
location	Resource location.	string
properties	Public IP address properties.	PublicIPAddressPropertiesFormat
sku	The public IP address SKU.	PublicIPAddressSku
tags	Resource tags.	object
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.	string[]

PublicIPAddressPropertiesFormat

Name	Description	Value
ddosSettings	The DDoS protection custom policy associated with the public IP address.	DdosSettings
deleteOption	Specify what happens to the public IP address when the VM using it is deleted	"Delete" "Detach"
dnsSettings	The FQDN of the DNS record associated with the public IP address.	PublicIPAddressDnsSettings
idleTimeoutInMinutes	The idle timeout of the public IP address.	int
ipAddress	The IP address associated with the public IP address resource.	string
ipTags	The list of tags associated with the public IP address.	IpTag[]
linkedPublicIPAddress	The linked public IP address of the public IP address resource.	PublicIPAddress
migrationPhase	Migration phase of Public IP Address.	"Abort" "Commit" "Committed" "None" "Prepare"
natGateway	The NatGateway for the Public IP address.	NatGateway
publicIPAddressVersion	The public IP address version.	"IPv4" "IPv6"
publicIPAllocationMethod	The public IP address allocation method.	"Dynamic" "Static"
publicIPPrefix	The Public IP Prefix this Public IP Address should be allocated from.	SubResource
servicePublicIPAddress	The service public IP address of the public IP address resource.	PublicIPAddress

DdosSettings

Name	Description	Value
ddosProtectionPlan	The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled	SubResource
protectionMode	The DDoS protection mode of the public IP	"Disabled" "Enabled" "VirtualNetworkInherited"

PublicIPAddressDnsSettings

Name	Description	Value
domainNameLabel	The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.	string
fqdn	The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.	string
reverseFqdn	The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.	string

IpTag

Name	Description	Value
ipTagType	The IP tag type. Example: FirstPartyUsage.	string
tag	The value of the IP tag associated with the public IP. Example: SQL.	string

NatGateway

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Nat Gateway properties.	NatGatewayPropertiesFormat
sku	The nat gateway SKU.	NatGatewaySku
tags	Resource tags.	object
zones	A list of availability zones denoting the zone in which Nat Gateway should be deployed.	string[]

NatGatewayPropertiesFormat

Name	Description	Value
idleTimeoutInMinutes	The idle timeout of the nat gateway.	int
publicIpAddresses	An array of public ip addresses associated with the nat gateway resource.	SubResource[]
publicIpPrefixes	An array of public ip prefixes associated with the nat gateway resource.	SubResource[]

NatGatewaySku

Name	Description	Value
name	Name of Nat Gateway SKU.	"Standard"

PublicIPAddressSku

Name	Description	Value
name	Name of a public IP address SKU.	"Basic" "Standard"
tier	Tier of a public IP address SKU.	"Global" "Regional"

Subnet

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the subnet.	SubnetPropertiesFormat
type	Resource type.	string

SubnetPropertiesFormat

Name	Description	Value
addressPrefix	The address prefix for the subnet.	string
addressPrefixes	List of address prefixes for the subnet.	string[]
applicationGatewayIpConfigurations	Application gateway IP configurations of virtual network resource.	ApplicationGatewayIPConfiguration[]
delegations	An array of references to the delegations on the subnet.	Delegation[]
ipAllocations	Array of IpAllocation which reference this subnet.	SubResource[]
natGateway	Nat gateway associated with this subnet.	SubResource
networkSecurityGroup	The reference to the NetworkSecurityGroup resource.	NetworkSecurityGroup
privateEndpointNetworkPolicies	Enable or Disable apply network policies on private end point in the subnet.	"Disabled" "Enabled"
privateLinkServiceNetworkPolicies	Enable or Disable apply network policies on private link service in the subnet.	"Disabled" "Enabled"
routeTable	The reference to the RouteTable resource.	RouteTable
serviceEndpointPolicies	An array of service endpoint policies.	ServiceEndpointPolicy[]
serviceEndpoints	An array of service endpoints.	ServiceEndpointPropertiesFormat[]

ApplicationGatewayIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	Name of the IP configuration that is unique within an Application Gateway.	string
properties	Properties of the application gateway IP configuration.	ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

Name	Description	Value
subnet	Reference to the subnet resource. A subnet from where application gateway gets its private address.	SubResource

Delegation

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a subnet. This name can be used to access the resource.	string
properties	Properties of the subnet.	ServiceDelegationPropertiesFormat
type	Resource type.	string

ServiceDelegationPropertiesFormat

Name	Description	Value
serviceName	The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).	string

NetworkSecurityGroup

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the network security group.	NetworkSecurityGroupPropertiesFormat
tags	Resource tags.	object

NetworkSecurityGroupPropertiesFormat

Name	Description	Value
flushConnection	When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation.	bool
securityRules	A collection of security rules of the network security group.	SecurityRule[]

SecurityRule

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the security rule.	SecurityRulePropertiesFormat
type	The type of the resource.	string

SecurityRulePropertiesFormat

Name	Description	Value
access	The network traffic is allowed or denied.	"Allow" "Deny" (required)
description	A description for this rule. Restricted to 140 chars.	string
destinationAddressPrefix	The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.	string
destinationAddressPrefixes	The destination address prefixes. CIDR or destination IP ranges.	string[]
destinationApplicationSecurityGroups	The application security group specified as destination.	ApplicationSecurityGroup[]
destinationPortRange	The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
destinationPortRanges	The destination port ranges.	string[]
direction	The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.	"Inbound" "Outbound" (required)
priority	The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.	int
protocol	Network protocol this rule applies to.	"*" "Ah" "Esp" "Icmp" "Tcp" "Udp" (required)
sourceAddressPrefix	The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.	string
sourceAddressPrefixes	The CIDR or source IP ranges.	string[]
sourceApplicationSecurityGroups	The application security group specified as source.	ApplicationSecurityGroup[]
sourcePortRange	The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.	string
sourcePortRanges	The source port ranges.	string[]

RouteTable

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the route table.	RouteTablePropertiesFormat
tags	Resource tags.	object

RouteTablePropertiesFormat

Name	Description	Value
disableBgpRoutePropagation	Whether to disable the routes learned by BGP on that route table. True means disable.	bool
routes	Collection of routes contained within a route table.	Route[]

Route

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the route.	RoutePropertiesFormat
type	The type of the resource.	string

RoutePropertiesFormat

Name	Description	Value
addressPrefix	The destination CIDR to which the route applies.	string
hasBgpOverride	A value indicating whether this route overrides overlapping BGP routes regardless of LPM.	bool
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
nextHopType	The type of Azure hop the packet should be sent to.	"Internet" "None" "VirtualAppliance" "VirtualNetworkGateway" "VnetLocal" (required)

ServiceEndpointPolicy

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the service end point policy.	ServiceEndpointPolicyPropertiesFormat
tags	Resource tags.	object

ServiceEndpointPolicyPropertiesFormat

Name	Description	Value
contextualServiceEndpointPolicies	A collection of contextual service endpoint policy.	string[]
serviceAlias	The alias indicating if the policy belongs to a service	string
serviceEndpointPolicyDefinitions	A collection of service endpoint policy definitions of the service endpoint policy.	ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.	string
properties	Properties of the service endpoint policy definition.	ServiceEndpointPolicyDefinitionPropertiesFormat
type	The type of the resource.	string

ServiceEndpointPolicyDefinitionPropertiesFormat

Name	Description	Value
description	A description for this rule. Restricted to 140 chars.	string
service	Service endpoint name.	string
serviceResources	A list of service resources.	string[]

ServiceEndpointPropertiesFormat

Name	Description	Value
locations	A list of locations.	string[]
service	The type of the endpoint service.	string

VirtualNetworkTap

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Virtual Network Tap Properties.	VirtualNetworkTapPropertiesFormat
tags	Resource tags.	object

VirtualNetworkTapPropertiesFormat

Name	Description	Value
destinationLoadBalancerFrontEndIPConfiguration	The reference to the private IP address on the internal Load Balancer that will receive the tap.	FrontendIPConfiguration
destinationNetworkInterfaceIPConfiguration	The reference to the private IP Address of the collector nic that will receive the tap.	NetworkInterfaceIPConfiguration
destinationPort	The VXLAN destination port that will receive the tapped traffic.	int

FrontendIPConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.	string
properties	Properties of the load balancer probe.	FrontendIPConfigurationPropertiesFormat
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.	string[]

FrontendIPConfigurationPropertiesFormat

Name	Description	Value
gatewayLoadBalancer	The reference to gateway load balancer frontend IP.	SubResource
privateIPAddress	The private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.	"IPv4" "IPv6"
privateIPAllocationMethod	The Private IP allocation method.	"Dynamic" "Static"
publicIPAddress	The reference to the Public IP resource.	PublicIPAddress
publicIPPrefix	The reference to the Public IP Prefix resource.	SubResource
subnet	The reference to the subnet resource.	Subnet

PrivateLinkService

Name	Description	Value
extendedLocation	The extended location of the load balancer.	ExtendedLocation
id	Resource ID.	string
location	Resource location.	string
properties	Properties of the private link service.	PrivateLinkServiceProperties
tags	Resource tags.	object

PrivateLinkServiceProperties

Name	Description	Value
autoApproval	The auto-approval list of the private link service.	PrivateLinkServicePropertiesAutoApproval
enableProxyProtocol	Whether the private link service is enabled for proxy protocol or not.	bool
fqdns	The list of Fqdn.	string[]
ipConfigurations	An array of private link service IP configurations.	PrivateLinkServiceIpConfiguration[]
loadBalancerFrontendIpConfigurations	An array of references to the load balancer IP configurations.	FrontendIPConfiguration[]
visibility	The visibility list of the private link service.	PrivateLinkServicePropertiesVisibility

PrivateLinkServicePropertiesAutoApproval

Name	Description	Value
subscriptions	The list of subscriptions.	string[]

PrivateLinkServiceIpConfiguration

Name	Description	Value
id	Resource ID.	string
name	The name of private link service ip configuration.	string
properties	Properties of the private link service ip configuration.	PrivateLinkServiceIpConfigurationProperties

PrivateLinkServiceIpConfigurationProperties

Name	Description	Value
primary	Whether the ip configuration is primary or not.	bool
privateIPAddress	The private IP address of the IP configuration.	string
privateIPAddressVersion	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.	"IPv4" "IPv6"
privateIPAllocationMethod	The private IP address allocation method.	"Dynamic" "Static"
subnet	The reference to the subnet resource.	Subnet

PrivateLinkServicePropertiesVisibility

Name	Description	Value
subscriptions	The list of subscriptions.	string[]