Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. CircuitProvider
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.CircuitProvider

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

    From the official documentation:

    A circuit provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which offer Internet and private transit service, it might also include Internet exchange (IX) points and even organizations with whom you peer directly. Each circuit within NetBox must be assigned a provider and a circuit ID which is unique to that provider.

    Each provider may be assigned an autonomous system number (ASN), an account number, and contact information.

    Example Usage

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

const test = new netbox.CircuitProvider("test", {});

    import pulumi
import pulumi_netbox as netbox

test = netbox.CircuitProvider("test")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.NewCircuitProvider(ctx, "test", nil)
		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 test = new Netbox.CircuitProvider("test");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.CircuitProvider;
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 test = new CircuitProvider("test");

    }
}

    resources:
  test:
    type: netbox:CircuitProvider

    Create CircuitProvider Resource

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

    Constructor syntax

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

@overload
def CircuitProvider(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    circuit_provider_id: Optional[str] = None,
                    name: Optional[str] = None,
                    slug: Optional[str] = None)
    func NewCircuitProvider(ctx *Context, name string, args *CircuitProviderArgs, opts ...ResourceOption) (*CircuitProvider, error)
    public CircuitProvider(string name, CircuitProviderArgs? args = null, CustomResourceOptions? opts = null)
    public CircuitProvider(String name, CircuitProviderArgs args)
public CircuitProvider(String name, CircuitProviderArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args CircuitProviderArgs
    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 CircuitProviderArgs
    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 CircuitProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CircuitProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CircuitProviderArgs
    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 circuitProviderResource = new Netbox.CircuitProvider("circuitProviderResource", new()
{
    CircuitProviderId = "string",
    Name = "string",
    Slug = "string",
});

    example, err := netbox.NewCircuitProvider(ctx, "circuitProviderResource", &netbox.CircuitProviderArgs{
	CircuitProviderId: pulumi.String("string"),
	Name:              pulumi.String("string"),
	Slug:              pulumi.String("string"),
})

    var circuitProviderResource = new CircuitProvider("circuitProviderResource", CircuitProviderArgs.builder()
    .circuitProviderId("string")
    .name("string")
    .slug("string")
    .build());

    circuit_provider_resource = netbox.CircuitProvider("circuitProviderResource",
    circuit_provider_id="string",
    name="string",
    slug="string")

    const circuitProviderResource = new netbox.CircuitProvider("circuitProviderResource", {
    circuitProviderId: "string",
    name: "string",
    slug: "string",
});

    type: netbox:CircuitProvider
properties:
    circuitProviderId: string
    name: string
    slug: string

    CircuitProvider 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 CircuitProvider resource accepts the following input properties:

    CircuitProviderId string
    The ID of this resource.
    Name string
    Slug string
    CircuitProviderId string
    The ID of this resource.
    Name string
    Slug string
    circuitProviderId String
    The ID of this resource.
    name String
    slug String
    circuitProviderId string
    The ID of this resource.
    name string
    slug string
    circuit_provider_id str
    The ID of this resource.
    name str
    slug str
    circuitProviderId String
    The ID of this resource.
    name String
    slug String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CircuitProvider Resource

    Get an existing CircuitProvider 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?: CircuitProviderState, opts?: CustomResourceOptions): CircuitProvider
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        circuit_provider_id: Optional[str] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None) -> CircuitProvider
    func GetCircuitProvider(ctx *Context, name string, id IDInput, state *CircuitProviderState, opts ...ResourceOption) (*CircuitProvider, error)
    public static CircuitProvider Get(string name, Input<string> id, CircuitProviderState? state, CustomResourceOptions? opts = null)
    public static CircuitProvider get(String name, Output<String> id, CircuitProviderState state, CustomResourceOptions options)
    resources:  _:    type: netbox:CircuitProvider    get:      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:
    CircuitProviderId string
    The ID of this resource.
    Name string
    Slug string
    CircuitProviderId string
    The ID of this resource.
    Name string
    Slug string
    circuitProviderId String
    The ID of this resource.
    name String
    slug String
    circuitProviderId string
    The ID of this resource.
    name string
    slug string
    circuit_provider_id str
    The ID of this resource.
    name str
    slug str
    circuitProviderId String
    The ID of this resource.
    name String
    slug String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
    e-breuninger/terraform-provider-netbox