1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getCircuitProviderNetwork
Viewing docs for netbox 5.8.0
published on Friday, Sep 4, 2026 by e-breuninger
Viewing docs for netbox 5.8.0
published on Friday, Sep 4, 2026 by e-breuninger

    Example Usage

    Using getCircuitProviderNetwork

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCircuitProviderNetwork(args: GetCircuitProviderNetworkArgs, opts?: InvokeOptions): Promise<GetCircuitProviderNetworkResult>
    function getCircuitProviderNetworkOutput(args: GetCircuitProviderNetworkOutputArgs, opts?: InvokeOutputOptions): Output<GetCircuitProviderNetworkResult>
    def get_circuit_provider_network(id: Optional[str] = None,
                                     name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetCircuitProviderNetworkResult
    def get_circuit_provider_network_output(id: pulumi.Input[Optional[str]] = None,
                                     name: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetCircuitProviderNetworkResult]
    func LookupCircuitProviderNetwork(ctx *Context, args *LookupCircuitProviderNetworkArgs, opts ...InvokeOption) (*LookupCircuitProviderNetworkResult, error)
    func LookupCircuitProviderNetworkOutput(ctx *Context, args *LookupCircuitProviderNetworkOutputArgs, opts ...InvokeOption) LookupCircuitProviderNetworkResultOutput

    > Note: This function is named LookupCircuitProviderNetwork in the Go SDK.

    public static class GetCircuitProviderNetwork 
    {
        public static Task<GetCircuitProviderNetworkResult> InvokeAsync(GetCircuitProviderNetworkArgs args, InvokeOptions? opts = null)
        public static Output<GetCircuitProviderNetworkResult> Invoke(GetCircuitProviderNetworkInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetCircuitProviderNetworkResult> Invoke(GetCircuitProviderNetworkInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetCircuitProviderNetworkResult> getCircuitProviderNetwork(GetCircuitProviderNetworkArgs args, InvokeOptions options)
    public static Output<GetCircuitProviderNetworkResult> getCircuitProviderNetwork(GetCircuitProviderNetworkArgs args, InvokeOptions options)
    public static Output<GetCircuitProviderNetworkResult> getCircuitProviderNetwork(GetCircuitProviderNetworkArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getCircuitProviderNetwork:getCircuitProviderNetwork
      arguments:
        # arguments dictionary
    data "netbox_get_circuit_provider_network" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    At least one of id or name must be given.
    Name string
    At least one of id or name must be given.
    Id string
    At least one of id or name must be given.
    Name string
    At least one of id or name must be given.
    id string
    At least one of id or name must be given.
    name string
    At least one of id or name must be given.
    id String
    At least one of id or name must be given.
    name String
    At least one of id or name must be given.
    id string
    At least one of id or name must be given.
    name string
    At least one of id or name must be given.
    id str
    At least one of id or name must be given.
    name str
    At least one of id or name must be given.
    id String
    At least one of id or name must be given.
    name String
    At least one of id or name must be given.

    getCircuitProviderNetwork Result

    The following output properties are available:

    Comments string
    CustomFields Dictionary<string, string>
    Description string
    Id string
    At least one of id or name must be given.
    ProviderId double
    ServiceId string
    Tags List<string>
    Name string
    At least one of id or name must be given.
    Comments string
    CustomFields map[string]string
    Description string
    Id string
    At least one of id or name must be given.
    ProviderId float64
    ServiceId string
    Tags []string
    Name string
    At least one of id or name must be given.
    comments string
    custom_fields map(string)
    description string
    id string
    At least one of id or name must be given.
    provider_id number
    service_id string
    tags list(string)
    name string
    At least one of id or name must be given.
    comments String
    customFields Map<String,String>
    description String
    id String
    At least one of id or name must be given.
    providerId Double
    serviceId String
    tags List<String>
    name String
    At least one of id or name must be given.
    comments string
    customFields {[key: string]: string}
    description string
    id string
    At least one of id or name must be given.
    providerId number
    serviceId string
    tags string[]
    name string
    At least one of id or name must be given.
    comments str
    custom_fields Mapping[str, str]
    description str
    id str
    At least one of id or name must be given.
    provider_id float
    service_id str
    tags Sequence[str]
    name str
    At least one of id or name must be given.
    comments String
    customFields Map<String>
    description String
    id String
    At least one of id or name must be given.
    providerId Number
    serviceId String
    tags List<String>
    name String
    At least one of id or name must be given.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial