Home

NetBox Bicep Extension - Resource Reference

This wiki documents all resource types available in the NetBox Bicep extension. Each resource type maps to a NetBox REST API endpoint and can be declared in Bicep using infrastructure-as-code patterns.

Configuration

All resources require the NetBox extension to be configured with a URL and API token:

extension netbox with {
  url: 'https://netbox.example.com'
  token: 'your-api-token'
}

Resource Types

DCIM (Data Center Infrastructure Management)

Resource Type	Description	API Endpoint
Site	A physical location (datacenter, office, etc.)	/api/dcim/sites/
Region	A geographic region (e.g. continent, country, state)	/api/dcim/regions/
SiteGroup	A logical group of sites (e.g. corporate, branch, edge)	/api/dcim/site-groups/
Manufacturer	A hardware manufacturer (e.g. Cisco, Juniper, Dell)	/api/dcim/manufacturers/
Platform	A device platform (OS/firmware, e.g. Cisco IOS, Junos)	/api/dcim/platforms/
DeviceRole	A functional role for devices (e.g. router, switch, firewall)	/api/dcim/device-roles/
DeviceType	A device hardware model (e.g. Cisco Catalyst 9300)	/api/dcim/device-types/
Device	A physical device (server, switch, router, etc.)	/api/dcim/devices/
Interface	A physical network interface on a device	/api/dcim/interfaces/
Location	A location within a site (e.g. building, floor, room)	/api/dcim/locations/
Rack	A physical equipment rack	/api/dcim/racks/
RackRole	A functional role for racks (e.g. Compute, Storage)	/api/dcim/rack-roles/
RackType	A rack hardware model (template for racks)	/api/dcim/rack-types/

IPAM (IP Address Management)

Resource Type	Description	API Endpoint
Prefix	An IP prefix (subnet)	/api/ipam/prefixes/
IPAddress	An individual IP address	/api/ipam/ip-addresses/
IPRange	An arbitrary IP address range	/api/ipam/ip-ranges/
VLAN	A VLAN	/api/ipam/vlans/
VLANGroup	A VLAN group for organizing VLANs	/api/ipam/vlan-groups/
VLANTranslationPolicy	A VLAN translation policy	/api/ipam/vlan-translation-policies/
VRF	A VRF (Virtual Routing and Forwarding) instance	/api/ipam/vrfs/
RouteTarget	A BGP route target	/api/ipam/route-targets/
RIR	A Regional Internet Registry (e.g. ARIN, RIPE, APNIC)	/api/ipam/rirs/
Aggregate	A top-level IP aggregate (allocated by a RIR)	/api/ipam/aggregates/
IPAMRole	An IPAM role for prefixes and VLANs	/api/ipam/roles/
ASN	An Autonomous System Number	/api/ipam/asns/
ASNRange	A range of Autonomous System Numbers	/api/ipam/asn-ranges/

Tenancy

Resource Type	Description	API Endpoint
Tenant	A tenant (customer, department, or business unit)	/api/tenancy/tenants/
TenantGroup	A group of tenants (e.g. by department)	/api/tenancy/tenant-groups/
Contact	A contact person	/api/tenancy/contacts/
ContactGroup	A group of contacts	/api/tenancy/contact-groups/
ContactRole	A functional role for contacts (e.g. NOC, billing)	/api/tenancy/contact-roles/

Virtualization

Resource Type	Description	API Endpoint
ClusterType	A cluster technology type (e.g. VMware, Hyper-V)	/api/virtualization/cluster-types/
ClusterGroup	A logical group of clusters	/api/virtualization/cluster-groups/
Cluster	A virtualization cluster (e.g. vCenter, AKS)	/api/virtualization/clusters/
VirtualMachine	A virtual machine	/api/virtualization/virtual-machines/
VMInterface	A network interface on a virtual machine	/api/virtualization/interfaces/
VirtualDisk	A virtual disk attached to a virtual machine	/api/virtualization/virtual-disks/

Circuits

Resource Type	Description	API Endpoint
CircuitType	A type of circuit (e.g. Internet, MPLS, Dark Fiber)	/api/circuits/circuit-types/
Provider	A circuit provider (e.g. AT&T, Zayo, Lumen)	/api/circuits/providers/
Circuit	A communications circuit (e.g. Internet, MPLS)	/api/circuits/circuits/

VPN

Resource Type	Description	API Endpoint
TunnelGroup	A logical group of VPN tunnels	/api/vpn/tunnel-groups/
Tunnel	A VPN tunnel	/api/vpn/tunnels/
IKEProposal	An IKE (Internet Key Exchange) proposal	/api/vpn/ike-proposals/
IKEPolicy	An IKE (Internet Key Exchange) policy	/api/vpn/ike-policies/
IPSecProposal	An IPSec proposal (transform set)	/api/vpn/ipsec-proposals/
IPSecPolicy	An IPSec policy (grouping of IPSec proposals)	/api/vpn/ipsec-policies/
IPSecProfile	An IPSec profile (links IKE policy and IPSec policy)	/api/vpn/ipsec-profiles/
L2VPN	A Layer 2 VPN (e.g. VPLS, VXLAN, EVPN)	/api/vpn/l2vpns/

Wireless

Resource Type	Description	API Endpoint
WirelessLANGroup	A logical group of wireless LANs	/api/wireless/wireless-lan-groups/
WirelessLAN	A wireless LAN (Wi-Fi network)	/api/wireless/wireless-lans/
WirelessLink	A point-to-point wireless link between two interfaces	/api/wireless/wireless-links/

Extras

Resource Type	Description	API Endpoint
Tag	A tag for labeling and filtering objects	/api/extras/tags/

Users

Resource Type	Description	API Endpoint
User	A NetBox user account	/api/users/users/
UserGroup	A user group for permissions	/api/users/groups/

Output Properties

All resources return the following read-only output properties after creation:

Property	Type	Description
id	string	NetBox internal ID
url	string	API URL for this resource
display	string	Display name

These can be referenced in other resource declarations (e.g. site.id, manufacturer.id).