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

netbox.getCircuitProviderNetworks

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

    Example Usage

    Using getCircuitProviderNetworks

    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 getCircuitProviderNetworks(args: GetCircuitProviderNetworksArgs, opts?: InvokeOptions): Promise<GetCircuitProviderNetworksResult>
function getCircuitProviderNetworksOutput(args: GetCircuitProviderNetworksOutputArgs, opts?: InvokeOutputOptions): Output<GetCircuitProviderNetworksResult>
    def get_circuit_provider_networks(filters: Optional[Sequence[GetCircuitProviderNetworksFilter]] = None,
                                  id: Optional[str] = None,
                                  limit: Optional[float] = None,
                                  name_regex: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCircuitProviderNetworksResult
def get_circuit_provider_networks_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetCircuitProviderNetworksFilterArgs]]]] = None,
                                  id: pulumi.Input[Optional[str]] = None,
                                  limit: pulumi.Input[Optional[float]] = None,
                                  name_regex: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetCircuitProviderNetworksResult]
    func GetCircuitProviderNetworks(ctx *Context, args *GetCircuitProviderNetworksArgs, opts ...InvokeOption) (*GetCircuitProviderNetworksResult, error)
func GetCircuitProviderNetworksOutput(ctx *Context, args *GetCircuitProviderNetworksOutputArgs, opts ...InvokeOption) GetCircuitProviderNetworksResultOutput

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

    public static class GetCircuitProviderNetworks 
{
    public static Task<GetCircuitProviderNetworksResult> InvokeAsync(GetCircuitProviderNetworksArgs args, InvokeOptions? opts = null)
    public static Output<GetCircuitProviderNetworksResult> Invoke(GetCircuitProviderNetworksInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCircuitProviderNetworksResult> Invoke(GetCircuitProviderNetworksInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCircuitProviderNetworksResult> getCircuitProviderNetworks(GetCircuitProviderNetworksArgs args, InvokeOptions options)
public static Output<GetCircuitProviderNetworksResult> getCircuitProviderNetworks(GetCircuitProviderNetworksArgs args, InvokeOptions options)
public static Output<GetCircuitProviderNetworksResult> getCircuitProviderNetworks(GetCircuitProviderNetworksArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: netbox:index/getCircuitProviderNetworks:getCircuitProviderNetworks
  arguments:
    # arguments dictionary
    data "netbox_get_circuit_provider_networks" "name" {
    # arguments
}

    The following arguments are supported:

    Filters List<GetCircuitProviderNetworksFilter>
    Id string
    The ID of this resource.
    Limit double
    Defaults to 0.
    NameRegex string
    Filters []GetCircuitProviderNetworksFilter
    Id string
    The ID of this resource.
    Limit float64
    Defaults to 0.
    NameRegex string
    filters list(object)
    id string
    The ID of this resource.
    limit number
    Defaults to 0.
    name_regex string
    filters List<GetCircuitProviderNetworksFilter>
    id String
    The ID of this resource.
    limit Double
    Defaults to 0.
    nameRegex String
    filters GetCircuitProviderNetworksFilter[]
    id string
    The ID of this resource.
    limit number
    Defaults to 0.
    nameRegex string
    filters Sequence[GetCircuitProviderNetworksFilter]
    id str
    The ID of this resource.
    limit float
    Defaults to 0.
    name_regex str
    filters List<Property Map>
    id String
    The ID of this resource.
    limit Number
    Defaults to 0.
    nameRegex String

    getCircuitProviderNetworks Result

    The following output properties are available:

    id string
    The ID of this resource.
    provider_networks list(object)
    filters list(object)
    limit number
    Defaults to 0.
    name_regex string
    id String
    The ID of this resource.
    providerNetworks List<Property Map>
    filters List<Property Map>
    limit Number
    Defaults to 0.
    nameRegex String

    Supporting Types

    GetCircuitProviderNetworksFilter

    Name string
    Value string
    Name string
    Value string
    name string
    value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    GetCircuitProviderNetworksProviderNetwork

    Comments string
    CustomFields Dictionary<string, string>
    Description string
    Name string
    ProviderId double
    ProviderNetworkId double
    ServiceId string
    Tags List<string>
    Comments string
    CustomFields map[string]string
    Description string
    Name string
    ProviderId float64
    ProviderNetworkId float64
    ServiceId string
    Tags []string
    comments string
    custom_fields map(string)
    description string
    name string
    provider_id number
    provider_network_id number
    service_id string
    tags list(string)
    comments String
    customFields Map<String,String>
    description String
    name String
    providerId Double
    providerNetworkId Double
    serviceId String
    tags List<String>
    comments string
    customFields {[key: string]: string}
    description string
    name string
    providerId number
    providerNetworkId number
    serviceId string
    tags string[]
    comments str
    custom_fields Mapping[str, str]
    description str
    name str
    provider_id float
    provider_network_id float
    service_id str
    tags Sequence[str]
    comments String
    customFields Map<String>
    description String
    name String
    providerId Number
    providerNetworkId Number
    serviceId String
    tags 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