1. Pulumi Registry
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. ApplicationSegment
  5. getApplicationSegmentPRA
zpa logo
Zscaler Private Access v0.0.4, Jan 30 23

zpa.ApplicationSegment.getApplicationSegmentPRA

Use the zpa_application_segment_pra data source to get information about an application segment for Privileged Remote Access in the Zscaler Private Access cloud. This resource can then be referenced in an access policy rule, access policy timeout rule, access policy client forwarding rule and inspection policy. This resource supports Privileged Remote Access for both RDP and SSH.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var @this = Zpa.ApplicationSegment.GetApplicationSegmentPRA.Invoke(new()
    {
        Name = "PRA_Example",
    });

});

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zpa/sdk/go/zpa/ApplicationSegment"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApplicationSegment.GetApplicationSegmentPRA(ctx, &applicationsegment.GetApplicationSegmentPRAArgs{
			Name: pulumi.StringRef("PRA_Example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ApplicationSegment.ApplicationSegmentFunctions;
import com.pulumi.zpa.ApplicationSegment.inputs.GetApplicationSegmentPRAArgs;
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 = ApplicationSegmentFunctions.getApplicationSegmentPRA(GetApplicationSegmentPRAArgs.builder()
            .name("PRA_Example")
            .build());

    }
}

import pulumi
import pulumi_zpa as zpa

this = zpa.ApplicationSegment.get_application_segment_pra(name="PRA_Example")

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

const this = zpa.ApplicationSegment.getApplicationSegmentPRA({
    name: "PRA_Example",
});

variables:
  this:
    fn::invoke:
      Function: zpa:ApplicationSegment:getApplicationSegmentPRA
      Arguments:
        name: PRA_Example

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

return await Deployment.RunAsync(() => 
{
    var @this = Zpa.ApplicationSegment.GetApplicationSegmentPRA.Invoke(new()
    {
        Id = "123456789",
    });

});

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zpa/sdk/go/zpa/ApplicationSegment"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApplicationSegment.GetApplicationSegmentPRA(ctx, &applicationsegment.GetApplicationSegmentPRAArgs{
			Id: pulumi.StringRef("123456789"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ApplicationSegment.ApplicationSegmentFunctions;
import com.pulumi.zpa.ApplicationSegment.inputs.GetApplicationSegmentPRAArgs;
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 = ApplicationSegmentFunctions.getApplicationSegmentPRA(GetApplicationSegmentPRAArgs.builder()
            .id("123456789")
            .build());

    }
}

import pulumi
import pulumi_zpa as zpa

this = zpa.ApplicationSegment.get_application_segment_pra(id="123456789")

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

const this = zpa.ApplicationSegment.getApplicationSegmentPRA({
    id: "123456789",
});

variables:
  this:
    fn::invoke:
      Function: zpa:ApplicationSegment:getApplicationSegmentPRA
      Arguments:
        id: '123456789'

Using getApplicationSegmentPRA

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 getApplicationSegmentPRA(args: GetApplicationSegmentPRAArgs, opts?: InvokeOptions): Promise<GetApplicationSegmentPRAResult>
function getApplicationSegmentPRAOutput(args: GetApplicationSegmentPRAOutputArgs, opts?: InvokeOptions): Output<GetApplicationSegmentPRAResult>
def get_application_segment_pra(id: Optional[str] = None,
                                name: Optional[str] = None,
                                tcp_port_ranges: Optional[Sequence[_applicationsegment.GetApplicationSegmentPRATcpPortRange]] = None,
                                udp_port_ranges: Optional[Sequence[_applicationsegment.GetApplicationSegmentPRAUdpPortRange]] = None,
                                opts: Optional[InvokeOptions] = None) -> GetApplicationSegmentPRAResult
def get_application_segment_pra_output(id: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[_applicationsegment.GetApplicationSegmentPRATcpPortRangeArgs]]]] = None,
                                udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[_applicationsegment.GetApplicationSegmentPRAUdpPortRangeArgs]]]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetApplicationSegmentPRAResult]
func GetApplicationSegmentPRA(ctx *Context, args *GetApplicationSegmentPRAArgs, opts ...InvokeOption) (*GetApplicationSegmentPRAResult, error)
func GetApplicationSegmentPRAOutput(ctx *Context, args *GetApplicationSegmentPRAOutputArgs, opts ...InvokeOption) GetApplicationSegmentPRAResultOutput

> Note: This function is named GetApplicationSegmentPRA in the Go SDK.

public static class GetApplicationSegmentPRA 
{
    public static Task<GetApplicationSegmentPRAResult> InvokeAsync(GetApplicationSegmentPRAArgs args, InvokeOptions? opts = null)
    public static Output<GetApplicationSegmentPRAResult> Invoke(GetApplicationSegmentPRAInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApplicationSegmentPRAResult> getApplicationSegmentPRA(GetApplicationSegmentPRAArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: zpa:ApplicationSegment/getApplicationSegmentPRA:getApplicationSegmentPRA
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Name string

The name of the PRA Application Segment to be exported.

TcpPortRanges List<zscaler.PulumiPackage.Zpa.ApplicationSegment.Inputs.GetApplicationSegmentPRATcpPortRange>

(string) TCP port ranges used to access the app.

  • from:
  • to:
UdpPortRanges List<zscaler.PulumiPackage.Zpa.ApplicationSegment.Inputs.GetApplicationSegmentPRAUdpPortRange>

(string) UDP port ranges used to access the app.

  • from:
  • to:
Id string
Name string

The name of the PRA Application Segment to be exported.

TcpPortRanges []GetApplicationSegmentPRATcpPortRange

(string) TCP port ranges used to access the app.

  • from:
  • to:
UdpPortRanges []GetApplicationSegmentPRAUdpPortRange

(string) UDP port ranges used to access the app.

  • from:
  • to:
id String
name String

The name of the PRA Application Segment to be exported.

tcpPortRanges List<GetPRATcpPortRange>

(string) TCP port ranges used to access the app.

  • from:
  • to:
udpPortRanges List<GetPRAUdpPortRange>

(string) UDP port ranges used to access the app.

  • from:
  • to:
id string
name string

The name of the PRA Application Segment to be exported.

tcpPortRanges GetApplicationSegmentPRATcpPortRange[]

(string) TCP port ranges used to access the app.

  • from:
  • to:
udpPortRanges GetApplicationSegmentPRAUdpPortRange[]

(string) UDP port ranges used to access the app.

  • from:
  • to:
id str
name str

The name of the PRA Application Segment to be exported.

tcp_port_ranges GetApplicationSegmentPRATcpPortRange]

(string) TCP port ranges used to access the app.

  • from:
  • to:
udp_port_ranges GetApplicationSegmentPRAUdpPortRange]

(string) UDP port ranges used to access the app.

  • from:
  • to:
id String
name String

The name of the PRA Application Segment to be exported.

tcpPortRanges List<Property Map>

(string) TCP port ranges used to access the app.

  • from:
  • to:
udpPortRanges List<Property Map>

(string) UDP port ranges used to access the app.

  • from:
  • to:

getApplicationSegmentPRA Result

The following output properties are available:

BypassType string

(string) Indicates whether users can bypass ZPA to access applications.

ConfigSpace string

(string)

Description string

(string) Description of the application.

DomainNames List<string>

(string) List of domains and IPs.

DoubleEncrypt bool

(bool) Whether Double Encryption is enabled or disabled for the app.

Enabled bool

(bool) Whether this application is enabled or not

HealthCheckType string

(string)

HealthReporting string

(string) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.

IpAnchored bool

(bool)

IsCnameEnabled bool

(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.

PassiveHealthEnabled bool

(bool)

SegmentGroupId string

(String) Segment Group IDs

SegmentGroupName string
ServerGroups List<zscaler.PulumiPackage.Zpa.ApplicationSegment.Outputs.GetApplicationSegmentPRAServerGroup>

(string) List of Server Group IDs

  • id: - (string) List of Server Group IDs
SraApps List<zscaler.PulumiPackage.Zpa.ApplicationSegment.Outputs.GetApplicationSegmentPRASraApp>

(string) TCP port ranges used to access the app.

  • app_id: - (string)
  • name: - (string) Name of the Privileged Remote Access
  • description: - (string) Description of the Privileged Remote Access
  • domain: - (string) Domain name of the Privileged Remote Access
TcpPortRanges List<string>

(string) TCP port ranges used to access the app.

UdpPortRanges List<string>

(string) UDP port ranges used to access the app.

Id string
Name string
BypassType string

(string) Indicates whether users can bypass ZPA to access applications.

ConfigSpace string

(string)

Description string

(string) Description of the application.

DomainNames []string

(string) List of domains and IPs.

DoubleEncrypt bool

(bool) Whether Double Encryption is enabled or disabled for the app.

Enabled bool

(bool) Whether this application is enabled or not

HealthCheckType string

(string)

HealthReporting string

(string) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.

IpAnchored bool

(bool)

IsCnameEnabled bool

(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.

PassiveHealthEnabled bool

(bool)

SegmentGroupId string

(String) Segment Group IDs

SegmentGroupName string
ServerGroups []GetApplicationSegmentPRAServerGroup

(string) List of Server Group IDs

  • id: - (string) List of Server Group IDs
SraApps []GetApplicationSegmentPRASraApp

(string) TCP port ranges used to access the app.

  • app_id: - (string)
  • name: - (string) Name of the Privileged Remote Access
  • description: - (string) Description of the Privileged Remote Access
  • domain: - (string) Domain name of the Privileged Remote Access
TcpPortRanges []string

(string) TCP port ranges used to access the app.

UdpPortRanges []string

(string) UDP port ranges used to access the app.

Id string
Name string
bypassType String

(string) Indicates whether users can bypass ZPA to access applications.

configSpace String

(string)

description String

(string) Description of the application.

domainNames List<String>

(string) List of domains and IPs.

doubleEncrypt Boolean

(bool) Whether Double Encryption is enabled or disabled for the app.

enabled Boolean

(bool) Whether this application is enabled or not

healthCheckType String

(string)

healthReporting String

(string) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.

ipAnchored Boolean

(bool)

isCnameEnabled Boolean

(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.

passiveHealthEnabled Boolean

(bool)

segmentGroupId String

(String) Segment Group IDs

segmentGroupName String
serverGroups List<GetPRAServerGroup>

(string) List of Server Group IDs

  • id: - (string) List of Server Group IDs
sraApps List<GetPRASraApp>

(string) TCP port ranges used to access the app.

  • app_id: - (string)
  • name: - (string) Name of the Privileged Remote Access
  • description: - (string) Description of the Privileged Remote Access
  • domain: - (string) Domain name of the Privileged Remote Access
tcpPortRanges List<String>

(string) TCP port ranges used to access the app.

udpPortRanges List<String>

(string) UDP port ranges used to access the app.

id String
name String
bypassType string

(string) Indicates whether users can bypass ZPA to access applications.

configSpace string

(string)

description string

(string) Description of the application.

domainNames string[]

(string) List of domains and IPs.

doubleEncrypt boolean

(bool) Whether Double Encryption is enabled or disabled for the app.

enabled boolean

(bool) Whether this application is enabled or not

healthCheckType string

(string)

healthReporting string

(string) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.

ipAnchored boolean

(bool)

isCnameEnabled boolean

(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.

passiveHealthEnabled boolean

(bool)

segmentGroupId string

(String) Segment Group IDs

segmentGroupName string
serverGroups GetApplicationSegmentPRAServerGroup[]

(string) List of Server Group IDs

  • id: - (string) List of Server Group IDs
sraApps GetApplicationSegmentPRASraApp[]

(string) TCP port ranges used to access the app.

  • app_id: - (string)
  • name: - (string) Name of the Privileged Remote Access
  • description: - (string) Description of the Privileged Remote Access
  • domain: - (string) Domain name of the Privileged Remote Access
tcpPortRanges string[]

(string) TCP port ranges used to access the app.

udpPortRanges string[]

(string) UDP port ranges used to access the app.

id string
name string
bypass_type str

(string) Indicates whether users can bypass ZPA to access applications.

config_space str

(string)

description str

(string) Description of the application.

domain_names Sequence[str]

(string) List of domains and IPs.

double_encrypt bool

(bool) Whether Double Encryption is enabled or disabled for the app.

enabled bool

(bool) Whether this application is enabled or not

health_check_type str

(string)

health_reporting str

(string) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.

ip_anchored bool

(bool)

is_cname_enabled bool

(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.

passive_health_enabled bool

(bool)

segment_group_id str

(String) Segment Group IDs

segment_group_name str
server_groups GetApplicationSegmentPRAServerGroup]

(string) List of Server Group IDs

  • id: - (string) List of Server Group IDs
sra_apps GetApplicationSegmentPRASraApp]

(string) TCP port ranges used to access the app.

  • app_id: - (string)
  • name: - (string) Name of the Privileged Remote Access
  • description: - (string) Description of the Privileged Remote Access
  • domain: - (string) Domain name of the Privileged Remote Access
tcp_port_ranges Sequence[str]

(string) TCP port ranges used to access the app.

udp_port_ranges Sequence[str]

(string) UDP port ranges used to access the app.

id str
name str
bypassType String

(string) Indicates whether users can bypass ZPA to access applications.

configSpace String

(string)

description String

(string) Description of the application.

domainNames List<String>

(string) List of domains and IPs.

doubleEncrypt Boolean

(bool) Whether Double Encryption is enabled or disabled for the app.

enabled Boolean

(bool) Whether this application is enabled or not

healthCheckType String

(string)

healthReporting String

(string) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.

ipAnchored Boolean

(bool)

isCnameEnabled Boolean

(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.

passiveHealthEnabled Boolean

(bool)

segmentGroupId String

(String) Segment Group IDs

segmentGroupName String
serverGroups List<Property Map>

(string) List of Server Group IDs

  • id: - (string) List of Server Group IDs
sraApps List<Property Map>

(string) TCP port ranges used to access the app.

  • app_id: - (string)
  • name: - (string) Name of the Privileged Remote Access
  • description: - (string) Description of the Privileged Remote Access
  • domain: - (string) Domain name of the Privileged Remote Access
tcpPortRanges List<String>

(string) TCP port ranges used to access the app.

udpPortRanges List<String>

(string) UDP port ranges used to access the app.

id String
name String

Supporting Types

GetApplicationSegmentPRAServerGroup

Ids List<string>
Ids []string
ids List<String>
ids string[]
ids Sequence[str]
ids List<String>

GetApplicationSegmentPRASraApp

AppId string
ApplicationPort string

(string) Port for the Privileged Remote Accessvalues: RDP and SSH

ApplicationProtocol string

(string) Protocol for the Privileged Remote Access. Supported values: RDP and SSH

CertificateId string
CertificateName string
ConnectionSecurity string

(string) - Parameter required when application_protocol is of type RDP

Description string

(string) Description of the application.

Domain string
Enabled bool

(bool) Whether this application is enabled or not

Hidden bool
Id string
Name string

The name of the PRA Application Segment to be exported.

Portal bool
AppId string
ApplicationPort string

(string) Port for the Privileged Remote Accessvalues: RDP and SSH

ApplicationProtocol string

(string) Protocol for the Privileged Remote Access. Supported values: RDP and SSH

CertificateId string
CertificateName string
ConnectionSecurity string

(string) - Parameter required when application_protocol is of type RDP

Description string

(string) Description of the application.

Domain string
Enabled bool

(bool) Whether this application is enabled or not

Hidden bool
Id string
Name string

The name of the PRA Application Segment to be exported.

Portal bool
appId String
applicationPort String

(string) Port for the Privileged Remote Accessvalues: RDP and SSH

applicationProtocol String

(string) Protocol for the Privileged Remote Access. Supported values: RDP and SSH

certificateId String
certificateName String
connectionSecurity String

(string) - Parameter required when application_protocol is of type RDP

description String

(string) Description of the application.

domain String
enabled Boolean

(bool) Whether this application is enabled or not

hidden Boolean
id String
name String

The name of the PRA Application Segment to be exported.

portal Boolean
appId string
applicationPort string

(string) Port for the Privileged Remote Accessvalues: RDP and SSH

applicationProtocol string

(string) Protocol for the Privileged Remote Access. Supported values: RDP and SSH

certificateId string
certificateName string
connectionSecurity string

(string) - Parameter required when application_protocol is of type RDP

description string

(string) Description of the application.

domain string
enabled boolean

(bool) Whether this application is enabled or not

hidden boolean
id string
name string

The name of the PRA Application Segment to be exported.

portal boolean
app_id str
application_port str

(string) Port for the Privileged Remote Accessvalues: RDP and SSH

application_protocol str

(string) Protocol for the Privileged Remote Access. Supported values: RDP and SSH

certificate_id str
certificate_name str
connection_security str

(string) - Parameter required when application_protocol is of type RDP

description str

(string) Description of the application.

domain str
enabled bool

(bool) Whether this application is enabled or not

hidden bool
id str
name str

The name of the PRA Application Segment to be exported.

portal bool
appId String
applicationPort String

(string) Port for the Privileged Remote Accessvalues: RDP and SSH

applicationProtocol String

(string) Protocol for the Privileged Remote Access. Supported values: RDP and SSH

certificateId String
certificateName String
connectionSecurity String

(string) - Parameter required when application_protocol is of type RDP

description String

(string) Description of the application.

domain String
enabled Boolean

(bool) Whether this application is enabled or not

hidden Boolean
id String
name String

The name of the PRA Application Segment to be exported.

portal Boolean

GetApplicationSegmentPRATcpPortRange

From string
To string
From string
To string
from String
to String
from string
to string
from_ str
to str
from String
to String

GetApplicationSegmentPRAUdpPortRange

From string
To string
From string
To string
from String
to String
from string
to string
from_ str
to str
from String
to String

Package Details

Repository
zpa zscaler/pulumi-zpa
License
MIT
Notes

This Pulumi package is based on the zpa Terraform Provider.