1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. ApplicationSegment
Zscaler Private Access v1.0.2 published on Friday, Jun 20, 2025 by Zscaler
zscaler/pulumi-zpa

zpa.ApplicationSegment

Get Started
zpa logo
Zscaler Private Access v1.0.2 published on Friday, Jun 20, 2025 by Zscaler
zscaler/pulumi-zpa

    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/applicationSegment:ApplicationSegment example <application_segment_id>

    or

    $ pulumi import zpa:index/applicationSegment:ApplicationSegment example <application_segment_name>

    Create ApplicationSegment Resource

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

    Constructor syntax

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

@overload
def ApplicationSegment(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       domain_names: Optional[Sequence[str]] = None,
                       is_cname_enabled: Optional[bool] = None,
                       segment_group_name: Optional[str] = None,
                       config_space: Optional[str] = None,
                       description: Optional[str] = None,
                       bypass_on_reauth: Optional[bool] = None,
                       double_encrypt: Optional[bool] = None,
                       enabled: Optional[bool] = None,
                       fqdn_dns_check: Optional[bool] = None,
                       health_check_type: Optional[str] = None,
                       health_reporting: Optional[str] = None,
                       icmp_access_type: Optional[str] = None,
                       inspect_traffic_with_zia: Optional[bool] = None,
                       ip_anchored: Optional[bool] = None,
                       api_protection_enabled: Optional[bool] = None,
                       bypass_type: Optional[str] = None,
                       is_incomplete_dr_config: Optional[bool] = None,
                       server_groups: Optional[Sequence[ApplicationSegmentServerGroupArgs]] = None,
                       name: Optional[str] = None,
                       passive_health_enabled: Optional[bool] = None,
                       segment_group_id: Optional[str] = None,
                       match_style: Optional[str] = None,
                       select_connector_close_to_app: Optional[bool] = None,
                       microtenant_id: Optional[str] = None,
                       share_to_microtenants: Optional[Sequence[str]] = None,
                       tcp_keep_alive: Optional[str] = None,
                       tcp_port_range: Optional[Sequence[ApplicationSegmentTcpPortRangeArgs]] = None,
                       tcp_port_ranges: Optional[Sequence[str]] = None,
                       udp_port_range: Optional[Sequence[ApplicationSegmentUdpPortRangeArgs]] = None,
                       udp_port_ranges: Optional[Sequence[str]] = None,
                       use_in_dr_mode: Optional[bool] = None)
    func NewApplicationSegment(ctx *Context, name string, args ApplicationSegmentArgs, opts ...ResourceOption) (*ApplicationSegment, error)
    public ApplicationSegment(string name, ApplicationSegmentArgs args, CustomResourceOptions? opts = null)
    public ApplicationSegment(String name, ApplicationSegmentArgs args)
