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

zpa.PRAPortal

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

    Example Usage

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

const thisBaCertificate = zpa.getBaCertificate({
    name: "portal.acme.com",
});
const thisPRAPortal = new zpa.PRAPortal("thisPRAPortal", {
    description: "portal.acme.com",
    enabled: true,
    domain: "portal.acme.com",
    certificateId: thisBaCertificate.then(thisBaCertificate => thisBaCertificate.id),
    userNotification: "Created with Terraform",
    userNotificationEnabled: true,
});

    import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa

this_ba_certificate = zpa.get_ba_certificate(name="portal.acme.com")
this_pra_portal = zpa.PRAPortal("thisPRAPortal",
    description="portal.acme.com",
    enabled=True,
    domain="portal.acme.com",
    certificate_id=this_ba_certificate.id,
    user_notification="Created with Terraform",
    user_notification_enabled=True)

    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 {
		thisBaCertificate, err := zpa.GetBaCertificate(ctx, &zpa.GetBaCertificateArgs{
			Name: pulumi.StringRef("portal.acme.com"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = zpa.NewPRAPortal(ctx, "thisPRAPortal", &zpa.PRAPortalArgs{
			Description:             pulumi.String("portal.acme.com"),
			Enabled:                 pulumi.Bool(true),
			Domain:                  pulumi.String("portal.acme.com"),
			CertificateId:           pulumi.String(thisBaCertificate.Id),
			UserNotification:        pulumi.String("Created with Terraform"),
			UserNotificationEnabled: pulumi.Bool(true),
		})
		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(() => 
{
    var thisBaCertificate = Zpa.GetBaCertificate.Invoke(new()
    {
        Name = "portal.acme.com",
    });

    var thisPRAPortal = new Zpa.PRAPortal("thisPRAPortal", new()
    {
        Description = "portal.acme.com",
        Enabled = true,
        Domain = "portal.acme.com",
        CertificateId = thisBaCertificate.Apply(getBaCertificateResult => getBaCertificateResult.Id),
        UserNotification = "Created with Terraform",
        UserNotificationEnabled = true,
    });

});

    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.GetBaCertificateArgs;
import com.pulumi.zpa.PRAPortal;
import com.pulumi.zpa.PRAPortalArgs;
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 thisBaCertificate = ZpaFunctions.getBaCertificate(GetBaCertificateArgs.builder()
            .name("portal.acme.com")
            .build());

        var thisPRAPortal = new PRAPortal("thisPRAPortal", PRAPortalArgs.builder()
            .description("portal.acme.com")
            .enabled(true)
            .domain("portal.acme.com")
            .certificateId(thisBaCertificate.applyValue(getBaCertificateResult -> getBaCertificateResult.id()))
            .userNotification("Created with Terraform")
            .userNotificationEnabled(true)
            .build());

    }
}

    resources:
  thisPRAPortal:
    type: zpa:PRAPortal
    properties:
      description: portal.acme.com
      enabled: true
      domain: portal.acme.com
      certificateId: ${thisBaCertificate.id}
      userNotification: Created with Terraform
      userNotificationEnabled: true
variables:
  thisBaCertificate:
    fn::invoke:
      Function: zpa:getBaCertificate
      Arguments:
        name: portal.acme.com

    Create PRAPortal Resource

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

    Constructor syntax

    new PRAPortal(name: string, args?: PRAPortalArgs, opts?: CustomResourceOptions);
    @overload
def PRAPortal(resource_name: str,
              args: Optional[PRAPortalArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def PRAPortal(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              certificate_id: Optional[str] = None,
              description: Optional[str] = None,
              domain: Optional[str] = None,
              enabled: Optional[bool] = None,
              microtenant_id: Optional[str] = None,
              name: Optional[str] = None,
              user_notification: Optional[str] = None,
              user_notification_enabled: Optional[bool] = None)
    func NewPRAPortal(ctx *Context, name string, args *PRAPortalArgs, opts ...ResourceOption) (*PRAPortal, error)
    public PRAPortal(string name, PRAPortalArgs? args = null, CustomResourceOptions? opts = null)
    public PRAPortal(String name, PRAPortalArgs args)
public PRAPortal(String name, PRAPortalArgs args, CustomResourceOptions options)

    type: zpa:PRAPortal
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 PRAPortalArgs
    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 PRAPortalArgs
    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 PRAPortalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PRAPortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PRAPortalArgs
    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 praportalResource = new Zpa.PRAPortal("praportalResource", new()
{
    CertificateId = "string",
    Description = "string",
    Domain = "string",
    Enabled = false,
    MicrotenantId = "string",
    Name = "string",
    UserNotification = "string",
    UserNotificationEnabled = false,
});

    example, err := zpa.NewPRAPortal(ctx, "praportalResource", &zpa.PRAPortalArgs{
	CertificateId:           pulumi.String("string"),
	Description:             pulumi.String("string"),
	Domain:                  pulumi.String("string"),
	Enabled:                 pulumi.Bool(false),
	MicrotenantId:           pulumi.String("string"),
	Name:                    pulumi.String("string"),
	UserNotification:        pulumi.String("string"),
	UserNotificationEnabled: pulumi.Bool(false),
})

    var praportalResource = new PRAPortal("praportalResource", PRAPortalArgs.builder()
    .certificateId("string")
    .description("string")
    .domain("string")
    .enabled(false)
    .microtenantId("string")
    .name("string")
    .userNotification("string")
    .userNotificationEnabled(false)
    .build());

    praportal_resource = zpa.PRAPortal("praportalResource",
    certificate_id="string",
    description="string",
    domain="string",
    enabled=False,
    microtenant_id="string",
    name="string",
    user_notification="string",
    user_notification_enabled=False)

    const praportalResource = new zpa.PRAPortal("praportalResource", {
    certificateId: "string",
    description: "string",
    domain: "string",
    enabled: false,
    microtenantId: "string",
    name: "string",
    userNotification: "string",
    userNotificationEnabled: false,
});

    type: zpa:PRAPortal
properties:
    certificateId: string
    description: string
    domain: string
    enabled: false
    microtenantId: string
    name: string
    userNotification: string
    userNotificationEnabled: false

    PRAPortal 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 PRAPortal resource accepts the following input properties:

    CertificateId string
    The unique identifier of the certificate
    Description string
    The description of the privileged portal
    Domain string
    The domain of the privileged portal
    Enabled bool
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    Name string
    The name of the privileged portal
    UserNotification string
    The notification message displayed in the banner of the privileged portallink, if enabled
    UserNotificationEnabled bool
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    CertificateId string
    The unique identifier of the certificate
    Description string
    The description of the privileged portal
    Domain string
    The domain of the privileged portal
    Enabled bool
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    Name string
    The name of the privileged portal
    UserNotification string
    The notification message displayed in the banner of the privileged portallink, if enabled
    UserNotificationEnabled bool
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificateId String
    The unique identifier of the certificate
    description String
    The description of the privileged portal
    domain String
    The domain of the privileged portal
    enabled Boolean
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name String
    The name of the privileged portal
    userNotification String
    The notification message displayed in the banner of the privileged portallink, if enabled
    userNotificationEnabled Boolean
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificateId string
    The unique identifier of the certificate
    description string
    The description of the privileged portal
    domain string
    The domain of the privileged portal
    enabled boolean
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name string
    The name of the privileged portal
    userNotification string
    The notification message displayed in the banner of the privileged portallink, if enabled
    userNotificationEnabled boolean
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificate_id str
    The unique identifier of the certificate
    description str
    The description of the privileged portal
    domain str
    The domain of the privileged portal
    enabled bool
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name str
    The name of the privileged portal
    user_notification str
    The notification message displayed in the banner of the privileged portallink, if enabled
    user_notification_enabled bool
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificateId String
    The unique identifier of the certificate
    description String
    The description of the privileged portal
    domain String
    The domain of the privileged portal
    enabled Boolean
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name String
    The name of the privileged portal
    userNotification String
    The notification message displayed in the banner of the privileged portallink, if enabled
    userNotificationEnabled Boolean
    Indicates if the Notification Banner is enabled (true) or disabled (false)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PRAPortal 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 PRAPortal Resource

    Get an existing PRAPortal 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?: PRAPortalState, opts?: CustomResourceOptions): PRAPortal
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_id: Optional[str] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        enabled: Optional[bool] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        user_notification: Optional[str] = None,
        user_notification_enabled: Optional[bool] = None) -> PRAPortal
    func GetPRAPortal(ctx *Context, name string, id IDInput, state *PRAPortalState, opts ...ResourceOption) (*PRAPortal, error)
    public static PRAPortal Get(string name, Input<string> id, PRAPortalState? state, CustomResourceOptions? opts = null)
    public static PRAPortal get(String name, Output<String> id, PRAPortalState 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:
    CertificateId string
    The unique identifier of the certificate
    Description string
    The description of the privileged portal
    Domain string
    The domain of the privileged portal
    Enabled bool
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    Name string
    The name of the privileged portal
    UserNotification string
    The notification message displayed in the banner of the privileged portallink, if enabled
    UserNotificationEnabled bool
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    CertificateId string
    The unique identifier of the certificate
    Description string
    The description of the privileged portal
    Domain string
    The domain of the privileged portal
    Enabled bool
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    Name string
    The name of the privileged portal
    UserNotification string
    The notification message displayed in the banner of the privileged portallink, if enabled
    UserNotificationEnabled bool
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificateId String
    The unique identifier of the certificate
    description String
    The description of the privileged portal
    domain String
    The domain of the privileged portal
    enabled Boolean
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name String
    The name of the privileged portal
    userNotification String
    The notification message displayed in the banner of the privileged portallink, if enabled
    userNotificationEnabled Boolean
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificateId string
    The unique identifier of the certificate
    description string
    The description of the privileged portal
    domain string
    The domain of the privileged portal
    enabled boolean
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name string
    The name of the privileged portal
    userNotification string
    The notification message displayed in the banner of the privileged portallink, if enabled
    userNotificationEnabled boolean
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificate_id str
    The unique identifier of the certificate
    description str
    The description of the privileged portal
    domain str
    The domain of the privileged portal
    enabled bool
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name str
    The name of the privileged portal
    user_notification str
    The notification message displayed in the banner of the privileged portallink, if enabled
    user_notification_enabled bool
    Indicates if the Notification Banner is enabled (true) or disabled (false)
    certificateId String
    The unique identifier of the certificate
    description String
    The description of the privileged portal
    domain String
    The domain of the privileged portal
    enabled Boolean
    Whether or not the privileged portal is enabled
    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. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
    name String
    The name of the privileged portal
    userNotification String
    The notification message displayed in the banner of the privileged portallink, if enabled
    userNotificationEnabled Boolean
    Indicates if the Notification Banner is enabled (true) or disabled (false)

    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_portal_controller can be imported by using <PORTAL ID> or <PORTAL NAME> as the import ID.

    For example:

    $ pulumi import zpa:index/pRAPortal:PRAPortal this <portal_id>

    or

    $ pulumi import zpa:index/pRAPortal:PRAPortal this <portal_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