zpa.getMicrotenant
Explore with Pulumi AI
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:
getMicrotenant Result
The following output properties are available:
- Creation
Time string - Criteria
Attribute string - Criteria
Attribute List<string>Values - Description string
- Enabled bool
- Modified
By string - Modified
Time string - Operator string
- Priority string
- Roles
List<Zscaler.
Zpa. Outputs. Get Microtenant Role> - Users
List<Zscaler.
Zpa. Outputs. Get Microtenant User> - Id string
- Name string
- (Required) Name of the microtenant controller.
- Creation
Time string - Criteria
Attribute string - Criteria
Attribute []stringValues - Description string
- Enabled bool
- Modified
By string - Modified
Time string - Operator string
- Priority string
- Roles
[]Get
Microtenant Role - Users
[]Get
Microtenant User - Id string
- Name string
- (Required) Name of the microtenant controller.
- creation
Time String - criteria
Attribute String - criteria
Attribute List<String>Values - description String
- enabled Boolean
- modified
By String - modified
Time String - operator String
- priority String
- roles
List<Get
Microtenant Role> - users
List<Get
Microtenant User> - id String
- name String
- (Required) Name of the microtenant controller.
- creation
Time string - criteria
Attribute string - criteria
Attribute string[]Values - description string
- enabled boolean
- modified
By string - modified
Time string - operator string
- priority string
- roles
Get
Microtenant Role[] - users
Get
Microtenant User[] - id string
- name string
- (Required) Name of the microtenant controller.
- creation_
time str - criteria_
attribute str - criteria_
attribute_ Sequence[str]values - description str
- enabled bool
- modified_
by str - modified_
time str - operator str
- priority str
- roles
Sequence[Get
Microtenant Role] - users
Sequence[Get
Microtenant User] - id str
- name str
- (Required) Name of the microtenant controller.
- creation
Time String - criteria
Attribute String - criteria
Attribute List<String>Values - description String
- enabled Boolean
- modified
By String - modified
Time 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
- Custom
Role This property is required. bool - 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. string - Name
This property is required. string - (Required) Name of the microtenant controller.
- custom
Role 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. 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.
- custom
Role 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 - Creation
Time This property is required. string - Customer
Id This property is required. string - Description
This property is required. string - Display
Name This property is required. string - Email
This property is required. string - Enabled
This property is required. bool - Eula
This property is required. string - Force
Pwd Change This property is required. bool - Group
Ids This property is required. string - Id
This property is required. string - Is
Enabled This property is required. bool - Is
Locked This property is required. bool - Language
Code This property is required. string - Local
Login Disabled This property is required. bool - Microtenant
Id This property is required. string - Microtenant
Name This property is required. string - Modified
Time 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 - Phone
Number This property is required. bool - Pin
Session This property is required. string - Role
Id This property is required. bool - Timezone
This property is required. string - Tmp
Password This property is required. string - Token
Id This property is required. string - Two
Factor Auth Enabled This property is required. bool - Two
Factor Auth Type This property is required. string - Username
This property is required. string
- Comments
This property is required. string - Creation
Time This property is required. string - Customer
Id This property is required. string - Description
This property is required. string - Display
Name This property is required. string - Email
This property is required. string - Enabled
This property is required. bool - Eula
This property is required. string - Force
Pwd Change This property is required. bool - Group
Ids This property is required. string - Id
This property is required. string - Is
Enabled This property is required. bool - Is
Locked This property is required. bool - Language
Code This property is required. string - Local
Login Disabled This property is required. bool - Microtenant
Id This property is required. string - Microtenant
Name This property is required. string - Modified
Time 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 - Phone
Number This property is required. bool - Pin
Session This property is required. string - Role
Id This property is required. bool - Timezone
This property is required. string - Tmp
Password This property is required. string - Token
Id This property is required. string - Two
Factor Auth Enabled This property is required. bool - Two
Factor Auth Type This property is required. string - Username
This property is required. string
- comments
This property is required. String - creation
Time This property is required. String - customer
Id This property is required. String - description
This property is required. String - display
Name This property is required. String - email
This property is required. String - enabled
This property is required. Boolean - eula
This property is required. String - force
Pwd Change This property is required. Boolean - group
Ids This property is required. String - id
This property is required. String - is
Enabled This property is required. Boolean - is
Locked This property is required. Boolean - language
Code This property is required. String - local
Login Disabled This property is required. Boolean - microtenant
Id This property is required. String - microtenant
Name This property is required. String - modified
Time 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 - phone
Number This property is required. Boolean - pin
Session This property is required. String - role
Id This property is required. Boolean - timezone
This property is required. String - tmp
Password This property is required. String - token
Id This property is required. String - two
Factor Auth Enabled This property is required. Boolean - two
Factor Auth Type This property is required. String - username
This property is required. String
- comments
This property is required. string - creation
Time This property is required. string - customer
Id This property is required. string - description
This property is required. string - display
Name This property is required. string - email
This property is required. string - enabled
This property is required. boolean - eula
This property is required. string - force
Pwd Change This property is required. boolean - group
Ids This property is required. string - id
This property is required. string - is
Enabled This property is required. boolean - is
Locked This property is required. boolean - language
Code This property is required. string - local
Login Disabled This property is required. boolean - microtenant
Id This property is required. string - microtenant
Name This property is required. string - modified
Time 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 - phone
Number This property is required. boolean - pin
Session This property is required. string - role
Id This property is required. boolean - timezone
This property is required. string - tmp
Password This property is required. string - token
Id This property is required. string - two
Factor Auth Enabled This property is required. boolean - two
Factor Auth Type 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 - creation
Time This property is required. String - customer
Id This property is required. String - description
This property is required. String - display
Name This property is required. String - email
This property is required. String - enabled
This property is required. Boolean - eula
This property is required. String - force
Pwd Change This property is required. Boolean - group
Ids This property is required. String - id
This property is required. String - is
Enabled This property is required. Boolean - is
Locked This property is required. Boolean - language
Code This property is required. String - local
Login Disabled This property is required. Boolean - microtenant
Id This property is required. String - microtenant
Name This property is required. String - modified
Time 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 - phone
Number This property is required. Boolean - pin
Session This property is required. String - role
Id This property is required. Boolean - timezone
This property is required. String - tmp
Password This property is required. String - token
Id This property is required. String - two
Factor Auth Enabled This property is required. Boolean - two
Factor Auth Type 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.