Zscaler Internet Access v1.0.1, Jun 6 25

Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler

zia.Provider

Explore with Pulumi AI

Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler

The provider type for the zia 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,
             api_key: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             http_proxy: Optional[str] = None,
             max_retries: Optional[int] = None,
             parallelism: Optional[int] = None,
             password: Optional[str] = None,
             private_key: Optional[str] = None,
             request_timeout: Optional[int] = None,
             sandbox_cloud: Optional[str] = None,
             sandbox_token: Optional[str] = None,
             use_legacy_client: Optional[bool] = None,
             username: Optional[str] = None,
             vanity_domain: Optional[str] = None,
             zia_cloud: 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:zia
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:

ApiKey string: It can also be sourced from the following environment variable: ZIA_API_KEY
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
HttpProxy string: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
MaxRetries int: maximum number of retries to attempt before erroring out.
Parallelism int: Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/oneapi/understanding-rate-limiting.
Password string: It can also be sourced from the following environment variable: ZIA_PASSWORD
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.
SandboxCloud string: Zscaler Sandbox Cloud It can also be sourced from the following environment variable: ZSCALER_SANDBOX_CLOUD
SandboxToken string: Zscaler Sandbox Token It can also be sourced from the following environment variable: ZSCALER_SANDBOX_TOKEN
UseLegacyClient bool: It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
Username string: It can also be sourced from the following environment variable: ZIA_USERNAME
VanityDomain string: Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
ZiaCloud string: It can also be sourced from the following environment variable: ZIA_CLOUD
ZscalerCloud string: Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD

ApiKey string: It can also be sourced from the following environment variable: ZIA_API_KEY
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
HttpProxy string: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
MaxRetries int: maximum number of retries to attempt before erroring out.
Parallelism int: Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/oneapi/understanding-rate-limiting.
Password string: It can also be sourced from the following environment variable: ZIA_PASSWORD
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.
SandboxCloud string: Zscaler Sandbox Cloud It can also be sourced from the following environment variable: ZSCALER_SANDBOX_CLOUD
SandboxToken string: Zscaler Sandbox Token It can also be sourced from the following environment variable: ZSCALER_SANDBOX_TOKEN
UseLegacyClient bool: It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
Username string: It can also be sourced from the following environment variable: ZIA_USERNAME
VanityDomain string: Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
ZiaCloud string: It can also be sourced from the following environment variable: ZIA_CLOUD
ZscalerCloud string: Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD

apiKey String: It can also be sourced from the following environment variable: ZIA_API_KEY
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
httpProxy String: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
maxRetries Integer: maximum number of retries to attempt before erroring out.
parallelism Integer: Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/oneapi/understanding-rate-limiting.
password String: It can also be sourced from the following environment variable: ZIA_PASSWORD
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.
sandboxCloud String: Zscaler Sandbox Cloud It can also be sourced from the following environment variable: ZSCALER_SANDBOX_CLOUD
sandboxToken String: Zscaler Sandbox Token It can also be sourced from the following environment variable: ZSCALER_SANDBOX_TOKEN
useLegacyClient Boolean: It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
username String: It can also be sourced from the following environment variable: ZIA_USERNAME
vanityDomain String: Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
ziaCloud String: It can also be sourced from the following environment variable: ZIA_CLOUD
zscalerCloud String: Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD

apiKey string: It can also be sourced from the following environment variable: ZIA_API_KEY
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
httpProxy string: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
maxRetries number: maximum number of retries to attempt before erroring out.
parallelism number: Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/oneapi/understanding-rate-limiting.
password string: It can also be sourced from the following environment variable: ZIA_PASSWORD
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.
sandboxCloud string: Zscaler Sandbox Cloud It can also be sourced from the following environment variable: ZSCALER_SANDBOX_CLOUD
sandboxToken string: Zscaler Sandbox Token It can also be sourced from the following environment variable: ZSCALER_SANDBOX_TOKEN
useLegacyClient boolean: It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
username string: It can also be sourced from the following environment variable: ZIA_USERNAME
vanityDomain string: Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
ziaCloud string: It can also be sourced from the following environment variable: ZIA_CLOUD
zscalerCloud string: Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD

api_key str: It can also be sourced from the following environment variable: ZIA_API_KEY
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
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.
parallelism int: Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/oneapi/understanding-rate-limiting.
password str: It can also be sourced from the following environment variable: ZIA_PASSWORD
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.
sandbox_cloud str: Zscaler Sandbox Cloud It can also be sourced from the following environment variable: ZSCALER_SANDBOX_CLOUD
sandbox_token str: Zscaler Sandbox Token It can also be sourced from the following environment variable: ZSCALER_SANDBOX_TOKEN
use_legacy_client bool: It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
username str: It can also be sourced from the following environment variable: ZIA_USERNAME
vanity_domain str: Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
zia_cloud str: It can also be sourced from the following environment variable: ZIA_CLOUD
zscaler_cloud str: Zscaler Cloud Name It can also be sourced from the following environment variable: ZSCALER_CLOUD

apiKey String: It can also be sourced from the following environment variable: ZIA_API_KEY
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
httpProxy String: Alternate HTTP proxy of scheme://hostname or scheme://hostname:port format
maxRetries Number: maximum number of retries to attempt before erroring out.
parallelism Number: Number of concurrent requests to make within a resource where bulk operations are not possible. Take note of https://help.zscaler.com/oneapi/understanding-rate-limiting.
password String: It can also be sourced from the following environment variable: ZIA_PASSWORD
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.
sandboxCloud String: Zscaler Sandbox Cloud It can also be sourced from the following environment variable: ZSCALER_SANDBOX_CLOUD
sandboxToken String: Zscaler Sandbox Token It can also be sourced from the following environment variable: ZSCALER_SANDBOX_TOKEN
useLegacyClient Boolean: It can also be sourced from the following environment variable: ZSCALER_USE_LEGACY_CLIENT
username String: It can also be sourced from the following environment variable: ZIA_USERNAME
vanityDomain String: Zscaler Vanity Domain It can also be sourced from the following environment variable: ZSCALER_VANITY_DOMAIN
ziaCloud String: It can also be sourced from the following environment variable: ZIA_CLOUD
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: zia zscaler/pulumi-zia
License: MIT
Notes: This Pulumi package is based on the zia Terraform Provider.

Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler

zscaler/pulumi-zia

zia.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Provider Resource Methods

TerraformConfig Method

Using TerraformConfig

TerraformConfig Result

Package Details

On this page

On this page