1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getBranchConnectorGroup
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler
zpa logo
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler

    Use the zpa_branch_connector_group data source to get information about branch connector group resources from ZTW shared within the Zscaler Private Access cloud. This data source can be used when configuring zpa.PolicyAccessRule or zpa.PolicyAccessRuleV2, zpa.PolicyAccessForwardingRule, zpa.PolicyAccessForwardingRuleV2, where the object_type is BRANCH_CONNECTOR_GROUP

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = zpa.getBranchConnectorGroup({
        name: "GROUP01",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    this = zpa.get_branch_connector_group(name="GROUP01")
    
    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.GetBranchConnectorGroup(ctx, &zpa.GetBranchConnectorGroupArgs{
    			Name: pulumi.StringRef("GROUP01"),
    		}, 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.GetBranchConnectorGroup.Invoke(new()
        {
            Name = "GROUP01",
        });
    
    });
    
    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.GetBranchConnectorGroupArgs;
    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.getBranchConnectorGroup(GetBranchConnectorGroupArgs.builder()
                .name("GROUP01")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: zpa:getBranchConnectorGroup
          arguments:
            name: GROUP01
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = zpa.getBranchConnectorGroup({
        id: "123635465",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    this = zpa.get_branch_connector_group(id="123635465")
    
    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.GetBranchConnectorGroup(ctx, &zpa.GetBranchConnectorGroupArgs{
    			Id: pulumi.StringRef("123635465"),
    		}, 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.GetBranchConnectorGroup.Invoke(new()
        {
            Id = "123635465",
        });
    
    });
    
    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.GetBranchConnectorGroupArgs;
    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.getBranchConnectorGroup(GetBranchConnectorGroupArgs.builder()
                .id("123635465")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: zpa:getBranchConnectorGroup
          arguments:
            id: '123635465'
    

    Using getBranchConnectorGroup

    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 getBranchConnectorGroup(args: GetBranchConnectorGroupArgs, opts?: InvokeOptions): Promise<GetBranchConnectorGroupResult>
    function getBranchConnectorGroupOutput(args: GetBranchConnectorGroupOutputArgs, opts?: InvokeOptions): Output<GetBranchConnectorGroupResult>
    def get_branch_connector_group(id: Optional[str] = None,
                                   name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetBranchConnectorGroupResult
    def get_branch_connector_group_output(id: Optional[pulumi.Input[str]] = None,
                                   name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetBranchConnectorGroupResult]
    func GetBranchConnectorGroup(ctx *Context, args *GetBranchConnectorGroupArgs, opts ...InvokeOption) (*GetBranchConnectorGroupResult, error)
    func GetBranchConnectorGroupOutput(ctx *Context, args *GetBranchConnectorGroupOutputArgs, opts ...InvokeOption) GetBranchConnectorGroupResultOutput

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

    public static class GetBranchConnectorGroup 
    {
        public static Task<GetBranchConnectorGroupResult> InvokeAsync(GetBranchConnectorGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetBranchConnectorGroupResult> Invoke(GetBranchConnectorGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBranchConnectorGroupResult> getBranchConnectorGroup(GetBranchConnectorGroupArgs args, InvokeOptions options)
    public static Output<GetBranchConnectorGroupResult> getBranchConnectorGroup(GetBranchConnectorGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getBranchConnectorGroup:getBranchConnectorGroup
      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

    getBranchConnectorGroup Result

    The following output properties are available:

    Enabled bool
    Id string
    Name string
    Enabled bool
    Id string
    Name string
    enabled Boolean
    id String
    name String
    enabled boolean
    id string
    name string
    enabled bool
    id str
    name str
    enabled Boolean
    id String
    name 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.3 published on Wednesday, Jan 21, 2026 by Zscaler
      Meet Neo: Your AI Platform Teammate