1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getCredentialPool
Zscaler Private Access v1.0.2 published on Friday, Jun 20, 2025 by Zscaler

zpa.getCredentialPool

Start a Neo task
Explain and create a zpa.getCredentialPool resource
zpa logo
Zscaler Private Access v1.0.2 published on Friday, Jun 20, 2025 by Zscaler

    The zpa_pra_credential_pool data source to get information about a privileged remote access credential pool created in the Zscaler Private Access cloud.

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

    Example Usage

    Retrieves PRA Credential Pool By Name

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = zpa.getCredentialPool({
        name: "PRACredentialPool01",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    this = zpa.get_credential_pool(name="PRACredentialPool01")
    
    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.GetCredentialPool(ctx, &zpa.GetCredentialPoolArgs{
    			Name: pulumi.StringRef("PRACredentialPool01"),
    		}, 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.GetCredentialPool.Invoke(new()
        {
            Name = "PRACredentialPool01",
        });
    
    });
    
    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.GetCredentialPoolArgs;
    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.getCredentialPool(GetCredentialPoolArgs.builder()
                .name("PRACredentialPool01")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: zpa:getCredentialPool
          arguments:
            name: PRACredentialPool01
    

    Retrieves PRA Credential Pool By ID

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = zpa.getCredentialPool({
        id: "5458",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    this = zpa.get_credential_pool(id="5458")
    
    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.GetCredentialPool(ctx, &zpa.GetCredentialPoolArgs{
    			Id: pulumi.StringRef("5458"),
    		}, 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.GetCredentialPool.Invoke(new()
        {
            Id = "5458",
        });
    
    });
    
    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.GetCredentialPoolArgs;
    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.getCredentialPool(GetCredentialPoolArgs.builder()
                .id("5458")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: zpa:getCredentialPool
          arguments:
            id: '5458'
    

    Using getCredentialPool

    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 getCredentialPool(args: GetCredentialPoolArgs, opts?: InvokeOptions): Promise<GetCredentialPoolResult>
    function getCredentialPoolOutput(args: GetCredentialPoolOutputArgs, opts?: InvokeOptions): Output<GetCredentialPoolResult>
    def get_credential_pool(credentials: Optional[Sequence[GetCredentialPoolCredential]] = None,
                            id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetCredentialPoolResult
    def get_credential_pool_output(credentials: Optional[pulumi.Input[Sequence[pulumi.Input[GetCredentialPoolCredentialArgs]]]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetCredentialPoolResult]
    func GetCredentialPool(ctx *Context, args *GetCredentialPoolArgs, opts ...InvokeOption) (*GetCredentialPoolResult, error)
    func GetCredentialPoolOutput(ctx *Context, args *GetCredentialPoolOutputArgs, opts ...InvokeOption) GetCredentialPoolResultOutput

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

    public static class GetCredentialPool 
    {
        public static Task<GetCredentialPoolResult> InvokeAsync(GetCredentialPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetCredentialPoolResult> Invoke(GetCredentialPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCredentialPoolResult> getCredentialPool(GetCredentialPoolArgs args, InvokeOptions options)
    public static Output<GetCredentialPoolResult> getCredentialPool(GetCredentialPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getCredentialPool:getCredentialPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Credentials List<zscaler.PulumiPackage.Zpa.Inputs.GetCredentialPoolCredential>
    Id string
    Name string
    • (String) The name of the privileged credential.
    Credentials []GetCredentialPoolCredential
    Id string
    Name string
    • (String) The name of the privileged credential.
    credentials List<GetCredentialPoolCredential>
    id String
    name String
    • (String) The name of the privileged credential.
    credentials GetCredentialPoolCredential[]
    id string
    name string
    • (String) The name of the privileged credential.
    credentials Sequence[GetCredentialPoolCredential]
    id str
    name str
    • (String) The name of the privileged credential.
    credentials List<Property Map>
    id String
    name String
    • (String) The name of the privileged credential.

    getCredentialPool Result

    The following output properties are available:

    CreationTime string
    CredentialMappingCount string
    CredentialType string
    Credentials []GetCredentialPoolCredential
    MicrotenantId string
    MicrotenantName string
    ModifiedBy string
    ModifiedTime string
    Id string
    Name string
    • (String) The name of the privileged credential.
    creationTime String
    credentialMappingCount String
    credentialType String
    credentials List<GetCredentialPoolCredential>
    microtenantId String
    microtenantName String
    modifiedBy String
    modifiedTime String
    id String
    name String
    • (String) The name of the privileged credential.
    creationTime string
    credentialMappingCount string
    credentialType string
    credentials GetCredentialPoolCredential[]
    microtenantId string
    microtenantName string
    modifiedBy string
    modifiedTime string
    id string
    name string
    • (String) The name of the privileged credential.
    creationTime String
    credentialMappingCount String
    credentialType String
    credentials List<Property Map>
    microtenantId String
    microtenantName String
    modifiedBy String
    modifiedTime String
    id String
    name String
    • (String) The name of the privileged credential.

    Supporting Types

    GetCredentialPoolCredential

    Ids List<string>
    Ids []string
    ids List<String>
    ids string[]
    ids Sequence[str]
    ids List<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.2 published on Friday, Jun 20, 2025 by Zscaler
      Meet Neo: Your AI Platform Teammate