@bdzscaler/pulumi-zia/getURLCategories.d.ts

A Pulumi package for creating and managing zia cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * * [Official documentation](https://help.zscaler.com/zia/about-url-categories)
 * * [API documentation](https://help.zscaler.com/zia/url-categories#/urlCategories-get)
 *
 * Use the **zia_url_categories** data source to get information about all or custom URL categories. By default, the response includes keywords.
 */
export declare function getURLCategories(args?: GetURLCategoriesArgs, opts?: pulumi.InvokeOptions): Promise<GetURLCategoriesResult>;
/**
 * A collection of arguments for invoking getURLCategories.
 */
export interface GetURLCategoriesArgs {
    /**
     * (String) Name of the URL category. This is only required for custom URL categories.
     */
    configuredName?: string;
    /**
     * (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
     */
    customCategory?: boolean;
    /**
     * (Number) The number of custom IP address ranges associated to the URL category.
     */
    customIpRangesCount?: number;
    /**
     * URL category
     */
    id?: string;
    /**
     * (String)
     */
    superCategory?: string;
}
/**
 * A collection of values returned by getURLCategories.
 */
export interface GetURLCategoriesResult {
    /**
     * (String) Name of the URL category. This is only required for custom URL categories.
     */
    readonly configuredName: string;
    /**
     * (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
     */
    readonly customCategory: boolean;
    /**
     * (Number) The number of custom IP address ranges associated to the URL category.
     */
    readonly customIpRangesCount?: number;
    /**
     * (Number) The number of custom URLs associated to the URL category.
     */
    readonly customUrlsCount: number;
    /**
     * (List of 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).
     */
    readonly dbCategorizedUrls: string[];
    /**
     * (String) Description of the category.
     */
    readonly description: string;
    /**
     * (Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
     */
    readonly editable: boolean;
    /**
     * (String) Identifier that uniquely identifies an entity
     */
    readonly id: string;
    readonly ipRanges: string[];
    readonly ipRangesRetainingParentCategories: string[];
    /**
     * (Number) The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
     */
    readonly ipRangesRetainingParentCategoryCount: number;
    /**
     * (List of String) Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
     */
    readonly keywords: string[];
    readonly keywordsRetainingParentCategories: string[];
    /**
     * (List of Object) Scope of the custom categories.
     */
    readonly scopes: outputs.GetURLCategoriesScope[];
    /**
     * (String)
     */
    readonly superCategory?: string;
    /**
     * (String) The admin scope type. The attribute name is subject to change. `ORGANIZATION`, `DEPARTMENT`, `LOCATION`, `LOCATION_GROUP`
     */
    readonly type: string;
    /**
     * (List of Object) URL and keyword counts for the category.
     */
    readonly urlKeywordCounts: outputs.GetURLCategoriesUrlKeywordCount[];
    /**
     * (List of 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).
     */
    readonly urls: string[];
    /**
     * (Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
     */
    readonly urlsRetainingParentCategoryCount: number;
    /**
     * (Number) The unique ID for the URL category.
     */
    readonly val: number;
}
/**
 * * [Official documentation](https://help.zscaler.com/zia/about-url-categories)
 * * [API documentation](https://help.zscaler.com/zia/url-categories#/urlCategories-get)
 *
 * Use the **zia_url_categories** data source to get information about all or custom URL categories. By default, the response includes keywords.
 */
export declare function getURLCategoriesOutput(args?: GetURLCategoriesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetURLCategoriesResult>;
/**
 * A collection of arguments for invoking getURLCategories.
 */
export interface GetURLCategoriesOutputArgs {
    /**
     * (String) Name of the URL category. This is only required for custom URL categories.
     */
    configuredName?: pulumi.Input<string>;
    /**
     * (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
     */
    customCategory?: pulumi.Input<boolean>;
    /**
     * (Number) The number of custom IP address ranges associated to the URL category.
     */
    customIpRangesCount?: pulumi.Input<number>;
    /**
     * URL category
     */
    id?: pulumi.Input<string>;
    /**
     * (String)
     */
    superCategory?: pulumi.Input<string>;
}