avi.getTenant

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “AVI: avi.Tenant” sidebar_current: “docs-avi-datasource-tenant” description: |- Get information of Avi Tenant.

avi.Tenant

This data source is used to to get avi.Tenant objects.

Example Usage

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

const fooTenant = avi.getTenant({
    name: "foo",
    uuid: "tenant-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_tenant = avi.get_tenant(name="foo",
    uuid="tenant-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupTenant(ctx, &avi.LookupTenantArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("tenant-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooTenant = Avi.GetTenant.Invoke(new()
    {
        Name = "foo",
        Uuid = "tenant-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.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 fooTenant = AviFunctions.getTenant(GetTenantArgs.builder()
            .name("foo")
            .uuid("tenant-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooTenant:
    fn::invoke:
      function: avi:getTenant
      arguments:
        name: foo
        uuid: tenant-f9cf6b3e-a411-436f-95e2-2982ba2b217b

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>

def get_tenant(id: Optional[str] = None,
               name: Optional[str] = None,
               uuid: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetTenantResult
def get_tenant_output(id: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               uuid: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetTenantResult]

func LookupTenant(ctx *Context, args *LookupTenantArgs, opts ...InvokeOption) (*LookupTenantResult, error)
func LookupTenantOutput(ctx *Context, args *LookupTenantOutputArgs, opts ...InvokeOption) LookupTenantResultOutput

> 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)
}

public static CompletableFuture<GetTenantResult> getTenant(GetTenantArgs args, InvokeOptions options)
public static Output<GetTenantResult> getTenant(GetTenantArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getTenant:getTenant
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Name string: Search Tenant by name.
Uuid string: Search Tenant by uuid.

Id string
Name string: Search Tenant by name.
Uuid string: Search Tenant by uuid.

id String
name String: Search Tenant by name.
uuid String: Search Tenant by uuid.

id string
name string: Search Tenant by name.
uuid string: Search Tenant by uuid.

id str
name str: Search Tenant by name.
uuid str: Search Tenant by uuid.

id String
name String: Search Tenant by name.
uuid String: Search Tenant by uuid.

getTenant Result

The following output properties are available:

Attrs List<GetTenantAttr>: Key/value tenant attributes. Field introduced in 30.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ConfigSettings List<GetTenantConfigSetting>: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<GetTenantConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CreatedBy string: Creator of this tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EnforceLabelGroup string: The referred label groups are enforced on the tenant if this is set to true.if this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
LabelGroupRefs List<string>: The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to true. It is a reference to an object of type labelgroup. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
Local string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Attrs []GetTenantAttr: Key/value tenant attributes. Field introduced in 30.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
ConfigSettings []GetTenantConfigSetting: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []GetTenantConfigpbAttribute: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CreatedBy string: Creator of this tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EnforceLabelGroup string: The referred label groups are enforced on the tenant if this is set to true.if this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
Id string
LabelGroupRefs []string: The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to true. It is a reference to an object of type labelgroup. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
Local string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

attrs List<GetTenantAttr>: Key/value tenant attributes. Field introduced in 30.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
configSettings List<GetTenantConfigSetting>: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<GetTenantConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
createdBy String: Creator of this tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enforceLabelGroup String: The referred label groups are enforced on the tenant if this is set to true.if this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
labelGroupRefs List<String>: The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to true. It is a reference to an object of type labelgroup. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
local String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

attrs GetTenantAttr[]: Key/value tenant attributes. Field introduced in 30.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
configSettings GetTenantConfigSetting[]: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes GetTenantConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
createdBy string: Creator of this tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enforceLabelGroup string: The referred label groups are enforced on the tenant if this is set to true.if this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
id string
labelGroupRefs string[]: The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to true. It is a reference to an object of type labelgroup. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
local string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

attrs Sequence[GetTenantAttr]: Key/value tenant attributes. Field introduced in 30.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
config_settings Sequence[GetTenantConfigSetting]: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[GetTenantConfigpbAttribute]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
created_by str: Creator of this tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enforce_label_group str: The referred label groups are enforced on the tenant if this is set to true.if this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
id str
label_group_refs Sequence[str]: The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to true. It is a reference to an object of type labelgroup. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
local str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

attrs List<Property Map>: Key/value tenant attributes. Field introduced in 30.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
configSettings List<Property Map>: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
createdBy String: Creator of this tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enforceLabelGroup String: The referred label groups are enforced on the tenant if this is set to true.if this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
id String
labelGroupRefs List<String>: The label_groups to be enforced on the tenant. This is strictly enforced only if enforce_label_group is set to true. It is a reference to an object of type labelgroup. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
local String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.