1. Packages
  2. Netbox Provider
  3. API Docs
  4. getTenant
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

netbox.getTenant

Explore with Pulumi AI

netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

Example Usage

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

const customerA = netbox.getTenant({
    name: "Customer A",
});
Copy
import pulumi
import pulumi_netbox as netbox

customer_a = netbox.get_tenant(name="Customer A")
Copy
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.LookupTenant(ctx, &netbox.LookupTenantArgs{
			Name: pulumi.StringRef("Customer A"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var customerA = Netbox.GetTenant.Invoke(new()
    {
        Name = "Customer A",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.NetboxFunctions;
import com.pulumi.netbox.inputs.GetTenantArgs;
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) {
        final var customerA = NetboxFunctions.getTenant(GetTenantArgs.builder()
            .name("Customer A")
            .build());

    }
}
Copy
variables:
  customerA:
    fn::invoke:
      function: netbox:getTenant
      arguments:
        name: Customer A
Copy

Using getTenant

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 getTenant(args: GetTenantArgs, opts?: InvokeOptions): Promise<GetTenantResult>
function getTenantOutput(args: GetTenantOutputArgs, opts?: InvokeOptions): Output<GetTenantResult>
Copy
def get_tenant(description: Optional[str] = None,
               id: Optional[str] = None,
               name: Optional[str] = None,
               slug: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetTenantResult
def get_tenant_output(description: Optional[pulumi.Input[str]] = None,
               id: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               slug: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetTenantResult]
Copy
func LookupTenant(ctx *Context, args *LookupTenantArgs, opts ...InvokeOption) (*LookupTenantResult, error)
func LookupTenantOutput(ctx *Context, args *LookupTenantOutputArgs, opts ...InvokeOption) LookupTenantResultOutput
Copy

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

public static class GetTenant 
{
    public static Task<GetTenantResult> InvokeAsync(GetTenantArgs args, InvokeOptions? opts = null)
    public static Output<GetTenantResult> Invoke(GetTenantInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTenantResult> getTenant(GetTenantArgs args, InvokeOptions options)
public static Output<GetTenantResult> getTenant(GetTenantArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netbox:index/getTenant:getTenant
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Description string
Id string
The ID of this resource.
Name string
At least one of name or slug must be given.
Slug string
At least one of name or slug must be given.
Description string
Id string
The ID of this resource.
Name string
At least one of name or slug must be given.
Slug string
At least one of name or slug must be given.
description String
id String
The ID of this resource.
name String
At least one of name or slug must be given.
slug String
At least one of name or slug must be given.
description string
id string
The ID of this resource.
name string
At least one of name or slug must be given.
slug string
At least one of name or slug must be given.
description str
id str
The ID of this resource.
name str
At least one of name or slug must be given.
slug str
At least one of name or slug must be given.
description String
id String
The ID of this resource.
name String
At least one of name or slug must be given.
slug String
At least one of name or slug must be given.

getTenant Result

The following output properties are available:

GroupId double
Id string
The ID of this resource.
Name string
At least one of name or slug must be given.
Slug string
At least one of name or slug must be given.
Description string
GroupId float64
Id string
The ID of this resource.
Name string
At least one of name or slug must be given.
Slug string
At least one of name or slug must be given.
Description string
groupId Double
id String
The ID of this resource.
name String
At least one of name or slug must be given.
slug String
At least one of name or slug must be given.
description String
groupId number
id string
The ID of this resource.
name string
At least one of name or slug must be given.
slug string
At least one of name or slug must be given.
description string
group_id float
id str
The ID of this resource.
name str
At least one of name or slug must be given.
slug str
At least one of name or slug must be given.
description str
groupId Number
id String
The ID of this resource.
name String
At least one of name or slug must be given.
slug String
At least one of name or slug must be given.
description String

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