Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. URLCategories
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

zia.URLCategories

Explore with Pulumi AI

Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 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",
    ],
});
Copy
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",
    ])
Copy
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
	})
}
Copy
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",
        },
    });

});
Copy
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());

    }
}
Copy
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
Copy

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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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,
});
Copy
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),
})
Copy
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());
Copy
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=[{
        "scope_entities": {
            "ids": [0],
        },
        "scope_group_member_entities": {
            "ids": [0],
        },
        "type": "string",
    }],
    super_category="string",
    type="string",
    url_keyword_counts={
        "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)
Copy
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,
});
Copy
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
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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
CustomIpRangesCount int
CustomUrlsCount int
DbCategorizedUrls List<string>
Description string
Editable bool
IpRanges List<string>
IpRangesRetainingParentCategories List<string>
IpRangesRetainingParentCategoryCount int
Keywords List<string>
KeywordsRetainingParentCategories List<string>
Scopes List<zscaler.PulumiPackage.Zia.Inputs.URLCategoriesScope>
SuperCategory string
Super Category of the URL category. This field is required when creating custom URL categories.
Type string
UrlKeywordCounts zscaler.PulumiPackage.Zia.Inputs.URLCategoriesUrlKeywordCounts
Urls List<string>
UrlsRetainingParentCategoryCount int
ConfiguredName string
Name of the URL category. This is only required for custom URL categories.
CustomCategory bool
CustomIpRangesCount int
CustomUrlsCount int
DbCategorizedUrls []string
Description string
Editable bool
IpRanges []string
IpRangesRetainingParentCategories []string
IpRangesRetainingParentCategoryCount int
Keywords []string
KeywordsRetainingParentCategories []string
Scopes []URLCategoriesScopeArgs
SuperCategory string
Super Category of the URL category. This field is required when creating custom URL categories.
Type string
UrlKeywordCounts URLCategoriesUrlKeywordCountsArgs
Urls []string
UrlsRetainingParentCategoryCount int
configuredName String
Name of the URL category. This is only required for custom URL categories.
customCategory Boolean
customIpRangesCount Integer
customUrlsCount Integer
dbCategorizedUrls List<String>
description String
editable Boolean
ipRanges List<String>
ipRangesRetainingParentCategories List<String>
ipRangesRetainingParentCategoryCount Integer
keywords List<String>
keywordsRetainingParentCategories List<String>
scopes List<URLCategoriesScope>
superCategory String
Super Category of the URL category. This field is required when creating custom URL categories.
type String
urlKeywordCounts URLCategoriesUrlKeywordCounts
urls List<String>
urlsRetainingParentCategoryCount Integer
configuredName string
Name of the URL category. This is only required for custom URL categories.
customCategory boolean
customIpRangesCount number
customUrlsCount number
dbCategorizedUrls string[]
description string
editable boolean
ipRanges string[]
ipRangesRetainingParentCategories string[]
ipRangesRetainingParentCategoryCount number
keywords string[]
keywordsRetainingParentCategories string[]
scopes URLCategoriesScope[]
superCategory string
Super Category of the URL category. This field is required when creating custom URL categories.
type string
urlKeywordCounts URLCategoriesUrlKeywordCounts
urls string[]
urlsRetainingParentCategoryCount number
configured_name str
Name of the URL category. This is only required for custom URL categories.
custom_category bool
custom_ip_ranges_count int
custom_urls_count int
db_categorized_urls Sequence[str]
description str
editable bool
ip_ranges Sequence[str]
ip_ranges_retaining_parent_categories Sequence[str]
ip_ranges_retaining_parent_category_count int
keywords Sequence[str]
keywords_retaining_parent_categories Sequence[str]
scopes Sequence[URLCategoriesScopeArgs]
super_category str
Super Category of the URL category. This field is required when creating custom URL categories.
type str
url_keyword_counts URLCategoriesUrlKeywordCountsArgs
urls Sequence[str]
urls_retaining_parent_category_count int
configuredName String
Name of the URL category. This is only required for custom URL categories.
customCategory Boolean
customIpRangesCount Number
customUrlsCount Number
dbCategorizedUrls List<String>
description String
editable Boolean
ipRanges List<String>
ipRangesRetainingParentCategories List<String>
ipRangesRetainingParentCategoryCount Number
keywords List<String>
keywordsRetainingParentCategories List<String>
scopes List<Property Map>
superCategory String
Super Category of the URL category. This field is required when creating custom URL categories.
type String
urlKeywordCounts Property Map
urls List<String>
urlsRetainingParentCategoryCount Number

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)
resources:  _:    type: zia:URLCategories    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
CustomIpRangesCount int
CustomUrlsCount int
DbCategorizedUrls List<string>
Description string
Editable bool
IpRanges List<string>
IpRangesRetainingParentCategories List<string>
IpRangesRetainingParentCategoryCount int
Keywords List<string>
KeywordsRetainingParentCategories List<string>
Scopes List<zscaler.PulumiPackage.Zia.Inputs.URLCategoriesScope>
SuperCategory string
Super Category of the URL category. This field is required when creating custom URL categories.
Type string
UrlKeywordCounts zscaler.PulumiPackage.Zia.Inputs.URLCategoriesUrlKeywordCounts
Urls List<string>
UrlsRetainingParentCategoryCount int
CategoryId string
ConfiguredName string
Name of the URL category. This is only required for custom URL categories.
CustomCategory bool
CustomIpRangesCount int
CustomUrlsCount int
DbCategorizedUrls []string
Description string
Editable bool
IpRanges []string
IpRangesRetainingParentCategories []string
IpRangesRetainingParentCategoryCount int
Keywords []string
KeywordsRetainingParentCategories []string
Scopes []URLCategoriesScopeArgs
SuperCategory string
Super Category of the URL category. This field is required when creating custom URL categories.
Type string
UrlKeywordCounts URLCategoriesUrlKeywordCountsArgs
Urls []string
UrlsRetainingParentCategoryCount int
categoryId String
configuredName String
Name of the URL category. This is only required for custom URL categories.
customCategory Boolean
customIpRangesCount Integer
customUrlsCount Integer
dbCategorizedUrls List<String>
description String
editable Boolean
ipRanges List<String>
ipRangesRetainingParentCategories List<String>
ipRangesRetainingParentCategoryCount Integer
keywords List<String>
keywordsRetainingParentCategories List<String>
scopes List<URLCategoriesScope>
superCategory String
Super Category of the URL category. This field is required when creating custom URL categories.
type String
urlKeywordCounts URLCategoriesUrlKeywordCounts
urls List<String>
urlsRetainingParentCategoryCount Integer
categoryId string
configuredName string
Name of the URL category. This is only required for custom URL categories.
customCategory boolean
customIpRangesCount number
customUrlsCount number
dbCategorizedUrls string[]
description string
editable boolean
ipRanges string[]
ipRangesRetainingParentCategories string[]
ipRangesRetainingParentCategoryCount number
keywords string[]
keywordsRetainingParentCategories string[]
scopes URLCategoriesScope[]
superCategory string
Super Category of the URL category. This field is required when creating custom URL categories.
type string
urlKeywordCounts URLCategoriesUrlKeywordCounts
urls string[]
urlsRetainingParentCategoryCount number
category_id str
configured_name str
Name of the URL category. This is only required for custom URL categories.
custom_category bool
custom_ip_ranges_count int
custom_urls_count int
db_categorized_urls Sequence[str]
description str
editable bool
ip_ranges Sequence[str]
ip_ranges_retaining_parent_categories Sequence[str]
ip_ranges_retaining_parent_category_count int
keywords Sequence[str]
keywords_retaining_parent_categories Sequence[str]
scopes Sequence[URLCategoriesScopeArgs]
super_category str
Super Category of the URL category. This field is required when creating custom URL categories.
type str
url_keyword_counts URLCategoriesUrlKeywordCountsArgs
urls Sequence[str]
urls_retaining_parent_category_count int
categoryId String
configuredName String
Name of the URL category. This is only required for custom URL categories.
customCategory Boolean
customIpRangesCount Number
customUrlsCount Number
dbCategorizedUrls List<String>
description String
editable Boolean
ipRanges List<String>
ipRangesRetainingParentCategories List<String>
ipRangesRetainingParentCategoryCount Number
keywords List<String>
keywordsRetainingParentCategories List<String>
scopes List<Property Map>
superCategory String
Super Category of the URL category. This field is required when creating custom URL categories.
type String
urlKeywordCounts Property Map
urls List<String>
urlsRetainingParentCategoryCount Number

Supporting Types

URLCategoriesScope
, URLCategoriesScopeArgs

scopeEntities Property Map
list of scope IDs
scopeGroupMemberEntities Property Map
list of scope group member IDs
type String

URLCategoriesScopeScopeEntities
, URLCategoriesScopeScopeEntitiesArgs

Ids This property is required. List<int>
Ids This property is required. []int
ids This property is required. List<Integer>
ids This property is required. number[]
ids This property is required. Sequence[int]
ids This property is required. List<Number>

URLCategoriesScopeScopeGroupMemberEntities
, URLCategoriesScopeScopeGroupMemberEntitiesArgs

Ids This property is required. List<int>
Ids This property is required. []int
ids This property is required. List<Integer>
ids This property is required. number[]
ids This property is required. Sequence[int]
ids This property is required. 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>
Copy

or

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

⚠️ 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.
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia