1. Packages
  2. Mso Provider
  3. API Docs
  4. getTenant
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.getTenant

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Data source for MSO Tenant.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mso from "@pulumi/mso";
    
    const example = mso.getTenant({
        name: "mso",
    });
    
    import pulumi
    import pulumi_mso as mso
    
    example = mso.get_tenant(name="mso")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/mso/mso"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mso.LookupTenant(ctx, &mso.LookupTenantArgs{
    			Name: "mso",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mso = Pulumi.Mso;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Mso.GetTenant.Invoke(new()
        {
            Name = "mso",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mso.MsoFunctions;
    import com.pulumi.mso.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 example = MsoFunctions.getTenant(GetTenantArgs.builder()
                .name("mso")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: mso:getTenant
          arguments:
            name: mso
    

    Argument Reference

    • name - (Required) The name of the Tenant.

    Attribute Reference

    • display_name - (Read-Only) The name of the Tenant as displayed on the MSO UI.
    • description - (Read-Only) The description of the Tenant.
    • user_associations - (Read-Only) A list of associated users of the Tenant.
      • user_id - (Read-Only) The user ID associated to this tenant.
    • site_association - (Read-Only) A list of associated sites of the Tenant.
      • site_id - (Read-Only) The site ID associated with this Tenant.
      • security_domains - (Read-Only) The security domain associated with this Tenant.
      • vendor - (Read-Only) The cloud vendor associated with this Tenant. Only applicable for cloud sites.
      • aws_account_id - (Read-Only) The ID of the AWS account.
      • is_aws_account_trusted - (Read-Only) Whether this account is trusted.
      • aws_access_key_id - (Read-Only) The Access Key ID of the AWS account.
      • aws_secret_key - (Read-Only) The Secret Key ID of the AWS account.
      • azure_subscription_id - (Read-Only) The subscription ID of the Azure account.
      • azure_access_type - (Read-Only) The type of the Azure account.
      • azure_application_id - (Read-Only) The application ID of the Azure account.
      • azure_client_secret - (Read-Only) The client secret of the Azure account.
      • azure_active_directory_id - (Read-Only) The active directory ID of the Azure account.
      • azure_shared_account_id - (Read-Only) The shared account ID of the Azure account.
      • gcp_project_id - (Read-Only) The project ID of the GCP account.
      • gcp_access_type - (Read-Only) The access type of the GCP account.
      • gcp_name - (Read-Only) The name of the GCP account.
      • gcp_key_id - (Read-Only) The key ID of the GCP account.
      • gcp_private_key - (Read-Only) The private key of the GCP account.
      • gcp_client_id - (Read-Only) The client ID of the GCP account.
      • gcp_email - (Read-Only) The email of the GCP account.

    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,
                   opts: Optional[InvokeOptions] = None) -> GetTenantResult
    def get_tenant_output(id: Optional[pulumi.Input[str]] = None,
                   name: 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: mso:index/getTenant:getTenant
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Id string
    Name string
    Id string
    name String
    id String
    name string
    id string
    name str
    id str
    name String
    id String

    getTenant Result

    The following output properties are available:

    Supporting Types

    GetTenantSiteAssociation

    GetTenantUserAssociation

    UserId string
    UserId string
    userId String
    userId string
    userId String

    Package Details

    Repository
    mso ciscodevnet/terraform-provider-mso
    License
    Notes
    This Pulumi package is based on the mso Terraform Provider.
    mso logo
    mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet