1. Packages
  2. Packages
  3. Zscaler Private Access (ZPA)
  4. API Docs
  5. getPrivateCloud
Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler
zpa logo
Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler

    The zpa_private_cloud data source to get information about a private cloud in the Zscaler Private Access cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    // ZPA Private Cloud Data Source
    const foo = zpa.getPrivateCloud({
        name: "PrivateCloud01",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    # ZPA Private Cloud Data Source
    foo = zpa.get_private_cloud(name="PrivateCloud01")
    
    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 {
    		// ZPA Private Cloud Data Source
    		_, err := zpa.GetPrivateCloud(ctx, &zpa.LookupPrivateCloudArgs{
    			Name: pulumi.StringRef("PrivateCloud01"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zpa = zscaler.PulumiPackage.Zpa;
    
    return await Deployment.RunAsync(() => 
    {
        // ZPA Private Cloud Data Source
        var foo = Zpa.GetPrivateCloud.Invoke(new()
        {
            Name = "PrivateCloud01",
        });
    
    });
    
    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.GetPrivateCloudArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            // ZPA Private Cloud Data Source
            final var foo = ZpaFunctions.getPrivateCloud(GetPrivateCloudArgs.builder()
                .name("PrivateCloud01")
                .build());
    
        }
    }
    
    variables:
      # ZPA Private Cloud Data Source
      foo:
        fn::invoke:
          function: zpa:getPrivateCloud
          arguments:
            name: PrivateCloud01
    
    pulumi {
      required_providers {
        zpa = {
          source = "pulumi/zpa"
        }
      }
    }
    
    data "zpa_getprivatecloud" "foo" {
      name = "PrivateCloud01"
    }
    
    # ZPA Private Cloud Data Source
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    // ZPA Private Cloud Data Source
    const foo = zpa.getPrivateCloud({
        id: "123456789",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    # ZPA Private Cloud Data Source
    foo = zpa.get_private_cloud(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 {
    		// ZPA Private Cloud Data Source
    		_, err := zpa.GetPrivateCloud(ctx, &zpa.LookupPrivateCloudArgs{
    			Id: pulumi.StringRef("123456789"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zpa = zscaler.PulumiPackage.Zpa;
    
    return await Deployment.RunAsync(() => 
    {
        // ZPA Private Cloud Data Source
        var foo = Zpa.GetPrivateCloud.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.GetPrivateCloudArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            // ZPA Private Cloud Data Source
            final var foo = ZpaFunctions.getPrivateCloud(GetPrivateCloudArgs.builder()
                .id("123456789")
                .build());
    
        }
    }
    
    variables:
      # ZPA Private Cloud Data Source
      foo:
        fn::invoke:
          function: zpa:getPrivateCloud
          arguments:
            id: '123456789'
    
    pulumi {
      required_providers {
        zpa = {
          source = "pulumi/zpa"
        }
      }
    }
    
    data "zpa_getprivatecloud" "foo" {
      id = "123456789"
    }
    
    # ZPA Private Cloud Data Source
    

    Using getPrivateCloud

    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 getPrivateCloud(args: GetPrivateCloudArgs, opts?: InvokeOptions): Promise<GetPrivateCloudResult>
    function getPrivateCloudOutput(args: GetPrivateCloudOutputArgs, opts?: InvokeOptions): Output<GetPrivateCloudResult>
    def get_private_cloud(id: Optional[str] = None,
                          microtenant_id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPrivateCloudResult
    def get_private_cloud_output(id: pulumi.Input[Optional[str]] = None,
                          microtenant_id: pulumi.Input[Optional[str]] = None,
                          name: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPrivateCloudResult]
    func LookupPrivateCloud(ctx *Context, args *LookupPrivateCloudArgs, opts ...InvokeOption) (*LookupPrivateCloudResult, error)
    func LookupPrivateCloudOutput(ctx *Context, args *LookupPrivateCloudOutputArgs, opts ...InvokeOption) LookupPrivateCloudResultOutput

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

    public static class GetPrivateCloud 
    {
        public static Task<GetPrivateCloudResult> InvokeAsync(GetPrivateCloudArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivateCloudResult> Invoke(GetPrivateCloudInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivateCloudResult> getPrivateCloud(GetPrivateCloudArgs args, InvokeOptions options)
    public static Output<GetPrivateCloudResult> getPrivateCloud(GetPrivateCloudArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getPrivateCloud:getPrivateCloud
      arguments:
        # arguments dictionary
    data "zpa_get_private_cloud" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    MicrotenantId string
    Name string
    Id string
    MicrotenantId string
    Name string
    id string
    microtenant_id string
    name string
    id String
    microtenantId String
    name String
    id string
    microtenantId string
    name string
    id String
    microtenantId String
    name String

    getPrivateCloud Result

    The following output properties are available:

    Supporting Types

    GetPrivateCloudAssistantGroupsId

    Enabled bool
    Id string
    Name string
    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

    GetPrivateCloudPrivateBrokerGroupId

    Enabled bool
    Id string
    Name string
    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

    GetPrivateCloudPrivateExporterGroupId

    Enabled bool
    Id string
    Name string
    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

    GetPrivateCloudSiemId

    Enabled bool
    Id string
    Name string
    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

    GetPrivateCloudSiteControllerGroupId

    Enabled bool
    Id string
    Name string
    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

    GetPrivateCloudZpnFireDrillSite

    Package Details

    Repository
    zpa zscaler/pulumi-zpa
    License
    MIT
    Notes
    This Pulumi package is based on the zpa Terraform Provider.
    zpa logo
    Viewing docs for Zscaler Private Access v1.0.4
    published on Monday, Jun 29, 2026 by Zscaler

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial