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

netbox.TenantGroup

Explore with Pulumi AI

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

From the official documentation:

Tenants can be organized by custom groups. For instance, you might create one group called “Customers” and one called “Departments.” The assignment of a tenant to a group is optional.

Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called “Customers” containing subgroups of individual tenants grouped by product or account team.

Example Usage

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

const test = new netbox.TenantGroup("test", {});
Copy
import pulumi
import pulumi_netbox as netbox

test = netbox.TenantGroup("test")
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.NewTenantGroup(ctx, "test", 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 test = new Netbox.TenantGroup("test");

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.TenantGroup;
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) {
        var test = new TenantGroup("test");

    }
}
Copy
resources:
  test:
    type: netbox:TenantGroup
Copy

Create TenantGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TenantGroup(name: string, args?: TenantGroupArgs, opts?: CustomResourceOptions);
@overload
def TenantGroup(resource_name: str,
                args: Optional[TenantGroupArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def TenantGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                parent_id: Optional[float] = None,
                slug: Optional[str] = None,
                tenant_group_id: Optional[str] = None)
func NewTenantGroup(ctx *Context, name string, args *TenantGroupArgs, opts ...ResourceOption) (*TenantGroup, error)
public TenantGroup(string name, TenantGroupArgs? args = null, CustomResourceOptions? opts = null)
public TenantGroup(String name, TenantGroupArgs args)
public TenantGroup(String name, TenantGroupArgs args, CustomResourceOptions options)

type: netbox:TenantGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args TenantGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args TenantGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args TenantGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args TenantGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TenantGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var tenantGroupResource = new Netbox.TenantGroup("tenantGroupResource", new()
{
    Description = "string",
    Name = "string",
    ParentId = 0,
    Slug = "string",
    TenantGroupId = "string",
});
Copy
example, err := netbox.NewTenantGroup(ctx, "tenantGroupResource", &netbox.TenantGroupArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
ParentId: pulumi.Float64(0),
Slug: pulumi.String("string"),
TenantGroupId: pulumi.String("string"),
})
Copy
var tenantGroupResource = new TenantGroup("tenantGroupResource", TenantGroupArgs.builder()
    .description("string")
    .name("string")
    .parentId(0)
    .slug("string")
    .tenantGroupId("string")
    .build());
Copy
tenant_group_resource = netbox.TenantGroup("tenantGroupResource",
    description="string",
    name="string",
    parent_id=0,
    slug="string",
    tenant_group_id="string")
Copy
const tenantGroupResource = new netbox.TenantGroup("tenantGroupResource", {
    description: "string",
    name: "string",
    parentId: 0,
    slug: "string",
    tenantGroupId: "string",
});
Copy
type: netbox:TenantGroup
properties:
    description: string
    name: string
    parentId: 0
    slug: string
    tenantGroupId: string
Copy

TenantGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TenantGroup resource accepts the following input properties:

Description string
Name string
ParentId double
Slug string
TenantGroupId string
The ID of this resource.
Description string
Name string
ParentId float64
Slug string
TenantGroupId string
The ID of this resource.
description String
name String
parentId Double
slug String
tenantGroupId String
The ID of this resource.
description string
name string
parentId number
slug string
tenantGroupId string
The ID of this resource.
description str
name str
parent_id float
slug str
tenant_group_id str
The ID of this resource.
description String
name String
parentId Number
slug String
tenantGroupId String
The ID of this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the TenantGroup resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing TenantGroup Resource

Get an existing TenantGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TenantGroupState, opts?: CustomResourceOptions): TenantGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        parent_id: Optional[float] = None,
        slug: Optional[str] = None,
        tenant_group_id: Optional[str] = None) -> TenantGroup
func GetTenantGroup(ctx *Context, name string, id IDInput, state *TenantGroupState, opts ...ResourceOption) (*TenantGroup, error)
public static TenantGroup Get(string name, Input<string> id, TenantGroupState? state, CustomResourceOptions? opts = null)
public static TenantGroup get(String name, Output<String> id, TenantGroupState state, CustomResourceOptions options)
resources:  _:    type: netbox:TenantGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string
Name string
ParentId double
Slug string
TenantGroupId string
The ID of this resource.
Description string
Name string
ParentId float64
Slug string
TenantGroupId string
The ID of this resource.
description String
name String
parentId Double
slug String
tenantGroupId String
The ID of this resource.
description string
name string
parentId number
slug string
tenantGroupId string
The ID of this resource.
description str
name str
parent_id float
slug str
tenant_group_id str
The ID of this resource.
description String
name String
parentId Number
slug String
tenantGroupId String
The ID of this resource.

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