Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getMicrotenant
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

zpa.getMicrotenant

Explore with Pulumi AI

zpa logo
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

    The zpa_microtenant_controller data source to get information about a machine group created in the Zscaler Private Access cloud. This data source allows administrators to retrieve a specific microtenant ID, which can be passed to other supported resources via the microtenant_id attribute.

    ⚠️ WARNING:: This feature is in limited availability and requires additional license. To learn more, contact Zscaler Support or your local account team.

    Example Usage

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

const this = zpa.getMicrotenant({
    name: "Microtenant_A",
});

    import pulumi
import pulumi_zpa as zpa

this = zpa.get_microtenant(name="Microtenant_A")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zpa/sdk/go/zpa"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zpa.LookupMicrotenant(ctx, &zpa.LookupMicrotenantArgs{
			Name: pulumi.StringRef("Microtenant_A"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Zpa.GetMicrotenant.Invoke(new()
    {
        Name = "Microtenant_A",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ZpaFunctions;
import com.pulumi.zpa.inputs.GetMicrotenantArgs;
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 this = ZpaFunctions.getMicrotenant(GetMicrotenantArgs.builder()
            .name("Microtenant_A")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      Function: zpa:getMicrotenant
      Arguments:
        name: Microtenant_A

    Using getMicrotenant

    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 getMicrotenant(args: GetMicrotenantArgs, opts?: InvokeOptions): Promise<GetMicrotenantResult>
function getMicrotenantOutput(args: GetMicrotenantOutputArgs, opts?: InvokeOptions): Output<GetMicrotenantResult>
    def get_microtenant(id: Optional[str] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetMicrotenantResult
def get_microtenant_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetMicrotenantResult]
    func LookupMicrotenant(ctx *Context, args *LookupMicrotenantArgs, opts ...InvokeOption) (*LookupMicrotenantResult, error)
func LookupMicrotenantOutput(ctx *Context, args *LookupMicrotenantOutputArgs, opts ...InvokeOption) LookupMicrotenantResultOutput

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

    public static class GetMicrotenant 
{
    public static Task<GetMicrotenantResult> InvokeAsync(GetMicrotenantArgs args, InvokeOptions? opts = null)
    public static Output<GetMicrotenantResult> Invoke(GetMicrotenantInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMicrotenantResult> getMicrotenant(GetMicrotenantArgs args, InvokeOptions options)
public static Output<GetMicrotenantResult> getMicrotenant(GetMicrotenantArgs args, InvokeOptions options)

    fn::invoke:
  function: zpa:index/getMicrotenant:getMicrotenant
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    • (Required) Name of the microtenant controller.
    Id string
    Name string
    • (Required) Name of the microtenant controller.
    id String
    name String
    • (Required) Name of the microtenant controller.
    id string
    name string
    • (Required) Name of the microtenant controller.
    id str
    name str
    • (Required) Name of the microtenant controller.
    id String
    name String
    • (Required) Name of the microtenant controller.

    getMicrotenant Result

    The following output properties are available:

    CreationTime string
    CriteriaAttribute string
    CriteriaAttributeValues []string
    Description string
    Enabled bool
    ModifiedBy string
    ModifiedTime string
    Operator string
    Priority string
    Roles []GetMicrotenantRole
    Users []GetMicrotenantUser
    Id string
    Name string
    • (Required) Name of the microtenant controller.
    creationTime String
    criteriaAttribute String
    criteriaAttributeValues List<String>
    description String
    enabled Boolean
    modifiedBy String
    modifiedTime String
    operator String
    priority String
    roles List<GetMicrotenantRole>
    users List<GetMicrotenantUser>
    id String
    name String
    • (Required) Name of the microtenant controller.
    creationTime string
    criteriaAttribute string
    criteriaAttributeValues string[]
    description string
    enabled boolean
    modifiedBy string
    modifiedTime string
    operator string
    priority string
    roles GetMicrotenantRole[]
    users GetMicrotenantUser[]
    id string
    name string
    • (Required) Name of the microtenant controller.
    creationTime String
    criteriaAttribute String
    criteriaAttributeValues List<String>
    description String
    enabled Boolean
    modifiedBy String
    modifiedTime String
    operator String
    priority String
    roles List<Property Map>
    users List<Property Map>
    id String
    name String
    • (Required) Name of the microtenant controller.

    Supporting Types

    GetMicrotenantRole

    CustomRole bool
    Id string
    Name string
    • (Required) Name of the microtenant controller.
    CustomRole bool
    Id string
    Name string
    • (Required) Name of the microtenant controller.
    customRole Boolean
    id String
    name String
    • (Required) Name of the microtenant controller.
    customRole boolean
    id string
    name string
    • (Required) Name of the microtenant controller.
    custom_role bool
    id str
    name str
    • (Required) Name of the microtenant controller.
    customRole Boolean
    id String
    name String
    • (Required) Name of the microtenant controller.

    GetMicrotenantUser

    Comments string
    CreationTime string
    CustomerId string
    Description string
    DisplayName string
    Email string
    Enabled bool
    Eula string
    ForcePwdChange bool
    GroupIds string
    Id string
    IsEnabled bool
    IsLocked bool
    LanguageCode string
    LocalLoginDisabled bool
    MicrotenantId string
    MicrotenantName string
    ModifiedTime int
    Modifiedby int
    Name string
    • (Required) Name of the microtenant controller.
    Password string
    PhoneNumber bool
    PinSession string
    RoleId bool
    Timezone string
    TmpPassword string
    TokenId string
    TwoFactorAuthEnabled bool
    TwoFactorAuthType string
    Username string
    Comments string
    CreationTime string
    CustomerId string
    Description string
    DisplayName string
    Email string
    Enabled bool
    Eula string
    ForcePwdChange bool
    GroupIds string
    Id string
    IsEnabled bool
    IsLocked bool
    LanguageCode string
    LocalLoginDisabled bool
    MicrotenantId string
    MicrotenantName string
    ModifiedTime int
    Modifiedby int
    Name string
    • (Required) Name of the microtenant controller.
    Password string
    PhoneNumber bool
    PinSession string
    RoleId bool
    Timezone string
    TmpPassword string
    TokenId string
    TwoFactorAuthEnabled bool
    TwoFactorAuthType string
    Username string
    comments String
    creationTime String
    customerId String
    description String
    displayName String
    email String
    enabled Boolean
    eula String
    forcePwdChange Boolean
    groupIds String
    id String
    isEnabled Boolean
    isLocked Boolean
    languageCode String
    localLoginDisabled Boolean
    microtenantId String
    microtenantName String
    modifiedTime Integer
    modifiedby Integer
    name String
    • (Required) Name of the microtenant controller.
    password String
    phoneNumber Boolean
    pinSession String
    roleId Boolean
    timezone String
    tmpPassword String
    tokenId String
    twoFactorAuthEnabled Boolean
    twoFactorAuthType String
    username String
    comments string
    creationTime string
    customerId string
    description string
    displayName string
    email string
    enabled boolean
    eula string
    forcePwdChange boolean
    groupIds string
    id string
    isEnabled boolean
    isLocked boolean
    languageCode string
    localLoginDisabled boolean
    microtenantId string
    microtenantName string
    modifiedTime number
    modifiedby number
    name string
    • (Required) Name of the microtenant controller.
    password string
    phoneNumber boolean
    pinSession string
    roleId boolean
    timezone string
    tmpPassword string
    tokenId string
    twoFactorAuthEnabled boolean
    twoFactorAuthType string
    username string
    comments String
    creationTime String
    customerId String
    description String
    displayName String
    email String
    enabled Boolean
    eula String
    forcePwdChange Boolean
    groupIds String
    id String
    isEnabled Boolean
    isLocked Boolean
    languageCode String
    localLoginDisabled Boolean
    microtenantId String
    microtenantName String
    modifiedTime Number
    modifiedby Number
    name String
    • (Required) Name of the microtenant controller.
    password String
    phoneNumber Boolean
    pinSession String
    roleId Boolean
    timezone String
    tmpPassword String
    tokenId String
    twoFactorAuthEnabled Boolean
    twoFactorAuthType String
    username String

    Package Details

    Repository
    zpa zscaler/pulumi-zpa
    License
    MIT
    Notes
    This Pulumi package is based on the zpa Terraform Provider.
    zpa logo
    Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zpa