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 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>
Copy
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]
Copy
func GetTenants(ctx *Context, args *GetTenantsArgs, opts ...InvokeOption) (*GetTenantsResult, error)
func GetTenantsOutput(ctx *Context, args *GetTenantsOutputArgs, opts ...InvokeOption) GetTenantsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetTenantsResult> getTenants(GetTenantsArgs args, InvokeOptions options)
public static Output<GetTenantsResult> getTenants(GetTenantsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netbox:index/getTenants:getTenants
  arguments:
    # arguments dictionary
Copy

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 This property is required. string
Value This property is required. string
Name This property is required. string
Value This property is required. string
name This property is required. String
value This property is required. String
name This property is required. string
value This property is required. string
name This property is required. str
value This property is required. str
name This property is required. String
value This property is required. String

GetTenantsTenant

CircuitCount This property is required. double
ClusterCount This property is required. double
Comments This property is required. string
Created This property is required. string
CustomFields This property is required. Dictionary<string, string>
Description This property is required. string
DeviceCount This property is required. double
Id This property is required. double
IpAddressCount This property is required. double
LastUpdated This property is required. string
Name This property is required. string
PrefixCount This property is required. double
RackCount This property is required. double
SiteCount This property is required. double
Slug This property is required. string
TenantGroups This property is required. List<GetTenantsTenantTenantGroup>
VlanCount This property is required. double
VmCount This property is required. double
VrfCount This property is required. double
CircuitCount This property is required. float64
ClusterCount This property is required. float64
Comments This property is required. string
Created This property is required. string
CustomFields This property is required. map[string]string
Description This property is required. string
DeviceCount This property is required. float64
Id This property is required. float64
IpAddressCount This property is required. float64
LastUpdated This property is required. string
Name This property is required. string
PrefixCount This property is required. float64
RackCount This property is required. float64
SiteCount This property is required. float64
Slug This property is required. string
TenantGroups This property is required. []GetTenantsTenantTenantGroup
VlanCount This property is required. float64
VmCount This property is required. float64
VrfCount This property is required. float64
circuitCount This property is required. Double
clusterCount This property is required. Double
comments This property is required. String
created This property is required. String
customFields This property is required. Map<String,String>
description This property is required. String
deviceCount This property is required. Double
id This property is required. Double
ipAddressCount This property is required. Double
lastUpdated This property is required. String
name This property is required. String
prefixCount This property is required. Double
rackCount This property is required. Double
siteCount This property is required. Double
slug This property is required. String
tenantGroups This property is required. List<GetTenantsTenantTenantGroup>
vlanCount This property is required. Double
vmCount This property is required. Double
vrfCount This property is required. Double
circuitCount This property is required. number
clusterCount This property is required. number
comments This property is required. string
created This property is required. string
customFields This property is required. {[key: string]: string}
description This property is required. string
deviceCount This property is required. number
id This property is required. number
ipAddressCount This property is required. number
lastUpdated This property is required. string
name This property is required. string
prefixCount This property is required. number
rackCount This property is required. number
siteCount This property is required. number
slug This property is required. string
tenantGroups This property is required. GetTenantsTenantTenantGroup[]
vlanCount This property is required. number
vmCount This property is required. number
vrfCount This property is required. number
circuit_count This property is required. float
cluster_count This property is required. float
comments This property is required. str
created This property is required. str
custom_fields This property is required. Mapping[str, str]
description This property is required. str
device_count This property is required. float
id This property is required. float
ip_address_count This property is required. float
last_updated This property is required. str
name This property is required. str
prefix_count This property is required. float
rack_count This property is required. float
site_count This property is required. float
slug This property is required. str
tenant_groups This property is required. Sequence[GetTenantsTenantTenantGroup]
vlan_count This property is required. float
vm_count This property is required. float
vrf_count This property is required. float
circuitCount This property is required. Number
clusterCount This property is required. Number
comments This property is required. String
created This property is required. String
customFields This property is required. Map<String>
description This property is required. String
deviceCount This property is required. Number
id This property is required. Number
ipAddressCount This property is required. Number
lastUpdated This property is required. String
name This property is required. String
prefixCount This property is required. Number
rackCount This property is required. Number
siteCount This property is required. Number
slug This property is required. String
tenantGroups This property is required. List<Property Map>
vlanCount This property is required. Number
vmCount This property is required. Number
vrfCount This property is required. Number

GetTenantsTenantTenantGroup

Id This property is required. double
Name This property is required. string
Slug This property is required. string
TenantCount This property is required. double
Id This property is required. float64
Name This property is required. string
Slug This property is required. string
TenantCount This property is required. float64
id This property is required. Double
name This property is required. String
slug This property is required. String
tenantCount This property is required. Double
id This property is required. number
name This property is required. string
slug This property is required. string
tenantCount This property is required. number
id This property is required. float
name This property is required. str
slug This property is required. str
tenant_count This property is required. float
id This property is required. Number
name This property is required. String
slug This property is required. String
tenantCount This property is required. Number

Package Details

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