1. Packages
  2. Packages
  3. Zscaler Private Access (ZPA)
  4. API Docs
  5. PrivateCloudGroup
Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler
zpa logo
Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler

    The zpa_private_cloud_group resource creates a private cloud group in the Zscaler Private Access cloud.

    Private Cloud Connector Onboarding Methods

    Private Cloud Connectors can be onboarded into ZPA in two ways. This resource supports both:

    1. OAuth2 user codes (recommended for new deployments) - Set userCodes with the codes generated on each Private Cloud Connector VM. The provider creates the group and then calls the OAuth2 user code verification API to enroll the connectors.
    2. Provisioning key (legacy / still supported) - Create the group with this resource, then create a zpa.ProvisioningKey referencing it. The key is then injected into the Private Cloud Connector VM at deployment time.

    In both methods, the Private Cloud Connector enrollment requires an enrollmentCertId. You can either:

    • Set enrollmentCertId explicitly using the zpa.getEnrollmentCert data source, or
    • Omit it entirely - the provider will automatically look up the “Connector” enrollment certificate by name and populate the ID for you.

    Example Usage

    OAuth2 Enrollment With User Codes (Explicit Enrollment Certificate)

    Set the enrollment certificate explicitly and provide the user codes displayed on the Private Cloud Connector VMs after deployment. The provider will create the group and then call the user code verification API to complete enrollment.

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const connector = zpa.getEnrollmentCert({
        name: "Connector",
    });
    const _this = new zpa.PrivateCloudGroup("this", {
        name: "PrivateCloudGroup01",
        description: "Example private cloud group",
        enabled: true,
        cityCountry: "San Jose, US",
        latitude: "37.33874",
        longitude: "-121.8852525",
        location: "San Jose, CA, USA",
        upgradeDay: "SUNDAY",
        upgradeTimeInSecs: "66600",
        siteId: "72058304855088543",
        versionProfileId: "0",
        overrideVersionProfile: true,
        isPublic: "TRUE",
        enrollmentCertId: connector.then(connector => connector.id),
        userCodes: [
            "CODE_FROM_VM_1",
            "CODE_FROM_VM_2",
        ],
    });
    
    import pulumi
    import pulumi_zpa as zpa
    import zscaler_pulumi_zpa as zpa
    
    connector = zpa.get_enrollment_cert(name="Connector")
    this = zpa.PrivateCloudGroup("this",
        name="PrivateCloudGroup01",
        description="Example private cloud group",
        enabled=True,
        city_country="San Jose, US",
        latitude="37.33874",
        longitude="-121.8852525",
        location="San Jose, CA, USA",
        upgrade_day="SUNDAY",
        upgrade_time_in_secs="66600",
        site_id="72058304855088543",
        version_profile_id="0",
        override_version_profile=True,
        is_public="TRUE",
        enrollment_cert_id=connector.id,
        user_codes=[
            "CODE_FROM_VM_1",
            "CODE_FROM_VM_2",
        ])
    
    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 {
    		connector, err := zpa.GetEnrollmentCert(ctx, &zpa.GetEnrollmentCertArgs{
    			Name: pulumi.StringRef("Connector"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = zpa.NewPrivateCloudGroup(ctx, "this", &zpa.PrivateCloudGroupArgs{
    			Name:                   pulumi.String("PrivateCloudGroup01"),
    			Description:            pulumi.String("Example private cloud group"),
    			Enabled:                pulumi.Bool(true),
    			CityCountry:            pulumi.String("San Jose, US"),
    			Latitude:               pulumi.String("37.33874"),
    			Longitude:              pulumi.String("-121.8852525"),
    			Location:               pulumi.String("San Jose, CA, USA"),
    			UpgradeDay:             pulumi.String("SUNDAY"),
    			UpgradeTimeInSecs:      pulumi.String("66600"),
    			SiteId:                 "72058304855088543",
    			VersionProfileId:       pulumi.String("0"),
    			OverrideVersionProfile: pulumi.Bool(true),
    			IsPublic:               pulumi.String("TRUE"),
    			EnrollmentCertId:       pulumi.String(connector.Id),
    			UserCodes: pulumi.StringArray{
    				pulumi.String("CODE_FROM_VM_1"),
    				pulumi.String("CODE_FROM_VM_2"),
    			},
    		})
    		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 connector = Zpa.GetEnrollmentCert.Invoke(new()
        {
            Name = "Connector",
        });
    
        var @this = new Zpa.PrivateCloudGroup("this", new()
        {
            Name = "PrivateCloudGroup01",
            Description = "Example private cloud group",
            Enabled = true,
            CityCountry = "San Jose, US",
            Latitude = "37.33874",
            Longitude = "-121.8852525",
            Location = "San Jose, CA, USA",
            UpgradeDay = "SUNDAY",
            UpgradeTimeInSecs = "66600",
            SiteId = "72058304855088543",
            VersionProfileId = "0",
            OverrideVersionProfile = true,
            IsPublic = "TRUE",
            EnrollmentCertId = connector.Apply(getEnrollmentCertResult => getEnrollmentCertResult.Id),
            UserCodes = new[]
            {
                "CODE_FROM_VM_1",
                "CODE_FROM_VM_2",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.ZpaFunctions;
    import com.pulumi.zpa.inputs.GetEnrollmentCertArgs;
    import com.pulumi.zpa.PrivateCloudGroup;
    import com.pulumi.zpa.PrivateCloudGroupArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            final var connector = ZpaFunctions.getEnrollmentCert(GetEnrollmentCertArgs.builder()
                .name("Connector")
                .build());
    
            var this_ = new PrivateCloudGroup("this", PrivateCloudGroupArgs.builder()
                .name("PrivateCloudGroup01")
                .description("Example private cloud group")
                .enabled(true)
                .cityCountry("San Jose, US")
                .latitude("37.33874")
                .longitude("-121.8852525")
                .location("San Jose, CA, USA")
                .upgradeDay("SUNDAY")
                .upgradeTimeInSecs("66600")
                .siteId("72058304855088543")
                .versionProfileId("0")
                .overrideVersionProfile(true)
                .isPublic("TRUE")
                .enrollmentCertId(connector.id())
                .userCodes(            
                    "CODE_FROM_VM_1",
                    "CODE_FROM_VM_2")
                .build());
    
        }
    }
    
    resources:
      this:
        type: zpa:PrivateCloudGroup
        properties:
          name: PrivateCloudGroup01
          description: Example private cloud group
          enabled: true
          cityCountry: San Jose, US
          latitude: '37.33874'
          longitude: '-121.8852525'
          location: San Jose, CA, USA
          upgradeDay: SUNDAY
          upgradeTimeInSecs: '66600'
          siteId: '72058304855088543'
          versionProfileId: '0'
          overrideVersionProfile: true
          isPublic: TRUE
          enrollmentCertId: ${connector.id}
          userCodes:
            - CODE_FROM_VM_1
            - CODE_FROM_VM_2
    variables:
      connector:
        fn::invoke:
          function: zpa:getEnrollmentCert
          arguments:
            name: Connector
    
    pulumi {
      required_providers {
        zpa = {
          source = "pulumi/zpa"
        }
      }
    }
    
    data "zpa_getenrollmentcert" "connector" {
      name = "Connector"
    }
    
    resource "zpa_privatecloudgroup" "this" {
      name                     = "PrivateCloudGroup01"
      description              = "Example private cloud group"
      enabled                  = true
      city_country             = "San Jose, US"
      latitude                 = "37.33874"
      longitude                = "-121.8852525"
      location                 = "San Jose, CA, USA"
      upgrade_day              = "SUNDAY"
      upgrade_time_in_secs     = "66600"
      site_id                  = "72058304855088543"
      version_profile_id       = "0"
      override_version_profile = true
      is_public                = "TRUE"
      enrollment_cert_id       = data.zpa_getenrollmentcert.connector.id
      user_codes               = ["CODE_FROM_VM_1", "CODE_FROM_VM_2"]
    }
    

    OAuth2 Enrollment With User Codes (Auto-Resolved Enrollment Certificate)

    Omit enrollmentCertId entirely and the provider will automatically resolve the “Connector” enrollment certificate for you. This is the simplest configuration and is functionally equivalent to the explicit example above.

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const example = new zpa.PrivateCloudGroup("example", {
        name: "PrivateCloudGroup01",
        description: "Example private cloud group",
        enabled: true,
        countryCode: "US",
        cityCountry: "San Jose, US",
        latitude: "37.33874",
        longitude: "-121.8852525",
        location: "San Jose, CA, USA",
        upgradeDay: "SUNDAY",
        upgradeTimeInSecs: "66600",
        siteId: "72058304855088543",
        versionProfileId: "0",
        overrideVersionProfile: true,
        isPublic: "TRUE",
        userCodes: [
            "CODE_FROM_VM_1",
            "CODE_FROM_VM_2",
        ],
    });
    
    import pulumi
    import zscaler_pulumi_zpa as zpa
    
    example = zpa.PrivateCloudGroup("example",
        name="PrivateCloudGroup01",
        description="Example private cloud group",
        enabled=True,
        country_code="US",
        city_country="San Jose, US",
        latitude="37.33874",
        longitude="-121.8852525",
        location="San Jose, CA, USA",
        upgrade_day="SUNDAY",
        upgrade_time_in_secs="66600",
        site_id="72058304855088543",
        version_profile_id="0",
        override_version_profile=True,
        is_public="TRUE",
        user_codes=[
            "CODE_FROM_VM_1",
            "CODE_FROM_VM_2",
        ])
    
    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 {
    		_, err := zpa.NewPrivateCloudGroup(ctx, "example", &zpa.PrivateCloudGroupArgs{
    			Name:                   pulumi.String("PrivateCloudGroup01"),
    			Description:            pulumi.String("Example private cloud group"),
    			Enabled:                pulumi.Bool(true),
    			CountryCode:            pulumi.String("US"),
    			CityCountry:            pulumi.String("San Jose, US"),
    			Latitude:               pulumi.String("37.33874"),
    			Longitude:              pulumi.String("-121.8852525"),
    			Location:               pulumi.String("San Jose, CA, USA"),
    			UpgradeDay:             pulumi.String("SUNDAY"),
    			UpgradeTimeInSecs:      pulumi.String("66600"),
    			SiteId:                 "72058304855088543",
    			VersionProfileId:       pulumi.String("0"),
    			OverrideVersionProfile: pulumi.Bool(true),
    			IsPublic:               pulumi.String("TRUE"),
    			UserCodes: pulumi.StringArray{
    				pulumi.String("CODE_FROM_VM_1"),
    				pulumi.String("CODE_FROM_VM_2"),
    			},
    		})
    		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 example = new Zpa.PrivateCloudGroup("example", new()
        {
            Name = "PrivateCloudGroup01",
            Description = "Example private cloud group",
            Enabled = true,
            CountryCode = "US",
            CityCountry = "San Jose, US",
            Latitude = "37.33874",
            Longitude = "-121.8852525",
            Location = "San Jose, CA, USA",
            UpgradeDay = "SUNDAY",
            UpgradeTimeInSecs = "66600",
            SiteId = "72058304855088543",
            VersionProfileId = "0",
            OverrideVersionProfile = true,
            IsPublic = "TRUE",
            UserCodes = new[]
            {
                "CODE_FROM_VM_1",
                "CODE_FROM_VM_2",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.PrivateCloudGroup;
    import com.pulumi.zpa.PrivateCloudGroupArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = new PrivateCloudGroup("example", PrivateCloudGroupArgs.builder()
                .name("PrivateCloudGroup01")
                .description("Example private cloud group")
                .enabled(true)
                .countryCode("US")
                .cityCountry("San Jose, US")
                .latitude("37.33874")
                .longitude("-121.8852525")
                .location("San Jose, CA, USA")
                .upgradeDay("SUNDAY")
                .upgradeTimeInSecs("66600")
                .siteId("72058304855088543")
                .versionProfileId("0")
                .overrideVersionProfile(true)
                .isPublic("TRUE")
                .userCodes(            
                    "CODE_FROM_VM_1",
                    "CODE_FROM_VM_2")
                .build());
    
        }
    }
    
    resources:
      example:
        type: zpa:PrivateCloudGroup
        properties:
          name: PrivateCloudGroup01
          description: Example private cloud group
          enabled: true
          countryCode: US
          cityCountry: San Jose, US
          latitude: '37.33874'
          longitude: '-121.8852525'
          location: San Jose, CA, USA
          upgradeDay: SUNDAY
          upgradeTimeInSecs: '66600'
          siteId: '72058304855088543'
          versionProfileId: '0'
          overrideVersionProfile: true
          isPublic: TRUE
          userCodes:
            - CODE_FROM_VM_1
            - CODE_FROM_VM_2
    
    pulumi {
      required_providers {
        zpa = {
          source = "pulumi/zpa"
        }
      }
    }
    
    resource "zpa_privatecloudgroup" "example" {
      name                     = "PrivateCloudGroup01"
      description              = "Example private cloud group"
      enabled                  = true
      country_code             = "US"
      city_country             = "San Jose, US"
      latitude                 = "37.33874"
      longitude                = "-121.8852525"
      location                 = "San Jose, CA, USA"
      upgrade_day              = "SUNDAY"
      upgrade_time_in_secs     = "66600"
      site_id                  = "72058304855088543"
      version_profile_id       = "0"
      override_version_profile = true
      is_public                = "TRUE"
      user_codes               = ["CODE_FROM_VM_1", "CODE_FROM_VM_2"]
    }
    

    Enrolling Private Cloud Connectors Via Provisioning Key (Explicit Enrollment Certificate)

    Create the Private Cloud Connector Group, then create a zpa.ProvisioningKey that references the group’s ID. The provisioning key is then injected into the Private Cloud Connector VM at deployment time.

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const connector = zpa.getEnrollmentCert({
        name: "Connector",
    });
    const example = new zpa.PrivateCloudGroup("example", {
        name: "Example",
        description: "Example",
        enabled: true,
        cityCountry: "San Jose, CA",
        countryCode: "US",
        latitude: "37.338",
        longitude: "-121.8863",
        location: "San Jose, CA, US",
        upgradeDay: "SUNDAY",
        upgradeTimeInSecs: "66600",
        dnsQueryType: "IPV4_IPV6",
        enrollmentCertId: connector.then(connector => connector.id),
    });
    const exampleProvisioningKey = new zpa.ProvisioningKey("example", {
        name: "ProvisioningKey01",
        associationType: "CONNECTOR_GRP",
        maxUsage: "10",
        enrollmentCertId: connector.then(connector => connector.id),
        zcomponentId: example.id,
    });
    
    import pulumi
    import pulumi_zpa as zpa
    import zscaler_pulumi_zpa as zpa
    
    connector = zpa.get_enrollment_cert(name="Connector")
    example = zpa.PrivateCloudGroup("example",
        name="Example",
        description="Example",
        enabled=True,
        city_country="San Jose, CA",
        country_code="US",
        latitude="37.338",
        longitude="-121.8863",
        location="San Jose, CA, US",
        upgrade_day="SUNDAY",
        upgrade_time_in_secs="66600",
        dns_query_type="IPV4_IPV6",
        enrollment_cert_id=connector.id)
    example_provisioning_key = zpa.ProvisioningKey("example",
        name="ProvisioningKey01",
        association_type="CONNECTOR_GRP",
        max_usage="10",
        enrollment_cert_id=connector.id,
        zcomponent_id=example.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 {
    		connector, err := zpa.GetEnrollmentCert(ctx, &zpa.GetEnrollmentCertArgs{
    			Name: pulumi.StringRef("Connector"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		example, err := zpa.NewPrivateCloudGroup(ctx, "example", &zpa.PrivateCloudGroupArgs{
    			Name:              pulumi.String("Example"),
    			Description:       pulumi.String("Example"),
    			Enabled:           pulumi.Bool(true),
    			CityCountry:       pulumi.String("San Jose, CA"),
    			CountryCode:       pulumi.String("US"),
    			Latitude:          pulumi.String("37.338"),
    			Longitude:         pulumi.String("-121.8863"),
    			Location:          pulumi.String("San Jose, CA, US"),
    			UpgradeDay:        pulumi.String("SUNDAY"),
    			UpgradeTimeInSecs: pulumi.String("66600"),
    			DnsQueryType:      "IPV4_IPV6",
    			EnrollmentCertId:  pulumi.String(connector.Id),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = zpa.NewProvisioningKey(ctx, "example", &zpa.ProvisioningKeyArgs{
    			Name:             pulumi.String("ProvisioningKey01"),
    			AssociationType:  pulumi.String("CONNECTOR_GRP"),
    			MaxUsage:         pulumi.String("10"),
    			EnrollmentCertId: pulumi.String(connector.Id),
    			ZcomponentId:     example.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 connector = Zpa.GetEnrollmentCert.Invoke(new()
        {
            Name = "Connector",
        });
    
        var example = new Zpa.PrivateCloudGroup("example", new()
        {
            Name = "Example",
            Description = "Example",
            Enabled = true,
            CityCountry = "San Jose, CA",
            CountryCode = "US",
            Latitude = "37.338",
            Longitude = "-121.8863",
            Location = "San Jose, CA, US",
            UpgradeDay = "SUNDAY",
            UpgradeTimeInSecs = "66600",
            DnsQueryType = "IPV4_IPV6",
            EnrollmentCertId = connector.Apply(getEnrollmentCertResult => getEnrollmentCertResult.Id),
        });
    
        var exampleProvisioningKey = new Zpa.ProvisioningKey("example", new()
        {
            Name = "ProvisioningKey01",
            AssociationType = "CONNECTOR_GRP",
            MaxUsage = "10",
            EnrollmentCertId = connector.Apply(getEnrollmentCertResult => getEnrollmentCertResult.Id),
            ZcomponentId = example.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.ZpaFunctions;
    import com.pulumi.zpa.inputs.GetEnrollmentCertArgs;
    import com.pulumi.zpa.PrivateCloudGroup;
    import com.pulumi.zpa.PrivateCloudGroupArgs;
    import com.pulumi.zpa.ProvisioningKey;
    import com.pulumi.zpa.ProvisioningKeyArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            final var connector = ZpaFunctions.getEnrollmentCert(GetEnrollmentCertArgs.builder()
                .name("Connector")
                .build());
    
            var example = new PrivateCloudGroup("example", PrivateCloudGroupArgs.builder()
                .name("Example")
                .description("Example")
                .enabled(true)
                .cityCountry("San Jose, CA")
                .countryCode("US")
                .latitude("37.338")
                .longitude("-121.8863")
                .location("San Jose, CA, US")
                .upgradeDay("SUNDAY")
                .upgradeTimeInSecs("66600")
                .dnsQueryType("IPV4_IPV6")
                .enrollmentCertId(connector.id())
                .build());
    
            var exampleProvisioningKey = new ProvisioningKey("exampleProvisioningKey", ProvisioningKeyArgs.builder()
                .name("ProvisioningKey01")
                .associationType("CONNECTOR_GRP")
                .maxUsage("10")
                .enrollmentCertId(connector.id())
                .zcomponentId(example.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: zpa:PrivateCloudGroup
        properties:
          name: Example
          description: Example
          enabled: true
          cityCountry: San Jose, CA
          countryCode: US
          latitude: '37.338'
          longitude: '-121.8863'
          location: San Jose, CA, US
          upgradeDay: SUNDAY
          upgradeTimeInSecs: '66600'
          dnsQueryType: IPV4_IPV6
          enrollmentCertId: ${connector.id}
      exampleProvisioningKey:
        type: zpa:ProvisioningKey
        name: example
        properties:
          name: ProvisioningKey01
          associationType: CONNECTOR_GRP
          maxUsage: '10'
          enrollmentCertId: ${connector.id}
          zcomponentId: ${example.id}
    variables:
      connector:
        fn::invoke:
          function: zpa:getEnrollmentCert
          arguments:
            name: Connector
    
    pulumi {
      required_providers {
        zpa = {
          source = "pulumi/zpa"
        }
      }
    }
    
    data "zpa_getenrollmentcert" "connector" {
      name = "Connector"
    }
    
    resource "zpa_privatecloudgroup" "example" {
      name                 = "Example"
      description          = "Example"
      enabled              = true
      city_country         = "San Jose, CA"
      country_code         = "US"
      latitude             = "37.338"
      longitude            = "-121.8863"
      location             = "San Jose, CA, US"
      upgrade_day          = "SUNDAY"
      upgrade_time_in_secs = "66600"
      dns_query_type       = "IPV4_IPV6"
      enrollment_cert_id   = data.zpa_getenrollmentcert.connector.id
    }
    resource "zpa_provisioningkey" "example" {
      name               = "ProvisioningKey01"
      association_type   = "CONNECTOR_GRP"
      max_usage          = "10"
      enrollment_cert_id = data.zpa_getenrollmentcert.connector.id
      zcomponent_id      = zpa_privatecloudgroup.example.id
    }
    

    Create PrivateCloudGroup Resource

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

    Constructor syntax

    new PrivateCloudGroup(name: string, args?: PrivateCloudGroupArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateCloudGroup(resource_name: str,
                          args: Optional[PrivateCloudGroupArgs] = None,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivateCloudGroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          city_country: Optional[str] = None,
                          country_code: Optional[str] = None,
                          description: Optional[str] = None,
                          enabled: Optional[bool] = None,
                          enrollment_cert_id: Optional[str] = None,
                          is_public: Optional[str] = None,
                          latitude: Optional[str] = None,
                          location: Optional[str] = None,
                          longitude: Optional[str] = None,
                          microtenant_id: Optional[str] = None,
                          name: Optional[str] = None,
                          override_version_profile: Optional[bool] = None,
                          upgrade_day: Optional[str] = None,
                          upgrade_time_in_secs: Optional[str] = None,
                          user_codes: Optional[Sequence[str]] = None,
                          version_profile_id: Optional[str] = None,
                          version_profile_name: Optional[str] = None)
    func NewPrivateCloudGroup(ctx *Context, name string, args *PrivateCloudGroupArgs, opts ...ResourceOption) (*PrivateCloudGroup, error)
    public PrivateCloudGroup(string name, PrivateCloudGroupArgs? args = null, CustomResourceOptions? opts = null)
    public PrivateCloudGroup(String name, PrivateCloudGroupArgs args)
    public PrivateCloudGroup(String name, PrivateCloudGroupArgs args, CustomResourceOptions options)
    
    type: zpa:PrivateCloudGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "zpa_private_cloud_group" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PrivateCloudGroupArgs
    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 PrivateCloudGroupArgs
    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 PrivateCloudGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateCloudGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateCloudGroupArgs
    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 privateCloudGroupResource = new Zpa.PrivateCloudGroup("privateCloudGroupResource", new()
    {
        CityCountry = "string",
        CountryCode = "string",
        Description = "string",
        Enabled = false,
        EnrollmentCertId = "string",
        IsPublic = "string",
        Latitude = "string",
        Location = "string",
        Longitude = "string",
        MicrotenantId = "string",
        Name = "string",
        OverrideVersionProfile = false,
        UpgradeDay = "string",
        UpgradeTimeInSecs = "string",
        UserCodes = new[]
        {
            "string",
        },
        VersionProfileId = "string",
        VersionProfileName = "string",
    });
    
    example, err := zpa.NewPrivateCloudGroup(ctx, "privateCloudGroupResource", &zpa.PrivateCloudGroupArgs{
    	CityCountry:            pulumi.String("string"),
    	CountryCode:            pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	Enabled:                pulumi.Bool(false),
    	EnrollmentCertId:       pulumi.String("string"),
    	IsPublic:               pulumi.String("string"),
    	Latitude:               pulumi.String("string"),
    	Location:               pulumi.String("string"),
    	Longitude:              pulumi.String("string"),
    	MicrotenantId:          pulumi.String("string"),
    	Name:                   pulumi.String("string"),
    	OverrideVersionProfile: pulumi.Bool(false),
    	UpgradeDay:             pulumi.String("string"),
    	UpgradeTimeInSecs:      pulumi.String("string"),
    	UserCodes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	VersionProfileId:   pulumi.String("string"),
    	VersionProfileName: pulumi.String("string"),
    })
    
    resource "zpa_private_cloud_group" "privateCloudGroupResource" {
      lifecycle {
        create_before_destroy = true
      }
      city_country             = "string"
      country_code             = "string"
      description              = "string"
      enabled                  = false
      enrollment_cert_id       = "string"
      is_public                = "string"
      latitude                 = "string"
      location                 = "string"
      longitude                = "string"
      microtenant_id           = "string"
      name                     = "string"
      override_version_profile = false
      upgrade_day              = "string"
      upgrade_time_in_secs     = "string"
      user_codes               = ["string"]
      version_profile_id       = "string"
      version_profile_name     = "string"
    }
    
    var privateCloudGroupResource = new PrivateCloudGroup("privateCloudGroupResource", PrivateCloudGroupArgs.builder()
        .cityCountry("string")
        .countryCode("string")
        .description("string")
        .enabled(false)
        .enrollmentCertId("string")
        .isPublic("string")
        .latitude("string")
        .location("string")
        .longitude("string")
        .microtenantId("string")
        .name("string")
        .overrideVersionProfile(false)
        .upgradeDay("string")
        .upgradeTimeInSecs("string")
        .userCodes("string")
        .versionProfileId("string")
        .versionProfileName("string")
        .build());
    
    private_cloud_group_resource = zpa.PrivateCloudGroup("privateCloudGroupResource",
        city_country="string",
        country_code="string",
        description="string",
        enabled=False,
        enrollment_cert_id="string",
        is_public="string",
        latitude="string",
        location="string",
        longitude="string",
        microtenant_id="string",
        name="string",
        override_version_profile=False,
        upgrade_day="string",
        upgrade_time_in_secs="string",
        user_codes=["string"],
        version_profile_id="string",
        version_profile_name="string")
    
    const privateCloudGroupResource = new zpa.PrivateCloudGroup("privateCloudGroupResource", {
        cityCountry: "string",
        countryCode: "string",
        description: "string",
        enabled: false,
        enrollmentCertId: "string",
        isPublic: "string",
        latitude: "string",
        location: "string",
        longitude: "string",
        microtenantId: "string",
        name: "string",
        overrideVersionProfile: false,
        upgradeDay: "string",
        upgradeTimeInSecs: "string",
        userCodes: ["string"],
        versionProfileId: "string",
        versionProfileName: "string",
    });
    
    type: zpa:PrivateCloudGroup
    properties:
        cityCountry: string
        countryCode: string
        description: string
        enabled: false
        enrollmentCertId: string
        isPublic: string
        latitude: string
        location: string
        longitude: string
        microtenantId: string
        name: string
        overrideVersionProfile: false
        upgradeDay: string
        upgradeTimeInSecs: string
        userCodes:
            - string
        versionProfileId: string
        versionProfileName: string
    

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

    CityCountry string
    • City and country of the Private Cloud Group
    CountryCode string
    • Country code of the Private Cloud Group
    Description string
    • Description of the Private Cloud Group
    Enabled bool
    • Whether this Private Cloud Group is enabled or not
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    IsPublic string
    • Whether the Private Cloud Group is public
    Latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    Location string
    • Location of the Private Cloud Group
    Longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    MicrotenantId string
    • Microtenant ID for the Private Cloud Group
    Name string
    • Name of the Private Cloud Group
    OverrideVersionProfile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    UpgradeDay string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    UpgradeTimeInSecs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    UserCodes List<string>
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    VersionProfileId string
    • ID of the version profile for the Private Cloud Group
    VersionProfileName string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    CityCountry string
    • City and country of the Private Cloud Group
    CountryCode string
    • Country code of the Private Cloud Group
    Description string
    • Description of the Private Cloud Group
    Enabled bool
    • Whether this Private Cloud Group is enabled or not
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    IsPublic string
    • Whether the Private Cloud Group is public
    Latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    Location string
    • Location of the Private Cloud Group
    Longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    MicrotenantId string
    • Microtenant ID for the Private Cloud Group
    Name string
    • Name of the Private Cloud Group
    OverrideVersionProfile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    UpgradeDay string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    UpgradeTimeInSecs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    UserCodes []string
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    VersionProfileId string
    • ID of the version profile for the Private Cloud Group
    VersionProfileName string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    city_country string
    • City and country of the Private Cloud Group
    country_code string
    • Country code of the Private Cloud Group
    description string
    • Description of the Private Cloud Group
    enabled bool
    • Whether this Private Cloud Group is enabled or not
    enrollment_cert_id string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    is_public string
    • Whether the Private Cloud Group is public
    latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location string
    • Location of the Private Cloud Group
    longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenant_id string
    • Microtenant ID for the Private Cloud Group
    name string
    • Name of the Private Cloud Group
    override_version_profile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgrade_day string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgrade_time_in_secs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    user_codes list(string)
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    version_profile_id string
    • ID of the version profile for the Private Cloud Group
    version_profile_name string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    cityCountry String
    • City and country of the Private Cloud Group
    countryCode String
    • Country code of the Private Cloud Group
    description String
    • Description of the Private Cloud Group
    enabled Boolean
    • Whether this Private Cloud Group is enabled or not
    enrollmentCertId String
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    isPublic String
    • Whether the Private Cloud Group is public
    latitude String
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location String
    • Location of the Private Cloud Group
    longitude String
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenantId String
    • Microtenant ID for the Private Cloud Group
    name String
    • Name of the Private Cloud Group
    overrideVersionProfile Boolean
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgradeDay String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgradeTimeInSecs String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    userCodes List<String>
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    versionProfileId String
    • ID of the version profile for the Private Cloud Group
    versionProfileName String
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    cityCountry string
    • City and country of the Private Cloud Group
    countryCode string
    • Country code of the Private Cloud Group
    description string
    • Description of the Private Cloud Group
    enabled boolean
    • Whether this Private Cloud Group is enabled or not
    enrollmentCertId string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    isPublic string
    • Whether the Private Cloud Group is public
    latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location string
    • Location of the Private Cloud Group
    longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenantId string
    • Microtenant ID for the Private Cloud Group
    name string
    • Name of the Private Cloud Group
    overrideVersionProfile boolean
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgradeDay string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgradeTimeInSecs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    userCodes string[]
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    versionProfileId string
    • ID of the version profile for the Private Cloud Group
    versionProfileName string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    city_country str
    • City and country of the Private Cloud Group
    country_code str
    • Country code of the Private Cloud Group
    description str
    • Description of the Private Cloud Group
    enabled bool
    • Whether this Private Cloud Group is enabled or not
    enrollment_cert_id str
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    is_public str
    • Whether the Private Cloud Group is public
    latitude str
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location str
    • Location of the Private Cloud Group
    longitude str
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenant_id str
    • Microtenant ID for the Private Cloud Group
    name str
    • Name of the Private Cloud Group
    override_version_profile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgrade_day str
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgrade_time_in_secs str
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    user_codes Sequence[str]
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    version_profile_id str
    • ID of the version profile for the Private Cloud Group
    version_profile_name str
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    cityCountry String
    • City and country of the Private Cloud Group
    countryCode String
    • Country code of the Private Cloud Group
    description String
    • Description of the Private Cloud Group
    enabled Boolean
    • Whether this Private Cloud Group is enabled or not
    enrollmentCertId String
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    isPublic String
    • Whether the Private Cloud Group is public
    latitude String
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location String
    • Location of the Private Cloud Group
    longitude String
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenantId String
    • Microtenant ID for the Private Cloud Group
    name String
    • Name of the Private Cloud Group
    overrideVersionProfile Boolean
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgradeDay String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgradeTimeInSecs String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    userCodes List<String>
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    versionProfileId String
    • ID of the version profile for the Private Cloud Group
    versionProfileName String
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true

    Outputs

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

    Get an existing PrivateCloudGroup 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?: PrivateCloudGroupState, opts?: CustomResourceOptions): PrivateCloudGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            city_country: Optional[str] = None,
            country_code: Optional[str] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            enrollment_cert_id: Optional[str] = None,
            is_public: Optional[str] = None,
            latitude: Optional[str] = None,
            location: Optional[str] = None,
            longitude: Optional[str] = None,
            microtenant_id: Optional[str] = None,
            name: Optional[str] = None,
            override_version_profile: Optional[bool] = None,
            upgrade_day: Optional[str] = None,
            upgrade_time_in_secs: Optional[str] = None,
            user_codes: Optional[Sequence[str]] = None,
            version_profile_id: Optional[str] = None,
            version_profile_name: Optional[str] = None) -> PrivateCloudGroup
    func GetPrivateCloudGroup(ctx *Context, name string, id IDInput, state *PrivateCloudGroupState, opts ...ResourceOption) (*PrivateCloudGroup, error)
    public static PrivateCloudGroup Get(string name, Input<string> id, PrivateCloudGroupState? state, CustomResourceOptions? opts = null)
    public static PrivateCloudGroup get(String name, Output<String> id, PrivateCloudGroupState state, CustomResourceOptions options)
    resources:  _:    type: zpa:PrivateCloudGroup    get:      id: ${id}
    import {
      to = zpa_private_cloud_group.example
      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:
    CityCountry string
    • City and country of the Private Cloud Group
    CountryCode string
    • Country code of the Private Cloud Group
    Description string
    • Description of the Private Cloud Group
    Enabled bool
    • Whether this Private Cloud Group is enabled or not
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    IsPublic string
    • Whether the Private Cloud Group is public
    Latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    Location string
    • Location of the Private Cloud Group
    Longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    MicrotenantId string
    • Microtenant ID for the Private Cloud Group
    Name string
    • Name of the Private Cloud Group
    OverrideVersionProfile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    UpgradeDay string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    UpgradeTimeInSecs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    UserCodes List<string>
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    VersionProfileId string
    • ID of the version profile for the Private Cloud Group
    VersionProfileName string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    CityCountry string
    • City and country of the Private Cloud Group
    CountryCode string
    • Country code of the Private Cloud Group
    Description string
    • Description of the Private Cloud Group
    Enabled bool
    • Whether this Private Cloud Group is enabled or not
    EnrollmentCertId string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    IsPublic string
    • Whether the Private Cloud Group is public
    Latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    Location string
    • Location of the Private Cloud Group
    Longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    MicrotenantId string
    • Microtenant ID for the Private Cloud Group
    Name string
    • Name of the Private Cloud Group
    OverrideVersionProfile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    UpgradeDay string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    UpgradeTimeInSecs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    UserCodes []string
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    VersionProfileId string
    • ID of the version profile for the Private Cloud Group
    VersionProfileName string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    city_country string
    • City and country of the Private Cloud Group
    country_code string
    • Country code of the Private Cloud Group
    description string
    • Description of the Private Cloud Group
    enabled bool
    • Whether this Private Cloud Group is enabled or not
    enrollment_cert_id string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    is_public string
    • Whether the Private Cloud Group is public
    latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location string
    • Location of the Private Cloud Group
    longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenant_id string
    • Microtenant ID for the Private Cloud Group
    name string
    • Name of the Private Cloud Group
    override_version_profile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgrade_day string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgrade_time_in_secs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    user_codes list(string)
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    version_profile_id string
    • ID of the version profile for the Private Cloud Group
    version_profile_name string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    cityCountry String
    • City and country of the Private Cloud Group
    countryCode String
    • Country code of the Private Cloud Group
    description String
    • Description of the Private Cloud Group
    enabled Boolean
    • Whether this Private Cloud Group is enabled or not
    enrollmentCertId String
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    isPublic String
    • Whether the Private Cloud Group is public
    latitude String
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location String
    • Location of the Private Cloud Group
    longitude String
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenantId String
    • Microtenant ID for the Private Cloud Group
    name String
    • Name of the Private Cloud Group
    overrideVersionProfile Boolean
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgradeDay String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgradeTimeInSecs String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    userCodes List<String>
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    versionProfileId String
    • ID of the version profile for the Private Cloud Group
    versionProfileName String
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    cityCountry string
    • City and country of the Private Cloud Group
    countryCode string
    • Country code of the Private Cloud Group
    description string
    • Description of the Private Cloud Group
    enabled boolean
    • Whether this Private Cloud Group is enabled or not
    enrollmentCertId string
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    isPublic string
    • Whether the Private Cloud Group is public
    latitude string
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location string
    • Location of the Private Cloud Group
    longitude string
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenantId string
    • Microtenant ID for the Private Cloud Group
    name string
    • Name of the Private Cloud Group
    overrideVersionProfile boolean
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgradeDay string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgradeTimeInSecs string
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    userCodes string[]
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    versionProfileId string
    • ID of the version profile for the Private Cloud Group
    versionProfileName string
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    city_country str
    • City and country of the Private Cloud Group
    country_code str
    • Country code of the Private Cloud Group
    description str
    • Description of the Private Cloud Group
    enabled bool
    • Whether this Private Cloud Group is enabled or not
    enrollment_cert_id str
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    is_public str
    • Whether the Private Cloud Group is public
    latitude str
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location str
    • Location of the Private Cloud Group
    longitude str
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenant_id str
    • Microtenant ID for the Private Cloud Group
    name str
    • Name of the Private Cloud Group
    override_version_profile bool
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgrade_day str
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgrade_time_in_secs str
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    user_codes Sequence[str]
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    version_profile_id str
    • ID of the version profile for the Private Cloud Group
    version_profile_name str
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true
    cityCountry String
    • City and country of the Private Cloud Group
    countryCode String
    • Country code of the Private Cloud Group
    description String
    • Description of the Private Cloud Group
    enabled Boolean
    • Whether this Private Cloud Group is enabled or not
    enrollmentCertId String
    ID of the enrollment certificate that can be used for OAuth2 enrollment. If not set, the provider will automatically look up the 'Connector' enrollment certificate by name.
    isPublic String
    • Whether the Private Cloud Group is public
    latitude String
    • Latitude of the Private Cloud Group. Integer or decimal. With values in the range of -90 to 90
    location String
    • Location of the Private Cloud Group
    longitude String
    • Longitude of the Private Cloud Group. Integer or decimal. With values in the range of -180 to 180
    microtenantId String
    • Microtenant ID for the Private Cloud Group
    name String
    • Name of the Private Cloud Group
    overrideVersionProfile Boolean
    • Whether the default version profile of the Private Cloud Group is applied or overridden
    upgradeDay String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified day. Supported values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    upgradeTimeInSecs String
    • Private Cloud Controllers in this group will attempt to update to a newer version of the software during this specified time. Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals
    userCodes List<String>
    User codes from deployed Private Cloud Controllers for OAuth2 enrollment. When provided, the provider will call the user code verification API to enroll the Private Cloud Controllers. These codes are obtained from the Private Cloud Controller VM after deployment.
    versionProfileId String
    • ID of the version profile for the Private Cloud Group
    versionProfileName String
    Name of the version profile. To learn more, see Version Profile Use Cases. This value is required, if the value for overrideVersionProfile is set to true

    Import

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

    Private Cloud Group can be imported by using <GROUP ID> or <GROUP NAME> as the import ID.

    $ pulumi import zpa:index/privateCloudGroup:PrivateCloudGroup example <group_id>
    

    or

    $ pulumi import zpa:index/privateCloudGroup:PrivateCloudGroup example <group_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
    Viewing docs for Zscaler Private Access v1.0.4
    published on Monday, Jun 29, 2026 by Zscaler

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial