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

zpa.getMicrotenant

Explore with Pulumi AI

Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

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",
});
Copy
import pulumi
import pulumi_zpa as zpa

this = zpa.get_microtenant(name="Microtenant_A")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func LookupMicrotenant(ctx *Context, args *LookupMicrotenantArgs, opts ...InvokeOption) (*LookupMicrotenantResult, error)
func LookupMicrotenantOutput(ctx *Context, args *LookupMicrotenantOutputArgs, opts ...InvokeOption) LookupMicrotenantResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetMicrotenantResult> getMicrotenant(GetMicrotenantArgs args, InvokeOptions options)
public static Output<GetMicrotenantResult> getMicrotenant(GetMicrotenantArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: zpa:index/getMicrotenant:getMicrotenant
  arguments:
    # arguments dictionary
Copy

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 This property is required. bool
Id This property is required. string
Name This property is required. string
  • (Required) Name of the microtenant controller.
CustomRole This property is required. bool
Id This property is required. string
Name This property is required. string
  • (Required) Name of the microtenant controller.
customRole This property is required. Boolean
id This property is required. String
name This property is required. String
  • (Required) Name of the microtenant controller.
customRole This property is required. boolean
id This property is required. string
name This property is required. string
  • (Required) Name of the microtenant controller.
custom_role This property is required. bool
id This property is required. str
name This property is required. str
  • (Required) Name of the microtenant controller.
customRole This property is required. Boolean
id This property is required. String
name This property is required. String
  • (Required) Name of the microtenant controller.

GetMicrotenantUser

Comments This property is required. string
CreationTime This property is required. string
CustomerId This property is required. string
Description This property is required. string
DisplayName This property is required. string
Email This property is required. string
Enabled This property is required. bool
Eula This property is required. string
ForcePwdChange This property is required. bool
GroupIds This property is required. string
Id This property is required. string
IsEnabled This property is required. bool
IsLocked This property is required. bool
LanguageCode This property is required. string
LocalLoginDisabled This property is required. bool
MicrotenantId This property is required. string
MicrotenantName This property is required. string
ModifiedTime This property is required. int
Modifiedby This property is required. int
Name This property is required. string
  • (Required) Name of the microtenant controller.
Password This property is required. string
PhoneNumber This property is required. bool
PinSession This property is required. string
RoleId This property is required. bool
Timezone This property is required. string
TmpPassword This property is required. string
TokenId This property is required. string
TwoFactorAuthEnabled This property is required. bool
TwoFactorAuthType This property is required. string
Username This property is required. string
Comments This property is required. string
CreationTime This property is required. string
CustomerId This property is required. string
Description This property is required. string
DisplayName This property is required. string
Email This property is required. string
Enabled This property is required. bool
Eula This property is required. string
ForcePwdChange This property is required. bool
GroupIds This property is required. string
Id This property is required. string
IsEnabled This property is required. bool
IsLocked This property is required. bool
LanguageCode This property is required. string
LocalLoginDisabled This property is required. bool
MicrotenantId This property is required. string
MicrotenantName This property is required. string
ModifiedTime This property is required. int
Modifiedby This property is required. int
Name This property is required. string
  • (Required) Name of the microtenant controller.
Password This property is required. string
PhoneNumber This property is required. bool
PinSession This property is required. string
RoleId This property is required. bool
Timezone This property is required. string
TmpPassword This property is required. string
TokenId This property is required. string
TwoFactorAuthEnabled This property is required. bool
TwoFactorAuthType This property is required. string
Username This property is required. string
comments This property is required. String
creationTime This property is required. String
customerId This property is required. String
description This property is required. String
displayName This property is required. String
email This property is required. String
enabled This property is required. Boolean
eula This property is required. String
forcePwdChange This property is required. Boolean
groupIds This property is required. String
id This property is required. String
isEnabled This property is required. Boolean
isLocked This property is required. Boolean
languageCode This property is required. String
localLoginDisabled This property is required. Boolean
microtenantId This property is required. String
microtenantName This property is required. String
modifiedTime This property is required. Integer
modifiedby This property is required. Integer
name This property is required. String
  • (Required) Name of the microtenant controller.
password This property is required. String
phoneNumber This property is required. Boolean
pinSession This property is required. String
roleId This property is required. Boolean
timezone This property is required. String
tmpPassword This property is required. String
tokenId This property is required. String
twoFactorAuthEnabled This property is required. Boolean
twoFactorAuthType This property is required. String
username This property is required. String
comments This property is required. string
creationTime This property is required. string
customerId This property is required. string
description This property is required. string
displayName This property is required. string
email This property is required. string
enabled This property is required. boolean
eula This property is required. string
forcePwdChange This property is required. boolean
groupIds This property is required. string
id This property is required. string
isEnabled This property is required. boolean
isLocked This property is required. boolean
languageCode This property is required. string
localLoginDisabled This property is required. boolean
microtenantId This property is required. string
microtenantName This property is required. string
modifiedTime This property is required. number
modifiedby This property is required. number
name This property is required. string
  • (Required) Name of the microtenant controller.
password This property is required. string
phoneNumber This property is required. boolean
pinSession This property is required. string
roleId This property is required. boolean
timezone This property is required. string
tmpPassword This property is required. string
tokenId This property is required. string
twoFactorAuthEnabled This property is required. boolean
twoFactorAuthType This property is required. string
username This property is required. string
comments This property is required. str
creation_time This property is required. str
customer_id This property is required. str
description This property is required. str
display_name This property is required. str
email This property is required. str
enabled This property is required. bool
eula This property is required. str
force_pwd_change This property is required. bool
group_ids This property is required. str
id This property is required. str
is_enabled This property is required. bool
is_locked This property is required. bool
language_code This property is required. str
local_login_disabled This property is required. bool
microtenant_id This property is required. str
microtenant_name This property is required. str
modified_time This property is required. int
modifiedby This property is required. int
name This property is required. str
  • (Required) Name of the microtenant controller.
password This property is required. str
phone_number This property is required. bool
pin_session This property is required. str
role_id This property is required. bool
timezone This property is required. str
tmp_password This property is required. str
token_id This property is required. str
two_factor_auth_enabled This property is required. bool
two_factor_auth_type This property is required. str
username This property is required. str
comments This property is required. String
creationTime This property is required. String
customerId This property is required. String
description This property is required. String
displayName This property is required. String
email This property is required. String
enabled This property is required. Boolean
eula This property is required. String
forcePwdChange This property is required. Boolean
groupIds This property is required. String
id This property is required. String
isEnabled This property is required. Boolean
isLocked This property is required. Boolean
languageCode This property is required. String
localLoginDisabled This property is required. Boolean
microtenantId This property is required. String
microtenantName This property is required. String
modifiedTime This property is required. Number
modifiedby This property is required. Number
name This property is required. String
  • (Required) Name of the microtenant controller.
password This property is required. String
phoneNumber This property is required. Boolean
pinSession This property is required. String
roleId This property is required. Boolean
timezone This property is required. String
tmpPassword This property is required. String
tokenId This property is required. String
twoFactorAuthEnabled This property is required. Boolean
twoFactorAuthType This property is required. String
username This property is required. String

Package Details

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