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

zia.TenantRestrictionProfile

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

    The zia.TenantRestrictionProfile resource manages tenant restriction profiles in the Zscaler Internet Access (ZIA) cloud. Tenant restriction profiles control access to cloud application tenants (e.g., Microsoft 365, Google Workspace) by restricting users to authorized tenant domains.

    Example Usage

    Basic Tenant Restriction Profile

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";

const example = new zia.TenantRestrictionProfile("example", {
    name: "Example Tenant Profile",
    description: "Managed by Pulumi",
    appType: "MICROSOFT",
    itemTypePrimary: "TENANT_ID",
    itemDataPrimary: ["tenant-id-12345"],
    restrictPersonalO365Domains: true,
});

    import zscaler_pulumi_zia as zia

example = zia.TenantRestrictionProfile("example",
    name="Example Tenant Profile",
    description="Managed by Pulumi",
    app_type="MICROSOFT",
    item_type_primary="TENANT_ID",
    item_data_primary=["tenant-id-12345"],
    restrict_personal_o365_domains=True,
)

    resources:
  example:
    type: zia:TenantRestrictionProfile
    properties:
      name: Example Tenant Profile
      description: Managed by Pulumi
      appType: MICROSOFT
      itemTypePrimary: TENANT_ID
      itemDataPrimary:
        - tenant-id-12345
      restrictPersonalO365Domains: true

    Create TenantRestrictionProfile Resource

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

    Constructor syntax

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

@overload
def TenantRestrictionProfile(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             name: Optional[str] = None,
                             item_data_secondary: Optional[Sequence[str]] = None,
                             allow_google_visitors: Optional[bool] = None,
                             app_type: Optional[str] = None,
                             description: Optional[str] = None,
                             item_data_primary: Optional[Sequence[str]] = None,
                             allow_gcp_cloud_storage_read: Optional[bool] = None,
                             item_type_primary: Optional[str] = None,
                             item_type_secondary: Optional[str] = None,
                             item_value: Optional[Sequence[str]] = None,
                             ms_login_services_tr_v2: Optional[bool] = None,
                             allow_google_consumers: Optional[bool] = None,
                             restrict_personal_o365_domains: Optional[bool] = None)
    func NewTenantRestrictionProfile(ctx *Context, name string, args TenantRestrictionProfileArgs, opts ...ResourceOption) (*TenantRestrictionProfile, error)
    public TenantRestrictionProfile(string name, TenantRestrictionProfileArgs args, CustomResourceOptions? opts = null)
    public TenantRestrictionProfile(String name, TenantRestrictionProfileArgs args)
