Zscaler Private Access v0.0.11, May 4 24

Zscaler Private Access v0.0.11 published on Saturday, May 4, 2024 by Zscaler

zpa.PRAConsole

Explore with Pulumi AI

Zscaler Private Access v0.0.11 published on Saturday, May 4, 2024 by Zscaler

Create PRAConsole Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PRAConsole(name: string, args: PRAConsoleArgs, opts?: CustomResourceOptions);

@overload
def PRAConsole(resource_name: str,
               args: PRAConsoleArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def PRAConsole(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               pra_application: Optional[PRAConsolePraApplicationArgs] = None,
               pra_portals: Optional[Sequence[PRAConsolePraPortalArgs]] = None,
               description: Optional[str] = None,
               enabled: Optional[bool] = None,
               icon_text: Optional[str] = None,
               microtenant_id: Optional[str] = None,
               name: Optional[str] = None)

func NewPRAConsole(ctx *Context, name string, args PRAConsoleArgs, opts ...ResourceOption) (*PRAConsole, error)

public PRAConsole(string name, PRAConsoleArgs args, CustomResourceOptions? opts = null)

public PRAConsole(String name, PRAConsoleArgs args)
public PRAConsole(String name, PRAConsoleArgs args, CustomResourceOptions options)

type: zpa:PRAConsole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args PRAConsoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args PRAConsoleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PRAConsoleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PRAConsoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PRAConsoleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var praconsoleResource = new Zpa.PRAConsole("praconsoleResource", new()
{
    PraApplication = new Zpa.Inputs.PRAConsolePraApplicationArgs
    {
        Id = "string",
    },
    PraPortals = new[]
    {
        new Zpa.Inputs.PRAConsolePraPortalArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    Description = "string",
    Enabled = false,
    IconText = "string",
    MicrotenantId = "string",
    Name = "string",
});

example, err := zpa.NewPRAConsole(ctx, "praconsoleResource", &zpa.PRAConsoleArgs{
	PraApplication: &zpa.PRAConsolePraApplicationArgs{
		Id: pulumi.String("string"),
	},
	PraPortals: zpa.PRAConsolePraPortalArray{
		&zpa.PRAConsolePraPortalArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Description:   pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	IconText:      pulumi.String("string"),
	MicrotenantId: pulumi.String("string"),
	Name:          pulumi.String("string"),
})

var praconsoleResource = new PRAConsole("praconsoleResource", PRAConsoleArgs.builder()
    .praApplication(PRAConsolePraApplicationArgs.builder()
        .id("string")
        .build())
    .praPortals(PRAConsolePraPortalArgs.builder()
        .ids("string")
        .build())
    .description("string")
    .enabled(false)
    .iconText("string")
    .microtenantId("string")
    .name("string")
    .build());

praconsole_resource = zpa.PRAConsole("praconsoleResource",
    pra_application=zpa.PRAConsolePraApplicationArgs(
        id="string",
    ),
    pra_portals=[zpa.PRAConsolePraPortalArgs(
        ids=["string"],
    )],
    description="string",
    enabled=False,
    icon_text="string",
    microtenant_id="string",
    name="string")

const praconsoleResource = new zpa.PRAConsole("praconsoleResource", {
    praApplication: {
        id: "string",
    },
    praPortals: [{
        ids: ["string"],
    }],
    description: "string",
    enabled: false,
    iconText: "string",
    microtenantId: "string",
    name: "string",
});

type: zpa:PRAConsole
properties:
    description: string
    enabled: false
    iconText: string
    microtenantId: string
    name: string
    praApplication:
        id: string
    praPortals:
        - ids:
            - string

PRAConsole Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The PRAConsole resource accepts the following input properties:

PraApplication Zscaler.Zpa.Inputs.PRAConsolePraApplication
PraPortals List<Zscaler.Zpa.Inputs.PRAConsolePraPortal>
Description string: The description of the privileged console
Enabled bool: Whether or not the privileged console is enabled
IconText string: The privileged console icon. The icon image is converted to base64 encoded text format
MicrotenantId string: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Name string: The name of the privileged console

PraApplication PRAConsolePraApplicationArgs
PraPortals []PRAConsolePraPortalArgs
Description string: The description of the privileged console
Enabled bool: Whether or not the privileged console is enabled
IconText string: The privileged console icon. The icon image is converted to base64 encoded text format
MicrotenantId string: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Name string: The name of the privileged console

praApplication PRAConsolePraApplication
praPortals List<PRAConsolePraPortal>
description String: The description of the privileged console
enabled Boolean: Whether or not the privileged console is enabled
iconText String: The privileged console icon. The icon image is converted to base64 encoded text format
microtenantId String: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name String: The name of the privileged console

praApplication PRAConsolePraApplication
praPortals PRAConsolePraPortal[]
description string: The description of the privileged console
enabled boolean: Whether or not the privileged console is enabled
iconText string: The privileged console icon. The icon image is converted to base64 encoded text format
microtenantId string: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name string: The name of the privileged console

pra_application PRAConsolePraApplicationArgs
pra_portals Sequence[PRAConsolePraPortalArgs]
description str: The description of the privileged console
enabled bool: Whether or not the privileged console is enabled
icon_text str: The privileged console icon. The icon image is converted to base64 encoded text format
microtenant_id str: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name str: The name of the privileged console

praApplication Property Map
praPortals List<Property Map>
description String: The description of the privileged console
enabled Boolean: Whether or not the privileged console is enabled
iconText String: The privileged console icon. The icon image is converted to base64 encoded text format
microtenantId String: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name String: The name of the privileged console

Outputs

All input properties are implicitly available as output properties. Additionally, the PRAConsole resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing PRAConsole Resource

Get an existing PRAConsole resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PRAConsoleState, opts?: CustomResourceOptions): PRAConsole

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        icon_text: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        pra_application: Optional[PRAConsolePraApplicationArgs] = None,
        pra_portals: Optional[Sequence[PRAConsolePraPortalArgs]] = None) -> PRAConsole

func GetPRAConsole(ctx *Context, name string, id IDInput, state *PRAConsoleState, opts ...ResourceOption) (*PRAConsole, error)

public static PRAConsole Get(string name, Input<string> id, PRAConsoleState? state, CustomResourceOptions? opts = null)

public static PRAConsole get(String name, Output<String> id, PRAConsoleState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: The description of the privileged console
Enabled bool: Whether or not the privileged console is enabled
IconText string: The privileged console icon. The icon image is converted to base64 encoded text format
MicrotenantId string: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Name string: The name of the privileged console
PraApplication Zscaler.Zpa.Inputs.PRAConsolePraApplication
PraPortals List<Zscaler.Zpa.Inputs.PRAConsolePraPortal>

Description string: The description of the privileged console
Enabled bool: Whether or not the privileged console is enabled
IconText string: The privileged console icon. The icon image is converted to base64 encoded text format
MicrotenantId string: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
Name string: The name of the privileged console
PraApplication PRAConsolePraApplicationArgs
PraPortals []PRAConsolePraPortalArgs

description String: The description of the privileged console
enabled Boolean: Whether or not the privileged console is enabled
iconText String: The privileged console icon. The icon image is converted to base64 encoded text format
microtenantId String: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name String: The name of the privileged console
praApplication PRAConsolePraApplication
praPortals List<PRAConsolePraPortal>

description string: The description of the privileged console
enabled boolean: Whether or not the privileged console is enabled
iconText string: The privileged console icon. The icon image is converted to base64 encoded text format
microtenantId string: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name string: The name of the privileged console
praApplication PRAConsolePraApplication
praPortals PRAConsolePraPortal[]

description str: The description of the privileged console
enabled bool: Whether or not the privileged console is enabled
icon_text str: The privileged console icon. The icon image is converted to base64 encoded text format
microtenant_id str: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name str: The name of the privileged console
pra_application PRAConsolePraApplicationArgs
pra_portals Sequence[PRAConsolePraPortalArgs]

description String: The description of the privileged console
enabled Boolean: Whether or not the privileged console is enabled
iconText String: The privileged console icon. The icon image is converted to base64 encoded text format
microtenantId String: The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
name String: The name of the privileged console
praApplication Property Map
praPortals List<Property Map>

Supporting Types

PRAConsolePraApplication, PRAConsolePraApplicationArgs

Id string: The unique identifier of the Privileged Remote Access-enabled application

Id string: The unique identifier of the Privileged Remote Access-enabled application

id String: The unique identifier of the Privileged Remote Access-enabled application

id string: The unique identifier of the Privileged Remote Access-enabled application

id str: The unique identifier of the Privileged Remote Access-enabled application

id String: The unique identifier of the Privileged Remote Access-enabled application

PRAConsolePraPortal, PRAConsolePraPortalArgs

Ids List<string>: The unique identifier of the privileged portal

Ids []string: The unique identifier of the privileged portal

ids List<String>: The unique identifier of the privileged portal

ids string[]: The unique identifier of the privileged portal

ids Sequence[str]: The unique identifier of the privileged portal

ids List<String>: The unique identifier of the privileged portal

Import

Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language.

Visit

pra_credential_controller can be imported by using <CONSOLE ID> or <CONSOLE NAME> as the import ID.

For example:

$ pulumi import zpa:index/pRAConsole:PRAConsole this <console_id>

$ pulumi import zpa:index/pRAConsole:PRAConsole this <console_name>

To learn more about importing existing cloud resources, see Importing resources.

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.11 published on Saturday, May 4, 2024 by Zscaler

zscaler/pulumi-zpa

zpa.PRAConsole

On this page

On this page

Create PRAConsole Resource

Constructor syntax

Parameters

Constructor example

PRAConsole Resource Properties

Inputs

Outputs

Look up Existing PRAConsole Resource

Supporting Types

PRAConsolePraApplication, PRAConsolePraApplicationArgs

PRAConsolePraPortal, PRAConsolePraPortalArgs

Import

Package Details

On this page

On this page