zscaler-pulumi-zia 1.4.0

A native Pulumi provider for Zscaler Internet Access (ZIA).

Zscaler Internet Access (ZIA) Resource Provider

The ZIA Resource Provider lets you manage ZIA resources. To use this package, please install the Pulumi CLI first.

Installing

This package is available for several languages/platforms:

Node.js (JavaScript/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

npm install @bdzscaler/pulumi-zia

or yarn:

yarn add @bdzscaler/pulumi-zia

Python

To use from Python, install using pip:

pip install zscaler-pulumi-zia

Go

To use from Go, use go get to grab the latest version of the library:

go get github.com/zscaler/pulumi-zia/sdk/go/...

.NET

To use from .NET, install using dotnet add package:

dotnet add package zscaler.PulumiPackage.Zia

Zscaler OneAPI Client Secret Authentication

The following configuration points are available for the zia provider:

You can provide credentials via the ZSCALER_CLIENT_ID, ZSCALER_CLIENT_SECRET, ZSCALER_VANITY_DOMAIN, ZSCALER_CLOUD environment variables, representing your Zidentity OneAPI credentials clientId, clientSecret, vanityDomain and zscaler_cloud respectively.

Argument	Description	Environment Variable
client_id	(String) Zscaler API Client ID, used with clientSecret or PrivateKey OAuth auth mode.	ZSCALER_CLIENT_ID
client_secret	(String) Secret key associated with the API Client ID for authentication.	ZSCALER_CLIENT_SECRET
vanity_domain	(String) Refers to the domain name used by your organization.	ZSCALER_VANITY_DOMAIN
zscaler_cloud	(String) The name of the Zidentity cloud, e.g., beta.	ZSCALER_CLOUD

Zscaler OneAPI Private Key Authentication

The following configuration points are available for the zia provider:

You can provide credentials via the ZSCALER_CLIENT_ID, ZSCALER_CLIENT_SECRET, ZSCALER_VANITY_DOMAIN, ZSCALER_CLOUD environment variables, representing your Zidentity OneAPI credentials clientId, clientSecret, vanityDomain and zscaler_cloud respectively.

Argument	Description	Environment Variable
client_id	(String) Zscaler API Client ID, used with clientSecret or PrivateKey OAuth auth mode.	ZSCALER_CLIENT_ID
privateKey	(String) A string Private key value.	ZSCALER_PRIVATE_KEY
vanity_domain	(String) Refers to the domain name used by your organization.	ZSCALER_VANITY_DOMAIN
zscaler_cloud	(String) The name of the Zidentity cloud, e.g., beta.	ZSCALER_CLOUD

Zscaler Sandbox Authentication

The following configuration points are available for the zia provider:

You can provide credentials via the ZSCALER_SANDBOX_TOKEN, ZSCALER_SANDBOX_CLOUD, environment variables, representing your Zidentity OneAPI credentials sandbox_token, sandbox_cloud respectively.

Argument	Description	Environment Variable
sandbox_token	(String) ZIA Sandbox API Token	ZSCALER_SANDBOX_TOKEN
sandbox_cloud	(String) Zscaler Sandbox Cloud name.	ZSCALER_SANDBOX_CLOUD

ZIA Native API Credential Configuration

The following configuration points are available for the zia provider:

• zia:username (client id: ZIA_USERNAME) - (Required) This is the API username to interact with the ZIA cloud.
• zia:password (client secret: ZIA_PASSWORD) - (Required) This is the password for the API username to authenticate in the ZIA cloud.
• zia:api_key (customer id: ZIA_API_KEY) - (Required) This is the API Key used in combination with the username and password
• zia:zia_cloud (cloud environment: ZIA_CLOUD) - (Required) The cloud name where the ZIA tenant is hosted. The supported values are:
  • zscaler
  • zscalerone
  • zscalertwo
  • zscalerthree
  • zscloud
  • zscalerbeta
  • zscalergov

Reference

For detailed reference documentation, please visit the Pulumi registry.

Support

This template/solution are released under an as-is, best effort, support policy. These scripts should be seen as community supported and Zscaler Business Development Team will contribute our expertise as and when possible. We do not provide technical support or help in using or troubleshooting the components of the project through our normal support options such as Zscaler support teams, or ASC (Authorized Support Centers) partners and backline support options. The underlying product used (Zscaler Internet Access API) by the scripts or templates are still supported, but the support is only for the product functionality and not for help in deploying or using the template or script itself. Unless explicitly tagged, all projects or work posted in our GitHub repository at (https://github.com/zscaler) or sites other than our official Downloads page on https://support.zscaler.com are provided under the best effort policy.