public TenantRestrictionProfile(String name, TenantRestrictionProfileArgs args, CustomResourceOptions options)

    type: zia:TenantRestrictionProfile
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 TenantRestrictionProfileArgs
    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 TenantRestrictionProfileArgs
    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 TenantRestrictionProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TenantRestrictionProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TenantRestrictionProfileArgs
    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 tenantRestrictionProfileResource = new Zia.TenantRestrictionProfile("tenantRestrictionProfileResource", new()
{
    Name = "string",
    ItemDataSecondary = new[]
    {
        "string",
    },
    AllowGoogleVisitors = false,
    AppType = "string",
    Description = "string",
    ItemDataPrimary = new[]
    {
        "string",
    },
    AllowGcpCloudStorageRead = false,
    ItemTypePrimary = "string",
    ItemTypeSecondary = "string",
    ItemValue = new[]
    {
        "string",
    },
    MsLoginServicesTrV2 = false,
    AllowGoogleConsumers = false,
    RestrictPersonalO365Domains = false,
});

    example, err := zia.NewTenantRestrictionProfile(ctx, "tenantRestrictionProfileResource", &zia.TenantRestrictionProfileArgs{
	Name: pulumi.String("string"),
	ItemDataSecondary: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowGoogleVisitors: pulumi.Bool(false),
	AppType:             pulumi.String("string"),
	Description:         pulumi.String("string"),
	ItemDataPrimary: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowGcpCloudStorageRead: pulumi.Bool(false),
	ItemTypePrimary:          pulumi.String("string"),
	ItemTypeSecondary:        pulumi.String("string"),
	ItemValue: pulumi.StringArray{
		pulumi.String("string"),
	},
	MsLoginServicesTrV2:         pulumi.Bool(false),
	AllowGoogleConsumers:        pulumi.Bool(false),
	RestrictPersonalO365Domains: pulumi.Bool(false),
})

    var tenantRestrictionProfileResource = new TenantRestrictionProfile("tenantRestrictionProfileResource", TenantRestrictionProfileArgs.builder()
    .name("string")
    .itemDataSecondary("string")
    .allowGoogleVisitors(false)
    .appType("string")
    .description("string")
    .itemDataPrimary("string")
    .allowGcpCloudStorageRead(false)
    .itemTypePrimary("string")
    .itemTypeSecondary("string")
    .itemValue("string")
    .msLoginServicesTrV2(false)
    .allowGoogleConsumers(false)
    .restrictPersonalO365Domains(false)
    .build());

    tenant_restriction_profile_resource = zia.TenantRestrictionProfile("tenantRestrictionProfileResource",
    name="string",
    item_data_secondary=["string"],
    allow_google_visitors=False,
    app_type="string",
    description="string",
    item_data_primary=["string"],
    allow_gcp_cloud_storage_read=False,
    item_type_primary="string",
    item_type_secondary="string",
    item_value=["string"],
    ms_login_services_tr_v2=False,
    allow_google_consumers=False,
    restrict_personal_o365_domains=False)

    const tenantRestrictionProfileResource = new zia.TenantRestrictionProfile("tenantRestrictionProfileResource", {
    name: "string",
    itemDataSecondary: ["string"],
    allowGoogleVisitors: false,
    appType: "string",
    description: "string",
    itemDataPrimary: ["string"],
    allowGcpCloudStorageRead: false,
    itemTypePrimary: "string",
    itemTypeSecondary: "string",
    itemValue: ["string"],
    msLoginServicesTrV2: false,
    allowGoogleConsumers: false,
    restrictPersonalO365Domains: false,
});

    type: zia:TenantRestrictionProfile
properties:
    allowGcpCloudStorageRead: false
    allowGoogleConsumers: false
    allowGoogleVisitors: false
    appType: string
    description: string
    itemDataPrimary:
        - string
    itemDataSecondary:
        - string
    itemTypePrimary: string
    itemTypeSecondary: string
    itemValue:
        - string
    msLoginServicesTrV2: false
    name: string
    restrictPersonalO365Domains: false

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

    Name string
    Name of the tenant restriction profile.
    AllowGcpCloudStorageRead bool
    Whether to allow GCP Cloud Storage read access.
    AllowGoogleConsumers bool
    Whether to allow Google consumer accounts.
    AllowGoogleVisitors bool
    Whether to allow Google visitor accounts.
    AppType string
    The cloud application type (e.g., 'MICROSOFT', 'GOOGLE').
    Description string
    Description of the tenant restriction profile.
    ItemDataPrimary List<string>
    List of primary item data values (e.g., tenant IDs).
    ItemDataSecondary List<string>
    List of secondary item data values.
    ItemTypePrimary string
    The primary item type (e.g., 'TENANT_ID').
    ItemTypeSecondary string
    The secondary item type.
    ItemValue List<string>
    List of item values.
    MsLoginServicesTrV2 bool
    Whether to enable Microsoft login services tenant restriction v2.
    RestrictPersonalO365Domains bool
    Whether to restrict personal Office 365 domains.
    Name string
    Name of the tenant restriction profile.
    AllowGcpCloudStorageRead bool
    Whether to allow GCP Cloud Storage read access.
    AllowGoogleConsumers bool
    Whether to allow Google consumer accounts.
    AllowGoogleVisitors bool
    Whether to allow Google visitor accounts.
    AppType string
    The cloud application type (e.g., 'MICROSOFT', 'GOOGLE').
    Description string
    Description of the tenant restriction profile.
    ItemDataPrimary []string
    List of primary item data values (e.g., tenant IDs).
    ItemDataSecondary []string
    List of secondary item data values.
    ItemTypePrimary string
    The primary item type (e.g., 'TENANT_ID').
    ItemTypeSecondary string
    The secondary item type.
    ItemValue []string
    List of item values.
    MsLoginServicesTrV2 bool
    Whether to enable Microsoft login services tenant restriction v2.
    RestrictPersonalO365Domains bool
    Whether to restrict personal Office 365 domains.
    name String
    Name of the tenant restriction profile.
    allowGcpCloudStorageRead Boolean
    Whether to allow GCP Cloud Storage read access.
    allowGoogleConsumers Boolean
    Whether to allow Google consumer accounts.
    allowGoogleVisitors Boolean
    Whether to allow Google visitor accounts.
    appType String
    The cloud application type (e.g., 'MICROSOFT', 'GOOGLE').
    description String
    Description of the tenant restriction profile.
    itemDataPrimary List<String>
    List of primary item data values (e.g., tenant IDs).
    itemDataSecondary List<String>
    List of secondary item data values.
    itemTypePrimary String
    The primary item type (e.g., 'TENANT_ID').
    itemTypeSecondary String
    The secondary item type.
    itemValue List<String>
    List of item values.
    msLoginServicesTrV2 Boolean
    Whether to enable Microsoft login services tenant restriction v2.
    restrictPersonalO365Domains Boolean
    Whether to restrict personal Office 365 domains.
    name string
    Name of the tenant restriction profile.
    allowGcpCloudStorageRead boolean
    Whether to allow GCP Cloud Storage read access.
    allowGoogleConsumers boolean
    Whether to allow Google consumer accounts.
    allowGoogleVisitors boolean
    Whether to allow Google visitor accounts.
    appType string
    The cloud application type (e.g., 'MICROSOFT', 'GOOGLE').
    description string
    Description of the tenant restriction profile.
    itemDataPrimary string[]
    List of primary item data values (e.g., tenant IDs).
    itemDataSecondary string[]
    List of secondary item data values.
    itemTypePrimary string
    The primary item type (e.g., 'TENANT_ID').
    itemTypeSecondary string
    The secondary item type.
    itemValue string[]
    List of item values.
    msLoginServicesTrV2 boolean
    Whether to enable Microsoft login services tenant restriction v2.
    restrictPersonalO365Domains boolean
    Whether to restrict personal Office 365 domains.
    name str
    Name of the tenant restriction profile.
    allow_gcp_cloud_storage_read bool
    Whether to allow GCP Cloud Storage read access.
    allow_google_consumers bool
    Whether to allow Google consumer accounts.
    allow_google_visitors bool
    Whether to allow Google visitor accounts.
    app_type str
    The cloud application type (e.g., 'MICROSOFT', 'GOOGLE').
    description str
    Description of the tenant restriction profile.
    item_data_primary Sequence[str]
    List of primary item data values (e.g., tenant IDs).
    item_data_secondary Sequence[str]
    List of secondary item data values.
    item_type_primary str
    The primary item type (e.g., 'TENANT_ID').
    item_type_secondary str
    The secondary item type.
    item_value Sequence[str]
    List of item values.
    ms_login_services_tr_v2 bool
    Whether to enable Microsoft login services tenant restriction v2.
    restrict_personal_o365_domains bool
    Whether to restrict personal Office 365 domains.
    name String
    Name of the tenant restriction profile.
    allowGcpCloudStorageRead Boolean
    Whether to allow GCP Cloud Storage read access.
    allowGoogleConsumers Boolean
    Whether to allow Google consumer accounts.
    allowGoogleVisitors Boolean
    Whether to allow Google visitor accounts.
    appType String
    The cloud application type (e.g., 'MICROSOFT', 'GOOGLE').
    description String
    Description of the tenant restriction profile.
    itemDataPrimary List<String>
    List of primary item data values (e.g., tenant IDs).
    itemDataSecondary List<String>
    List of secondary item data values.
    itemTypePrimary String
    The primary item type (e.g., 'TENANT_ID').
    itemTypeSecondary String
    The secondary item type.
    itemValue List<String>
    List of item values.
    msLoginServicesTrV2 Boolean
    Whether to enable Microsoft login services tenant restriction v2.
    restrictPersonalO365Domains Boolean
    Whether to restrict personal Office 365 domains.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TenantRestrictionProfile resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProfileId int
    The unique identifier for the tenant restriction profile assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProfileId int
    The unique identifier for the tenant restriction profile assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    profileId Integer
    The unique identifier for the tenant restriction profile assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    profileId number
    The unique identifier for the tenant restriction profile assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    profile_id int
    The unique identifier for the tenant restriction profile assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    profileId Number
    The unique identifier for the tenant restriction profile assigned by the ZIA cloud.

    Import

    An existing tenant restriction profile can be imported using its ID, e.g.

    $ pulumi import zia:index:TenantRestrictionProfile example 12345

    To learn more about importing existing cloud resources, see Importing resources.

    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.