1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getApplicationSegment
Zscaler Private Access v1.0.1 published on Thursday, Jun 5, 2025 by Zscaler

zpa.getApplicationSegment

Explore with Pulumi AI

zpa logo
Zscaler Private Access v1.0.1 published on Thursday, Jun 5, 2025 by Zscaler

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = zpa.getApplicationSegment({
        name: "example",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    this = zpa.get_application_segment(name="example")
    
    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.LookupApplicationSegment(ctx, &zpa.LookupApplicationSegmentArgs{
    			Name: pulumi.StringRef("example"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zpa = Pulumi.Zpa;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = Zpa.GetApplicationSegment.Invoke(new()
        {
            Name = "example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.ZpaFunctions;
    import com.pulumi.zpa.inputs.GetApplicationSegmentArgs;
    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 = ZpaFunctions.getApplicationSegment(GetApplicationSegmentArgs.builder()
                .name("example")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: zpa:getApplicationSegment
          arguments:
            name: example
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = zpa.getApplicationSegment({
        id: "123456789",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    this = zpa.get_application_segment(id="123456789")
    
    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.LookupApplicationSegment(ctx, &zpa.LookupApplicationSegmentArgs{
    			Id: pulumi.StringRef("123456789"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zpa = Pulumi.Zpa;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = Zpa.GetApplicationSegment.Invoke(new()
        {
            Id = "123456789",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.ZpaFunctions;
    import com.pulumi.zpa.inputs.GetApplicationSegmentArgs;
    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 = ZpaFunctions.getApplicationSegment(GetApplicationSegmentArgs.builder()
                .id("123456789")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: zpa:getApplicationSegment
          arguments:
            id: '123456789'
    

    Using getApplicationSegment

    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 getApplicationSegment(args: GetApplicationSegmentArgs, opts?: InvokeOptions): Promise<GetApplicationSegmentResult>
    function getApplicationSegmentOutput(args: GetApplicationSegmentOutputArgs, opts?: InvokeOptions): Output<GetApplicationSegmentResult>
    def get_application_segment(id: Optional[str] = None,
                                is_incomplete_dr_config: Optional[bool] = None,
                                microtenant_id: Optional[str] = None,
                                microtenant_name: Optional[str] = None,
                                name: Optional[str] = None,
                                tcp_port_range: Optional[Sequence[GetApplicationSegmentTcpPortRange]] = None,
                                udp_port_range: Optional[Sequence[GetApplicationSegmentUdpPortRange]] = None,
                                opts: Optional[InvokeOptions] = None) -> GetApplicationSegmentResult
    def get_application_segment_output(id: Optional[pulumi.Input[str]] = None,
                                is_incomplete_dr_config: Optional[pulumi.Input[bool]] = None,
                                microtenant_id: Optional[pulumi.Input[str]] = None,
                                microtenant_name: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                tcp_port_range: Optional[pulumi.Input[Sequence[pulumi.Input[GetApplicationSegmentTcpPortRangeArgs]]]] = None,
                                udp_port_range: Optional[pulumi.Input[Sequence[pulumi.Input[GetApplicationSegmentUdpPortRangeArgs]]]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetApplicationSegmentResult]
    func LookupApplicationSegment(ctx *Context, args *LookupApplicationSegmentArgs, opts ...InvokeOption) (*LookupApplicationSegmentResult, error)
    func LookupApplicationSegmentOutput(ctx *Context, args *LookupApplicationSegmentOutputArgs, opts ...InvokeOption) LookupApplicationSegmentResultOutput

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

    public static class GetApplicationSegment 
    {
        public static Task<GetApplicationSegmentResult> InvokeAsync(GetApplicationSegmentArgs args, InvokeOptions? opts = null)
        public static Output<GetApplicationSegmentResult> Invoke(GetApplicationSegmentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApplicationSegmentResult> getApplicationSegment(GetApplicationSegmentArgs args, InvokeOptions options)
    public static Output<GetApplicationSegmentResult> getApplicationSegment(GetApplicationSegmentArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getApplicationSegment:getApplicationSegment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getApplicationSegment Result

    The following output properties are available:

    ApiProtectionEnabled bool
    BypassType string
    ConfigSpace string
    CreationTime string
    DefaultIdleTimeout string
    DefaultMaxAge string
    Description string
    DomainNames List<string>
    DoubleEncrypt bool
    Enabled bool
    HealthCheckType string
    HealthReporting string
    IpAnchored bool
    IsCnameEnabled bool
    IsIncompleteDrConfig bool
    ModifiedTime string
    Modifiedby string
    PassiveHealthEnabled bool
    SegmentGroupId string
    SegmentGroupName string
    SelectConnectorCloseToApp bool
    ServerGroups List<zscaler.PulumiPackage.Zpa.Outputs.GetApplicationSegmentServerGroup>
    TcpPortRange List<zscaler.PulumiPackage.Zpa.Outputs.GetApplicationSegmentTcpPortRange>
    TcpPortRanges List<string>
    UdpPortRange List<zscaler.PulumiPackage.Zpa.Outputs.GetApplicationSegmentUdpPortRange>
    UdpPortRanges List<string>
    UseInDrMode bool
    Id string
    MicrotenantId string
    MicrotenantName string
    Name string

    Supporting Types

    GetApplicationSegmentServerGroup

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

    GetApplicationSegmentTcpPortRange

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

    GetApplicationSegmentUdpPortRange

    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.1 published on Thursday, Jun 5, 2025 by Zscaler