public ApplicationSegment(String name, ApplicationSegmentArgs args, CustomResourceOptions options)

    type: zpa:ApplicationSegment
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 ApplicationSegmentArgs
    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 ApplicationSegmentArgs
    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 ApplicationSegmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationSegmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationSegmentArgs
    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 applicationSegmentResource = new Zpa.ApplicationSegment("applicationSegmentResource", new()
{
    DomainNames = new[]
    {
        "string",
    },
    IsCnameEnabled = false,
    SegmentGroupName = "string",
    ConfigSpace = "string",
    Description = "string",
    BypassOnReauth = false,
    DoubleEncrypt = false,
    Enabled = false,
    FqdnDnsCheck = false,
    HealthCheckType = "string",
    HealthReporting = "string",
    IcmpAccessType = "string",
    InspectTrafficWithZia = false,
    IpAnchored = false,
    ApiProtectionEnabled = false,
    BypassType = "string",
    IsIncompleteDrConfig = false,
    ServerGroups = new[]
    {
        new Zpa.Inputs.ApplicationSegmentServerGroupArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    PassiveHealthEnabled = false,
    SegmentGroupId = "string",
    MatchStyle = "string",
    SelectConnectorCloseToApp = false,
    MicrotenantId = "string",
    ShareToMicrotenants = new[]
    {
        "string",
    },
    TcpKeepAlive = "string",
    TcpPortRange = new[]
    {
        new Zpa.Inputs.ApplicationSegmentTcpPortRangeArgs
        {
            From = "string",
            To = "string",
        },
    },
    TcpPortRanges = new[]
    {
        "string",
    },
    UdpPortRange = new[]
    {
        new Zpa.Inputs.ApplicationSegmentUdpPortRangeArgs
        {
            From = "string",
            To = "string",
        },
    },
    UdpPortRanges = new[]
    {
        "string",
    },
    UseInDrMode = false,
});

    example, err := zpa.NewApplicationSegment(ctx, "applicationSegmentResource", &zpa.ApplicationSegmentArgs{
	DomainNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsCnameEnabled:        pulumi.Bool(false),
	SegmentGroupName:      pulumi.String("string"),
	ConfigSpace:           pulumi.String("string"),
	Description:           pulumi.String("string"),
	BypassOnReauth:        pulumi.Bool(false),
	DoubleEncrypt:         pulumi.Bool(false),
	Enabled:               pulumi.Bool(false),
	FqdnDnsCheck:          pulumi.Bool(false),
	HealthCheckType:       pulumi.String("string"),
	HealthReporting:       pulumi.String("string"),
	IcmpAccessType:        pulumi.String("string"),
	InspectTrafficWithZia: pulumi.Bool(false),
	IpAnchored:            pulumi.Bool(false),
	ApiProtectionEnabled:  pulumi.Bool(false),
	BypassType:            pulumi.String("string"),
	IsIncompleteDrConfig:  pulumi.Bool(false),
	ServerGroups: zpa.ApplicationSegmentServerGroupArray{
		&zpa.ApplicationSegmentServerGroupArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name:                      pulumi.String("string"),
	PassiveHealthEnabled:      pulumi.Bool(false),
	SegmentGroupId:            pulumi.String("string"),
	MatchStyle:                pulumi.String("string"),
	SelectConnectorCloseToApp: pulumi.Bool(false),
	MicrotenantId:             pulumi.String("string"),
	ShareToMicrotenants: pulumi.StringArray{
		pulumi.String("string"),
	},
	TcpKeepAlive: pulumi.String("string"),
	TcpPortRange: zpa.ApplicationSegmentTcpPortRangeArray{
		&zpa.ApplicationSegmentTcpPortRangeArgs{
			From: pulumi.String("string"),
			To:   pulumi.String("string"),
		},
	},
	TcpPortRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	UdpPortRange: zpa.ApplicationSegmentUdpPortRangeArray{
		&zpa.ApplicationSegmentUdpPortRangeArgs{
			From: pulumi.String("string"),
			To:   pulumi.String("string"),
		},
	},
	UdpPortRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	UseInDrMode: pulumi.Bool(false),
})

    var applicationSegmentResource = new ApplicationSegment("applicationSegmentResource", ApplicationSegmentArgs.builder()
    .domainNames("string")
    .isCnameEnabled(false)
    .segmentGroupName("string")
    .configSpace("string")
    .description("string")
    .bypassOnReauth(false)
    .doubleEncrypt(false)
    .enabled(false)
    .fqdnDnsCheck(false)
    .healthCheckType("string")
    .healthReporting("string")
    .icmpAccessType("string")
    .inspectTrafficWithZia(false)
    .ipAnchored(false)
    .apiProtectionEnabled(false)
    .bypassType("string")
    .isIncompleteDrConfig(false)
    .serverGroups(ApplicationSegmentServerGroupArgs.builder()
        .ids("string")
        .build())
    .name("string")
    .passiveHealthEnabled(false)
    .segmentGroupId("string")
    .matchStyle("string")
    .selectConnectorCloseToApp(false)
    .microtenantId("string")
    .shareToMicrotenants("string")
    .tcpKeepAlive("string")
    .tcpPortRange(ApplicationSegmentTcpPortRangeArgs.builder()
        .from("string")
        .to("string")
        .build())
    .tcpPortRanges("string")
    .udpPortRange(ApplicationSegmentUdpPortRangeArgs.builder()
        .from("string")
        .to("string")
        .build())
    .udpPortRanges("string")
    .useInDrMode(false)
    .build());

    application_segment_resource = zpa.ApplicationSegment("applicationSegmentResource",
    domain_names=["string"],
    is_cname_enabled=False,
    segment_group_name="string",
    config_space="string",
    description="string",
    bypass_on_reauth=False,
    double_encrypt=False,
    enabled=False,
    fqdn_dns_check=False,
    health_check_type="string",
    health_reporting="string",
    icmp_access_type="string",
    inspect_traffic_with_zia=False,
    ip_anchored=False,
    api_protection_enabled=False,
    bypass_type="string",
    is_incomplete_dr_config=False,
    server_groups=[{
        "ids": ["string"],
    }],
    name="string",
    passive_health_enabled=False,
    segment_group_id="string",
    match_style="string",
    select_connector_close_to_app=False,
    microtenant_id="string",
    share_to_microtenants=["string"],
    tcp_keep_alive="string",
    tcp_port_range=[{
        "from_": "string",
        "to": "string",
    }],
    tcp_port_ranges=["string"],
    udp_port_range=[{
        "from_": "string",
        "to": "string",
    }],
    udp_port_ranges=["string"],
    use_in_dr_mode=False)

    const applicationSegmentResource = new zpa.ApplicationSegment("applicationSegmentResource", {
    domainNames: ["string"],
    isCnameEnabled: false,
    segmentGroupName: "string",
    configSpace: "string",
    description: "string",
    bypassOnReauth: false,
    doubleEncrypt: false,
    enabled: false,
    fqdnDnsCheck: false,
    healthCheckType: "string",
    healthReporting: "string",
    icmpAccessType: "string",
    inspectTrafficWithZia: false,
    ipAnchored: false,
    apiProtectionEnabled: false,
    bypassType: "string",
    isIncompleteDrConfig: false,
    serverGroups: [{
        ids: ["string"],
    }],
    name: "string",
    passiveHealthEnabled: false,
    segmentGroupId: "string",
    matchStyle: "string",
    selectConnectorCloseToApp: false,
    microtenantId: "string",
    shareToMicrotenants: ["string"],
    tcpKeepAlive: "string",
    tcpPortRange: [{
        from: "string",
        to: "string",
    }],
    tcpPortRanges: ["string"],
    udpPortRange: [{
        from: "string",
        to: "string",
    }],
    udpPortRanges: ["string"],
    useInDrMode: false,
});

    type: zpa:ApplicationSegment
properties:
    apiProtectionEnabled: false
    bypassOnReauth: false
    bypassType: string
    configSpace: string
    description: string
    domainNames:
        - string
    doubleEncrypt: false
    enabled: false
    fqdnDnsCheck: false
    healthCheckType: string
    healthReporting: string
    icmpAccessType: string
    inspectTrafficWithZia: false
    ipAnchored: false
    isCnameEnabled: false
    isIncompleteDrConfig: false
    matchStyle: string
    microtenantId: string
    name: string
    passiveHealthEnabled: false
    segmentGroupId: string
    segmentGroupName: string
    selectConnectorCloseToApp: false
    serverGroups:
        - ids:
            - string
    shareToMicrotenants:
        - string
    tcpKeepAlive: string
    tcpPortRange:
        - from: string
          to: string
    tcpPortRanges:
        - string
    udpPortRange:
        - from: string
          to: string
    udpPortRanges:
        - string
    useInDrMode: false

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

    DomainNames List<string>
    List of domains and IPs.
    ApiProtectionEnabled bool
    If set to true, designates the application segment for API traffic inspection
    BypassOnReauth bool
    BypassType string
    Indicates whether users can bypass ZPA to access applications.
    ConfigSpace string
    Description string
    Description of the application.
    DoubleEncrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    Enabled bool
    Whether this application is enabled or not.
    FqdnDnsCheck bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    InspectTrafficWithZia bool
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    MicrotenantId string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SegmentGroupId string
    SegmentGroupName string
    SelectConnectorCloseToApp bool
    ServerGroups List<zscaler.PulumiPackage.Zpa.Inputs.ApplicationSegmentServerGroup>
    ShareToMicrotenants List<string>
    Share the Application Segment to microtenants
    TcpKeepAlive string
    TcpPortRange List<zscaler.PulumiPackage.Zpa.Inputs.ApplicationSegmentTcpPortRange>
    tcp port range
    TcpPortRanges List<string>
    TCP port ranges used to access the app.
    UdpPortRange List<zscaler.PulumiPackage.Zpa.Inputs.ApplicationSegmentUdpPortRange>
    udp port range
    UdpPortRanges List<string>
    UDP port ranges used to access the app.
    UseInDrMode bool
    DomainNames []string
    List of domains and IPs.
    ApiProtectionEnabled bool
    If set to true, designates the application segment for API traffic inspection
    BypassOnReauth bool
    BypassType string
    Indicates whether users can bypass ZPA to access applications.
    ConfigSpace string
    Description string
    Description of the application.
    DoubleEncrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    Enabled bool
    Whether this application is enabled or not.
    FqdnDnsCheck bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    InspectTrafficWithZia bool
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    MicrotenantId string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SegmentGroupId string
    SegmentGroupName string
    SelectConnectorCloseToApp bool
    ServerGroups []ApplicationSegmentServerGroupArgs
    ShareToMicrotenants []string
    Share the Application Segment to microtenants
    TcpKeepAlive string
    TcpPortRange []ApplicationSegmentTcpPortRangeArgs
    tcp port range
    TcpPortRanges []string
    TCP port ranges used to access the app.
    UdpPortRange []ApplicationSegmentUdpPortRangeArgs
    udp port range
    UdpPortRanges []string
    UDP port ranges used to access the app.
    UseInDrMode bool
    domainNames List<String>
    List of domains and IPs.
    apiProtectionEnabled Boolean
    If set to true, designates the application segment for API traffic inspection
    bypassOnReauth Boolean
    bypassType String
    Indicates whether users can bypass ZPA to access applications.
    configSpace String
    description String
    Description of the application.
    doubleEncrypt Boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled Boolean
    Whether this application is enabled or not.
    fqdnDnsCheck Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    inspectTrafficWithZia Boolean
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenantId String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    segmentGroupId String
    segmentGroupName String
    selectConnectorCloseToApp Boolean
    serverGroups List<ApplicationSegmentServerGroup>
    shareToMicrotenants List<String>
    Share the Application Segment to microtenants
    tcpKeepAlive String
    tcpPortRange List<ApplicationSegmentTcpPortRange>
    tcp port range
    tcpPortRanges List<String>
    TCP port ranges used to access the app.
    udpPortRange List<ApplicationSegmentUdpPortRange>
    udp port range
    udpPortRanges List<String>
    UDP port ranges used to access the app.
    useInDrMode Boolean
    domainNames string[]
    List of domains and IPs.
    apiProtectionEnabled boolean
    If set to true, designates the application segment for API traffic inspection
    bypassOnReauth boolean
    bypassType string
    Indicates whether users can bypass ZPA to access applications.
    configSpace string
    description string
    Description of the application.
    doubleEncrypt boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled boolean
    Whether this application is enabled or not.
    fqdnDnsCheck boolean
    healthCheckType string
    healthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType string
    inspectTrafficWithZia boolean
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenantId string
    name string
    Name of the application.
    passiveHealthEnabled boolean
    segmentGroupId string
    segmentGroupName string
    selectConnectorCloseToApp boolean
    serverGroups ApplicationSegmentServerGroup[]
    shareToMicrotenants string[]
    Share the Application Segment to microtenants
    tcpKeepAlive string
    tcpPortRange ApplicationSegmentTcpPortRange[]
    tcp port range
    tcpPortRanges string[]
    TCP port ranges used to access the app.
    udpPortRange ApplicationSegmentUdpPortRange[]
    udp port range
    udpPortRanges string[]
    UDP port ranges used to access the app.
    useInDrMode boolean
    domain_names Sequence[str]
    List of domains and IPs.
    api_protection_enabled bool
    If set to true, designates the application segment for API traffic inspection
    bypass_on_reauth bool
    bypass_type str
    Indicates whether users can bypass ZPA to access applications.
    config_space str
    description str
    Description of the application.
    double_encrypt bool
    Whether Double Encryption is enabled or disabled for the app.
    enabled bool
    Whether this application is enabled or not.
    fqdn_dns_check 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
    inspect_traffic_with_zia bool
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenant_id str
    name str
    Name of the application.
    passive_health_enabled bool
    segment_group_id str
    segment_group_name str
    select_connector_close_to_app bool
    server_groups Sequence[ApplicationSegmentServerGroupArgs]
    share_to_microtenants Sequence[str]
    Share the Application Segment to microtenants
    tcp_keep_alive str
    tcp_port_range Sequence[ApplicationSegmentTcpPortRangeArgs]
    tcp port range
    tcp_port_ranges Sequence[str]
    TCP port ranges used to access the app.
    udp_port_range Sequence[ApplicationSegmentUdpPortRangeArgs]
    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.
    apiProtectionEnabled Boolean
    If set to true, designates the application segment for API traffic inspection
    bypassOnReauth Boolean
    bypassType String
    Indicates whether users can bypass ZPA to access applications.
    configSpace String
    description String
    Description of the application.
    doubleEncrypt Boolean
    Whether Double Encryption is enabled or disabled for the app.
    enabled Boolean
    Whether this application is enabled or not.
    fqdnDnsCheck Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    inspectTrafficWithZia Boolean
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenantId String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    segmentGroupId String
    segmentGroupName String
    selectConnectorCloseToApp Boolean
    serverGroups List<Property Map>
    shareToMicrotenants List<String>
    Share the Application Segment to microtenants
    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 ApplicationSegment 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 ApplicationSegment Resource

    Get an existing ApplicationSegment 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?: ApplicationSegmentState, opts?: CustomResourceOptions): ApplicationSegment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_protection_enabled: Optional[bool] = None,
        bypass_on_reauth: Optional[bool] = None,
        bypass_type: Optional[str] = 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,
        fqdn_dns_check: Optional[bool] = None,
        health_check_type: Optional[str] = None,
        health_reporting: Optional[str] = None,
        icmp_access_type: Optional[str] = None,
        inspect_traffic_with_zia: Optional[bool] = None,
        ip_anchored: Optional[bool] = None,
        is_cname_enabled: Optional[bool] = None,
        is_incomplete_dr_config: Optional[bool] = None,
        match_style: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        passive_health_enabled: Optional[bool] = None,
        segment_group_id: Optional[str] = None,
        segment_group_name: Optional[str] = None,
        select_connector_close_to_app: Optional[bool] = None,
        server_groups: Optional[Sequence[ApplicationSegmentServerGroupArgs]] = None,
        share_to_microtenants: Optional[Sequence[str]] = None,
        tcp_keep_alive: Optional[str] = None,
        tcp_port_range: Optional[Sequence[ApplicationSegmentTcpPortRangeArgs]] = None,
        tcp_port_ranges: Optional[Sequence[str]] = None,
        udp_port_range: Optional[Sequence[ApplicationSegmentUdpPortRangeArgs]] = None,
        udp_port_ranges: Optional[Sequence[str]] = None,
        use_in_dr_mode: Optional[bool] = None) -> ApplicationSegment
    func GetApplicationSegment(ctx *Context, name string, id IDInput, state *ApplicationSegmentState, opts ...ResourceOption) (*ApplicationSegment, error)
    public static ApplicationSegment Get(string name, Input<string> id, ApplicationSegmentState? state, CustomResourceOptions? opts = null)
    public static ApplicationSegment get(String name, Output<String> id, ApplicationSegmentState state, CustomResourceOptions options)
    resources:  _:    type: zpa:ApplicationSegment    get:      id: ${id}
    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:
    ApiProtectionEnabled bool
    If set to true, designates the application segment for API traffic inspection
    BypassOnReauth bool
    BypassType string
    Indicates whether users can bypass ZPA to access applications.
    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
    Whether this application is enabled or not.
    FqdnDnsCheck bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    InspectTrafficWithZia bool
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    MicrotenantId string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SegmentGroupId string
    SegmentGroupName string
    SelectConnectorCloseToApp bool
    ServerGroups List<zscaler.PulumiPackage.Zpa.Inputs.ApplicationSegmentServerGroup>
    ShareToMicrotenants List<string>
    Share the Application Segment to microtenants
    TcpKeepAlive string
    TcpPortRange List<zscaler.PulumiPackage.Zpa.Inputs.ApplicationSegmentTcpPortRange>
    tcp port range
    TcpPortRanges List<string>
    TCP port ranges used to access the app.
    UdpPortRange List<zscaler.PulumiPackage.Zpa.Inputs.ApplicationSegmentUdpPortRange>
    udp port range
    UdpPortRanges List<string>
    UDP port ranges used to access the app.
    UseInDrMode bool
    ApiProtectionEnabled bool
    If set to true, designates the application segment for API traffic inspection
    BypassOnReauth bool
    BypassType string
    Indicates whether users can bypass ZPA to access applications.
    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
    Whether this application is enabled or not.
    FqdnDnsCheck bool
    HealthCheckType string
    HealthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    IcmpAccessType string
    InspectTrafficWithZia bool
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    MicrotenantId string
    Name string
    Name of the application.
    PassiveHealthEnabled bool
    SegmentGroupId string
    SegmentGroupName string
    SelectConnectorCloseToApp bool
    ServerGroups []ApplicationSegmentServerGroupArgs
    ShareToMicrotenants []string
    Share the Application Segment to microtenants
    TcpKeepAlive string
    TcpPortRange []ApplicationSegmentTcpPortRangeArgs
    tcp port range
    TcpPortRanges []string
    TCP port ranges used to access the app.
    UdpPortRange []ApplicationSegmentUdpPortRangeArgs
    udp port range
    UdpPortRanges []string
    UDP port ranges used to access the app.
    UseInDrMode bool
    apiProtectionEnabled Boolean
    If set to true, designates the application segment for API traffic inspection
    bypassOnReauth Boolean
    bypassType String
    Indicates whether users can bypass ZPA to access applications.
    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
    Whether this application is enabled or not.
    fqdnDnsCheck Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    inspectTrafficWithZia Boolean
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenantId String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    segmentGroupId String
    segmentGroupName String
    selectConnectorCloseToApp Boolean
    serverGroups List<ApplicationSegmentServerGroup>
    shareToMicrotenants List<String>
    Share the Application Segment to microtenants
    tcpKeepAlive String
    tcpPortRange List<ApplicationSegmentTcpPortRange>
    tcp port range
    tcpPortRanges List<String>
    TCP port ranges used to access the app.
    udpPortRange List<ApplicationSegmentUdpPortRange>
    udp port range
    udpPortRanges List<String>
    UDP port ranges used to access the app.
    useInDrMode Boolean
    apiProtectionEnabled boolean
    If set to true, designates the application segment for API traffic inspection
    bypassOnReauth boolean
    bypassType string
    Indicates whether users can bypass ZPA to access applications.
    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
    Whether this application is enabled or not.
    fqdnDnsCheck boolean
    healthCheckType string
    healthReporting string
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType string
    inspectTrafficWithZia boolean
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenantId string
    name string
    Name of the application.
    passiveHealthEnabled boolean
    segmentGroupId string
    segmentGroupName string
    selectConnectorCloseToApp boolean
    serverGroups ApplicationSegmentServerGroup[]
    shareToMicrotenants string[]
    Share the Application Segment to microtenants
    tcpKeepAlive string
    tcpPortRange ApplicationSegmentTcpPortRange[]
    tcp port range
    tcpPortRanges string[]
    TCP port ranges used to access the app.
    udpPortRange ApplicationSegmentUdpPortRange[]
    udp port range
    udpPortRanges string[]
    UDP port ranges used to access the app.
    useInDrMode boolean
    api_protection_enabled bool
    If set to true, designates the application segment for API traffic inspection
    bypass_on_reauth bool
    bypass_type str
    Indicates whether users can bypass ZPA to access applications.
    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
    Whether this application is enabled or not.
    fqdn_dns_check 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
    inspect_traffic_with_zia bool
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenant_id str
    name str
    Name of the application.
    passive_health_enabled bool
    segment_group_id str
    segment_group_name str
    select_connector_close_to_app bool
    server_groups Sequence[ApplicationSegmentServerGroupArgs]
    share_to_microtenants Sequence[str]
    Share the Application Segment to microtenants
    tcp_keep_alive str
    tcp_port_range Sequence[ApplicationSegmentTcpPortRangeArgs]
    tcp port range
    tcp_port_ranges Sequence[str]
    TCP port ranges used to access the app.
    udp_port_range Sequence[ApplicationSegmentUdpPortRangeArgs]
    udp port range
    udp_port_ranges Sequence[str]
    UDP port ranges used to access the app.
    use_in_dr_mode bool
    apiProtectionEnabled Boolean
    If set to true, designates the application segment for API traffic inspection
    bypassOnReauth Boolean
    bypassType String
    Indicates whether users can bypass ZPA to access applications.
    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
    Whether this application is enabled or not.
    fqdnDnsCheck Boolean
    healthCheckType String
    healthReporting String
    Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
    icmpAccessType String
    inspectTrafficWithZia Boolean
    Indicates if Inspect Traffic with ZIA is enabled for the application.
    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
    microtenantId String
    name String
    Name of the application.
    passiveHealthEnabled Boolean
    segmentGroupId String
    segmentGroupName String
    selectConnectorCloseToApp Boolean
    serverGroups List<Property Map>
    shareToMicrotenants List<String>
    Share the Application Segment to microtenants
    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

    ApplicationSegmentServerGroup, ApplicationSegmentServerGroupArgs

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

    ApplicationSegmentTcpPortRange, ApplicationSegmentTcpPortRangeArgs

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

    ApplicationSegmentUdpPortRange, ApplicationSegmentUdpPortRangeArgs

    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.
    zpa logo
    Zscaler Private Access v1.0.2 published on Friday, Jun 20, 2025 by Zscaler
    zscaler/pulumi-zpa
      Meet Neo: Your AI Platform Teammate