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. Provider
Zscaler Private Access v1.0.1 published on Thursday, Jun 5, 2025 by Zscaler
zscaler/pulumi-zpa

zpa.Provider

Explore with Pulumi AI

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

    The provider type for the zpa package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             backoff: Optional[bool] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             customer_id: Optional[str] = None,
             http_proxy: Optional[str] = None,
             max_retries: Optional[int] = None,
             max_wait_seconds: Optional[int] = None,
             microtenant_id: Optional[str] = None,
             min_wait_seconds: Optional[int] = None,
             parallelism: Optional[int] = None,
             private_key: Optional[str] = None,
             request_timeout: Optional[int] = None,
             use_legacy_client: Optional[bool] = None,
             vanity_domain: Optional[str] = None,
             zpa_client_id: Optional[str] = None,
             zpa_client_secret: Optional[str] = None,
             zpa_cloud: Optional[str] = None,
             zpa_customer_id: Optional[str] = None,
             zscaler_cloud: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:zpa
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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider 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 Provider resource accepts the following input properties:

    Backoff bool
    Use exponential back off strategy for rate limits.
    ClientId string
    zpa client id It can also be sourced from the following environment variable: ZSCALER_CLIENT_ID
    ClientSecret string
    zpa client secret It can also be sourced from the following environment variable: ZSCALER_CLIENT_SECRET
    CustomerId string
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    HttpProxy string
    Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
    MaxRetries int
    maximum number of retries to attempt before erroring out.
    MaxWaitSeconds int
    maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    MicrotenantId string
    zpa microtenant ID
    MinWaitSeconds int
    minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    Parallelism int
    Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/zpa/understanding-rate-limiting.
    PrivateKey string
    zpa private key It can also be sourced from the following environment variable: ZSCALER_PRIVATE_KEY
    RequestTimeout int
    Timeout for single request (in seconds) which is made to Zscaler, the default is 0 (means no limit is set). The maximum value can be 300.
    UseLegacyClient bool
    Enables interaction with the ZPA legacy API framework It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
    VanityDomain string
    Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
    ZpaClientId string
    zpa client id It can also be sourced from the following environment variable: ZPA_CLIENT_ID
    ZpaClientSecret string
    zpa client secret It can also be sourced from the following environment variable: ZPA_CLIENT_SECRET
    ZpaCloud string
    Cloud to use PRODUCTION, ZPATWO, BETA, GOV, GOVUS, PREVIEW, DEV, QA, QA2 It can also be sourced from the following environment variable: ZPA_CLOUD
    ZpaCustomerId string
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    ZscalerCloud string
    Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD
    Backoff bool
    Use exponential back off strategy for rate limits.
    ClientId string
    zpa client id It can also be sourced from the following environment variable: ZSCALER_CLIENT_ID
    ClientSecret string
    zpa client secret It can also be sourced from the following environment variable: ZSCALER_CLIENT_SECRET
    CustomerId string
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    HttpProxy string
    Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
    MaxRetries int
    maximum number of retries to attempt before erroring out.
    MaxWaitSeconds int
    maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    MicrotenantId string
    zpa microtenant ID
    MinWaitSeconds int
    minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    Parallelism int
    Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/zpa/understanding-rate-limiting.
    PrivateKey string
    zpa private key It can also be sourced from the following environment variable: ZSCALER_PRIVATE_KEY
    RequestTimeout int
    Timeout for single request (in seconds) which is made to Zscaler, the default is 0 (means no limit is set). The maximum value can be 300.
    UseLegacyClient bool
    Enables interaction with the ZPA legacy API framework It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
    VanityDomain string
    Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
    ZpaClientId string
    zpa client id It can also be sourced from the following environment variable: ZPA_CLIENT_ID
    ZpaClientSecret string
    zpa client secret It can also be sourced from the following environment variable: ZPA_CLIENT_SECRET
    ZpaCloud string
    Cloud to use PRODUCTION, ZPATWO, BETA, GOV, GOVUS, PREVIEW, DEV, QA, QA2 It can also be sourced from the following environment variable: ZPA_CLOUD
    ZpaCustomerId string
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    ZscalerCloud string
    Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD
    backoff Boolean
    Use exponential back off strategy for rate limits.
    clientId String
    zpa client id It can also be sourced from the following environment variable: ZSCALER_CLIENT_ID
    clientSecret String
    zpa client secret It can also be sourced from the following environment variable: ZSCALER_CLIENT_SECRET
    customerId String
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    httpProxy String
    Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
    maxRetries Integer
    maximum number of retries to attempt before erroring out.
    maxWaitSeconds Integer
    maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    microtenantId String
    zpa microtenant ID
    minWaitSeconds Integer
    minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    parallelism Integer
    Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/zpa/understanding-rate-limiting.
    privateKey String
    zpa private key It can also be sourced from the following environment variable: ZSCALER_PRIVATE_KEY
    requestTimeout Integer
    Timeout for single request (in seconds) which is made to Zscaler, the default is 0 (means no limit is set). The maximum value can be 300.
    useLegacyClient Boolean
    Enables interaction with the ZPA legacy API framework It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
    vanityDomain String
    Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
    zpaClientId String
    zpa client id It can also be sourced from the following environment variable: ZPA_CLIENT_ID
    zpaClientSecret String
    zpa client secret It can also be sourced from the following environment variable: ZPA_CLIENT_SECRET
    zpaCloud String
    Cloud to use PRODUCTION, ZPATWO, BETA, GOV, GOVUS, PREVIEW, DEV, QA, QA2 It can also be sourced from the following environment variable: ZPA_CLOUD
    zpaCustomerId String
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    zscalerCloud String
    Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD
    backoff boolean
    Use exponential back off strategy for rate limits.
    clientId string
    zpa client id It can also be sourced from the following environment variable: ZSCALER_CLIENT_ID
    clientSecret string
    zpa client secret It can also be sourced from the following environment variable: ZSCALER_CLIENT_SECRET
    customerId string
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    httpProxy string
    Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
    maxRetries number
    maximum number of retries to attempt before erroring out.
    maxWaitSeconds number
    maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    microtenantId string
    zpa microtenant ID
    minWaitSeconds number
    minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    parallelism number
    Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/zpa/understanding-rate-limiting.
    privateKey string
    zpa private key It can also be sourced from the following environment variable: ZSCALER_PRIVATE_KEY
    requestTimeout number
    Timeout for single request (in seconds) which is made to Zscaler, the default is 0 (means no limit is set). The maximum value can be 300.
    useLegacyClient boolean
    Enables interaction with the ZPA legacy API framework It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
    vanityDomain string
    Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
    zpaClientId string
    zpa client id It can also be sourced from the following environment variable: ZPA_CLIENT_ID
    zpaClientSecret string
    zpa client secret It can also be sourced from the following environment variable: ZPA_CLIENT_SECRET
    zpaCloud string
    Cloud to use PRODUCTION, ZPATWO, BETA, GOV, GOVUS, PREVIEW, DEV, QA, QA2 It can also be sourced from the following environment variable: ZPA_CLOUD
    zpaCustomerId string
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    zscalerCloud string
    Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD
    backoff bool
    Use exponential back off strategy for rate limits.
    client_id str
    zpa client id It can also be sourced from the following environment variable: ZSCALER_CLIENT_ID
    client_secret str
    zpa client secret It can also be sourced from the following environment variable: ZSCALER_CLIENT_SECRET
    customer_id str
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    http_proxy str
    Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
    max_retries int
    maximum number of retries to attempt before erroring out.
    max_wait_seconds int
    maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    microtenant_id str
    zpa microtenant ID
    min_wait_seconds int
    minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    parallelism int
    Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/zpa/understanding-rate-limiting.
    private_key str
    zpa private key It can also be sourced from the following environment variable: ZSCALER_PRIVATE_KEY
    request_timeout int
    Timeout for single request (in seconds) which is made to Zscaler, the default is 0 (means no limit is set). The maximum value can be 300.
    use_legacy_client bool
    Enables interaction with the ZPA legacy API framework It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
    vanity_domain str
    Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
    zpa_client_id str
    zpa client id It can also be sourced from the following environment variable: ZPA_CLIENT_ID
    zpa_client_secret str
    zpa client secret It can also be sourced from the following environment variable: ZPA_CLIENT_SECRET
    zpa_cloud str
    Cloud to use PRODUCTION, ZPATWO, BETA, GOV, GOVUS, PREVIEW, DEV, QA, QA2 It can also be sourced from the following environment variable: ZPA_CLOUD
    zpa_customer_id str
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    zscaler_cloud str
    Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD
    backoff Boolean
    Use exponential back off strategy for rate limits.
    clientId String
    zpa client id It can also be sourced from the following environment variable: ZSCALER_CLIENT_ID
    clientSecret String
    zpa client secret It can also be sourced from the following environment variable: ZSCALER_CLIENT_SECRET
    customerId String
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    httpProxy String
    Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
    maxRetries Number
    maximum number of retries to attempt before erroring out.
    maxWaitSeconds Number
    maximum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    microtenantId String
    zpa microtenant ID
    minWaitSeconds Number
    minimum seconds to wait when rate limit is hit. We use exponential backoffs when backoff is enabled.
    parallelism Number
    Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/zpa/understanding-rate-limiting.
    privateKey String
    zpa private key It can also be sourced from the following environment variable: ZSCALER_PRIVATE_KEY
    requestTimeout Number
    Timeout for single request (in seconds) which is made to Zscaler, the default is 0 (means no limit is set). The maximum value can be 300.
    useLegacyClient Boolean
    Enables interaction with the ZPA legacy API framework It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
    vanityDomain String
    Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
    zpaClientId String
    zpa client id It can also be sourced from the following environment variable: ZPA_CLIENT_ID
    zpaClientSecret String
    zpa client secret It can also be sourced from the following environment variable: ZPA_CLIENT_SECRET
    zpaCloud String
    Cloud to use PRODUCTION, ZPATWO, BETA, GOV, GOVUS, PREVIEW, DEV, QA, QA2 It can also be sourced from the following environment variable: ZPA_CLOUD
    zpaCustomerId String
    zpa customer id It can also be sourced from the following environment variable: ZPA_CUSTOMER_ID
    zscalerCloud String
    Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider 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.

    Provider Resource Methods

    TerraformConfig Method

    This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

    Using TerraformConfig

    terraformConfig(): Output<Provider.TerraformConfigResult>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)
    public Output<Provider.TerraformConfigResult> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    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