1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. Provider
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.Provider

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    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,
             cloud: Optional[str] = None,
             debug: Optional[bool] = None,
             http_proxy: Optional[str] = None,
             max_retries: 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)
    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
    (Legacy) The API key for ZIA. Can also be set via the ZIA_API_KEY environment variable. Prefer OAuth2 credentials instead.
    ClientId string
    The OAuth2 client ID for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_ID environment variable.
    ClientSecret string
    The OAuth2 client secret for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_SECRET environment variable.
    Cloud string
    The Zscaler cloud name (e.g. 'zscaler', 'zscalerone', 'zscalertwo', 'zscalerthree', 'zscloud', 'zscalerbeta', 'zscalergov'). Can also be set via the ZSCALER_CLOUD environment variable.
    Debug bool
    If true, enables verbose Zscaler SDK logging (API requests/responses). Logs are written to stderr and optionally to the file specified by the ZSCALER_SDK_LOG_FILE environment variable.
    HttpProxy string
    HTTP proxy URL for API requests (e.g. 'http://proxy.example.com:8080'). Can also be set via the ZSCALER_HTTP_PROXY environment variable.
    MaxRetries int
    Maximum number of retries for API requests. Default is determined by the SDK.
    Password string
    (Legacy) The admin password for ZIA. Can also be set via the ZIA_PASSWORD environment variable. Prefer OAuth2 credentials instead.
    PrivateKey string
    The private key for service principal authentication. Can also be set via the ZSCALER_PRIVATE_KEY environment variable.
    RequestTimeout int
    Timeout in seconds for API requests.
    SandboxCloud string
    The Zscaler Sandbox cloud name. Can also be set via the ZIA_SANDBOX_CLOUD environment variable.
    SandboxToken string
    The API token for Zscaler Sandbox. Can also be set via the ZIA_SANDBOX_TOKEN environment variable.
    UseLegacyClient bool
    If true, use the legacy ZIA client authentication instead of OAuth2.
    Username string
    (Legacy) The admin username for ZIA. Can also be set via the ZIA_USERNAME environment variable. Prefer OAuth2 credentials instead.
    VanityDomain string
    The vanity domain for your Zscaler organization. Can also be set via the ZSCALER_VANITY_DOMAIN environment variable.
    ZiaCloud string
    (Legacy) The ZIA cloud name. Can also be set via the ZIA_CLOUD environment variable. Prefer the 'cloud' parameter instead.
    ApiKey string
    (Legacy) The API key for ZIA. Can also be set via the ZIA_API_KEY environment variable. Prefer OAuth2 credentials instead.
    ClientId string
    The OAuth2 client ID for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_ID environment variable.
    ClientSecret string
    The OAuth2 client secret for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_SECRET environment variable.
    Cloud string
    The Zscaler cloud name (e.g. 'zscaler', 'zscalerone', 'zscalertwo', 'zscalerthree', 'zscloud', 'zscalerbeta', 'zscalergov'). Can also be set via the ZSCALER_CLOUD environment variable.
    Debug bool
    If true, enables verbose Zscaler SDK logging (API requests/responses). Logs are written to stderr and optionally to the file specified by the ZSCALER_SDK_LOG_FILE environment variable.
    HttpProxy string
    HTTP proxy URL for API requests (e.g. 'http://proxy.example.com:8080'). Can also be set via the ZSCALER_HTTP_PROXY environment variable.
    MaxRetries int
    Maximum number of retries for API requests. Default is determined by the SDK.
    Password string
    (Legacy) The admin password for ZIA. Can also be set via the ZIA_PASSWORD environment variable. Prefer OAuth2 credentials instead.
    PrivateKey string
    The private key for service principal authentication. Can also be set via the ZSCALER_PRIVATE_KEY environment variable.
    RequestTimeout int
    Timeout in seconds for API requests.
    SandboxCloud string
    The Zscaler Sandbox cloud name. Can also be set via the ZIA_SANDBOX_CLOUD environment variable.
    SandboxToken string
    The API token for Zscaler Sandbox. Can also be set via the ZIA_SANDBOX_TOKEN environment variable.
    UseLegacyClient bool
    If true, use the legacy ZIA client authentication instead of OAuth2.
    Username string
    (Legacy) The admin username for ZIA. Can also be set via the ZIA_USERNAME environment variable. Prefer OAuth2 credentials instead.
    VanityDomain string
    The vanity domain for your Zscaler organization. Can also be set via the ZSCALER_VANITY_DOMAIN environment variable.
    ZiaCloud string
    (Legacy) The ZIA cloud name. Can also be set via the ZIA_CLOUD environment variable. Prefer the 'cloud' parameter instead.
    apiKey String
    (Legacy) The API key for ZIA. Can also be set via the ZIA_API_KEY environment variable. Prefer OAuth2 credentials instead.
    clientId String
    The OAuth2 client ID for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_ID environment variable.
    clientSecret String
    The OAuth2 client secret for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_SECRET environment variable.
    cloud String
    The Zscaler cloud name (e.g. 'zscaler', 'zscalerone', 'zscalertwo', 'zscalerthree', 'zscloud', 'zscalerbeta', 'zscalergov'). Can also be set via the ZSCALER_CLOUD environment variable.
    debug Boolean
    If true, enables verbose Zscaler SDK logging (API requests/responses). Logs are written to stderr and optionally to the file specified by the ZSCALER_SDK_LOG_FILE environment variable.
    httpProxy String
    HTTP proxy URL for API requests (e.g. 'http://proxy.example.com:8080'). Can also be set via the ZSCALER_HTTP_PROXY environment variable.
    maxRetries Integer
    Maximum number of retries for API requests. Default is determined by the SDK.
    password String
    (Legacy) The admin password for ZIA. Can also be set via the ZIA_PASSWORD environment variable. Prefer OAuth2 credentials instead.
    privateKey String
    The private key for service principal authentication. Can also be set via the ZSCALER_PRIVATE_KEY environment variable.
    requestTimeout Integer
    Timeout in seconds for API requests.
    sandboxCloud String
    The Zscaler Sandbox cloud name. Can also be set via the ZIA_SANDBOX_CLOUD environment variable.
    sandboxToken String
    The API token for Zscaler Sandbox. Can also be set via the ZIA_SANDBOX_TOKEN environment variable.
    useLegacyClient Boolean
    If true, use the legacy ZIA client authentication instead of OAuth2.
    username String
    (Legacy) The admin username for ZIA. Can also be set via the ZIA_USERNAME environment variable. Prefer OAuth2 credentials instead.
    vanityDomain String
    The vanity domain for your Zscaler organization. Can also be set via the ZSCALER_VANITY_DOMAIN environment variable.
    ziaCloud String
    (Legacy) The ZIA cloud name. Can also be set via the ZIA_CLOUD environment variable. Prefer the 'cloud' parameter instead.
    apiKey string
    (Legacy) The API key for ZIA. Can also be set via the ZIA_API_KEY environment variable. Prefer OAuth2 credentials instead.
    clientId string
    The OAuth2 client ID for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_ID environment variable.
    clientSecret string
    The OAuth2 client secret for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_SECRET environment variable.
    cloud string
    The Zscaler cloud name (e.g. 'zscaler', 'zscalerone', 'zscalertwo', 'zscalerthree', 'zscloud', 'zscalerbeta', 'zscalergov'). Can also be set via the ZSCALER_CLOUD environment variable.
    debug boolean
    If true, enables verbose Zscaler SDK logging (API requests/responses). Logs are written to stderr and optionally to the file specified by the ZSCALER_SDK_LOG_FILE environment variable.
    httpProxy string
    HTTP proxy URL for API requests (e.g. 'http://proxy.example.com:8080'). Can also be set via the ZSCALER_HTTP_PROXY environment variable.
    maxRetries number
    Maximum number of retries for API requests. Default is determined by the SDK.
    password string
    (Legacy) The admin password for ZIA. Can also be set via the ZIA_PASSWORD environment variable. Prefer OAuth2 credentials instead.
    privateKey string
    The private key for service principal authentication. Can also be set via the ZSCALER_PRIVATE_KEY environment variable.
    requestTimeout number
    Timeout in seconds for API requests.
    sandboxCloud string
    The Zscaler Sandbox cloud name. Can also be set via the ZIA_SANDBOX_CLOUD environment variable.
    sandboxToken string
    The API token for Zscaler Sandbox. Can also be set via the ZIA_SANDBOX_TOKEN environment variable.
    useLegacyClient boolean
    If true, use the legacy ZIA client authentication instead of OAuth2.
    username string
    (Legacy) The admin username for ZIA. Can also be set via the ZIA_USERNAME environment variable. Prefer OAuth2 credentials instead.
    vanityDomain string
    The vanity domain for your Zscaler organization. Can also be set via the ZSCALER_VANITY_DOMAIN environment variable.
    ziaCloud string
    (Legacy) The ZIA cloud name. Can also be set via the ZIA_CLOUD environment variable. Prefer the 'cloud' parameter instead.
    api_key str
    (Legacy) The API key for ZIA. Can also be set via the ZIA_API_KEY environment variable. Prefer OAuth2 credentials instead.
    client_id str
    The OAuth2 client ID for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_ID environment variable.
    client_secret str
    The OAuth2 client secret for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_SECRET environment variable.
    cloud str
    The Zscaler cloud name (e.g. 'zscaler', 'zscalerone', 'zscalertwo', 'zscalerthree', 'zscloud', 'zscalerbeta', 'zscalergov'). Can also be set via the ZSCALER_CLOUD environment variable.
    debug bool
    If true, enables verbose Zscaler SDK logging (API requests/responses). Logs are written to stderr and optionally to the file specified by the ZSCALER_SDK_LOG_FILE environment variable.
    http_proxy str
    HTTP proxy URL for API requests (e.g. 'http://proxy.example.com:8080'). Can also be set via the ZSCALER_HTTP_PROXY environment variable.
    max_retries int
    Maximum number of retries for API requests. Default is determined by the SDK.
    password str
    (Legacy) The admin password for ZIA. Can also be set via the ZIA_PASSWORD environment variable. Prefer OAuth2 credentials instead.
    private_key str
    The private key for service principal authentication. Can also be set via the ZSCALER_PRIVATE_KEY environment variable.
    request_timeout int
    Timeout in seconds for API requests.
    sandbox_cloud str
    The Zscaler Sandbox cloud name. Can also be set via the ZIA_SANDBOX_CLOUD environment variable.
    sandbox_token str
    The API token for Zscaler Sandbox. Can also be set via the ZIA_SANDBOX_TOKEN environment variable.
    use_legacy_client bool
    If true, use the legacy ZIA client authentication instead of OAuth2.
    username str
    (Legacy) The admin username for ZIA. Can also be set via the ZIA_USERNAME environment variable. Prefer OAuth2 credentials instead.
    vanity_domain str
    The vanity domain for your Zscaler organization. Can also be set via the ZSCALER_VANITY_DOMAIN environment variable.
    zia_cloud str
    (Legacy) The ZIA cloud name. Can also be set via the ZIA_CLOUD environment variable. Prefer the 'cloud' parameter instead.
    apiKey String
    (Legacy) The API key for ZIA. Can also be set via the ZIA_API_KEY environment variable. Prefer OAuth2 credentials instead.
    clientId String
    The OAuth2 client ID for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_ID environment variable.
    clientSecret String
    The OAuth2 client secret for authenticating with the Zscaler API. Can also be set via the ZSCALER_CLIENT_SECRET environment variable.
    cloud String
    The Zscaler cloud name (e.g. 'zscaler', 'zscalerone', 'zscalertwo', 'zscalerthree', 'zscloud', 'zscalerbeta', 'zscalergov'). Can also be set via the ZSCALER_CLOUD environment variable.
    debug Boolean
    If true, enables verbose Zscaler SDK logging (API requests/responses). Logs are written to stderr and optionally to the file specified by the ZSCALER_SDK_LOG_FILE environment variable.
    httpProxy String
    HTTP proxy URL for API requests (e.g. 'http://proxy.example.com:8080'). Can also be set via the ZSCALER_HTTP_PROXY environment variable.
    maxRetries Number
    Maximum number of retries for API requests. Default is determined by the SDK.
    password String
    (Legacy) The admin password for ZIA. Can also be set via the ZIA_PASSWORD environment variable. Prefer OAuth2 credentials instead.
    privateKey String
    The private key for service principal authentication. Can also be set via the ZSCALER_PRIVATE_KEY environment variable.
    requestTimeout Number
    Timeout in seconds for API requests.
    sandboxCloud String
    The Zscaler Sandbox cloud name. Can also be set via the ZIA_SANDBOX_CLOUD environment variable.
    sandboxToken String
    The API token for Zscaler Sandbox. Can also be set via the ZIA_SANDBOX_TOKEN environment variable.
    useLegacyClient Boolean
    If true, use the legacy ZIA client authentication instead of OAuth2.
    username String
    (Legacy) The admin username for ZIA. Can also be set via the ZIA_USERNAME environment variable. Prefer OAuth2 credentials instead.
    vanityDomain String
    The vanity domain for your Zscaler organization. Can also be set via the ZSCALER_VANITY_DOMAIN environment variable.
    ziaCloud String
    (Legacy) The ZIA cloud name. Can also be set via the ZIA_CLOUD environment variable. Prefer the 'cloud' parameter instead.

    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.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.