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

zpa.PRAConsole

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_pra_console_controller resource creates a privileged remote access console in the Zscaler Private Access cloud. This resource can then be referenced in an privileged access policy resource and a privileged access portal.

    Example Usage

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

// Creates Segment Group for Application Segment"
const thisSegmentGroup = new zpa.SegmentGroup("thisSegmentGroup", {
    description: "Example",
    enabled: true,
});
// Creates Privileged Remote Access Application Segment"
const thisApplicationSegmentPRA = new zpa.ApplicationSegmentPRA("thisApplicationSegmentPRA", {
    description: "Example",
    enabled: true,
    healthReporting: "ON_ACCESS",
    bypassType: "NEVER",
    isCnameEnabled: true,
    tcpPortRanges: [
        "3389",
        "3389",
    ],
    domainNames: ["rdp_pra.example.com"],
    segmentGroupId: thisSegmentGroup.id,
    commonAppsDto: {
        appsConfigs: [{
            name: "rdp_pra",
            domain: "rdp_pra.example.com",
            applicationProtocol: "RDP",
            connectionSecurity: "ANY",
            applicationPort: "3389",
            enabled: true,
            appTypes: ["SECURE_REMOTE_ACCESS"],
        }],
    },
});
const thisApplicationSegmentByType = zpa.getApplicationSegmentByType({
    applicationType: "SECURE_REMOTE_ACCESS",
    name: "rdp_pra",
});
const thisBaCertificate = zpa.getBaCertificate({
    name: "pra01.example.com",
});
// Creates PRA Portal"
const this1 = new zpa.PRAPortal("this1", {
    description: "pra01.example.com",
    enabled: true,
    domain: "pra01.example.com",
    certificateId: thisBaCertificate.then(thisBaCertificate => thisBaCertificate.id),
    userNotification: "Created with Terraform",
    userNotificationEnabled: true,
});
const sshPra = new zpa.PRAConsole("sshPra", {
    description: "Created with Terraform",
    enabled: true,
    praApplication: {
        id: thisApplicationSegmentByType.then(thisApplicationSegmentByType => thisApplicationSegmentByType.id),
    },
    praPortals: [{
        ids: [zpa_pra_portal_controller["this"].id],
    }],
});

    import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa

# Creates Segment Group for Application Segment"
this_segment_group = zpa.SegmentGroup("thisSegmentGroup",
    description="Example",
    enabled=True)
# Creates Privileged Remote Access Application Segment"
this_application_segment_pra = zpa.ApplicationSegmentPRA("thisApplicationSegmentPRA",
    description="Example",
    enabled=True,
    health_reporting="ON_ACCESS",
    bypass_type="NEVER",
    is_cname_enabled=True,
    tcp_port_ranges=[
        "3389",
        "3389",
    ],
    domain_names=["rdp_pra.example.com"],
    segment_group_id=this_segment_group.id,
    common_apps_dto=zpa.ApplicationSegmentPRACommonAppsDtoArgs(
        apps_configs=[zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs(
            name="rdp_pra",
            domain="rdp_pra.example.com",
            application_protocol="RDP",
            connection_security="ANY",
            application_port="3389",
            enabled=True,
            app_types=["SECURE_REMOTE_ACCESS"],
        )],
    ))
this_application_segment_by_type = zpa.get_application_segment_by_type(application_type="SECURE_REMOTE_ACCESS",
    name="rdp_pra")
this_ba_certificate = zpa.get_ba_certificate(name="pra01.example.com")
# Creates PRA Portal"
this1 = zpa.PRAPortal("this1",
    description="pra01.example.com",
    enabled=True,
    domain="pra01.example.com",
    certificate_id=this_ba_certificate.id,
    user_notification="Created with Terraform",
    user_notification_enabled=True)
