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

netbox.CircuitType

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:

    Circuits are classified by functional type. These types are completely customizable, and are typically used to convey the type of service being delivered over a circuit.

    Example Usage

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

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

    import pulumi
import pulumi_netbox as netbox

test = netbox.CircuitType("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.NewCircuitType(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.CircuitType("test");

});

    package generated_program;

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

    }
}

    resources:
  test:
    type: netbox:CircuitType

    Create CircuitType Resource

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

    Constructor syntax

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

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

    type: netbox:CircuitType
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 CircuitTypeArgs
    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 CircuitTypeArgs
    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 CircuitTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CircuitTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CircuitTypeArgs
    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 circuitTypeResource = new Netbox.CircuitType("circuitTypeResource", new()
{
    CircuitTypeId = "string",
    Name = "string",
    Slug = "string",
});

    example, err := netbox.NewCircuitType(ctx, "circuitTypeResource", &netbox.CircuitTypeArgs{
	CircuitTypeId: pulumi.String("string"),
	Name:          pulumi.String("string"),
	Slug:          pulumi.String("string"),
})

    var circuitTypeResource = new CircuitType("circuitTypeResource", CircuitTypeArgs.builder()
    .circuitTypeId("string")
    .name("string")
    .slug("string")
    .build());

    circuit_type_resource = netbox.CircuitType("circuitTypeResource",
    circuit_type_id="string",
    name="string",
    slug="string")

    const circuitTypeResource = new netbox.CircuitType("circuitTypeResource", {
    circuitTypeId: "string",
    name: "string",
    slug: "string",
});

    type: netbox:CircuitType
properties:
    circuitTypeId: string
    name: string
    slug: string

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

    CircuitTypeId string
    The ID of this resource.
    Name string
    Slug string
    CircuitTypeId string
    The ID of this resource.
    Name string
    Slug string
    circuitTypeId String
    The ID of this resource.
    name String
    slug String
    circuitTypeId string
    The ID of this resource.
    name string
    slug string
    circuit_type_id str
    The ID of this resource.
    name str
    slug str
    circuitTypeId String
    The ID of this resource.
    name String
    slug String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CircuitType 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 CircuitType Resource

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