1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getSegmentGroup
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

zpa.getSegmentGroup

Explore with Pulumi AI

Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

Example Usage

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

const example = zpa.getSegmentGroup({
    name: "segment_group_name",
});
Copy
import pulumi
import pulumi_zpa as zpa

example = zpa.get_segment_group(name="segment_group_name")
Copy
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.LookupSegmentGroup(ctx, &zpa.LookupSegmentGroupArgs{
			Name: pulumi.StringRef("segment_group_name"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = Pulumi.Zpa;

return await Deployment.RunAsync(() => 
{
    var example = Zpa.GetSegmentGroup.Invoke(new()
    {
        Name = "segment_group_name",
    });

});
Copy
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.GetSegmentGroupArgs;
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 example = ZpaFunctions.getSegmentGroup(GetSegmentGroupArgs.builder()
            .name("segment_group_name")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      Function: zpa:getSegmentGroup
      Arguments:
        name: segment_group_name
Copy

Using getSegmentGroup

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 getSegmentGroup(args: GetSegmentGroupArgs, opts?: InvokeOptions): Promise<GetSegmentGroupResult>
function getSegmentGroupOutput(args: GetSegmentGroupOutputArgs, opts?: InvokeOptions): Output<GetSegmentGroupResult>
Copy
def get_segment_group(id: Optional[str] = None,
                      microtenant_id: Optional[str] = None,
                      microtenant_name: Optional[str] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSegmentGroupResult
def get_segment_group_output(id: Optional[pulumi.Input[str]] = None,
                      microtenant_id: Optional[pulumi.Input[str]] = None,
                      microtenant_name: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSegmentGroupResult]
Copy
func LookupSegmentGroup(ctx *Context, args *LookupSegmentGroupArgs, opts ...InvokeOption) (*LookupSegmentGroupResult, error)
func LookupSegmentGroupOutput(ctx *Context, args *LookupSegmentGroupOutputArgs, opts ...InvokeOption) LookupSegmentGroupResultOutput
Copy

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

public static class GetSegmentGroup 
{
    public static Task<GetSegmentGroupResult> InvokeAsync(GetSegmentGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetSegmentGroupResult> Invoke(GetSegmentGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSegmentGroupResult> getSegmentGroup(GetSegmentGroupArgs args, InvokeOptions options)
public static Output<GetSegmentGroupResult> getSegmentGroup(GetSegmentGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: zpa:index/getSegmentGroup:getSegmentGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
MicrotenantId string
MicrotenantName string
Name string
Id string
MicrotenantId string
MicrotenantName string
Name string
id String
microtenantId String
microtenantName String
name String
id string
microtenantId string
microtenantName string
name string
id String
microtenantId String
microtenantName String
name String

getSegmentGroup Result

The following output properties are available:

Supporting Types

GetSegmentGroupApplication

BypassType This property is required. string
ConfigSpace This property is required. string
CreationTime This property is required. string
DefaultIdleTimeout This property is required. string
DefaultMaxAge This property is required. string
Description This property is required. string
DomainName This property is required. string
DomainNames This property is required. List<string>
DoubleEncrypt This property is required. bool
Enabled This property is required. bool
HealthCheckType This property is required. string
Id This property is required. string
IpAnchored This property is required. bool
LogFeatures This property is required. List<string>
ModifiedBy This property is required. string
ModifiedTime This property is required. string
Name This property is required. string
PassiveHealthEnabled This property is required. bool
ServerGroups This property is required. List<Zscaler.Zpa.Inputs.GetSegmentGroupApplicationServerGroup>
TcpPortRanges This property is required. List<string>
TcpPortsIns This property is required. List<string>
TcpPortsOuts This property is required. List<string>
UdpPortRanges This property is required. List<string>
BypassType This property is required. string
ConfigSpace This property is required. string
CreationTime This property is required. string
DefaultIdleTimeout This property is required. string
DefaultMaxAge This property is required. string
Description This property is required. string
DomainName This property is required. string
DomainNames This property is required. []string
DoubleEncrypt This property is required. bool
Enabled This property is required. bool
HealthCheckType This property is required. string
Id This property is required. string
IpAnchored This property is required. bool
LogFeatures This property is required. []string
ModifiedBy This property is required. string
ModifiedTime This property is required. string
Name This property is required. string
PassiveHealthEnabled This property is required. bool
ServerGroups This property is required. []GetSegmentGroupApplicationServerGroup
TcpPortRanges This property is required. []string
TcpPortsIns This property is required. []string
TcpPortsOuts This property is required. []string
UdpPortRanges This property is required. []string
bypassType This property is required. String
configSpace This property is required. String
creationTime This property is required. String
defaultIdleTimeout This property is required. String
defaultMaxAge This property is required. String
description This property is required. String
domainName This property is required. String
domainNames This property is required. List<String>
doubleEncrypt This property is required. Boolean
enabled This property is required. Boolean
healthCheckType This property is required. String
id This property is required. String
ipAnchored This property is required. Boolean
logFeatures This property is required. List<String>
modifiedBy This property is required. String
modifiedTime This property is required. String
name This property is required. String
passiveHealthEnabled This property is required. Boolean
serverGroups This property is required. List<GetSegmentGroupApplicationServerGroup>
tcpPortRanges This property is required. List<String>
tcpPortsIns This property is required. List<String>
tcpPortsOuts This property is required. List<String>
udpPortRanges This property is required. List<String>
bypassType This property is required. string
configSpace This property is required. string
creationTime This property is required. string
defaultIdleTimeout This property is required. string
defaultMaxAge This property is required. string
description This property is required. string
domainName This property is required. string
domainNames This property is required. string[]
doubleEncrypt This property is required. boolean
enabled This property is required. boolean
healthCheckType This property is required. string
id This property is required. string
ipAnchored This property is required. boolean
logFeatures This property is required. string[]
modifiedBy This property is required. string
modifiedTime This property is required. string
name This property is required. string
passiveHealthEnabled This property is required. boolean
serverGroups This property is required. GetSegmentGroupApplicationServerGroup[]
tcpPortRanges This property is required. string[]
tcpPortsIns This property is required. string[]
tcpPortsOuts This property is required. string[]
udpPortRanges This property is required. string[]
bypass_type This property is required. str
config_space This property is required. str
creation_time This property is required. str
default_idle_timeout This property is required. str
default_max_age This property is required. str
description This property is required. str
domain_name This property is required. str
domain_names This property is required. Sequence[str]
double_encrypt This property is required. bool
enabled This property is required. bool
health_check_type This property is required. str
id This property is required. str
ip_anchored This property is required. bool
log_features This property is required. Sequence[str]
modified_by This property is required. str
modified_time This property is required. str
name This property is required. str
passive_health_enabled This property is required. bool
server_groups This property is required. Sequence[GetSegmentGroupApplicationServerGroup]
tcp_port_ranges This property is required. Sequence[str]
tcp_ports_ins This property is required. Sequence[str]
tcp_ports_outs This property is required. Sequence[str]
udp_port_ranges This property is required. Sequence[str]
bypassType This property is required. String
configSpace This property is required. String
creationTime This property is required. String
defaultIdleTimeout This property is required. String
defaultMaxAge This property is required. String
description This property is required. String
domainName This property is required. String
domainNames This property is required. List<String>
doubleEncrypt This property is required. Boolean
enabled This property is required. Boolean
healthCheckType This property is required. String
id This property is required. String
ipAnchored This property is required. Boolean
logFeatures This property is required. List<String>
modifiedBy This property is required. String
modifiedTime This property is required. String
name This property is required. String
passiveHealthEnabled This property is required. Boolean
serverGroups This property is required. List<Property Map>
tcpPortRanges This property is required. List<String>
tcpPortsIns This property is required. List<String>
tcpPortsOuts This property is required. List<String>
udpPortRanges This property is required. List<String>

GetSegmentGroupApplicationServerGroup

ConfigSpace This property is required. string
CreationTime This property is required. string
Description This property is required. string
DynamicDiscovery This property is required. bool
Enabled This property is required. bool
Id This property is required. string
ModifiedBy This property is required. string
ModifiedTime This property is required. string
Name This property is required. string
ConfigSpace This property is required. string
CreationTime This property is required. string
Description This property is required. string
DynamicDiscovery This property is required. bool
Enabled This property is required. bool
Id This property is required. string
ModifiedBy This property is required. string
ModifiedTime This property is required. string
Name This property is required. string
configSpace This property is required. String
creationTime This property is required. String
description This property is required. String
dynamicDiscovery This property is required. Boolean
enabled This property is required. Boolean
id This property is required. String
modifiedBy This property is required. String
modifiedTime This property is required. String
name This property is required. String
configSpace This property is required. string
creationTime This property is required. string
description This property is required. string
dynamicDiscovery This property is required. boolean
enabled This property is required. boolean
id This property is required. string
modifiedBy This property is required. string
modifiedTime This property is required. string
name This property is required. string
config_space This property is required. str
creation_time This property is required. str
description This property is required. str
dynamic_discovery This property is required. bool
enabled This property is required. bool
id This property is required. str
modified_by This property is required. str
modified_time This property is required. str
name This property is required. str
configSpace This property is required. String
creationTime This property is required. String
description This property is required. String
dynamicDiscovery This property is required. Boolean
enabled This property is required. Boolean
id This property is required. String
modifiedBy This property is required. String
modifiedTime This property is required. String
name This property is required. String

Package Details

Repository
zpa zscaler/pulumi-zpa
License
MIT
Notes
This Pulumi package is based on the zpa Terraform Provider.
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler