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

zia.getURLCategories

Explore with Pulumi AI

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

    Use the zia_url_categories data source to get information about all or custom URL categories. By default, the response includes keywords.

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

const example = zia.getURLCategories({
    id: "CUSTOM_08",
});

    import pulumi
import pulumi_zia as zia

example = zia.get_url_categories(id="CUSTOM_08")

    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.LookupURLCategories(ctx, &zia.LookupURLCategoriesArgs{
			Id: pulumi.StringRef("CUSTOM_08"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Zia.GetURLCategories.Invoke(new()
    {
        Id = "CUSTOM_08",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.ZiaFunctions;
import com.pulumi.zia.inputs.GetURLCategoriesArgs;
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) {
        final var example = ZiaFunctions.getURLCategories(GetURLCategoriesArgs.builder()
            .id("CUSTOM_08")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: zia:getURLCategories
      Arguments:
        id: CUSTOM_08

    Using getURLCategories

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getURLCategories(args: GetURLCategoriesArgs, opts?: InvokeOptions): Promise<GetURLCategoriesResult>
function getURLCategoriesOutput(args: GetURLCategoriesOutputArgs, opts?: InvokeOptions): Output<GetURLCategoriesResult>
    def get_url_categories(configured_name: Optional[str] = None,
                       custom_category: Optional[bool] = None,
                       custom_ip_ranges_count: Optional[int] = None,
                       id: Optional[str] = None,
                       super_category: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetURLCategoriesResult
def get_url_categories_output(configured_name: Optional[pulumi.Input[str]] = None,
                       custom_category: Optional[pulumi.Input[bool]] = None,
                       custom_ip_ranges_count: Optional[pulumi.Input[int]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       super_category: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetURLCategoriesResult]
    func LookupURLCategories(ctx *Context, args *LookupURLCategoriesArgs, opts ...InvokeOption) (*LookupURLCategoriesResult, error)
func LookupURLCategoriesOutput(ctx *Context, args *LookupURLCategoriesOutputArgs, opts ...InvokeOption) LookupURLCategoriesResultOutput

    > Note: This function is named LookupURLCategories in the Go SDK.

    public static class GetURLCategories 
{
    public static Task<GetURLCategoriesResult> InvokeAsync(GetURLCategoriesArgs args, InvokeOptions? opts = null)
    public static Output<GetURLCategoriesResult> Invoke(GetURLCategoriesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetURLCategoriesResult> getURLCategories(GetURLCategoriesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: zia:index/getURLCategories:getURLCategories
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConfiguredName string
    (String) Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomIpRangesCount int
    (Number) The number of custom IP address ranges associated to the URL category.
    Id string
    URL category
    SuperCategory string
    (String)
    ConfiguredName string
    (String) Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomIpRangesCount int
    (Number) The number of custom IP address ranges associated to the URL category.
    Id string
    URL category
    SuperCategory string
    (String)
    configuredName String
    (String) Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount Integer
    (Number) The number of custom IP address ranges associated to the URL category.
    id String
    URL category
    superCategory String
    (String)
    configuredName string
    (String) Name of the URL category. This is only required for custom URL categories.
    customCategory boolean
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount number
    (Number) The number of custom IP address ranges associated to the URL category.
    id string
    URL category
    superCategory string
    (String)
    configured_name str
    (String) Name of the URL category. This is only required for custom URL categories.
    custom_category bool
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    custom_ip_ranges_count int
    (Number) The number of custom IP address ranges associated to the URL category.
    id str
    URL category
    super_category str
    (String)
    configuredName String
    (String) Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customIpRangesCount Number
    (Number) The number of custom IP address ranges associated to the URL category.
    id String
    URL category
    superCategory String
    (String)

    getURLCategories Result

    The following output properties are available:

    ConfiguredName string
    (String) Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomUrlsCount int
    (Number) The number of custom URLs associated to the URL category.
    DbCategorizedUrls List<string>
    (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).
    Description string
    (String) Description of the category.
    Editable bool
    (Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
    Id string
    (String) Identifier that uniquely identifies an entity
    IpRanges List<string>
    IpRangesRetainingParentCategories List<string>
    IpRangesRetainingParentCategoryCount int
    (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>
    (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).
    KeywordsRetainingParentCategories List<string>
    Scopes List<zscaler.PulumiPackage.Zia.Outputs.GetURLCategoriesScope>
    (List of Object) Scope of the custom categories.
    Type string
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    UrlKeywordCounts List<zscaler.PulumiPackage.Zia.Outputs.GetURLCategoriesUrlKeywordCount>
    (List of Object) URL and keyword counts for the category.
    Urls List<string>
    (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).
    UrlsRetainingParentCategoryCount int
    (Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
    Val int
    (Number)
    CustomIpRangesCount int
    (Number) The number of custom IP address ranges associated to the URL category.
    SuperCategory string
    (String)
    ConfiguredName string
    (String) Name of the URL category. This is only required for custom URL categories.
    CustomCategory bool
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    CustomUrlsCount int
    (Number) The number of custom URLs associated to the URL category.
    DbCategorizedUrls []string
    (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).
    Description string
    (String) Description of the category.
    Editable bool
    (Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
    Id string
    (String) Identifier that uniquely identifies an entity
    IpRanges []string
    IpRangesRetainingParentCategories []string
    IpRangesRetainingParentCategoryCount int
    (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
    (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).
    KeywordsRetainingParentCategories []string
    Scopes []GetURLCategoriesScope
    (List of Object) Scope of the custom categories.
    Type string
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    UrlKeywordCounts []GetURLCategoriesUrlKeywordCount
    (List of Object) URL and keyword counts for the category.
    Urls []string
    (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).
    UrlsRetainingParentCategoryCount int
    (Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
    Val int
    (Number)
    CustomIpRangesCount int
    (Number) The number of custom IP address ranges associated to the URL category.
    SuperCategory string
    (String)
    configuredName String
    (String) Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customUrlsCount Integer
    (Number) The number of custom URLs associated to the URL category.
    dbCategorizedUrls List<String>
    (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).
    description String
    (String) Description of the category.
    editable Boolean
    (Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
    id String
    (String) Identifier that uniquely identifies an entity
    ipRanges List<String>
    ipRangesRetainingParentCategories List<String>
    ipRangesRetainingParentCategoryCount Integer
    (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>
    (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).
    keywordsRetainingParentCategories List<String>
    scopes List<GetURLCategoriesScope>
    (List of Object) Scope of the custom categories.
    type String
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts List<GetURLCategoriesUrlKeywordCount>
    (List of Object) URL and keyword counts for the category.
    urls List<String>
    (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).
    urlsRetainingParentCategoryCount Integer
    (Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
    val Integer
    (Number)
    customIpRangesCount Integer
    (Number) The number of custom IP address ranges associated to the URL category.
    superCategory String
    (String)
    configuredName string
    (String) Name of the URL category. This is only required for custom URL categories.
    customCategory boolean
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customUrlsCount number
    (Number) The number of custom URLs associated to the URL category.
    dbCategorizedUrls string[]
    (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).
    description string
    (String) Description of the category.
    editable boolean
    (Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
    id string
    (String) Identifier that uniquely identifies an entity
    ipRanges string[]
    ipRangesRetainingParentCategories string[]
    ipRangesRetainingParentCategoryCount number
    (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[]
    (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).
    keywordsRetainingParentCategories string[]
    scopes GetURLCategoriesScope[]
    (List of Object) Scope of the custom categories.
    type string
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts GetURLCategoriesUrlKeywordCount[]
    (List of Object) URL and keyword counts for the category.
    urls string[]
    (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).
    urlsRetainingParentCategoryCount number
    (Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
    val number
    (Number)
    customIpRangesCount number
    (Number) The number of custom IP address ranges associated to the URL category.
    superCategory string
    (String)
    configured_name str
    (String) Name of the URL category. This is only required for custom URL categories.
    custom_category bool
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    custom_urls_count int
    (Number) The number of custom URLs associated to the URL category.
    db_categorized_urls Sequence[str]
    (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).
    description str
    (String) Description of the category.
    editable bool
    (Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
    id str
    (String) Identifier that uniquely identifies an entity
    ip_ranges Sequence[str]
    ip_ranges_retaining_parent_categories Sequence[str]
    ip_ranges_retaining_parent_category_count int
    (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 Sequence[str]
    (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).
    keywords_retaining_parent_categories Sequence[str]
    scopes Sequence[GetURLCategoriesScope]
    (List of Object) Scope of the custom categories.
    type str
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    url_keyword_counts Sequence[GetURLCategoriesUrlKeywordCount]
    (List of Object) URL and keyword counts for the category.
    urls Sequence[str]
    (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).
    urls_retaining_parent_category_count int
    (Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
    val int
    (Number)
    custom_ip_ranges_count int
    (Number) The number of custom IP address ranges associated to the URL category.
    super_category str
    (String)
    configuredName String
    (String) Name of the URL category. This is only required for custom URL categories.
    customCategory Boolean
    (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
    customUrlsCount Number
    (Number) The number of custom URLs associated to the URL category.
    dbCategorizedUrls List<String>
    (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).
    description String
    (String) Description of the category.
    editable Boolean
    (Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
    id String
    (String) Identifier that uniquely identifies an entity
    ipRanges List<String>
    ipRangesRetainingParentCategories List<String>
    ipRangesRetainingParentCategoryCount Number
    (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>
    (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).
    keywordsRetainingParentCategories List<String>
    scopes List<Property Map>
    (List of Object) Scope of the custom categories.
    type String
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    urlKeywordCounts List<Property Map>
    (List of Object) URL and keyword counts for the category.
    urls List<String>
    (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).
    urlsRetainingParentCategoryCount Number
    (Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
    val Number
    (Number)
    customIpRangesCount Number
    (Number) The number of custom IP address ranges associated to the URL category.
    superCategory String
    (String)

    Supporting Types

    GetURLCategoriesScope

    ScopeEntities List<zscaler.PulumiPackage.Zia.Inputs.GetURLCategoriesScopeScopeEntity>
    (List of Object)
    ScopeGroupMemberEntities List<zscaler.PulumiPackage.Zia.Inputs.GetURLCategoriesScopeScopeGroupMemberEntity>
    (List of Object) 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
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    ScopeEntities []GetURLCategoriesScopeScopeEntity
    (List of Object)
    ScopeGroupMemberEntities []GetURLCategoriesScopeScopeGroupMemberEntity
    (List of Object) 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
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scopeEntities List<GetURLCategoriesScopeScopeEntity>
    (List of Object)
    scopeGroupMemberEntities List<GetURLCategoriesScopeScopeGroupMemberEntity>
    (List of Object) 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
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scopeEntities GetURLCategoriesScopeScopeEntity[]
    (List of Object)
    scopeGroupMemberEntities GetURLCategoriesScopeScopeGroupMemberEntity[]
    (List of Object) 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
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scope_entities Sequence[GetURLCategoriesScopeScopeEntity]
    (List of Object)
    scope_group_member_entities Sequence[GetURLCategoriesScopeScopeGroupMemberEntity]
    (List of Object) 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
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP
    scopeEntities List<Property Map>
    (List of Object)
    scopeGroupMemberEntities List<Property Map>
    (List of Object) 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
    (String) The admin scope type. The attribute name is subject to change. ORGANIZATION, DEPARTMENT, LOCATION, LOCATION_GROUP

    GetURLCategoriesScopeScopeEntity

    Extensions Dictionary<string, string>
    (Map of String)
    Id int
    URL category
    Name string
    (String) The configured name of the entity
    Extensions map[string]string
    (Map of String)
    Id int
    URL category
    Name string
    (String) The configured name of the entity
    extensions Map<String,String>
    (Map of String)
    id Integer
    URL category
    name String
    (String) The configured name of the entity
    extensions {[key: string]: string}
    (Map of String)
    id number
    URL category
    name string
    (String) The configured name of the entity
    extensions Mapping[str, str]
    (Map of String)
    id int
    URL category
    name str
    (String) The configured name of the entity
    extensions Map<String>
    (Map of String)
    id Number
    URL category
    name String
    (String) The configured name of the entity

    GetURLCategoriesScopeScopeGroupMemberEntity

    Extensions Dictionary<string, string>
    (Map of String)
    Id int
    URL category
    Name string
    (String) The configured name of the entity
    Extensions map[string]string
    (Map of String)
    Id int
    URL category
    Name string
    (String) The configured name of the entity
    extensions Map<String,String>
    (Map of String)
    id Integer
    URL category
    name String
    (String) The configured name of the entity
    extensions {[key: string]: string}
    (Map of String)
    id number
    URL category
    name string
    (String) The configured name of the entity
    extensions Mapping[str, str]
    (Map of String)
    id int
    URL category
    name str
    (String) The configured name of the entity
    extensions Map<String>
    (Map of String)
    id Number
    URL category
    name String
    (String) The configured name of the entity

    GetURLCategoriesUrlKeywordCount

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

    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