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

zpa.getServiceEdgeGroup

Explore with Pulumi AI

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

    Use the zpa_service_edge_group data source to get information about a service edge group in the Zscaler Private Access cloud. This data source can then be referenced in an App Connector Group. This data source can then be referenced in the following resources:

    NOTE: To ensure consistent search results across data sources, please avoid using multiple spaces or special characters in your search queries.

    • Create a server group
    • Provisioning Key
    • Access policy rule

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const foo = zpa.getServiceEdgeGroup({
        name: "DataCenter",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    foo = zpa.get_service_edge_group(name="DataCenter")
    
    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.LookupServiceEdgeGroup(ctx, &zpa.LookupServiceEdgeGroupArgs{
    			Name: pulumi.StringRef("DataCenter"),
    		}, 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 foo = Zpa.GetServiceEdgeGroup.Invoke(new()
        {
            Name = "DataCenter",
        });
    
    });
    
    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.GetServiceEdgeGroupArgs;
    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 foo = ZpaFunctions.getServiceEdgeGroup(GetServiceEdgeGroupArgs.builder()
                .name("DataCenter")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          function: zpa:getServiceEdgeGroup
          arguments:
            name: DataCenter
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const foo = zpa.getServiceEdgeGroup({
        id: "123456789",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    foo = zpa.get_service_edge_group(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.LookupServiceEdgeGroup(ctx, &zpa.LookupServiceEdgeGroupArgs{
    			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 foo = Zpa.GetServiceEdgeGroup.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.GetServiceEdgeGroupArgs;
    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 foo = ZpaFunctions.getServiceEdgeGroup(GetServiceEdgeGroupArgs.builder()
                .id("123456789")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          function: zpa:getServiceEdgeGroup
          arguments:
            id: '123456789'
    

    Using getServiceEdgeGroup

    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 getServiceEdgeGroup(args: GetServiceEdgeGroupArgs, opts?: InvokeOptions): Promise<GetServiceEdgeGroupResult>
    function getServiceEdgeGroupOutput(args: GetServiceEdgeGroupOutputArgs, opts?: InvokeOptions): Output<GetServiceEdgeGroupResult>
    def get_service_edge_group(id: Optional[str] = None,
                               name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetServiceEdgeGroupResult
    def get_service_edge_group_output(id: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetServiceEdgeGroupResult]
    func LookupServiceEdgeGroup(ctx *Context, args *LookupServiceEdgeGroupArgs, opts ...InvokeOption) (*LookupServiceEdgeGroupResult, error)
    func LookupServiceEdgeGroupOutput(ctx *Context, args *LookupServiceEdgeGroupOutputArgs, opts ...InvokeOption) LookupServiceEdgeGroupResultOutput

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

    public static class GetServiceEdgeGroup 
    {
        public static Task<GetServiceEdgeGroupResult> InvokeAsync(GetServiceEdgeGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetServiceEdgeGroupResult> Invoke(GetServiceEdgeGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServiceEdgeGroupResult> getServiceEdgeGroup(GetServiceEdgeGroupArgs args, InvokeOptions options)
    public static Output<GetServiceEdgeGroupResult> getServiceEdgeGroup(GetServiceEdgeGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getServiceEdgeGroup:getServiceEdgeGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    Id string
    Name string
    id String
    name String
    id string
    name string
    id str
    name str
    id String
    name String

    getServiceEdgeGroup Result

    The following output properties are available:

    Supporting Types

    GetServiceEdgeGroupServiceEdge

    ApplicationStartTime string
    ControlChannelStatus string
    CreationTime string
    CtrlBrokerName string
    CurrentVersion string
    Description string
    Enabled bool
    EnrollmentCert Dictionary<string, string>
    ExpectedUpgradeTime string
    ExpectedVersion string
    Fingerprint string
    Id string
    IpAcl string
    IssuedCertId string
    LastBrokerConnectTime string
    LastBrokerConnectTimeDuration string
    LastBrokerDisconnectTime string
    LastBrokerDisconnectTimeDuration string
    LastUpgradeTime string
    Latitude string
    ListenIps List<string>
    Location string
    Longitude string
    ModifiedBy string
    ModifiedTime string
    Platform string
    PreviousVersion string
    PrivateBrokerVersions List<zscaler.PulumiPackage.Zpa.Inputs.GetServiceEdgeGroupServiceEdgePrivateBrokerVersion>
    PrivateIp string
    ProvisioningKeyId string
    ProvisioningKeyName string
    PublicIp string
    PublishIps List<string>
    PublishIpv6 bool
    RuntimeOs string
    SargeVersion string
    ServiceEdgeGroupId string
    ServiceEdgeGroupName string
    UpgradeAttempt string
    UpgradeStatus string
    MicrotenantId string
    MicrotenantName string
    Name string
    ApplicationStartTime string
    ControlChannelStatus string
    CreationTime string
    CtrlBrokerName string
    CurrentVersion string
    Description string
    Enabled bool
    EnrollmentCert map[string]string
    ExpectedUpgradeTime string
    ExpectedVersion string
    Fingerprint string
    Id string
    IpAcl string
    IssuedCertId string
    LastBrokerConnectTime string
    LastBrokerConnectTimeDuration string
    LastBrokerDisconnectTime string
    LastBrokerDisconnectTimeDuration string
    LastUpgradeTime string
    Latitude string
    ListenIps []string
    Location string
    Longitude string
    ModifiedBy string
    ModifiedTime string
    Platform string
    PreviousVersion string
    PrivateBrokerVersions []GetServiceEdgeGroupServiceEdgePrivateBrokerVersion
    PrivateIp string
    ProvisioningKeyId string
    ProvisioningKeyName string
    PublicIp string
    PublishIps []string
    PublishIpv6 bool
    RuntimeOs string
    SargeVersion string
    ServiceEdgeGroupId string
    ServiceEdgeGroupName string
    UpgradeAttempt string
    UpgradeStatus string
    MicrotenantId string
    MicrotenantName string
    Name string
    applicationStartTime String
    controlChannelStatus String
    creationTime String
    ctrlBrokerName String
    currentVersion String
    description String
    enabled Boolean
    enrollmentCert Map<String,String>
    expectedUpgradeTime String
    expectedVersion String
    fingerprint String
    id String
    ipAcl String
    issuedCertId String
    lastBrokerConnectTime String
    lastBrokerConnectTimeDuration String
    lastBrokerDisconnectTime String
    lastBrokerDisconnectTimeDuration String
    lastUpgradeTime String
    latitude String
    listenIps List<String>
    location String
    longitude String
    modifiedBy String
    modifiedTime String
    platform String
    previousVersion String
    privateBrokerVersions List<GetServiceEdgeGroupServiceEdgePrivateBrokerVersion>
    privateIp String
    provisioningKeyId String
    provisioningKeyName String
    publicIp String
    publishIps List<String>
    publishIpv6 Boolean
    runtimeOs String
    sargeVersion String
    serviceEdgeGroupId String
    serviceEdgeGroupName String
    upgradeAttempt String
    upgradeStatus String
    microtenantId String
    microtenantName String
    name String
    applicationStartTime string
    controlChannelStatus string
    creationTime string
    ctrlBrokerName string
    currentVersion string
    description string
    enabled boolean
    enrollmentCert {[key: string]: string}
    expectedUpgradeTime string
    expectedVersion string
    fingerprint string
    id string
    ipAcl string
    issuedCertId string
    lastBrokerConnectTime string
    lastBrokerConnectTimeDuration string
    lastBrokerDisconnectTime string
    lastBrokerDisconnectTimeDuration string
    lastUpgradeTime string
    latitude string
    listenIps string[]
    location string
    longitude string
    modifiedBy string
    modifiedTime string
    platform string
    previousVersion string
    privateBrokerVersions GetServiceEdgeGroupServiceEdgePrivateBrokerVersion[]
    privateIp string
    provisioningKeyId string
    provisioningKeyName string
    publicIp string
    publishIps string[]
    publishIpv6 boolean
    runtimeOs string
    sargeVersion string
    serviceEdgeGroupId string
    serviceEdgeGroupName string
    upgradeAttempt string
    upgradeStatus string
    microtenantId string
    microtenantName string
    name string
    application_start_time str
    control_channel_status str
    creation_time str
    ctrl_broker_name str
    current_version str
    description str
    enabled bool
    enrollment_cert Mapping[str, str]
    expected_upgrade_time str
    expected_version str
    fingerprint str
    id str
    ip_acl str
    issued_cert_id str
    last_broker_connect_time str
    last_broker_connect_time_duration str
    last_broker_disconnect_time str
    last_broker_disconnect_time_duration str
    last_upgrade_time str
    latitude str
    listen_ips Sequence[str]
    location str
    longitude str
    modified_by str
    modified_time str
    platform str
    previous_version str
    private_broker_versions Sequence[GetServiceEdgeGroupServiceEdgePrivateBrokerVersion]
    private_ip str
    provisioning_key_id str
    provisioning_key_name str
    public_ip str
    publish_ips Sequence[str]
    publish_ipv6 bool
    runtime_os str
    sarge_version str
    service_edge_group_id str
    service_edge_group_name str
    upgrade_attempt str
    upgrade_status str
    microtenant_id str
    microtenant_name str
    name str
    applicationStartTime String
    controlChannelStatus String
    creationTime String
    ctrlBrokerName String
    currentVersion String
    description String
    enabled Boolean
    enrollmentCert Map<String>
    expectedUpgradeTime String
    expectedVersion String
    fingerprint String
    id String
    ipAcl String
    issuedCertId String
    lastBrokerConnectTime String
    lastBrokerConnectTimeDuration String
    lastBrokerDisconnectTime String
    lastBrokerDisconnectTimeDuration String
    lastUpgradeTime String
    latitude String
    listenIps List<String>
    location String
    longitude String
    modifiedBy String
    modifiedTime String
    platform String
    previousVersion String
    privateBrokerVersions List<Property Map>
    privateIp String
    provisioningKeyId String
    provisioningKeyName String
    publicIp String
    publishIps List<String>
    publishIpv6 Boolean
    runtimeOs String
    sargeVersion String
    serviceEdgeGroupId String
    serviceEdgeGroupName String
    upgradeAttempt String
    upgradeStatus String
    microtenantId String
    microtenantName String
    name String

    GetServiceEdgeGroupServiceEdgePrivateBrokerVersion

    GetServiceEdgeGroupServiceEdgePrivateBrokerVersionZpnSubModuleUpgrade

    GetServiceEdgeGroupTrustedNetwork

    CreationTime string
    Domain string
    Id string
    MasterCustomerId string
    ModifiedBy string
    ModifiedTime string
    Name string
    NetworkId string
    ZscalerCloud string
    CreationTime string
    Domain string
    Id string
    MasterCustomerId string
    ModifiedBy string
    ModifiedTime string
    Name string
    NetworkId string
    ZscalerCloud string
    creationTime String
    domain String
    id String
    masterCustomerId String
    modifiedBy String
    modifiedTime String
    name String
    networkId String
    zscalerCloud String
    creationTime string
    domain string
    id string
    masterCustomerId string
    modifiedBy string
    modifiedTime string
    name string
    networkId string
    zscalerCloud string
    creationTime String
    domain String
    id String
    masterCustomerId String
    modifiedBy String
    modifiedTime String
    name String
    networkId String
    zscalerCloud 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