Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. PraCredentialPool
Zscaler Private Access v1.0.1 published on Thursday, Jun 5, 2025 by Zscaler
zscaler/pulumi-zpa

zpa.PraCredentialPool

Explore with Pulumi AI

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

    The zpa_pra_credential_pool resource creates a privileged remote access credential pool in the Zscaler Private Access cloud. This resource can then be referenced in an privileged access policy resource.

    Example Usage

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

const thisPRACredential = new zpa.PRACredential("thisPRACredential", {
    description: "Created with Terraform",
    credentialType: "PASSWORD",
    userDomain: "acme.com",
    password: "",
});
// Creates Credential Pool of Type "USERNAME_PASSWORD"
const thisPraCredentialPool = new zpa.PraCredentialPool("thisPraCredentialPool", {
    credentialType: "USERNAME_PASSWORD",
    credentials: [{
        ids: [thisPRACredential.id],
    }],
});

    import pulumi
import zscaler_pulumi_zpa as zpa

this_pra_credential = zpa.PRACredential("thisPRACredential",
    description="Created with Terraform",
    credential_type="PASSWORD",
    user_domain="acme.com",
    password="")
# Creates Credential Pool of Type "USERNAME_PASSWORD"
this_pra_credential_pool = zpa.PraCredentialPool("thisPraCredentialPool",
    credential_type="USERNAME_PASSWORD",
    credentials=[{
        "ids": [this_pra_credential.id],
    }])

    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 {
		thisPRACredential, err := zpa.NewPRACredential(ctx, "thisPRACredential", &zpa.PRACredentialArgs{
			Description:    pulumi.String("Created with Terraform"),
			CredentialType: pulumi.String("PASSWORD"),
			UserDomain:     pulumi.String("acme.com"),
			Password:       pulumi.String(""),
		})
		if err != nil {
			return err
		}
		// Creates Credential Pool of Type "USERNAME_PASSWORD"
		_, err = zpa.NewPraCredentialPool(ctx, "thisPraCredentialPool", &zpa.PraCredentialPoolArgs{
			CredentialType: pulumi.String("USERNAME_PASSWORD"),
			Credentials: zpa.PraCredentialPoolCredentialArray{
				&zpa.PraCredentialPoolCredentialArgs{
					Ids: pulumi.StringArray{
						thisPRACredential.ID(),
					},
				},
			},
		})
		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(() => 
{
    var thisPRACredential = new Zpa.PRACredential("thisPRACredential", new()
    {
        Description = "Created with Terraform",
        CredentialType = "PASSWORD",
        UserDomain = "acme.com",
        Password = "",
    });

    // Creates Credential Pool of Type "USERNAME_PASSWORD"
    var thisPraCredentialPool = new Zpa.PraCredentialPool("thisPraCredentialPool", new()
    {
        CredentialType = "USERNAME_PASSWORD",
        Credentials = new[]
        {
            new Zpa.Inputs.PraCredentialPoolCredentialArgs
            {
                Ids = new[]
                {
                    thisPRACredential.Id,
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.PRACredential;
import com.pulumi.zpa.PRACredentialArgs;
import com.pulumi.zpa.PraCredentialPool;
import com.pulumi.zpa.PraCredentialPoolArgs;
import com.pulumi.zpa.inputs.PraCredentialPoolCredentialArgs;
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) {
        var thisPRACredential = new PRACredential("thisPRACredential", PRACredentialArgs.builder()
            .description("Created with Terraform")
            .credentialType("PASSWORD")
            .userDomain("acme.com")
            .password("")
            .build());

        // Creates Credential Pool of Type "USERNAME_PASSWORD"
        var thisPraCredentialPool = new PraCredentialPool("thisPraCredentialPool", PraCredentialPoolArgs.builder()
            .credentialType("USERNAME_PASSWORD")
            .credentials(PraCredentialPoolCredentialArgs.builder()
                .ids(thisPRACredential.id())
                .build())
            .build());

    }
}

    resources:
  # Creates Credential Pool of Type "USERNAME_PASSWORD"
  thisPraCredentialPool:
    type: zpa:PraCredentialPool
    properties:
      credentialType: USERNAME_PASSWORD
      credentials:
        - ids:
            - ${thisPRACredential.id}
  thisPRACredential:
    type: zpa:PRACredential
    properties:
      description: Created with Terraform
      credentialType: PASSWORD
      userDomain: acme.com
      password: ""

    Create PraCredentialPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PraCredentialPool(name: string, args?: PraCredentialPoolArgs, opts?: CustomResourceOptions);
    @overload
def PraCredentialPool(resource_name: str,
                      args: Optional[PraCredentialPoolArgs] = None,
                      opts: Optional[ResourceOptions] = None)

@overload
def PraCredentialPool(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      credential_type: Optional[str] = None,
                      credentials: Optional[Sequence[PraCredentialPoolCredentialArgs]] = None,
                      microtenant_id: Optional[str] = None,
                      name: Optional[str] = None)
    func NewPraCredentialPool(ctx *Context, name string, args *PraCredentialPoolArgs, opts ...ResourceOption) (*PraCredentialPool, error)
    public PraCredentialPool(string name, PraCredentialPoolArgs? args = null, CustomResourceOptions? opts = null)
    public PraCredentialPool(String name, PraCredentialPoolArgs args)
public PraCredentialPool(String name, PraCredentialPoolArgs args, CustomResourceOptions options)

    type: zpa:PraCredentialPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PraCredentialPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PraCredentialPoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PraCredentialPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PraCredentialPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PraCredentialPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var praCredentialPoolResource = new Zpa.PraCredentialPool("praCredentialPoolResource", new()
{
    CredentialType = "string",
    Credentials = new[]
    {
        new Zpa.Inputs.PraCredentialPoolCredentialArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    MicrotenantId = "string",
    Name = "string",
});

    example, err := zpa.NewPraCredentialPool(ctx, "praCredentialPoolResource", &zpa.PraCredentialPoolArgs{
	CredentialType: pulumi.String("string"),
	Credentials: zpa.PraCredentialPoolCredentialArray{
		&zpa.PraCredentialPoolCredentialArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	MicrotenantId: pulumi.String("string"),
	Name:          pulumi.String("string"),
})

    var praCredentialPoolResource = new PraCredentialPool("praCredentialPoolResource", PraCredentialPoolArgs.builder()
    .credentialType("string")
    .credentials(PraCredentialPoolCredentialArgs.builder()
        .ids("string")
        .build())
    .microtenantId("string")
    .name("string")
    .build());

    pra_credential_pool_resource = zpa.PraCredentialPool("praCredentialPoolResource",
    credential_type="string",
    credentials=[{
        "ids": ["string"],
    }],
    microtenant_id="string",
    name="string")

    const praCredentialPoolResource = new zpa.PraCredentialPool("praCredentialPoolResource", {
    credentialType: "string",
    credentials: [{
        ids: ["string"],
    }],
    microtenantId: "string",
    name: "string",
});

    type: zpa:PraCredentialPool
properties:
    credentialType: string
    credentials:
        - ids:
            - string
    microtenantId: string
    name: string

    PraCredentialPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PraCredentialPool resource accepts the following input properties:

    CredentialType string
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    Credentials List<zscaler.PulumiPackage.Zpa.Inputs.PraCredentialPoolCredential>
    List of PRA Credentials
    MicrotenantId string
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    Name string
    The name of the privileged credential
    CredentialType string
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    Credentials []PraCredentialPoolCredentialArgs
    List of PRA Credentials
    MicrotenantId string
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    Name string
    The name of the privileged credential
    credentialType String
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials List<PraCredentialPoolCredential>
    List of PRA Credentials
    microtenantId String
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name String
    The name of the privileged credential
    credentialType string
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials PraCredentialPoolCredential[]
    List of PRA Credentials
    microtenantId string
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name string
    The name of the privileged credential
    credential_type str
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials Sequence[PraCredentialPoolCredentialArgs]
    List of PRA Credentials
    microtenant_id str
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name str
    The name of the privileged credential
    credentialType String
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials List<Property Map>
    List of PRA Credentials
    microtenantId String
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name String
    The name of the privileged credential

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PraCredentialPool resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PraCredentialPool Resource

    Get an existing PraCredentialPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PraCredentialPoolState, opts?: CustomResourceOptions): PraCredentialPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credential_type: Optional[str] = None,
        credentials: Optional[Sequence[PraCredentialPoolCredentialArgs]] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None) -> PraCredentialPool
    func GetPraCredentialPool(ctx *Context, name string, id IDInput, state *PraCredentialPoolState, opts ...ResourceOption) (*PraCredentialPool, error)
    public static PraCredentialPool Get(string name, Input<string> id, PraCredentialPoolState? state, CustomResourceOptions? opts = null)
    public static PraCredentialPool get(String name, Output<String> id, PraCredentialPoolState state, CustomResourceOptions options)
    resources:  _:    type: zpa:PraCredentialPool    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CredentialType string
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    Credentials List<zscaler.PulumiPackage.Zpa.Inputs.PraCredentialPoolCredential>
    List of PRA Credentials
    MicrotenantId string
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    Name string
    The name of the privileged credential
    CredentialType string
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    Credentials []PraCredentialPoolCredentialArgs
    List of PRA Credentials
    MicrotenantId string
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    Name string
    The name of the privileged credential
    credentialType String
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials List<PraCredentialPoolCredential>
    List of PRA Credentials
    microtenantId String
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name String
    The name of the privileged credential
    credentialType string
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials PraCredentialPoolCredential[]
    List of PRA Credentials
    microtenantId string
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name string
    The name of the privileged credential
    credential_type str
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials Sequence[PraCredentialPoolCredentialArgs]
    List of PRA Credentials
    microtenant_id str
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name str
    The name of the privileged credential
    credentialType String
    The protocol type that was designated for that particular privileged credential. The protocol type options are SSH, RDP, and VNC. Each protocol type has its own credential requirements.
    credentials List<Property Map>
    List of PRA Credentials
    microtenantId String
    The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant.
    name String
    The name of the privileged credential

    Supporting Types

    PraCredentialPoolCredential, PraCredentialPoolCredentialArgs

    Ids List<string>
    Ids []string
    ids List<String>
    ids string[]
    ids Sequence[str]
    ids List<String>

    Import

    Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language.

    Visit

    zpa_pra_credential_pool can be imported by using <POOL ID> or <POOL NAME> as the import ID.

    For example:

    $ pulumi import zpa:index/praCredentialPool:PraCredentialPool this <pool_id>

    or

    $ pulumi import zpa:index/praCredentialPool:PraCredentialPool this <pool_name>

    To learn more about importing existing cloud resources, see Importing resources.

    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
    zscaler/pulumi-zpa