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

zia.UrlCategoryPredefined

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_url_categories_predefined resource manages predefined URL category overrides in the Zscaler Internet Access (ZIA) cloud service. This resource allows administrators to add custom URLs, keywords, and IP ranges to existing predefined (built-in) URL categories. Predefined categories cannot be deleted; the delete operation is a no-op.

    For more information, see the ZIA URL Categories documentation.

    Example Usage

    Override a Predefined URL Category

    Example coming soon!

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.NewUrlCategoryPredefined(ctx, "example", &zia.UrlCategoryPredefinedArgs{
			Name:     pulumi.String("FINANCE"),
			Urls:     pulumi.ToStringArray([]string{"finance.example.com", "banking.example.com"}),
			Keywords: pulumi.ToStringArray([]string{"financial-portal"}),
		})
		return err
	})
}

    Example coming soon!

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

const example = new zia.UrlCategoryPredefined("example", {
    name: "FINANCE",
    urls: [
        "finance.example.com",
        "banking.example.com",
    ],
    keywords: ["financial-portal"],
});

    import zscaler_pulumi_zia as zia

example = zia.UrlCategoryPredefined("example",
    name="FINANCE",
    urls=[
        "finance.example.com",
        "banking.example.com",
    ],
    keywords=["financial-portal"],
)

    resources:
  example:
    type: zia:UrlCategoryPredefined
    properties:
      name: FINANCE
      urls:
        - finance.example.com
        - banking.example.com
      keywords:
        - financial-portal

    Create UrlCategoryPredefined Resource

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

    Constructor syntax

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

@overload
def UrlCategoryPredefined(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          name: Optional[str] = None,
                          ip_ranges: Optional[Sequence[str]] = None,
                          ip_ranges_retaining_parent_category: Optional[Sequence[str]] = None,
                          keywords: Optional[Sequence[str]] = None,
                          keywords_retaining_parent_category: Optional[Sequence[str]] = None,
                          urls: Optional[Sequence[str]] = None)
    func NewUrlCategoryPredefined(ctx *Context, name string, args UrlCategoryPredefinedArgs, opts ...ResourceOption) (*UrlCategoryPredefined, error)
    public UrlCategoryPredefined(string name, UrlCategoryPredefinedArgs args, CustomResourceOptions? opts = null)
    public UrlCategoryPredefined(String name, UrlCategoryPredefinedArgs args)
public UrlCategoryPredefined(String name, UrlCategoryPredefinedArgs args, CustomResourceOptions options)

    type: zia:UrlCategoryPredefined
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 UrlCategoryPredefinedArgs
    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 UrlCategoryPredefinedArgs
    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 UrlCategoryPredefinedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UrlCategoryPredefinedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UrlCategoryPredefinedArgs
    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 urlCategoryPredefinedResource = new Zia.UrlCategoryPredefined("urlCategoryPredefinedResource", new()
{
    Name = "string",
    IpRanges = new[]
    {
        "string",
    },
    IpRangesRetainingParentCategory = new[]
    {
        "string",
    },
    Keywords = new[]
    {
        "string",
    },
    KeywordsRetainingParentCategory = new[]
    {
        "string",
    },
    Urls = new[]
    {
        "string",
    },
});

    example, err := zia.NewUrlCategoryPredefined(ctx, "urlCategoryPredefinedResource", &zia.UrlCategoryPredefinedArgs{
	Name: pulumi.String("string"),
	IpRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpRangesRetainingParentCategory: pulumi.StringArray{
		pulumi.String("string"),
	},
	Keywords: pulumi.StringArray{
		pulumi.String("string"),
	},
	KeywordsRetainingParentCategory: pulumi.StringArray{
		pulumi.String("string"),
	},
	Urls: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var urlCategoryPredefinedResource = new UrlCategoryPredefined("urlCategoryPredefinedResource", UrlCategoryPredefinedArgs.builder()
    .name("string")
    .ipRanges("string")
    .ipRangesRetainingParentCategory("string")
    .keywords("string")
    .keywordsRetainingParentCategory("string")
    .urls("string")
    .build());

    url_category_predefined_resource = zia.UrlCategoryPredefined("urlCategoryPredefinedResource",
    name="string",
    ip_ranges=["string"],
    ip_ranges_retaining_parent_category=["string"],
    keywords=["string"],
    keywords_retaining_parent_category=["string"],
    urls=["string"])

    const urlCategoryPredefinedResource = new zia.UrlCategoryPredefined("urlCategoryPredefinedResource", {
    name: "string",
    ipRanges: ["string"],
    ipRangesRetainingParentCategory: ["string"],
    keywords: ["string"],
    keywordsRetainingParentCategory: ["string"],
    urls: ["string"],
});

    type: zia:UrlCategoryPredefined
properties:
    ipRanges:
        - string
    ipRangesRetainingParentCategory:
        - string
    keywords:
        - string
    keywordsRetainingParentCategory:
        - string
    name: string
    urls:
        - string

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

    Name string
    The name or ID of the predefined URL category to override (e.g., FINANCE, SOCIAL_NETWORKING).
    IpRanges List<string>
    List of custom IP address ranges to add to the predefined category.
    IpRangesRetainingParentCategory List<string>
    List of IP ranges that retain their parent category classification.
    Keywords List<string>
    List of custom keywords to add to the predefined category.
    KeywordsRetainingParentCategory List<string>
    List of keywords that retain their parent category classification.
    Urls List<string>
    List of custom URLs to add to the predefined category.
    Name string
    The name or ID of the predefined URL category to override (e.g., FINANCE, SOCIAL_NETWORKING).
    IpRanges []string
    List of custom IP address ranges to add to the predefined category.
    IpRangesRetainingParentCategory []string
    List of IP ranges that retain their parent category classification.
    Keywords []string
    List of custom keywords to add to the predefined category.
    KeywordsRetainingParentCategory []string
    List of keywords that retain their parent category classification.
    Urls []string
    List of custom URLs to add to the predefined category.
    name String
    The name or ID of the predefined URL category to override (e.g., FINANCE, SOCIAL_NETWORKING).
    ipRanges List<String>
    List of custom IP address ranges to add to the predefined category.
    ipRangesRetainingParentCategory List<String>
    List of IP ranges that retain their parent category classification.
    keywords List<String>
    List of custom keywords to add to the predefined category.
    keywordsRetainingParentCategory List<String>
    List of keywords that retain their parent category classification.
    urls List<String>
    List of custom URLs to add to the predefined category.
    name string
    The name or ID of the predefined URL category to override (e.g., FINANCE, SOCIAL_NETWORKING).
    ipRanges string[]
    List of custom IP address ranges to add to the predefined category.
    ipRangesRetainingParentCategory string[]
    List of IP ranges that retain their parent category classification.
    keywords string[]
    List of custom keywords to add to the predefined category.
    keywordsRetainingParentCategory string[]
    List of keywords that retain their parent category classification.
    urls string[]
    List of custom URLs to add to the predefined category.
    name str
    The name or ID of the predefined URL category to override (e.g., FINANCE, SOCIAL_NETWORKING).
    ip_ranges Sequence[str]
    List of custom IP address ranges to add to the predefined category.
    ip_ranges_retaining_parent_category Sequence[str]
    List of IP ranges that retain their parent category classification.
    keywords Sequence[str]
    List of custom keywords to add to the predefined category.
    keywords_retaining_parent_category Sequence[str]
    List of keywords that retain their parent category classification.
    urls Sequence[str]
    List of custom URLs to add to the predefined category.
    name String
    The name or ID of the predefined URL category to override (e.g., FINANCE, SOCIAL_NETWORKING).
    ipRanges List<String>
    List of custom IP address ranges to add to the predefined category.
    ipRangesRetainingParentCategory List<String>
    List of IP ranges that retain their parent category classification.
    keywords List<String>
    List of custom keywords to add to the predefined category.
    keywordsRetainingParentCategory List<String>
    List of keywords that retain their parent category classification.
    urls List<String>
    List of custom URLs to add to the predefined category.

    Outputs

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

    CategoryId string
    The system-generated ID of the predefined URL category.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConfiguredName string
    The configured display name of the predefined URL category.
    CustomIpRangesCount int
    The number of custom IP ranges in the category.
    CustomUrlsCount int
    The number of custom URLs in the category.
    DbCategorizedUrls List<string>
    URLs in this category that have been categorized by the Zscaler database.
    Editable bool
    Whether the predefined URL category is editable.
    IpRangesRetainingParentCategoryCount int
    The number of IP ranges retaining parent category.
    SuperCategory string
    The super category of the predefined URL category.
    Type string
    The type of the URL category.
    UrlType string
    The URL type of the predefined category.
    UrlsRetainingParentCategoryCount int
    The number of URLs retaining parent category.
    Val int
    The internal numeric value of the URL category.
    CategoryId string
    The system-generated ID of the predefined URL category.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConfiguredName string
    The configured display name of the predefined URL category.
    CustomIpRangesCount int
    The number of custom IP ranges in the category.
    CustomUrlsCount int
    The number of custom URLs in the category.
    DbCategorizedUrls []string
    URLs in this category that have been categorized by the Zscaler database.
    Editable bool
    Whether the predefined URL category is editable.
    IpRangesRetainingParentCategoryCount int
    The number of IP ranges retaining parent category.
    SuperCategory string
    The super category of the predefined URL category.
    Type string
    The type of the URL category.
    UrlType string
    The URL type of the predefined category.
    UrlsRetainingParentCategoryCount int
    The number of URLs retaining parent category.
    Val int
    The internal numeric value of the URL category.
    categoryId String
    The system-generated ID of the predefined URL category.
    id String
    The provider-assigned unique ID for this managed resource.
    configuredName String
    The configured display name of the predefined URL category.
    customIpRangesCount Integer
    The number of custom IP ranges in the category.
    customUrlsCount Integer
    The number of custom URLs in the category.
    dbCategorizedUrls List<String>
    URLs in this category that have been categorized by the Zscaler database.
    editable Boolean
    Whether the predefined URL category is editable.
    ipRangesRetainingParentCategoryCount Integer
    The number of IP ranges retaining parent category.
    superCategory String
    The super category of the predefined URL category.
    type String
    The type of the URL category.
    urlType String
    The URL type of the predefined category.
    urlsRetainingParentCategoryCount Integer
    The number of URLs retaining parent category.
    val Integer
    The internal numeric value of the URL category.
    categoryId string
    The system-generated ID of the predefined URL category.
    id string
    The provider-assigned unique ID for this managed resource.
    configuredName string
    The configured display name of the predefined URL category.
    customIpRangesCount number
    The number of custom IP ranges in the category.
    customUrlsCount number
    The number of custom URLs in the category.
    dbCategorizedUrls string[]
    URLs in this category that have been categorized by the Zscaler database.
    editable boolean
    Whether the predefined URL category is editable.
    ipRangesRetainingParentCategoryCount number
    The number of IP ranges retaining parent category.
    superCategory string
    The super category of the predefined URL category.
    type string
    The type of the URL category.
    urlType string
    The URL type of the predefined category.
    urlsRetainingParentCategoryCount number
    The number of URLs retaining parent category.
    val number
    The internal numeric value of the URL category.
    category_id str
    The system-generated ID of the predefined URL category.
    id str
    The provider-assigned unique ID for this managed resource.
    configured_name str
    The configured display name of the predefined URL category.
    custom_ip_ranges_count int
    The number of custom IP ranges in the category.
    custom_urls_count int
    The number of custom URLs in the category.
    db_categorized_urls Sequence[str]
    URLs in this category that have been categorized by the Zscaler database.
    editable bool
    Whether the predefined URL category is editable.
    ip_ranges_retaining_parent_category_count int
    The number of IP ranges retaining parent category.
    super_category str
    The super category of the predefined URL category.
    type str
    The type of the URL category.
    url_type str
    The URL type of the predefined category.
    urls_retaining_parent_category_count int
    The number of URLs retaining parent category.
    val int
    The internal numeric value of the URL category.
    categoryId String
    The system-generated ID of the predefined URL category.
    id String
    The provider-assigned unique ID for this managed resource.
    configuredName String
    The configured display name of the predefined URL category.
    customIpRangesCount Number
    The number of custom IP ranges in the category.
    customUrlsCount Number
    The number of custom URLs in the category.
    dbCategorizedUrls List<String>
    URLs in this category that have been categorized by the Zscaler database.
    editable Boolean
    Whether the predefined URL category is editable.
    ipRangesRetainingParentCategoryCount Number
    The number of IP ranges retaining parent category.
    superCategory String
    The super category of the predefined URL category.
    type String
    The type of the URL category.
    urlType String
    The URL type of the predefined category.
    urlsRetainingParentCategoryCount Number
    The number of URLs retaining parent category.
    val Number
    The internal numeric value of the URL category.

    Import

    An existing Predefined URL Category override can be imported using its category ID, e.g.

    $ pulumi import zia:index:UrlCategoryPredefined example FINANCE

    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.