ssh_pra = zpa.PRAConsole("sshPra",
    description="Created with Terraform",
    enabled=True,
    pra_application=zpa.PRAConsolePraApplicationArgs(
        id=this_application_segment_by_type.id,
    ),
    pra_portals=[zpa.PRAConsolePraPortalArgs(
        ids=[zpa_pra_portal_controller["this"]["id"]],
    )])

    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 {
		// Creates Segment Group for Application Segment"
		thisSegmentGroup, err := zpa.NewSegmentGroup(ctx, "thisSegmentGroup", &zpa.SegmentGroupArgs{
			Description: pulumi.String("Example"),
			Enabled:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		// Creates Privileged Remote Access Application Segment"
		_, err = zpa.NewApplicationSegmentPRA(ctx, "thisApplicationSegmentPRA", &zpa.ApplicationSegmentPRAArgs{
			Description:     pulumi.String("Example"),
			Enabled:         pulumi.Bool(true),
			HealthReporting: pulumi.String("ON_ACCESS"),
			BypassType:      pulumi.String("NEVER"),
			IsCnameEnabled:  pulumi.Bool(true),
			TcpPortRanges: pulumi.StringArray{
				pulumi.String("3389"),
				pulumi.String("3389"),
			},
			DomainNames: pulumi.StringArray{
				pulumi.String("rdp_pra.example.com"),
			},
			SegmentGroupId: thisSegmentGroup.ID(),
			CommonAppsDto: &zpa.ApplicationSegmentPRACommonAppsDtoArgs{
				AppsConfigs: zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArray{
					&zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs{
						Name:                pulumi.String("rdp_pra"),
						Domain:              pulumi.String("rdp_pra.example.com"),
						ApplicationProtocol: pulumi.String("RDP"),
						ConnectionSecurity:  pulumi.String("ANY"),
						ApplicationPort:     pulumi.String("3389"),
						Enabled:             pulumi.Bool(true),
						AppTypes: pulumi.StringArray{
							pulumi.String("SECURE_REMOTE_ACCESS"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		thisApplicationSegmentByType, err := zpa.GetApplicationSegmentByType(ctx, &zpa.GetApplicationSegmentByTypeArgs{
			ApplicationType: "SECURE_REMOTE_ACCESS",
			Name:            pulumi.StringRef("rdp_pra"),
		}, nil)
		if err != nil {
			return err
		}
		thisBaCertificate, err := zpa.GetBaCertificate(ctx, &zpa.GetBaCertificateArgs{
			Name: pulumi.StringRef("pra01.example.com"),
		}, nil)
		if err != nil {
			return err
		}
		// Creates PRA Portal"
		_, err = zpa.NewPRAPortal(ctx, "this1", &zpa.PRAPortalArgs{
			Description:             pulumi.String("pra01.example.com"),
			Enabled:                 pulumi.Bool(true),
			Domain:                  pulumi.String("pra01.example.com"),
			CertificateId:           pulumi.String(thisBaCertificate.Id),
			UserNotification:        pulumi.String("Created with Terraform"),
			UserNotificationEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = zpa.NewPRAConsole(ctx, "sshPra", &zpa.PRAConsoleArgs{
			Description: pulumi.String("Created with Terraform"),
			Enabled:     pulumi.Bool(true),
			PraApplication: &zpa.PRAConsolePraApplicationArgs{
				Id: pulumi.String(thisApplicationSegmentByType.Id),
			},
			PraPortals: zpa.PRAConsolePraPortalArray{
				&zpa.PRAConsolePraPortalArgs{
					Ids: pulumi.StringArray{
						zpa_pra_portal_controller.This.Id,
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Creates Segment Group for Application Segment"
    var thisSegmentGroup = new Zpa.SegmentGroup("thisSegmentGroup", new()
    {
        Description = "Example",
        Enabled = true,
    });

    // Creates Privileged Remote Access Application Segment"
    var thisApplicationSegmentPRA = new Zpa.ApplicationSegmentPRA("thisApplicationSegmentPRA", new()
    {
        Description = "Example",
        Enabled = true,
        HealthReporting = "ON_ACCESS",
        BypassType = "NEVER",
        IsCnameEnabled = true,
        TcpPortRanges = new[]
        {
            "3389",
            "3389",
        },
        DomainNames = new[]
        {
            "rdp_pra.example.com",
        },
        SegmentGroupId = thisSegmentGroup.Id,
        CommonAppsDto = new Zpa.Inputs.ApplicationSegmentPRACommonAppsDtoArgs
        {
            AppsConfigs = new[]
            {
                new Zpa.Inputs.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs
                {
                    Name = "rdp_pra",
                    Domain = "rdp_pra.example.com",
                    ApplicationProtocol = "RDP",
                    ConnectionSecurity = "ANY",
                    ApplicationPort = "3389",
                    Enabled = true,
                    AppTypes = new[]
                    {
                        "SECURE_REMOTE_ACCESS",
                    },
                },
            },
        },
    });

    var thisApplicationSegmentByType = Zpa.GetApplicationSegmentByType.Invoke(new()
    {
        ApplicationType = "SECURE_REMOTE_ACCESS",
        Name = "rdp_pra",
    });

    var thisBaCertificate = Zpa.GetBaCertificate.Invoke(new()
    {
        Name = "pra01.example.com",
    });

    // Creates PRA Portal"
    var this1 = new Zpa.PRAPortal("this1", new()
    {
        Description = "pra01.example.com",
        Enabled = true,
        Domain = "pra01.example.com",
        CertificateId = thisBaCertificate.Apply(getBaCertificateResult => getBaCertificateResult.Id),
        UserNotification = "Created with Terraform",
        UserNotificationEnabled = true,
    });

    var sshPra = new Zpa.PRAConsole("sshPra", new()
    {
        Description = "Created with Terraform",
        Enabled = true,
        PraApplication = new Zpa.Inputs.PRAConsolePraApplicationArgs
        {
            Id = thisApplicationSegmentByType.Apply(getApplicationSegmentByTypeResult => getApplicationSegmentByTypeResult.Id),
        },
        PraPortals = new[]
        {
            new Zpa.Inputs.PRAConsolePraPortalArgs
            {
                Ids = new[]
                {
                    zpa_pra_portal_controller.This.Id,
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.SegmentGroup;
import com.pulumi.zpa.SegmentGroupArgs;
import com.pulumi.zpa.ApplicationSegmentPRA;
import com.pulumi.zpa.ApplicationSegmentPRAArgs;
import com.pulumi.zpa.inputs.ApplicationSegmentPRACommonAppsDtoArgs;
import com.pulumi.zpa.ZpaFunctions;
import com.pulumi.zpa.inputs.GetApplicationSegmentByTypeArgs;
import com.pulumi.zpa.inputs.GetBaCertificateArgs;
import com.pulumi.zpa.PRAPortal;
import com.pulumi.zpa.PRAPortalArgs;
import com.pulumi.zpa.PRAConsole;
import com.pulumi.zpa.PRAConsoleArgs;
import com.pulumi.zpa.inputs.PRAConsolePraApplicationArgs;
import com.pulumi.zpa.inputs.PRAConsolePraPortalArgs;
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) {
        // Creates Segment Group for Application Segment"
        var thisSegmentGroup = new SegmentGroup("thisSegmentGroup", SegmentGroupArgs.builder()
            .description("Example")
            .enabled(true)
            .build());

        // Creates Privileged Remote Access Application Segment"
        var thisApplicationSegmentPRA = new ApplicationSegmentPRA("thisApplicationSegmentPRA", ApplicationSegmentPRAArgs.builder()
            .description("Example")
            .enabled(true)
            .healthReporting("ON_ACCESS")
            .bypassType("NEVER")
            .isCnameEnabled(true)
            .tcpPortRanges(            
                "3389",
                "3389")
            .domainNames("rdp_pra.example.com")
            .segmentGroupId(thisSegmentGroup.id())
            .commonAppsDto(ApplicationSegmentPRACommonAppsDtoArgs.builder()
                .appsConfigs(ApplicationSegmentPRACommonAppsDtoAppsConfigArgs.builder()
                    .name("rdp_pra")
                    .domain("rdp_pra.example.com")
                    .applicationProtocol("RDP")
                    .connectionSecurity("ANY")
                    .applicationPort("3389")
                    .enabled(true)
                    .appTypes("SECURE_REMOTE_ACCESS")
                    .build())
                .build())
            .build());

        final var thisApplicationSegmentByType = ZpaFunctions.getApplicationSegmentByType(GetApplicationSegmentByTypeArgs.builder()
            .applicationType("SECURE_REMOTE_ACCESS")
            .name("rdp_pra")
            .build());

        final var thisBaCertificate = ZpaFunctions.getBaCertificate(GetBaCertificateArgs.builder()
            .name("pra01.example.com")
            .build());

        // Creates PRA Portal"
        var this1 = new PRAPortal("this1", PRAPortalArgs.builder()
            .description("pra01.example.com")
            .enabled(true)
            .domain("pra01.example.com")
            .certificateId(thisBaCertificate.applyValue(getBaCertificateResult -> getBaCertificateResult.id()))
            .userNotification("Created with Terraform")
            .userNotificationEnabled(true)
            .build());

        var sshPra = new PRAConsole("sshPra", PRAConsoleArgs.builder()
            .description("Created with Terraform")
            .enabled(true)
            .praApplication(PRAConsolePraApplicationArgs.builder()
                .id(thisApplicationSegmentByType.applyValue(getApplicationSegmentByTypeResult -> getApplicationSegmentByTypeResult.id()))
                .build())
            .praPortals(PRAConsolePraPortalArgs.builder()
                .ids(zpa_pra_portal_controller.this().id())
                .build())
            .build());

    }
}

    resources:
  # Creates Privileged Remote Access Application Segment"
  thisApplicationSegmentPRA:
    type: zpa:ApplicationSegmentPRA
    properties:
      description: Example
      enabled: true
      healthReporting: ON_ACCESS
      bypassType: NEVER
      isCnameEnabled: true
      tcpPortRanges:
        - '3389'
        - '3389'
      domainNames:
        - rdp_pra.example.com
      segmentGroupId: ${thisSegmentGroup.id}
      commonAppsDto:
        appsConfigs:
          - name: rdp_pra
            domain: rdp_pra.example.com
            applicationProtocol: RDP
            connectionSecurity: ANY
            applicationPort: '3389'
            enabled: true
            appTypes:
              - SECURE_REMOTE_ACCESS
  # Creates Segment Group for Application Segment"
  thisSegmentGroup:
    type: zpa:SegmentGroup
    properties:
      description: Example
      enabled: true
  # Creates PRA Portal"
  this1:
    type: zpa:PRAPortal
    properties:
      description: pra01.example.com
      enabled: true
      domain: pra01.example.com
      certificateId: ${thisBaCertificate.id}
      userNotification: Created with Terraform
      userNotificationEnabled: true
  sshPra:
    type: zpa:PRAConsole
    properties:
      description: Created with Terraform
      enabled: true
      praApplication:
        id: ${thisApplicationSegmentByType.id}
      praPortals:
        - ids:
            - ${zpa_pra_portal_controller.this.id}
variables:
  thisApplicationSegmentByType:
    fn::invoke:
      Function: zpa:getApplicationSegmentByType
      Arguments:
        applicationType: SECURE_REMOTE_ACCESS
        name: rdp_pra
  thisBaCertificate:
    fn::invoke:
      Function: zpa:getBaCertificate
      Arguments:
        name: pra01.example.com

    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={
        "id": "string",
    },
    pra_portals=[{
        "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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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>

    or

    $ 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.
    zpa logo
    Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zpa