Docs Packages
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. URLCategories
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
zscaler/pulumi-zia

zia.URLCategories

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
zscaler/pulumi-zia

    The zia_url_categories resource creates and manages a new custom URL category. If keywords are included within the request, they will be added to the new category.

    Example Usage

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

const example = new zia.URLCategories("example", {
    superCategory: "USER_DEFINED",
    configuredName: "MCAS Unsanctioned Apps",
    description: "MCAS Unsanctioned Apps",
    keywords: ["microsoft"],
    customCategory: true,
    type: "URL_CATEGORY",
    scopes: [{
        type: "LOCATION",
        scopeEntities: {
            ids: [data.zia_location_management.nyc_site.id],
        },
        scopeGroupMemberEntities: {
            ids: [data.zia_group_management.engineering.id],
        },
    }],
    urls: [
        ".coupons.com",
        ".resource.alaskaair.net",
        ".techrepublic.com",
        ".dailymotion.com",
        ".osiriscomm.com",
        ".uefa.com",
        ".Logz.io",
        ".alexa.com",
        ".baidu.com",
        ".cnn.com",
        ".level3.com",
    ],
});

    import pulumi
import zscaler_pulumi_zia as zia

example = zia.URLCategories("example",
    super_category="USER_DEFINED",
    configured_name="MCAS Unsanctioned Apps",
    description="MCAS Unsanctioned Apps",
    keywords=["microsoft"],
    custom_category=True,
    type="URL_CATEGORY",
    scopes=[zia.URLCategoriesScopeArgs(
        type="LOCATION",
        scope_entities=zia.URLCategoriesScopeScopeEntitiesArgs(
            ids=[data["zia_location_management"]["nyc_site"]["id"]],
        ),
        scope_group_member_entities=zia.URLCategoriesScopeScopeGroupMemberEntitiesArgs(
            ids=[data["zia_group_management"]["engineering"]["id"]],
        ),
    )],
    urls=[
        ".coupons.com",
        ".resource.alaskaair.net",
        ".techrepublic.com",
        ".dailymotion.com",
        ".osiriscomm.com",
        ".uefa.com",
        ".Logz.io",
        ".alexa.com",
        ".baidu.com",
        ".cnn.com",
        ".level3.com",
    ])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zia/sdk/go/zia"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.NewURLCategories(ctx, "example", &zia.URLCategoriesArgs{
			SuperCategory:  pulumi.String("USER_DEFINED"),
			ConfiguredName: pulumi.String("MCAS Unsanctioned Apps"),
			Description:    pulumi.String("MCAS Unsanctioned Apps"),
			Keywords: pulumi.StringArray{
				pulumi.String("microsoft"),
			},
			CustomCategory: pulumi.Bool(true),
			Type:           pulumi.String("URL_CATEGORY"),
			Scopes: zia.URLCategoriesScopeArray{
				&zia.URLCategoriesScopeArgs{
					Type: pulumi.String("LOCATION"),
					ScopeEntities: &zia.URLCategoriesScopeScopeEntitiesArgs{
						Ids: pulumi.IntArray{
							data.Zia_location_management.Nyc_site.Id,
						},
					},
					ScopeGroupMemberEntities: &zia.URLCategoriesScopeScopeGroupMemberEntitiesArgs{
						Ids: pulumi.IntArray{
							data.Zia_group_management.Engineering.Id,
						},
					},
				},
			},
			Urls: pulumi.StringArray{
				pulumi.String(".coupons.com"),
				pulumi.String(".resource.alaskaair.net"),
				pulumi.String(".techrepublic.com"),
				pulumi.String(".dailymotion.com"),
				pulumi.String(".osiriscomm.com"),
				pulumi.String(".uefa.com"),
				pulumi.String(".Logz.io"),
				pulumi.String(".alexa.com"),
				pulumi.String(".baidu.com"),
				pulumi.String(".cnn.com"),
				pulumi.String(".level3.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = zscaler.PulumiPackage.Zia;

return await Deployment.RunAsync(() => 
{
    var example = new Zia.URLCategories("example", new()
    {
        SuperCategory = "USER_DEFINED",
        ConfiguredName = "MCAS Unsanctioned Apps",
        Description = "MCAS Unsanctioned Apps",
        Keywords = new[]
        {
            "microsoft",
        },
        CustomCategory = true,
        Type = "URL_CATEGORY",
        Scopes = new[]
        {
            new Zia.Inputs.URLCategoriesScopeArgs
            {
                Type = "LOCATION",
                ScopeEntities = new Zia.Inputs.URLCategoriesScopeScopeEntitiesArgs
                {
                    Ids = new[]
                    {
                        data.Zia_location_management.Nyc_site.Id,
                    },
                },
                ScopeGroupMemberEntities = new Zia.Inputs.URLCategoriesScopeScopeGroupMemberEntitiesArgs
                {
                    Ids = new[]
                    {
                        data.Zia_group_management.Engineering.Id,
                    },
                },
            },
        },
        Urls = new[]
        {
            ".coupons.com",
            ".resource.alaskaair.net",
            ".techrepublic.com",
            ".dailymotion.com",
            ".osiriscomm.com",
            ".uefa.com",
            ".Logz.io",
            ".alexa.com",
            ".baidu.com",
            ".cnn.com",
            ".level3.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.URLCategories;
import com.pulumi.zia.URLCategoriesArgs;
import com.pulumi.zia.inputs.URLCategoriesScopeArgs;
import com.pulumi.zia.inputs.URLCategoriesScopeScopeEntitiesArgs;
import com.pulumi.zia.inputs.URLCategoriesScopeScopeGroupMemberEntitiesArgs;
import java.util.List;
import java.util.ArrayList;
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 URLCategories("example", URLCategoriesArgs.builder()        
            .superCategory("USER_DEFINED")
            .configuredName("MCAS Unsanctioned Apps")
            .description("MCAS Unsanctioned Apps")
            .keywords("microsoft")
            .customCategory(true)
            .type("URL_CATEGORY")
            .scopes(URLCategoriesScopeArgs.builder()
                .type("LOCATION")
                .scopeEntities(URLCategoriesScopeScopeEntitiesArgs.builder()
                    .ids(data.zia_location_management().nyc_site().id())
                    .build())
                .scopeGroupMemberEntities(URLCategoriesScopeScopeGroupMemberEntitiesArgs.builder()
                    .ids(data.zia_group_management().engineering().id())
                    .build())
                .build())
            .urls(            
                ".coupons.com",
                ".resource.alaskaair.net",
                ".techrepublic.com",
                ".dailymotion.com",
                ".osiriscomm.com",
                ".uefa.com",
                ".Logz.io",
                ".alexa.com",
                ".baidu.com",
                ".cnn.com",
                ".level3.com")
            .build());

    }
}

    resources:
  example:
    type: zia:URLCategories
    properties:
      superCategory: USER_DEFINED
      configuredName: MCAS Unsanctioned Apps
      description: MCAS Unsanctioned Apps
      keywords:
        - microsoft
      customCategory: true
      type: URL_CATEGORY
      scopes:
        - type: LOCATION
          scopeEntities:
            ids:
              - ${data.zia_location_management.nyc_site.id}
          scopeGroupMemberEntities:
            ids:
              - ${data.zia_group_management.engineering.id}
      urls:
        - .coupons.com
        - .resource.alaskaair.net
        - .techrepublic.com
        - .dailymotion.com
        - .osiriscomm.com
        - .uefa.com
        - .Logz.io
        - .alexa.com
        - .baidu.com
        - .cnn.com
        - .level3.com

    Create URLCategories Resource

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

    Constructor syntax

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

@overload
def URLCategories(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configured_name: Optional[str] = None,
                  custom_category: Optional[bool] = None,
                  custom_ip_ranges_count: Optional[int] = None,
                  custom_urls_count: Optional[int] = None,
                  db_categorized_urls: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  editable: Optional[bool] = None,
                  ip_ranges: Optional[Sequence[str]] = None,
                  ip_ranges_retaining_parent_categories: Optional[Sequence[str]] = None,
                  ip_ranges_retaining_parent_category_count: Optional[int] = None,
                  keywords: Optional[Sequence[str]] = None,
                  keywords_retaining_parent_categories: Optional[Sequence[str]] = None,
                  scopes: Optional[Sequence[URLCategoriesScopeArgs]] = None,
                  super_category: Optional[str] = None,
                  type: Optional[str] = None,
                  url_keyword_counts: Optional[URLCategoriesUrlKeywordCountsArgs] = None,
                  urls: Optional[Sequence[str]] = None,
                  urls_retaining_parent_category_count: Optional[int] = None)
    func NewURLCategories(ctx *Context, name string, args *URLCategoriesArgs, opts ...ResourceOption) (*URLCategories, error)
    public URLCategories(string name, URLCategoriesArgs? args = null, CustomResourceOptions? opts = null)
    public URLCategories(String name, URLCategoriesArgs args)
public URLCategories(String name, URLCategoriesArgs args, CustomResourceOptions options)

    type: zia:URLCategories
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 URLCategoriesArgs
    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 URLCategoriesArgs
    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 URLCategoriesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args URLCategoriesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args URLCategoriesArgs
    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 urlcategoriesResource = new Zia.URLCategories("urlcategoriesResource", new()
{
    ConfiguredName = "string",
    CustomCategory = false,
    CustomIpRangesCount = 0,
    CustomUrlsCount = 0,
    DbCategorizedUrls = new[]
    {
        "string",
    },
    Description = "string",
    Editable = false,
    IpRanges = new[]
    {
        "string",
    },
    IpRangesRetainingParentCategories = new[]
    {
        "string",
    },
    IpRangesRetainingParentCategoryCount = 0,
    Keywords = new[]
    {
        "string",
    },
    KeywordsRetainingParentCategories = new[]
    {
        "string",
    },
    Scopes = new[]
    {
        new Zia.Inputs.URLCategoriesScopeArgs
        {
            ScopeEntities = new Zia.Inputs.URLCategoriesScopeScopeEntitiesArgs
            {
                Ids = new[]
                {
                    0,
                },
            },
            ScopeGroupMemberEntities = new Zia.Inputs.URLCategoriesScopeScopeGroupMemberEntitiesArgs
            {
                Ids = new[]
                {
                    0,
                },
            },
            Type = "string",
        },
    },
    SuperCategory = "string",
    Type = "string",
    UrlKeywordCounts = new Zia.Inputs.URLCategoriesUrlKeywordCountsArgs
    {
        RetainParentKeywordCount = 0,
        RetainParentUrlCount = 0,
        TotalKeywordCount = 0,
        TotalUrlCount = 0,
    },
    Urls = new[]
    {
        "string",
    },
    UrlsRetainingParentCategoryCount = 0,
});

    example, err := zia.NewURLCategories(ctx, "urlcategoriesResource", &zia.URLCategoriesArgs{
	ConfiguredName:      pulumi.String("string"),
	CustomCategory:      pulumi.Bool(false),
	CustomIpRangesCount: pulumi.Int(0),
	CustomUrlsCount:     pulumi.Int(0),
	DbCategorizedUrls: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Editable:    pulumi.Bool(false),
	IpRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpRangesRetainingParentCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpRangesRetainingParentCategoryCount: pulumi.Int(0),
	Keywords: pulumi.StringArray{
		pulumi.String("string"),
	},
	KeywordsRetainingParentCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Scopes: zia.URLCategoriesScopeArray{
		&zia.URLCategoriesScopeArgs{
			ScopeEntities: &zia.URLCategoriesScopeScopeEntitiesArgs{
				Ids: pulumi.IntArray{
					pulumi.Int(0),
				},
			},
			ScopeGroupMemberEntities: &zia.URLCategoriesScopeScopeGroupMemberEntitiesArgs{
				Ids: pulumi.IntArray{
					pulumi.Int(0),
				},
			},
			Type: pulumi.String("string"),
		},
	},
	SuperCategory: pulumi.String("string"),
	Type:          pulumi.String("string"),
	UrlKeywordCounts: &zia.URLCategoriesUrlKeywordCountsArgs{
		RetainParentKeywordCount: pulumi.Int(0),
		RetainParentUrlCount:     pulumi.Int(0),
		TotalKeywordCount:        pulumi.Int(0),
		TotalUrlCount:            pulumi.Int(0),
	},
	Urls: pulumi.StringArray{
		pulumi.String("string"),
	},
	UrlsRetainingParentCategoryCount: pulumi.Int(0),
})

    var urlcategoriesResource = new URLCategories("urlcategoriesResource", URLCategoriesArgs.builder()
    .configuredName("string")
    .customCategory(false)
    .customIpRangesCount(0)
    .customUrlsCount(0)
    .dbCategorizedUrls("string")
    .description("string")
    .editable(false)
    .ipRanges("string")
    .ipRangesRetainingParentCategories("string")
    .ipRangesRetainingParentCategoryCount(0)
    .keywords("string")
    .keywordsRetainingParentCategories("string")
    .scopes(URLCategoriesScopeArgs.builder()
        .scopeEntities(URLCategoriesScopeScopeEntitiesArgs.builder()
            .ids(0)
            .build())
        .scopeGroupMemberEntities(URLCategoriesScopeScopeGroupMemberEntitiesArgs.builder()
            .ids(0)
            .build())
        .type("string")
        .build())
    .superCategory("string")
    .type("string")
    .urlKeywordCounts(URLCategoriesUrlKeywordCountsArgs.builder()
        .retainParentKeywordCount(0)
        .retainParentUrlCount(0)
        .totalKeywordCount(0)
        .totalUrlCount(0)
        .build())
    .urls("string")
    .urlsRetainingParentCategoryCount(0)
    .build());

    urlcategories_resource = zia.URLCategories("urlcategoriesResource",
    configured_name="string",
    custom_category=False,
    custom_ip_ranges_count=0,
    custom_urls_count=0,
    db_categorized_urls=["string"],
    description="string",
    editable=False,
    ip_ranges=["string"],
    ip_ranges_retaining_parent_categories=["string"],
    ip_ranges_retaining_parent_category_count=0,
    keywords=["string"],
    keywords_retaining_parent_categories=["string"],
    scopes=[zia.URLCategoriesScopeArgs(
        scope_entities=zia.URLCategoriesScopeScopeEntitiesArgs(
            ids=[0],
        ),
        scope_group_member_entities=zia.URLCategoriesScopeScopeGroupMemberEntitiesArgs(
            ids=[0],
        ),
        type="string",
    )],
    super_category="string",
    type="string",
    url_keyword_counts=zia.URLCategoriesUrlKeywordCountsArgs(
        retain_parent_keyword_count=0,
        retain_parent_url_count=0,
        total_keyword_count=0,
        total_url_count=0,
    ),
    urls=["string"],
    urls_retaining_parent_category_count=0)

    const urlcategoriesResource = new zia.URLCategories("urlcategoriesResource", {
    configuredName: "string",
    customCategory: false,
    customIpRangesCount: 0,
    customUrlsCount: 0,
    dbCategorizedUrls: ["string"],
    description: "string",
    editable: false,
    ipRanges: ["string"],
    ipRangesRetainingParentCategories: ["string"],
    ipRangesRetainingParentCategoryCount: 0,
    keywords: ["string"],
    keywordsRetainingParentCategories: ["string"],
    scopes: [{
        scopeEntities: {
            ids: [0],
        },
        scopeGroupMemberEntities: {
            ids: [0],
        },
        type: "string",
    }],
    superCategory: "string",
    type: "string",
    urlKeywordCounts: {
        retainParentKeywordCount: 0,
        retainParentUrlCount: 0,
        totalKeywordCount: 0,
        totalUrlCount: 0,
    },
    urls: ["string"],
    urlsRetainingParentCategoryCount: 0,
});

    type: zia:URLCategories
properties:
    configuredName: string
    customCategory: false
    customIpRangesCount: 0
    customUrlsCount: 0
    dbCategorizedUrls:
        - string
    description: string
    editable: false
    ipRanges:
        - string
    ipRangesRetainingParentCategories:
        - string
    ipRangesRetainingParentCategoryCount: 0
    keywords:
        - string
    keywordsRetainingParentCategories:
        - string
    scopes:
        - scopeEntities:
            ids:
                - 0
          scopeGroupMemberEntities:
            ids:
                - 0
          type: string
    superCategory: string
    type: string
    urlKeywordCounts:
        retainParentKeywordCount: 0
        retainParentUrlCount: 0
        totalKeywordCount: 0
        totalUrlCount: 0
    urls:
        - string
    urlsRetainingParentCategoryCount: 0

    URLCategories Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The URLCategories resource accepts the following input properties:

    ConfiguredName string
    Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomIpRangesCount int
    The number of custom IP address ranges associated to the URL category.
    CustomUrlsCount int
    The number of custom URLs associated to the URL category.
    DbCategorizedUrls List<string>
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    Description string
    Description of the category.
    Editable bool
    Value is set to false for custom URL category when due to scope user does not have edit permission
    IpRanges List<string>
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    IpRangesRetainingParentCategories List<string>
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    IpRangesRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    Keywords List<string>
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    KeywordsRetainingParentCategories List<string>
    Scopes List<zscaler.PulumiPackage.Zia.Inputs.URLCategoriesScope>
    Scope of the custom categories.
    SuperCategory string
    Super Category of the URL category. This field is required when creating custom URL categories.
    Type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    UrlKeywordCounts zscaler.PulumiPackage.Zia.Inputs.URLCategoriesUrlKeywordCounts
    URL and keyword counts for the category.
    Urls List<string>
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    UrlsRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    ConfiguredName string
    Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomIpRangesCount int
    The number of custom IP address ranges associated to the URL category.
    CustomUrlsCount int
    The number of custom URLs associated to the URL category.
    DbCategorizedUrls []string
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    Description string
    Description of the category.
    Editable bool
    Value is set to false for custom URL category when due to scope user does not have edit permission
    IpRanges []string
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    IpRangesRetainingParentCategories []string
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    IpRangesRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    Keywords []string
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    KeywordsRetainingParentCategories []string
    Scopes []URLCategoriesScopeArgs
    Scope of the custom categories.
    SuperCategory string
    Super Category of the URL category. This field is required when creating custom URL categories.
    Type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    UrlKeywordCounts URLCategoriesUrlKeywordCountsArgs
    URL and keyword counts for the category.
    Urls []string
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    UrlsRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    configuredName String
    Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount Integer
    The number of custom IP address ranges associated to the URL category.
    customUrlsCount Integer
    The number of custom URLs associated to the URL category.
    dbCategorizedUrls List<String>
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description String
    Description of the category.
    editable Boolean
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ipRanges List<String>
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ipRangesRetainingParentCategories List<String>
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ipRangesRetainingParentCategoryCount Integer
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords List<String>
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywordsRetainingParentCategories List<String>
    scopes List<URLCategoriesScope>
    Scope of the custom categories.
    superCategory String
    Super Category of the URL category. This field is required when creating custom URL categories.
    type String
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts URLCategoriesUrlKeywordCounts
    URL and keyword counts for the category.
    urls List<String>
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urlsRetainingParentCategoryCount Integer
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    configuredName string
    Name of the URL category. This is only required for custom URL categories.
    customCategory boolean
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount number
    The number of custom IP address ranges associated to the URL category.
    customUrlsCount number
    The number of custom URLs associated to the URL category.
    dbCategorizedUrls string[]
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description string
    Description of the category.
    editable boolean
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ipRanges string[]
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ipRangesRetainingParentCategories string[]
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ipRangesRetainingParentCategoryCount number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords string[]
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywordsRetainingParentCategories string[]
    scopes URLCategoriesScope[]
    Scope of the custom categories.
    superCategory string
    Super Category of the URL category. This field is required when creating custom URL categories.
    type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts URLCategoriesUrlKeywordCounts
    URL and keyword counts for the category.
    urls string[]
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urlsRetainingParentCategoryCount number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    configured_name str
    Name of the URL category. This is only required for custom URL categories.
    custom_category bool
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    custom_ip_ranges_count int
    The number of custom IP address ranges associated to the URL category.
    custom_urls_count int
    The number of custom URLs associated to the URL category.
    db_categorized_urls Sequence[str]
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description str
    Description of the category.
    editable bool
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ip_ranges Sequence[str]
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ip_ranges_retaining_parent_categories Sequence[str]
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ip_ranges_retaining_parent_category_count int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords Sequence[str]
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywords_retaining_parent_categories Sequence[str]
    scopes Sequence[URLCategoriesScopeArgs]
    Scope of the custom categories.
    super_category str
    Super Category of the URL category. This field is required when creating custom URL categories.
    type str
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    url_keyword_counts URLCategoriesUrlKeywordCountsArgs
    URL and keyword counts for the category.
    urls Sequence[str]
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urls_retaining_parent_category_count int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    configuredName String
    Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount Number
    The number of custom IP address ranges associated to the URL category.
    customUrlsCount Number
    The number of custom URLs associated to the URL category.
    dbCategorizedUrls List<String>
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description String
    Description of the category.
    editable Boolean
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ipRanges List<String>
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ipRangesRetainingParentCategories List<String>
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ipRangesRetainingParentCategoryCount Number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords List<String>
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywordsRetainingParentCategories List<String>
    scopes List<Property Map>
    Scope of the custom categories.
    superCategory String
    Super Category of the URL category. This field is required when creating custom URL categories.
    type String
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts Property Map
    URL and keyword counts for the category.
    urls List<String>
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urlsRetainingParentCategoryCount Number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.

    Outputs

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

    CategoryId string
    Id string
    The provider-assigned unique ID for this managed resource.
    CategoryId string
    Id string
    The provider-assigned unique ID for this managed resource.
    categoryId String
    id String
    The provider-assigned unique ID for this managed resource.
    categoryId string
    id string
    The provider-assigned unique ID for this managed resource.
    category_id str
    id str
    The provider-assigned unique ID for this managed resource.
    categoryId String
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing URLCategories Resource

    Get an existing URLCategories 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?: URLCategoriesState, opts?: CustomResourceOptions): URLCategories
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category_id: Optional[str] = None,
        configured_name: Optional[str] = None,
        custom_category: Optional[bool] = None,
        custom_ip_ranges_count: Optional[int] = None,
        custom_urls_count: Optional[int] = None,
        db_categorized_urls: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        editable: Optional[bool] = None,
        ip_ranges: Optional[Sequence[str]] = None,
        ip_ranges_retaining_parent_categories: Optional[Sequence[str]] = None,
        ip_ranges_retaining_parent_category_count: Optional[int] = None,
        keywords: Optional[Sequence[str]] = None,
        keywords_retaining_parent_categories: Optional[Sequence[str]] = None,
        scopes: Optional[Sequence[URLCategoriesScopeArgs]] = None,
        super_category: Optional[str] = None,
        type: Optional[str] = None,
        url_keyword_counts: Optional[URLCategoriesUrlKeywordCountsArgs] = None,
        urls: Optional[Sequence[str]] = None,
        urls_retaining_parent_category_count: Optional[int] = None) -> URLCategories
    func GetURLCategories(ctx *Context, name string, id IDInput, state *URLCategoriesState, opts ...ResourceOption) (*URLCategories, error)
    public static URLCategories Get(string name, Input<string> id, URLCategoriesState? state, CustomResourceOptions? opts = null)
    public static URLCategories get(String name, Output<String> id, URLCategoriesState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CategoryId string
    ConfiguredName string
    Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomIpRangesCount int
    The number of custom IP address ranges associated to the URL category.
    CustomUrlsCount int
    The number of custom URLs associated to the URL category.
    DbCategorizedUrls List<string>
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    Description string
    Description of the category.
    Editable bool
    Value is set to false for custom URL category when due to scope user does not have edit permission
    IpRanges List<string>
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    IpRangesRetainingParentCategories List<string>
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    IpRangesRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    Keywords List<string>
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    KeywordsRetainingParentCategories List<string>
    Scopes List<zscaler.PulumiPackage.Zia.Inputs.URLCategoriesScope>
    Scope of the custom categories.
    SuperCategory string
    Super Category of the URL category. This field is required when creating custom URL categories.
    Type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    UrlKeywordCounts zscaler.PulumiPackage.Zia.Inputs.URLCategoriesUrlKeywordCounts
    URL and keyword counts for the category.
    Urls List<string>
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    UrlsRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    CategoryId string
    ConfiguredName string
    Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomIpRangesCount int
    The number of custom IP address ranges associated to the URL category.
    CustomUrlsCount int
    The number of custom URLs associated to the URL category.
    DbCategorizedUrls []string
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    Description string
    Description of the category.
    Editable bool
    Value is set to false for custom URL category when due to scope user does not have edit permission
    IpRanges []string
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    IpRangesRetainingParentCategories []string
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    IpRangesRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    Keywords []string
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    KeywordsRetainingParentCategories []string
    Scopes []URLCategoriesScopeArgs
    Scope of the custom categories.
    SuperCategory string
    Super Category of the URL category. This field is required when creating custom URL categories.
    Type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    UrlKeywordCounts URLCategoriesUrlKeywordCountsArgs
    URL and keyword counts for the category.
    Urls []string
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    UrlsRetainingParentCategoryCount int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    categoryId String
    configuredName String
    Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount Integer
    The number of custom IP address ranges associated to the URL category.
    customUrlsCount Integer
    The number of custom URLs associated to the URL category.
    dbCategorizedUrls List<String>
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description String
    Description of the category.
    editable Boolean
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ipRanges List<String>
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ipRangesRetainingParentCategories List<String>
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ipRangesRetainingParentCategoryCount Integer
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords List<String>
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywordsRetainingParentCategories List<String>
    scopes List<URLCategoriesScope>
    Scope of the custom categories.
    superCategory String
    Super Category of the URL category. This field is required when creating custom URL categories.
    type String
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts URLCategoriesUrlKeywordCounts
    URL and keyword counts for the category.
    urls List<String>
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urlsRetainingParentCategoryCount Integer
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    categoryId string
    configuredName string
    Name of the URL category. This is only required for custom URL categories.
    customCategory boolean
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount number
    The number of custom IP address ranges associated to the URL category.
    customUrlsCount number
    The number of custom URLs associated to the URL category.
    dbCategorizedUrls string[]
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description string
    Description of the category.
    editable boolean
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ipRanges string[]
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ipRangesRetainingParentCategories string[]
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ipRangesRetainingParentCategoryCount number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords string[]
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywordsRetainingParentCategories string[]
    scopes URLCategoriesScope[]
    Scope of the custom categories.
    superCategory string
    Super Category of the URL category. This field is required when creating custom URL categories.
    type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts URLCategoriesUrlKeywordCounts
    URL and keyword counts for the category.
    urls string[]
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urlsRetainingParentCategoryCount number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    category_id str
    configured_name str
    Name of the URL category. This is only required for custom URL categories.
    custom_category bool
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    custom_ip_ranges_count int
    The number of custom IP address ranges associated to the URL category.
    custom_urls_count int
    The number of custom URLs associated to the URL category.
    db_categorized_urls Sequence[str]
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description str
    Description of the category.
    editable bool
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ip_ranges Sequence[str]
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ip_ranges_retaining_parent_categories Sequence[str]
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ip_ranges_retaining_parent_category_count int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords Sequence[str]
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywords_retaining_parent_categories Sequence[str]
    scopes Sequence[URLCategoriesScopeArgs]
    Scope of the custom categories.
    super_category str
    Super Category of the URL category. This field is required when creating custom URL categories.
    type str
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    url_keyword_counts URLCategoriesUrlKeywordCountsArgs
    URL and keyword counts for the category.
    urls Sequence[str]
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urls_retaining_parent_category_count int
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    categoryId String
    configuredName String
    Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount Number
    The number of custom IP address ranges associated to the URL category.
    customUrlsCount Number
    The number of custom URLs associated to the URL category.
    dbCategorizedUrls List<String>
    URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
    description String
    Description of the category.
    editable Boolean
    Value is set to false for custom URL category when due to scope user does not have edit permission
    ipRanges List<String>
    Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories. ⚠️ NOTE :: This field is available only if the option to configure custom IP ranges is enabled for your organization. To enable this option, contact Zscaler Support.
    ipRangesRetainingParentCategories List<String>
    The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
    ipRangesRetainingParentCategoryCount Number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
    keywords List<String>
    Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
    keywordsRetainingParentCategories List<String>
    scopes List<Property Map>
    Scope of the custom categories.
    superCategory String
    Super Category of the URL category. This field is required when creating custom URL categories.
    type String
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts Property Map
    URL and keyword counts for the category.
    urls List<String>
    Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
    urlsRetainingParentCategoryCount Number
    The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.

    Supporting Types

    URLCategoriesScope, URLCategoriesScopeArgs

    ScopeEntities zscaler.PulumiPackage.Zia.Inputs.URLCategoriesScopeScopeEntities
    list of scope IDs
    ScopeGroupMemberEntities zscaler.PulumiPackage.Zia.Inputs.URLCategoriesScopeScopeGroupMemberEntities
    Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
    Type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    ScopeEntities URLCategoriesScopeScopeEntities
    list of scope IDs
    ScopeGroupMemberEntities URLCategoriesScopeScopeGroupMemberEntities
    Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
    Type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scopeEntities URLCategoriesScopeScopeEntities
    list of scope IDs
    scopeGroupMemberEntities URLCategoriesScopeScopeGroupMemberEntities
    Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
    type String
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scopeEntities URLCategoriesScopeScopeEntities
    list of scope IDs
    scopeGroupMemberEntities URLCategoriesScopeScopeGroupMemberEntities
    Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
    type string
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scope_entities URLCategoriesScopeScopeEntities
    list of scope IDs
    scope_group_member_entities URLCategoriesScopeScopeGroupMemberEntities
    Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
    type str
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scopeEntities Property Map
    list of scope IDs
    scopeGroupMemberEntities Property Map
    Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
    type String
    The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP

    URLCategoriesScopeScopeEntities, URLCategoriesScopeScopeEntitiesArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    URLCategoriesScopeScopeGroupMemberEntities, URLCategoriesScopeScopeGroupMemberEntitiesArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    URLCategoriesUrlKeywordCounts, URLCategoriesUrlKeywordCountsArgs

    RetainParentKeywordCount int
    Count of total keywords with retain parent category.
    RetainParentUrlCount int
    Count of URLs with retain parent category.
    TotalKeywordCount int
    Total keyword count for the category.
    TotalUrlCount int
    Custom URL count for the category.
    RetainParentKeywordCount int
    Count of total keywords with retain parent category.
    RetainParentUrlCount int
    Count of URLs with retain parent category.
    TotalKeywordCount int
    Total keyword count for the category.
    TotalUrlCount int
    Custom URL count for the category.
    retainParentKeywordCount Integer
    Count of total keywords with retain parent category.
    retainParentUrlCount Integer
    Count of URLs with retain parent category.
    totalKeywordCount Integer
    Total keyword count for the category.
    totalUrlCount Integer
    Custom URL count for the category.
    retainParentKeywordCount number
    Count of total keywords with retain parent category.
    retainParentUrlCount number
    Count of URLs with retain parent category.
    totalKeywordCount number
    Total keyword count for the category.
    totalUrlCount number
    Custom URL count for the category.
    retain_parent_keyword_count int
    Count of total keywords with retain parent category.
    retain_parent_url_count int
    Count of URLs with retain parent category.
    total_keyword_count int
    Total keyword count for the category.
    total_url_count int
    Custom URL count for the category.
    retainParentKeywordCount Number
    Count of total keywords with retain parent category.
    retainParentUrlCount Number
    Count of URLs with retain parent category.
    totalKeywordCount Number
    Total keyword count for the category.
    totalUrlCount Number
    Custom URL count for the category.

    Import

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

    Visit

    zia_url_categories can be imported by using <CATEGORY_ID> or <CATEGORY_NAME> as the import ID.

    For example:

    $ pulumi import zia:index/uRLCategories:URLCategories example <category_id>

    or

    $ pulumi import zia:index/uRLCategories:URLCategories example <category_name>

    ⚠️ NOTE :: This provider only supports the importing of custom URL categories. The importing of built-in categories is not supported.

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
    zscaler/pulumi-zia