Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. CircuitProviderNetwork
Viewing docs for netbox 5.8.0
published on Friday, Sep 4, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

netbox.CircuitProviderNetwork

Viewing docs for netbox 5.8.0
published on Friday, Sep 4, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

    From the offical documentation:

    This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it might represent a provider’s regional MPLS network to which multiple circuits provide connectivity.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";

const providera = new netbox.CircuitProvider("providera", {
    name: "ProviderA",
    slug: "providera",
});
const networka = new netbox.CircuitProviderNetwork("networka", {
    name: "NetworkA",
    providerId: providera.circuitProviderId,
});

    import pulumi
import pulumi_netbox as netbox

providera = netbox.CircuitProvider("providera",
    name="ProviderA",
    slug="providera")
networka = netbox.CircuitProviderNetwork("networka",
    name="NetworkA",
    provider_id=providera.circuit_provider_id)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v5/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		providera, err := netbox.NewCircuitProvider(ctx, "providera", &netbox.CircuitProviderArgs{
			Name: pulumi.String("ProviderA"),
			Slug: pulumi.String("providera"),
		})
		if err != nil {
			return err
		}
		_, err = netbox.NewCircuitProviderNetwork(ctx, "networka", &netbox.CircuitProviderNetworkArgs{
			Name:       pulumi.String("NetworkA"),
			ProviderId: providera.CircuitProviderId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var providera = new Netbox.CircuitProvider("providera", new()
    {
        Name = "ProviderA",
        Slug = "providera",
    });

    var networka = new Netbox.CircuitProviderNetwork("networka", new()
    {
        Name = "NetworkA",
        ProviderId = providera.CircuitProviderId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.CircuitProvider;
import com.pulumi.netbox.CircuitProviderArgs;
import com.pulumi.netbox.CircuitProviderNetwork;
import com.pulumi.netbox.CircuitProviderNetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var providera = new CircuitProvider("providera", CircuitProviderArgs.builder()
            .name("ProviderA")
            .slug("providera")
            .build());

        var networka = new CircuitProviderNetwork("networka", CircuitProviderNetworkArgs.builder()
            .name("NetworkA")
            .providerId(providera.circuitProviderId())
            .build());

    }
}

    resources:
  providera:
    type: netbox:CircuitProvider
    properties:
      name: ProviderA
      slug: providera
  networka:
    type: netbox:CircuitProviderNetwork
    properties:
      name: NetworkA
      providerId: ${providera.circuitProviderId}

    Example coming soon!

    Create CircuitProviderNetwork Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CircuitProviderNetwork(name: string, args: CircuitProviderNetworkArgs, opts?: CustomResourceOptions);
    @overload
def CircuitProviderNetwork(resource_name: str,
                           args: CircuitProviderNetworkArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def CircuitProviderNetwork(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           provider_id: Optional[float] = None,
                           circuit_provider_network_id: Optional[str] = None,
                           comments: Optional[str] = None,
                           custom_fields: Optional[Mapping[str, str]] = None,
                           description: Optional[str] = None,
                           name: Optional[str] = None,
                           service_id: Optional[str] = None,
                           tags: Optional[Sequence[str]] = None)
    func NewCircuitProviderNetwork(ctx *Context, name string, args CircuitProviderNetworkArgs, opts ...ResourceOption) (*CircuitProviderNetwork, error)
    public CircuitProviderNetwork(string name, CircuitProviderNetworkArgs args, CustomResourceOptions? opts = null)
    public CircuitProviderNetwork(String name, CircuitProviderNetworkArgs args)
public CircuitProviderNetwork(String name, CircuitProviderNetworkArgs args, CustomResourceOptions options)

    type: netbox:CircuitProviderNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "netbox_circuit_provider_network" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CircuitProviderNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CircuitProviderNetworkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CircuitProviderNetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CircuitProviderNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CircuitProviderNetworkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var circuitProviderNetworkResource = new Netbox.CircuitProviderNetwork("circuitProviderNetworkResource", new()
{
    ProviderId = 0.0,
    CircuitProviderNetworkId = "string",
    Comments = "string",
    CustomFields = 
    {
        { "string", "string" },
    },
    Description = "string",
    Name = "string",
    ServiceId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := netbox.NewCircuitProviderNetwork(ctx, "circuitProviderNetworkResource", &netbox.CircuitProviderNetworkArgs{
	ProviderId:               pulumi.Float64(0),
	CircuitProviderNetworkId: pulumi.String("string"),
	Comments:                 pulumi.String("string"),
	CustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	ServiceId:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "netbox_circuit_provider_network" "circuitProviderNetworkResource" {
  lifecycle {
    create_before_destroy = true
  }
  provider_id                 = 0
  circuit_provider_network_id = "string"
  comments                    = "string"
  custom_fields = {
    "string" = "string"
  }
  description = "string"
  name        = "string"
  service_id  = "string"
  tags        = ["string"]
}

    var circuitProviderNetworkResource = new CircuitProviderNetwork("circuitProviderNetworkResource", CircuitProviderNetworkArgs.builder()
    .providerId(0.0)
    .circuitProviderNetworkId("string")
    .comments("string")
    .customFields(Map.of("string", "string"))
    .description("string")
    .name("string")
    .serviceId("string")
    .tags("string")
    .build());

    circuit_provider_network_resource = netbox.CircuitProviderNetwork("circuitProviderNetworkResource",
    provider_id=float(0),
    circuit_provider_network_id="string",
    comments="string",
    custom_fields={
        "string": "string",
    },
    description="string",
    name="string",
    service_id="string",
    tags=["string"])

    const circuitProviderNetworkResource = new netbox.CircuitProviderNetwork("circuitProviderNetworkResource", {
    providerId: 0,
    circuitProviderNetworkId: "string",
    comments: "string",
    customFields: {
        string: "string",
    },
    description: "string",
    name: "string",
    serviceId: "string",
    tags: ["string"],
});

    type: netbox:CircuitProviderNetwork
properties:
    circuitProviderNetworkId: string
    comments: string
    customFields:
        string: string
    description: string
    name: string
    providerId: 0
    serviceId: string
    tags:
        - string

    CircuitProviderNetwork Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CircuitProviderNetwork resource accepts the following input properties:

    ProviderId double
    CircuitProviderNetworkId string
    The ID of this resource.
    Comments string
    CustomFields Dictionary<string, string>
    Description string
    Name string
    ServiceId string
    Tags List<string>
    ProviderId float64
    CircuitProviderNetworkId string
    The ID of this resource.
    Comments string
    CustomFields map[string]string
    Description string
    Name string
    ServiceId string
    Tags []string
    provider_id number
    circuit_provider_network_id string
    The ID of this resource.
    comments string
    custom_fields map(string)
    description string
    name string
    service_id string
    tags list(string)
    providerId Double
    circuitProviderNetworkId String
    The ID of this resource.
    comments String
    customFields Map<String,String>
    description String
    name String
    serviceId String
    tags List<String>
    providerId number
    circuitProviderNetworkId string
    The ID of this resource.
    comments string
    customFields {[key: string]: string}
    description string
    name string
    serviceId string
    tags string[]
    provider_id float
    circuit_provider_network_id str
    The ID of this resource.
    comments str
    custom_fields Mapping[str, str]
    description str
    name str
    service_id str
    tags Sequence[str]
    providerId Number
    circuitProviderNetworkId String
    The ID of this resource.
    comments String
    customFields Map<String>
    description String
    name String
    serviceId String
    tags List<String>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CircuitProviderNetwork resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAlls List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAlls []string
    id string
    The provider-assigned unique ID for this managed resource.
    tags_alls list(string)
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAlls List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAlls string[]
    id str
    The provider-assigned unique ID for this managed resource.
    tags_alls Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAlls List<String>

    Look up Existing CircuitProviderNetwork Resource

    Get an existing CircuitProviderNetwork resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CircuitProviderNetworkState, opts?: CustomResourceOptions): CircuitProviderNetwork
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        circuit_provider_network_id: Optional[str] = None,
        comments: Optional[str] = None,
        custom_fields: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        provider_id: Optional[float] = None,
        service_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tags_alls: Optional[Sequence[str]] = None) -> CircuitProviderNetwork
    func GetCircuitProviderNetwork(ctx *Context, name string, id IDInput, state *CircuitProviderNetworkState, opts ...ResourceOption) (*CircuitProviderNetwork, error)
    public static CircuitProviderNetwork Get(string name, Input<string> id, CircuitProviderNetworkState? state, CustomResourceOptions? opts = null)
    public static CircuitProviderNetwork get(String name, Output<String> id, CircuitProviderNetworkState state, CustomResourceOptions options)
    resources:  _:    type: netbox:CircuitProviderNetwork    get:      id: ${id}
    import {
  to = netbox_circuit_provider_network.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CircuitProviderNetworkId string
    The ID of this resource.
    Comments string
    CustomFields Dictionary<string, string>
    Description string
    Name string
    ProviderId double
    ServiceId string
    Tags List<string>
    TagsAlls List<string>
    CircuitProviderNetworkId string
    The ID of this resource.
    Comments string
    CustomFields map[string]string
    Description string
    Name string
    ProviderId float64
    ServiceId string
    Tags []string
    TagsAlls []string
    circuit_provider_network_id string
    The ID of this resource.
    comments string
    custom_fields map(string)
    description string
    name string
    provider_id number
    service_id string
    tags list(string)
    tags_alls list(string)
    circuitProviderNetworkId String
    The ID of this resource.
    comments String
    customFields Map<String,String>
    description String
    name String
    providerId Double
    serviceId String
    tags List<String>
    tagsAlls List<String>
    circuitProviderNetworkId string
    The ID of this resource.
    comments string
    customFields {[key: string]: string}
    description string
    name string
    providerId number
    serviceId string
    tags string[]
    tagsAlls string[]
    circuit_provider_network_id str
    The ID of this resource.
    comments str
    custom_fields Mapping[str, str]
    description str
    name str
    provider_id float
    service_id str
    tags Sequence[str]
    tags_alls Sequence[str]
    circuitProviderNetworkId String
    The ID of this resource.
    comments String
    customFields Map<String>
    description String
    name String
    providerId Number
    serviceId String
    tags List<String>
    tagsAlls List<String>

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    Viewing docs for netbox 5.8.0
    published on Friday, Sep 4, 2026 by e-breuninger
    Schema (JSON)
    e-breuninger/terraform-provider-netbox

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial