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

zpa.ApplicationSegmentPRA

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_application_segment_pra resource creates 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

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

const _this = new zpa.ApplicationSegmentPRA("this", {
    description: "PRA_Example",
    enabled: true,
    healthReporting: "ON_ACCESS",
    bypassType: "NEVER",
    isCnameEnabled: true,
    tcpPortRanges: [
        "22",
        "22",
        "3389",
        "3389",
    ],
    domainNames: [
        "ssh_pra.example.com",
        "rdp_pra.example.com",
    ],
    segmentGroupId: zpa_segment_group["this"].id,
    serverGroups: [{
        ids: [zpa_server_group["this"].id],
    }],
    commonAppsDto: {
        appsConfigs: [
            {
                name: "ssh_pra",
                domain: "ssh_pra.example.com",
                applicationProtocol: "SSH",
                applicationPort: "22",
                enabled: true,
                appTypes: ["SECURE_REMOTE_ACCESS"],
            },
            {
                name: "rdp_pra",
                domain: "rdp_pra.example.com",
                applicationProtocol: "RDP",
                connectionSecurity: "ANY",
                applicationPort: "3389",
                enabled: true,
                appTypes: ["SECURE_REMOTE_ACCESS"],
            },
        ],
    },
});

    import pulumi
import zscaler_pulumi_zpa as zpa

this = zpa.ApplicationSegmentPRA("this",
    description="PRA_Example",
    enabled=True,
    health_reporting="ON_ACCESS",
    bypass_type="NEVER",
    is_cname_enabled=True,
    tcp_port_ranges=[
        "22",
        "22",
        "3389",
        "3389",
    ],
    domain_names=[
        "ssh_pra.example.com",
        "rdp_pra.example.com",
    ],
    segment_group_id=zpa_segment_group["this"]["id"],
    server_groups=[zpa.ApplicationSegmentPRAServerGroupArgs(
        ids=[zpa_server_group["this"]["id"]],
    )],
    common_apps_dto=zpa.ApplicationSegmentPRACommonAppsDtoArgs(
        apps_configs=[
            zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs(
                name="ssh_pra",
                domain="ssh_pra.example.com",
                application_protocol="SSH",
                application_port="22",
                enabled=True,
                app_types=["SECURE_REMOTE_ACCESS"],
            ),
            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"],
            ),
        ],
    ))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zpa.NewApplicationSegmentPRA(ctx, "this", &zpa.ApplicationSegmentPRAArgs{
			Description:     pulumi.String("PRA_Example"),
			Enabled:         pulumi.Bool(true),
			HealthReporting: pulumi.String("ON_ACCESS"),
			BypassType:      pulumi.String("NEVER"),
			IsCnameEnabled:  pulumi.Bool(true),
			TcpPortRanges: pulumi.StringArray{
				pulumi.String("22"),
				pulumi.String("22"),
				pulumi.String("3389"),
				pulumi.String("3389"),
			},
			DomainNames: pulumi.StringArray{
				pulumi.String("ssh_pra.example.com"),
				pulumi.String("rdp_pra.example.com"),
			},
			SegmentGroupId: pulumi.Any(zpa_segment_group.This.Id),
			ServerGroups: zpa.ApplicationSegmentPRAServerGroupArray{
				&zpa.ApplicationSegmentPRAServerGroupArgs{
					Ids: pulumi.StringArray{
						zpa_server_group.This.Id,
					},
				},
			},
			CommonAppsDto: &zpa.ApplicationSegmentPRACommonAppsDtoArgs{
				AppsConfigs: zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArray{
					&zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs{
						Name:                pulumi.String("ssh_pra"),
						Domain:              pulumi.String("ssh_pra.example.com"),
						ApplicationProtocol: pulumi.String("SSH"),
						ApplicationPort:     pulumi.String("22"),
						Enabled:             pulumi.Bool(true),
						AppTypes: pulumi.StringArray{
							pulumi.String("SECURE_REMOTE_ACCESS"),
						},
					},
					&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
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = new Zpa.ApplicationSegmentPRA("this", new()
    {
        Description = "PRA_Example",
        Enabled = true,
        HealthReporting = "ON_ACCESS",
        BypassType = "NEVER",
        IsCnameEnabled = true,
        TcpPortRanges = new[]
        {
            "22",
            "22",
            "3389",
            "3389",
        },
        DomainNames = new[]
        {
            "ssh_pra.example.com",
            "rdp_pra.example.com",
        },
        SegmentGroupId = zpa_segment_group.This.Id,
        ServerGroups = new[]
        {
            new Zpa.Inputs.ApplicationSegmentPRAServerGroupArgs
            {
                Ids = new[]
                {
                    zpa_server_group.This.Id,
                },
            },
        },
        CommonAppsDto = new Zpa.Inputs.ApplicationSegmentPRACommonAppsDtoArgs
        {
            AppsConfigs = new[]
            {
                new Zpa.Inputs.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs
                {
                    Name = "ssh_pra",
                    Domain = "ssh_pra.example.com",
                    ApplicationProtocol = "SSH",
                    ApplicationPort = "22",
                    Enabled = true,
                    AppTypes = new[]
                    {
                        "SECURE_REMOTE_ACCESS",
                    },
                },
                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",
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ApplicationSegmentPRA;
import com.pulumi.zpa.ApplicationSegmentPRAArgs;
import com.pulumi.zpa.inputs.ApplicationSegmentPRAServerGroupArgs;
import com.pulumi.zpa.inputs.ApplicationSegmentPRACommonAppsDtoArgs;
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) {
        var this_ = new ApplicationSegmentPRA("this", ApplicationSegmentPRAArgs.builder()
            .description("PRA_Example")
            .enabled(true)
            .healthReporting("ON_ACCESS")
            .bypassType("NEVER")
            .isCnameEnabled(true)
            .tcpPortRanges(            
                "22",
                "22",
                "3389",
                "3389")
            .domainNames(            
                "ssh_pra.example.com",
                "rdp_pra.example.com")
            .segmentGroupId(zpa_segment_group.this().id())
            .serverGroups(ApplicationSegmentPRAServerGroupArgs.builder()
                .ids(zpa_server_group.this().id())
                .build())
            .commonAppsDto(ApplicationSegmentPRACommonAppsDtoArgs.builder()
                .appsConfigs(                
                    ApplicationSegmentPRACommonAppsDtoAppsConfigArgs.builder()
                        .name("ssh_pra")
                        .domain("ssh_pra.example.com")
                        .applicationProtocol("SSH")
                        .applicationPort("22")
                        .enabled(true)
                        .appTypes("SECURE_REMOTE_ACCESS")
                        .build(),
                    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());

    }
}

    resources:
  this:
    type: zpa:ApplicationSegmentPRA
    properties:
      description: PRA_Example
      enabled: true
      healthReporting: ON_ACCESS
      bypassType: NEVER
      isCnameEnabled: true
      tcpPortRanges:
        - '22'
        - '22'
        - '3389'
        - '3389'
      domainNames:
        - ssh_pra.example.com
        - rdp_pra.example.com
      segmentGroupId: ${zpa_segment_group.this.id}
      serverGroups:
        - ids:
            - ${zpa_server_group.this.id}
      commonAppsDto:
        appsConfigs:
          - name: ssh_pra
            domain: ssh_pra.example.com
            applicationProtocol: SSH
            applicationPort: '22'
            enabled: true
            appTypes:
              - SECURE_REMOTE_ACCESS
          - name: rdp_pra
            domain: rdp_pra.example.com
            applicationProtocol: RDP
            connectionSecurity: ANY
            applicationPort: '3389'
            enabled: true
            appTypes:
              - SECURE_REMOTE_ACCESS

    Create ApplicationSegmentPRA Resource

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

    Constructor syntax

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

@overload
def ApplicationSegmentPRA(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          domain_names: Optional[Sequence[str]] = None,
                          segment_group_id: Optional[str] = None,
                          is_incomplete_dr_config: Optional[bool] = None,
                          use_in_dr_mode: Optional[bool] = None,
                          bypass_type: Optional[str] = None,
                          double_encrypt: Optional[bool] = None,
                          enabled: Optional[bool] = None,
                          health_check_type: Optional[str] = None,
                          health_reporting: Optional[str] = None,
                          icmp_access_type: Optional[str] = None,
                          ip_anchored: Optional[bool] = None,
                          name: Optional[str] = None,
                          config_space: Optional[str] = None,
                          description: Optional[str] = None,
                          is_cname_enabled: Optional[bool] = None,
                          passive_health_enabled: Optional[bool] = None,
                          common_apps_dto: Optional[ApplicationSegmentPRACommonAppsDtoArgs] = None,
                          select_connector_close_to_app: Optional[bool] = None,
                          server_groups: Optional[Sequence[ApplicationSegmentPRAServerGroupArgs]] = None,
                          tcp_keep_alive: Optional[str] = None,
                          tcp_port_range: Optional[Sequence[ApplicationSegmentPRATcpPortRangeArgs]] = None,
                          tcp_port_ranges: Optional[Sequence[str]] = None,
                          udp_port_range: Optional[Sequence[ApplicationSegmentPRAUdpPortRangeArgs]] = None,
                          udp_port_ranges: Optional[Sequence[str]] = None,
                          match_style: Optional[str] = None)
    func NewApplicationSegmentPRA(ctx *Context, name string, args ApplicationSegmentPRAArgs, opts ...ResourceOption) (*ApplicationSegmentPRA, error)
    public ApplicationSegmentPRA(string name, ApplicationSegmentPRAArgs args, CustomResourceOptions? opts = null)
    public ApplicationSegmentPRA(String name, ApplicationSegmentPRAArgs args)
public ApplicationSegmentPRA(String name, ApplicationSegmentPRAArgs args, CustomResourceOptions options)

    type: zpa:ApplicationSegmentPRA
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 ApplicationSegmentPRAArgs
    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 ApplicationSegmentPRAArgs
    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 ApplicationSegmentPRAArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationSegmentPRAArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationSegmentPRAArgs
    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 applicationSegmentPRAResource = new Zpa.ApplicationSegmentPRA("applicationSegmentPRAResource", new()
{
    DomainNames = new[]
    {
        "string",
    },
    SegmentGroupId = "string",
    IsIncompleteDrConfig = false,
    UseInDrMode = false,
    BypassType = "string",
    DoubleEncrypt = false,
    Enabled = false,
    HealthCheckType = "string",
    HealthReporting = "string",
    IcmpAccessType = "string",
    IpAnchored = false,
    Name = "string",
    ConfigSpace = "string",
    Description = "string",
    IsCnameEnabled = false,
    PassiveHealthEnabled = false,
    CommonAppsDto = new Zpa.Inputs.ApplicationSegmentPRACommonAppsDtoArgs
    {
        AppsConfigs = new[]
        {
            new Zpa.Inputs.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs
            {
                AppTypes = new[]
                {
                    "string",
                },
                ApplicationPort = "string",
                ApplicationProtocol = "string",
                ConnectionSecurity = "string",
                Domain = "string",
                Enabled = false,
                Id = "string",
                Name = "string",
            },
        },
    },
    SelectConnectorCloseToApp = false,
    ServerGroups = new[]
    {
        new Zpa.Inputs.ApplicationSegmentPRAServerGroupArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    TcpKeepAlive = "string",
    TcpPortRange = new[]
    {
        new Zpa.Inputs.ApplicationSegmentPRATcpPortRangeArgs
        {
            From = "string",
            To = "string",
        },
    },
    TcpPortRanges = new[]
    {
        "string",
    },
    UdpPortRange = new[]
    {
        new Zpa.Inputs.ApplicationSegmentPRAUdpPortRangeArgs
        {
            From = "string",
            To = "string",
        },
    },
    UdpPortRanges = new[]
    {
        "string",
    },
    MatchStyle = "string",
});

    example, err := zpa.NewApplicationSegmentPRA(ctx, "applicationSegmentPRAResource", &zpa.ApplicationSegmentPRAArgs{
	DomainNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	SegmentGroupId:       pulumi.String("string"),
	IsIncompleteDrConfig: pulumi.Bool(false),
	UseInDrMode:          pulumi.Bool(false),
	BypassType:           pulumi.String("string"),
	DoubleEncrypt:        pulumi.Bool(false),
	Enabled:              pulumi.Bool(false),
	HealthCheckType:      pulumi.String("string"),
	HealthReporting:      pulumi.String("string"),
	IcmpAccessType:       pulumi.String("string"),
	IpAnchored:           pulumi.Bool(false),
	Name:                 pulumi.String("string"),
	ConfigSpace:          pulumi.String("string"),
	Description:          pulumi.String("string"),
	IsCnameEnabled:       pulumi.Bool(false),
	PassiveHealthEnabled: pulumi.Bool(false),
	CommonAppsDto: &zpa.ApplicationSegmentPRACommonAppsDtoArgs{
		AppsConfigs: zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArray{
			&zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs{
				AppTypes: pulumi.StringArray{
					pulumi.String("string"),
				},
				ApplicationPort:     pulumi.String("string"),
				ApplicationProtocol: pulumi.String("string"),
				ConnectionSecurity:  pulumi.String("string"),
				Domain:              pulumi.String("string"),
				Enabled:             pulumi.Bool(false),
				Id:                  pulumi.String("string"),
				Name:                pulumi.String("string"),
			},
		},
	},
	SelectConnectorCloseToApp: pulumi.Bool(false),
	ServerGroups: zpa.ApplicationSegmentPRAServerGroupArray{
		&zpa.ApplicationSegmentPRAServerGroupArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	TcpKeepAlive: pulumi.String("string"),
	TcpPortRange: zpa.ApplicationSegmentPRATcpPortRangeArray{
		&zpa.ApplicationSegmentPRATcpPortRangeArgs{
			From: pulumi.String("string"),
			To:   pulumi.String("string"),
		},
	},
	TcpPortRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	UdpPortRange: zpa.ApplicationSegmentPRAUdpPortRangeArray{
		&zpa.ApplicationSegmentPRAUdpPortRangeArgs{
			From: pulumi.String("string"),
			To:   pulumi.String("string"),
		},
	},
	UdpPortRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	MatchStyle: pulumi.String("string"),
})

    var applicationSegmentPRAResource = new ApplicationSegmentPRA("applicationSegmentPRAResource", ApplicationSegmentPRAArgs.builder()
    .domainNames("string")
    .segmentGroupId("string")
    .isIncompleteDrConfig(false)
    .useInDrMode(false)
    .bypassType("string")
    .doubleEncrypt(false)
    .enabled(false)
    .healthCheckType("string")
    .healthReporting("string")
    .icmpAccessType("string")
    .ipAnchored(false)
    .name("string")
    .configSpace("string")
    .description("string")
    .isCnameEnabled(false)
    .passiveHealthEnabled(false)
    .commonAppsDto(ApplicationSegmentPRACommonAppsDtoArgs.builder()
        .appsConfigs(ApplicationSegmentPRACommonAppsDtoAppsConfigArgs.builder()
            .appTypes("string")
            .applicationPort("string")
            .applicationProtocol("string")
            .connectionSecurity("string")
            .domain("string")
            .enabled(false)
            .id("string")
            .name("string")
            .build())
        .build())
    .selectConnectorCloseToApp(false)
    .serverGroups(ApplicationSegmentPRAServerGroupArgs.builder()
        .ids("string")
        .build())
    .tcpKeepAlive("string")
    .tcpPortRange(ApplicationSegmentPRATcpPortRangeArgs.builder()
        .from("string")
        .to("string")
        .build())
    .tcpPortRanges("string")
    .udpPortRange(ApplicationSegmentPRAUdpPortRangeArgs.builder()
        .from("string")
        .to("string")
        .build())
    .udpPortRanges("string")
    .matchStyle("string")
    .build());

    application_segment_pra_resource = zpa.ApplicationSegmentPRA("applicationSegmentPRAResource",
    domain_names=["string"],
    segment_group_id="string",
    is_incomplete_dr_config=False,
    use_in_dr_mode=False,
    bypass_type="string",
    double_encrypt=False,
    enabled=False,
    health_check_type="string",
    health_reporting="string",
    icmp_access_type="string",
    ip_anchored=False,
    name="string",
    config_space="string",
    description="string",
    is_cname_enabled=False,
    passive_health_enabled=False,
    common_apps_dto=zpa.ApplicationSegmentPRACommonAppsDtoArgs(
        apps_configs=[zpa.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs(
            app_types=["string"],
            application_port="string",
            application_protocol="string",
            connection_security="string",
            domain="string",
            enabled=False,
            id="string",
            name="string",
        )],
    ),
    select_connector_close_to_app=False,
    server_groups=[zpa.ApplicationSegmentPRAServerGroupArgs(
        ids=["string"],
    )],
    tcp_keep_alive="string",
    tcp_port_range=[zpa.ApplicationSegmentPRATcpPortRangeArgs(
        from_="string",
        to="string",
    )],
    tcp_port_ranges=["string"],
    udp_port_range=[zpa.ApplicationSegmentPRAUdpPortRangeArgs(
        from_="string",
        to="string",
    )],
    udp_port_ranges=["string"],
    match_style="string")

    const applicationSegmentPRAResource = new zpa.ApplicationSegmentPRA("applicationSegmentPRAResource", {
    domainNames: ["string"],
    segmentGroupId: "string",
    isIncompleteDrConfig: false,
    useInDrMode: false,
    bypassType: "string",
    doubleEncrypt: false,
    enabled: false,
    healthCheckType: "string",
    healthReporting: "string",
    icmpAccessType: "string",
    ipAnchored: false,
    name: "string",
    configSpace: "string",
    description: "string",
    isCnameEnabled: false,
    passiveHealthEnabled: false,
    commonAppsDto: {
        appsConfigs: [{
            appTypes: ["string"],
            applicationPort: "string",
            applicationProtocol: "string",
            connectionSecurity: "string",
            domain: "string",
            enabled: false,
            id: "string",
            name: "string",
        }],
    },
    selectConnectorCloseToApp: false,
    serverGroups: [{
        ids: ["string"],
    }],
    tcpKeepAlive: "string",
    tcpPortRange: [{
        from: "string",
        to: "string",
    }],
    tcpPortRanges: ["string"],
    udpPortRange: [{
        from: "string",
        to: "string",
    }],
    udpPortRanges: ["string"],
    matchStyle: "string",
});

    type: zpa:ApplicationSegmentPRA
properties:
    bypassType: string
    commonAppsDto:
        appsConfigs:
            - appTypes:
                - string
              applicationPort: string
              applicationProtocol: string
              connectionSecurity: string
              domain: string
              enabled: false
              id: string
              name: string
    configSpace: string
    description: string
    domainNames:
        - string
    doubleEncrypt: false
    enabled: false
    healthCheckType: string
    healthReporting: string
    icmpAccessType: string
    ipAnchored: false
    isCnameEnabled: false
    isIncompleteDrConfig: false
    matchStyle: string
    name: string
    passiveHealthEnabled: false
    segmentGroupId: string
    selectConnectorCloseToApp: false
    serverGroups:
        - ids:
            - string
    tcpKeepAlive: string
    tcpPortRange:
        - from: string
          to: string
    tcpPortRanges:
        - string
    udpPortRange:
        - from: string
          to: string
    udpPortRanges:
        - string
    useInDrMode: false

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

    DomainNames List<string>
    List of domains and IPs.
    SegmentGroupId string
    BypassType string
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    CommonAppsDto Zscaler.Zpa.Inputs.ApplicationSegmentPRACommonAppsDto
    ConfigSpace string
    Description string
    Description of the application.
    DoubleEncrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    Enabled bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    IpAnchored bool
    IsCnameEnabled bool
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    IsIncompleteDrConfig bool
    MatchStyle string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SelectConnectorCloseToApp bool
    ServerGroups List<Zscaler.Zpa.Inputs.ApplicationSegmentPRAServerGroup>
    List of the server group IDs.
    TcpKeepAlive string
    TcpPortRange List<Zscaler.Zpa.Inputs.ApplicationSegmentPRATcpPortRange>
    tcp port range
    TcpPortRanges List<string>
    TCP port ranges used to access the app.
    UdpPortRange List<Zscaler.Zpa.Inputs.ApplicationSegmentPRAUdpPortRange>
    udp port range
    UdpPortRanges List<string>
    UDP port ranges used to access the app.
    UseInDrMode bool
    DomainNames []string
    List of domains and IPs.
    SegmentGroupId string
    BypassType string
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    CommonAppsDto ApplicationSegmentPRACommonAppsDtoArgs
    ConfigSpace string
    Description string
    Description of the application.
    DoubleEncrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    Enabled bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    IpAnchored bool
    IsCnameEnabled bool
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    IsIncompleteDrConfig bool
    MatchStyle string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SelectConnectorCloseToApp bool
    ServerGroups []ApplicationSegmentPRAServerGroupArgs
    List of the server group IDs.
    TcpKeepAlive string
    TcpPortRange []ApplicationSegmentPRATcpPortRangeArgs
    tcp port range
    TcpPortRanges []string
    TCP port ranges used to access the app.
    UdpPortRange []ApplicationSegmentPRAUdpPortRangeArgs
    udp port range
    UdpPortRanges []string
    UDP port ranges used to access the app.
    UseInDrMode bool
    domainNames List<String>
    List of domains and IPs.
    segmentGroupId String
    bypassType String
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    commonAppsDto ApplicationSegmentPRACommonAppsDto
    configSpace String
    description String
    Description of the application.
    doubleEncrypt Boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    ipAnchored Boolean
    isCnameEnabled Boolean
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    isIncompleteDrConfig Boolean
    matchStyle String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    selectConnectorCloseToApp Boolean
    serverGroups List<ApplicationSegmentPRAServerGroup>
    List of the server group IDs.
    tcpKeepAlive String
    tcpPortRange List<ApplicationSegmentPRATcpPortRange>
    tcp port range
    tcpPortRanges List<String>
    TCP port ranges used to access the app.
    udpPortRange List<ApplicationSegmentPRAUdpPortRange>
    udp port range
    udpPortRanges List<String>
    UDP port ranges used to access the app.
    useInDrMode Boolean
    domainNames string[]
    List of domains and IPs.
    segmentGroupId string
    bypassType string
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    commonAppsDto ApplicationSegmentPRACommonAppsDto
    configSpace string
    description string
    Description of the application.
    doubleEncrypt boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled boolean
    healthCheckType string
    healthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType string
    ipAnchored boolean
    isCnameEnabled boolean
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    isIncompleteDrConfig boolean
    matchStyle string
    name string
    Name of the application.
    passiveHealthEnabled boolean
    selectConnectorCloseToApp boolean
    serverGroups ApplicationSegmentPRAServerGroup[]
    List of the server group IDs.
    tcpKeepAlive string
    tcpPortRange ApplicationSegmentPRATcpPortRange[]
    tcp port range
    tcpPortRanges string[]
    TCP port ranges used to access the app.
    udpPortRange ApplicationSegmentPRAUdpPortRange[]
    udp port range
    udpPortRanges string[]
    UDP port ranges used to access the app.
    useInDrMode boolean
    domain_names Sequence[str]
    List of domains and IPs.
    segment_group_id str
    bypass_type str
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    common_apps_dto ApplicationSegmentPRACommonAppsDtoArgs
    config_space str
    description str
    Description of the application.
    double_encrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    enabled bool
    health_check_type str
    health_reporting str
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmp_access_type str
    ip_anchored bool
    is_cname_enabled bool
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    is_incomplete_dr_config bool
    match_style str
    name str
    Name of the application.
    passive_health_enabled bool
    select_connector_close_to_app bool
    server_groups Sequence[ApplicationSegmentPRAServerGroupArgs]
    List of the server group IDs.
    tcp_keep_alive str
    tcp_port_range Sequence[ApplicationSegmentPRATcpPortRangeArgs]
    tcp port range
    tcp_port_ranges Sequence[str]
    TCP port ranges used to access the app.
    udp_port_range Sequence[ApplicationSegmentPRAUdpPortRangeArgs]
    udp port range
    udp_port_ranges Sequence[str]
    UDP port ranges used to access the app.
    use_in_dr_mode bool
    domainNames List<String>
    List of domains and IPs.
    segmentGroupId String
    bypassType String
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    commonAppsDto Property Map
    configSpace String
    description String
    Description of the application.
    doubleEncrypt Boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    ipAnchored Boolean
    isCnameEnabled Boolean
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    isIncompleteDrConfig Boolean
    matchStyle String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    selectConnectorCloseToApp Boolean
    serverGroups List<Property Map>
    List of the server group IDs.
    tcpKeepAlive String
    tcpPortRange List<Property Map>
    tcp port range
    tcpPortRanges List<String>
    TCP port ranges used to access the app.
    udpPortRange List<Property Map>
    udp port range
    udpPortRanges List<String>
    UDP port ranges used to access the app.
    useInDrMode Boolean

    Outputs

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

    Get an existing ApplicationSegmentPRA 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?: ApplicationSegmentPRAState, opts?: CustomResourceOptions): ApplicationSegmentPRA
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bypass_type: Optional[str] = None,
        common_apps_dto: Optional[ApplicationSegmentPRACommonAppsDtoArgs] = None,
        config_space: Optional[str] = None,
        description: Optional[str] = None,
        domain_names: Optional[Sequence[str]] = None,
        double_encrypt: Optional[bool] = None,
        enabled: Optional[bool] = None,
        health_check_type: Optional[str] = None,
        health_reporting: Optional[str] = None,
        icmp_access_type: Optional[str] = None,
        ip_anchored: Optional[bool] = None,
        is_cname_enabled: Optional[bool] = None,
        is_incomplete_dr_config: Optional[bool] = None,
        match_style: Optional[str] = None,
        name: Optional[str] = None,
        passive_health_enabled: Optional[bool] = None,
        segment_group_id: Optional[str] = None,
        select_connector_close_to_app: Optional[bool] = None,
        server_groups: Optional[Sequence[ApplicationSegmentPRAServerGroupArgs]] = None,
        tcp_keep_alive: Optional[str] = None,
        tcp_port_range: Optional[Sequence[ApplicationSegmentPRATcpPortRangeArgs]] = None,
        tcp_port_ranges: Optional[Sequence[str]] = None,
        udp_port_range: Optional[Sequence[ApplicationSegmentPRAUdpPortRangeArgs]] = None,
        udp_port_ranges: Optional[Sequence[str]] = None,
        use_in_dr_mode: Optional[bool] = None) -> ApplicationSegmentPRA
    func GetApplicationSegmentPRA(ctx *Context, name string, id IDInput, state *ApplicationSegmentPRAState, opts ...ResourceOption) (*ApplicationSegmentPRA, error)
    public static ApplicationSegmentPRA Get(string name, Input<string> id, ApplicationSegmentPRAState? state, CustomResourceOptions? opts = null)
    public static ApplicationSegmentPRA get(String name, Output<String> id, ApplicationSegmentPRAState 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:
    BypassType string
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    CommonAppsDto Zscaler.Zpa.Inputs.ApplicationSegmentPRACommonAppsDto
    ConfigSpace string
    Description string
    Description of the application.
    DomainNames List<string>
    List of domains and IPs.
    DoubleEncrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    Enabled bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    IpAnchored bool
    IsCnameEnabled bool
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    IsIncompleteDrConfig bool
    MatchStyle string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SegmentGroupId string
    SelectConnectorCloseToApp bool
    ServerGroups List<Zscaler.Zpa.Inputs.ApplicationSegmentPRAServerGroup>
    List of the server group IDs.
    TcpKeepAlive string
    TcpPortRange List<Zscaler.Zpa.Inputs.ApplicationSegmentPRATcpPortRange>
    tcp port range
    TcpPortRanges List<string>
    TCP port ranges used to access the app.
    UdpPortRange List<Zscaler.Zpa.Inputs.ApplicationSegmentPRAUdpPortRange>
    udp port range
    UdpPortRanges List<string>
    UDP port ranges used to access the app.
    UseInDrMode bool
    BypassType string
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    CommonAppsDto ApplicationSegmentPRACommonAppsDtoArgs
    ConfigSpace string
    Description string
    Description of the application.
    DomainNames []string
    List of domains and IPs.
    DoubleEncrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    Enabled bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    IpAnchored bool
    IsCnameEnabled bool
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    IsIncompleteDrConfig bool
    MatchStyle string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SegmentGroupId string
    SelectConnectorCloseToApp bool
    ServerGroups []ApplicationSegmentPRAServerGroupArgs
    List of the server group IDs.
    TcpKeepAlive string
    TcpPortRange []ApplicationSegmentPRATcpPortRangeArgs
    tcp port range
    TcpPortRanges []string
    TCP port ranges used to access the app.
    UdpPortRange []ApplicationSegmentPRAUdpPortRangeArgs
    udp port range
    UdpPortRanges []string
    UDP port ranges used to access the app.
    UseInDrMode bool
    bypassType String
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    commonAppsDto ApplicationSegmentPRACommonAppsDto
    configSpace String
    description String
    Description of the application.
    domainNames List<String>
    List of domains and IPs.
    doubleEncrypt Boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    ipAnchored Boolean
    isCnameEnabled Boolean
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    isIncompleteDrConfig Boolean
    matchStyle String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    segmentGroupId String
    selectConnectorCloseToApp Boolean
    serverGroups List<ApplicationSegmentPRAServerGroup>
    List of the server group IDs.
    tcpKeepAlive String
    tcpPortRange List<ApplicationSegmentPRATcpPortRange>
    tcp port range
    tcpPortRanges List<String>
    TCP port ranges used to access the app.
    udpPortRange List<ApplicationSegmentPRAUdpPortRange>
    udp port range
    udpPortRanges List<String>
    UDP port ranges used to access the app.
    useInDrMode Boolean
    bypassType string
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    commonAppsDto ApplicationSegmentPRACommonAppsDto
    configSpace string
    description string
    Description of the application.
    domainNames string[]
    List of domains and IPs.
    doubleEncrypt boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled boolean
    healthCheckType string
    healthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType string
    ipAnchored boolean
    isCnameEnabled boolean
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    isIncompleteDrConfig boolean
    matchStyle string
    name string
    Name of the application.
    passiveHealthEnabled boolean
    segmentGroupId string
    selectConnectorCloseToApp boolean
    serverGroups ApplicationSegmentPRAServerGroup[]
    List of the server group IDs.
    tcpKeepAlive string
    tcpPortRange ApplicationSegmentPRATcpPortRange[]
    tcp port range
    tcpPortRanges string[]
    TCP port ranges used to access the app.
    udpPortRange ApplicationSegmentPRAUdpPortRange[]
    udp port range
    udpPortRanges string[]
    UDP port ranges used to access the app.
    useInDrMode boolean
    bypass_type str
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    common_apps_dto ApplicationSegmentPRACommonAppsDtoArgs
    config_space str
    description str
    Description of the application.
    domain_names Sequence[str]
    List of domains and IPs.
    double_encrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    enabled bool
    health_check_type str
    health_reporting str
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmp_access_type str
    ip_anchored bool
    is_cname_enabled bool
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    is_incomplete_dr_config bool
    match_style str
    name str
    Name of the application.
    passive_health_enabled bool
    segment_group_id str
    select_connector_close_to_app bool
    server_groups Sequence[ApplicationSegmentPRAServerGroupArgs]
    List of the server group IDs.
    tcp_keep_alive str
    tcp_port_range Sequence[ApplicationSegmentPRATcpPortRangeArgs]
    tcp port range
    tcp_port_ranges Sequence[str]
    TCP port ranges used to access the app.
    udp_port_range Sequence[ApplicationSegmentPRAUdpPortRangeArgs]
    udp port range
    udp_port_ranges Sequence[str]
    UDP port ranges used to access the app.
    use_in_dr_mode bool
    bypassType String
    Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET. The value NEVER indicates the use of the client forwarding policy.
    commonAppsDto Property Map
    configSpace String
    description String
    Description of the application.
    domainNames List<String>
    List of domains and IPs.
    doubleEncrypt Boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    ipAnchored Boolean
    isCnameEnabled Boolean
    Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
    isIncompleteDrConfig Boolean
    matchStyle String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    segmentGroupId String
    selectConnectorCloseToApp Boolean
    serverGroups List<Property Map>
    List of the server group IDs.
    tcpKeepAlive String
    tcpPortRange List<Property Map>
    tcp port range
    tcpPortRanges List<String>
    TCP port ranges used to access the app.
    udpPortRange List<Property Map>
    udp port range
    udpPortRanges List<String>
    UDP port ranges used to access the app.
    useInDrMode Boolean

    Supporting Types

    ApplicationSegmentPRACommonAppsDto, ApplicationSegmentPRACommonAppsDtoArgs

    ApplicationSegmentPRACommonAppsDtoAppsConfig, ApplicationSegmentPRACommonAppsDtoAppsConfigArgs

    AppTypes List<string>
    ApplicationPort string
    ApplicationProtocol string
    ConnectionSecurity string
    Domain string
    Enabled bool
    Id string
    Name string
    AppTypes []string
    ApplicationPort string
    ApplicationProtocol string
    ConnectionSecurity string
    Domain string
    Enabled bool
    Id string
    Name string
    appTypes List<String>
    applicationPort String
    applicationProtocol String
    connectionSecurity String
    domain String
    enabled Boolean
    id String
    name String
    appTypes string[]
    applicationPort string
    applicationProtocol string
    connectionSecurity string
    domain string
    enabled boolean
    id string
    name string
    appTypes List<String>
    applicationPort String
    applicationProtocol String
    connectionSecurity String
    domain String
    enabled Boolean
    id String
    name String

    ApplicationSegmentPRAServerGroup, ApplicationSegmentPRAServerGroupArgs

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

    ApplicationSegmentPRATcpPortRange, ApplicationSegmentPRATcpPortRangeArgs

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

    ApplicationSegmentPRAUdpPortRange, ApplicationSegmentPRAUdpPortRangeArgs

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

    Import

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

    Visit

    Application Segment can be imported by using <APPLICATION SEGMENT ID> or <APPLICATION SEGMENT NAME> as the import ID.

    $ pulumi import zpa:index/applicationSegmentPRA:ApplicationSegmentPRA example <application_segment_id>

    or

    $ pulumi import zpa:index/applicationSegmentPRA:ApplicationSegmentPRA example <application_segment_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