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

netbox.getTenants

Explore with Pulumi AI

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

    Using getTenants

    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 getTenants(args: GetTenantsArgs, opts?: InvokeOptions): Promise<GetTenantsResult>
function getTenantsOutput(args: GetTenantsOutputArgs, opts?: InvokeOptions): Output<GetTenantsResult>
    def get_tenants(filters: Optional[Sequence[GetTenantsFilter]] = None,
                id: Optional[str] = None,
                limit: Optional[float] = None,
                opts: Optional[InvokeOptions] = None) -> GetTenantsResult
def get_tenants_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetTenantsFilterArgs]]]] = None,
                id: Optional[pulumi.Input[str]] = None,
                limit: Optional[pulumi.Input[float]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetTenantsResult]
    func GetTenants(ctx *Context, args *GetTenantsArgs, opts ...InvokeOption) (*GetTenantsResult, error)
func GetTenantsOutput(ctx *Context, args *GetTenantsOutputArgs, opts ...InvokeOption) GetTenantsResultOutput

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

    public static class GetTenants 
{
    public static Task<GetTenantsResult> InvokeAsync(GetTenantsArgs args, InvokeOptions? opts = null)
    public static Output<GetTenantsResult> Invoke(GetTenantsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTenantsResult> getTenants(GetTenantsArgs args, InvokeOptions options)
public static Output<GetTenantsResult> getTenants(GetTenantsArgs args, InvokeOptions options)

    fn::invoke:
  function: netbox:index/getTenants:getTenants
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetTenantsFilter>
    Id string
    The ID of this resource.
    Limit double
    Defaults to 1000.
    Filters []GetTenantsFilter
    Id string
    The ID of this resource.
    Limit float64
    Defaults to 1000.
    filters List<GetTenantsFilter>
    id String
    The ID of this resource.
    limit Double
    Defaults to 1000.
    filters GetTenantsFilter[]
    id string
    The ID of this resource.
    limit number
    Defaults to 1000.
    filters Sequence[GetTenantsFilter]
    id str
    The ID of this resource.
    limit float
    Defaults to 1000.
    filters List<Property Map>
    id String
    The ID of this resource.
    limit Number
    Defaults to 1000.

    getTenants Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Tenants List<GetTenantsTenant>
    Filters List<GetTenantsFilter>
    Limit double
    Defaults to 1000.
    Id string
    The ID of this resource.
    Tenants []GetTenantsTenant
    Filters []GetTenantsFilter
    Limit float64
    Defaults to 1000.
    id String
    The ID of this resource.
    tenants List<GetTenantsTenant>
    filters List<GetTenantsFilter>
    limit Double
    Defaults to 1000.
    id string
    The ID of this resource.
    tenants GetTenantsTenant[]
    filters GetTenantsFilter[]
    limit number
    Defaults to 1000.
    id str
    The ID of this resource.
    tenants Sequence[GetTenantsTenant]
    filters Sequence[GetTenantsFilter]
    limit float
    Defaults to 1000.
    id String
    The ID of this resource.
    tenants List<Property Map>
    filters List<Property Map>
    limit Number
    Defaults to 1000.

    Supporting Types

    GetTenantsFilter

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

    GetTenantsTenant

    CircuitCount double
    ClusterCount double
    Comments string
    Created string
    CustomFields Dictionary<string, string>
    Description string
    DeviceCount double
    Id double
    IpAddressCount double
    LastUpdated string
    Name string
    PrefixCount double
    RackCount double
    SiteCount double
    Slug string
    TenantGroups List<GetTenantsTenantTenantGroup>
    VlanCount double
    VmCount double
    VrfCount double
    CircuitCount float64
    ClusterCount float64
    Comments string
    Created string
    CustomFields map[string]string
    Description string
    DeviceCount float64
    Id float64
    IpAddressCount float64
    LastUpdated string
    Name string
    PrefixCount float64
    RackCount float64
    SiteCount float64
    Slug string
    TenantGroups []GetTenantsTenantTenantGroup
    VlanCount float64
    VmCount float64
    VrfCount float64
    circuitCount Double
    clusterCount Double
    comments String
    created String
    customFields Map<String,String>
    description String
    deviceCount Double
    id Double
    ipAddressCount Double
    lastUpdated String
    name String
    prefixCount Double
    rackCount Double
    siteCount Double
    slug String
    tenantGroups List<GetTenantsTenantTenantGroup>
    vlanCount Double
    vmCount Double
    vrfCount Double
    circuitCount number
    clusterCount number
    comments string
    created string
    customFields {[key: string]: string}
    description string
    deviceCount number
    id number
    ipAddressCount number
    lastUpdated string
    name string
    prefixCount number
    rackCount number
    siteCount number
    slug string
    tenantGroups GetTenantsTenantTenantGroup[]
    vlanCount number
    vmCount number
    vrfCount number
    circuitCount Number
    clusterCount Number
    comments String
    created String
    customFields Map<String>
    description String
    deviceCount Number
    id Number
    ipAddressCount Number
    lastUpdated String
    name String
    prefixCount Number
    rackCount Number
    siteCount Number
    slug String
    tenantGroups List<Property Map>
    vlanCount Number
    vmCount Number
    vrfCount Number

    GetTenantsTenantTenantGroup

    Id double
    Name string
    Slug string
    TenantCount double
    Id float64
    Name string
    Slug string
    TenantCount float64
    id Double
    name String
    slug String
    tenantCount Double
    id number
    name string
    slug string
    tenantCount number
    id float
    name str
    slug str
    tenant_count float
    id Number
    name String
    slug String
    tenantCount Number

    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