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

zia.URLFilteringRules

Explore with Pulumi AI

Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

The zia_url_filtering_rules resource creates and manages a URL filtering rules within the Zscaler Internet Access cloud.

Example Usage

ALLOW ACTION

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

const _this = new zia.URLFilteringRules("this", {
    action: "ALLOW",
    description: "Example",
    deviceTrustLevels: [
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    enforceTimeValidity: true,
    order: 1,
    protocols: ["ANY_RULE"],
    requestMethods: [
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    sizeQuota: 10,
    state: "ENABLED",
    timeQuota: 15,
    urlCategories: ["ANY"],
    userAgentTypes: [
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ],
    validityEndTime: "Tue, 17 Jun 2025 23:00:00 UTC",
    validityStartTime: "Mon, 17 Jun 2024 23:30:00 UTC",
    validityTimeZoneId: "US/Pacific",
});
Copy
import pulumi
import zscaler_pulumi_zia as zia

this = zia.URLFilteringRules("this",
    action="ALLOW",
    description="Example",
    device_trust_levels=[
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    enforce_time_validity=True,
    order=1,
    protocols=["ANY_RULE"],
    request_methods=[
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    size_quota=10,
    state="ENABLED",
    time_quota=15,
    url_categories=["ANY"],
    user_agent_types=[
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ],
    validity_end_time="Tue, 17 Jun 2025 23:00:00 UTC",
    validity_start_time="Mon, 17 Jun 2024 23:30:00 UTC",
    validity_time_zone_id="US/Pacific")
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.NewURLFilteringRules(ctx, "this", &zia.URLFilteringRulesArgs{
			Action:      pulumi.String("ALLOW"),
			Description: pulumi.String("Example"),
			DeviceTrustLevels: pulumi.StringArray{
				pulumi.String("UNKNOWN_DEVICETRUSTLEVEL"),
				pulumi.String("LOW_TRUST"),
				pulumi.String("MEDIUM_TRUST"),
				pulumi.String("HIGH_TRUST"),
			},
			EnforceTimeValidity: pulumi.Bool(true),
			Order:               pulumi.Int(1),
			Protocols: pulumi.StringArray{
				pulumi.String("ANY_RULE"),
			},
			RequestMethods: pulumi.StringArray{
				pulumi.String("CONNECT"),
				pulumi.String("DELETE"),
				pulumi.String("GET"),
				pulumi.String("HEAD"),
				pulumi.String("OPTIONS"),
				pulumi.String("OTHER"),
				pulumi.String("POST"),
				pulumi.String("PUT"),
				pulumi.String("TRACE"),
			},
			SizeQuota: pulumi.Int(10),
			State:     pulumi.String("ENABLED"),
			TimeQuota: pulumi.Int(15),
			UrlCategories: pulumi.StringArray{
				pulumi.String("ANY"),
			},
			UserAgentTypes: pulumi.StringArray{
				pulumi.String("OPERA"),
				pulumi.String("FIREFOX"),
				pulumi.String("MSIE"),
				pulumi.String("MSEDGE"),
				pulumi.String("CHROME"),
				pulumi.String("SAFARI"),
				pulumi.String("MSCHREDGE"),
			},
			ValidityEndTime:    pulumi.String("Tue, 17 Jun 2025 23:00:00 UTC"),
			ValidityStartTime:  pulumi.String("Mon, 17 Jun 2024 23:30:00 UTC"),
			ValidityTimeZoneId: pulumi.String("US/Pacific"),
		})
		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 @this = new Zia.URLFilteringRules("this", new()
    {
        Action = "ALLOW",
        Description = "Example",
        DeviceTrustLevels = new[]
        {
            "UNKNOWN_DEVICETRUSTLEVEL",
            "LOW_TRUST",
            "MEDIUM_TRUST",
            "HIGH_TRUST",
        },
        EnforceTimeValidity = true,
        Order = 1,
        Protocols = new[]
        {
            "ANY_RULE",
        },
        RequestMethods = new[]
        {
            "CONNECT",
            "DELETE",
            "GET",
            "HEAD",
            "OPTIONS",
            "OTHER",
            "POST",
            "PUT",
            "TRACE",
        },
        SizeQuota = 10,
        State = "ENABLED",
        TimeQuota = 15,
        UrlCategories = new[]
        {
            "ANY",
        },
        UserAgentTypes = new[]
        {
            "OPERA",
            "FIREFOX",
            "MSIE",
            "MSEDGE",
            "CHROME",
            "SAFARI",
            "MSCHREDGE",
        },
        ValidityEndTime = "Tue, 17 Jun 2025 23:00:00 UTC",
        ValidityStartTime = "Mon, 17 Jun 2024 23:30:00 UTC",
        ValidityTimeZoneId = "US/Pacific",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.URLFilteringRules;
import com.pulumi.zia.URLFilteringRulesArgs;
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 this_ = new URLFilteringRules("this", URLFilteringRulesArgs.builder()
            .action("ALLOW")
            .description("Example")
            .deviceTrustLevels(            
                "UNKNOWN_DEVICETRUSTLEVEL",
                "LOW_TRUST",
                "MEDIUM_TRUST",
                "HIGH_TRUST")
            .enforceTimeValidity(true)
            .order(1)
            .protocols("ANY_RULE")
            .requestMethods(            
                "CONNECT",
                "DELETE",
                "GET",
                "HEAD",
                "OPTIONS",
                "OTHER",
                "POST",
                "PUT",
                "TRACE")
            .sizeQuota(10)
            .state("ENABLED")
            .timeQuota(15)
            .urlCategories("ANY")
            .userAgentTypes(            
                "OPERA",
                "FIREFOX",
                "MSIE",
                "MSEDGE",
                "CHROME",
                "SAFARI",
                "MSCHREDGE")
            .validityEndTime("Tue, 17 Jun 2025 23:00:00 UTC")
            .validityStartTime("Mon, 17 Jun 2024 23:30:00 UTC")
            .validityTimeZoneId("US/Pacific")
            .build());

    }
}
Copy
resources:
  this:
    type: zia:URLFilteringRules
    properties:
      action: ALLOW
      description: Example
      deviceTrustLevels:
        - UNKNOWN_DEVICETRUSTLEVEL
        - LOW_TRUST
        - MEDIUM_TRUST
        - HIGH_TRUST
      enforceTimeValidity: true
      order: 1
      protocols:
        - ANY_RULE
      requestMethods:
        - CONNECT
        - DELETE
        - GET
        - HEAD
        - OPTIONS
        - OTHER
        - POST
        - PUT
        - TRACE
      sizeQuota: 10
      state: ENABLED
      timeQuota: 15
      urlCategories:
        - ANY
      userAgentTypes:
        - OPERA
        - FIREFOX
        - MSIE
        - MSEDGE
        - CHROME
        - SAFARI
        - MSCHREDGE
      validityEndTime: Tue, 17 Jun 2025 23:00:00 UTC
      validityStartTime: Mon, 17 Jun 2024 23:30:00 UTC
      validityTimeZoneId: US/Pacific
Copy

BLOCK ACTION

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

const _this = new zia.URLFilteringRules("this", {
    action: "BLOCK",
    blockOverride: true,
    description: "Example",
    deviceTrustLevels: [
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    enforceTimeValidity: true,
    order: 1,
    overrideGroups: {
        ids: [76662385],
    },
    overrideUsers: {
        ids: [45513075],
    },
    protocols: ["ANY_RULE"],
    requestMethods: [
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    sizeQuota: 10,
    state: "ENABLED",
    timeQuota: 15,
    urlCategories: ["ANY"],
    userAgentTypes: [
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ],
    validityEndTime: "Tue, 17 Jun 2025 23:00:00 UTC",
    validityStartTime: "Mon, 17 Jun 2024 23:30:00 UTC",
    validityTimeZoneId: "US/Pacific",
});
Copy
import pulumi
import zscaler_pulumi_zia as zia

this = zia.URLFilteringRules("this",
    action="BLOCK",
    block_override=True,
    description="Example",
    device_trust_levels=[
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    enforce_time_validity=True,
    order=1,
    override_groups=zia.URLFilteringRulesOverrideGroupsArgs(
        ids=[76662385],
    ),
    override_users=zia.URLFilteringRulesOverrideUsersArgs(
        ids=[45513075],
    ),
    protocols=["ANY_RULE"],
    request_methods=[
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    size_quota=10,
    state="ENABLED",
    time_quota=15,
    url_categories=["ANY"],
    user_agent_types=[
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ],
    validity_end_time="Tue, 17 Jun 2025 23:00:00 UTC",
    validity_start_time="Mon, 17 Jun 2024 23:30:00 UTC",
    validity_time_zone_id="US/Pacific")
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.NewURLFilteringRules(ctx, "this", &zia.URLFilteringRulesArgs{
			Action:        pulumi.String("BLOCK"),
			BlockOverride: pulumi.Bool(true),
			Description:   pulumi.String("Example"),
			DeviceTrustLevels: pulumi.StringArray{
				pulumi.String("UNKNOWN_DEVICETRUSTLEVEL"),
				pulumi.String("LOW_TRUST"),
				pulumi.String("MEDIUM_TRUST"),
				pulumi.String("HIGH_TRUST"),
			},
			EnforceTimeValidity: pulumi.Bool(true),
			Order:               pulumi.Int(1),
			OverrideGroups: &zia.URLFilteringRulesOverrideGroupsArgs{
				Ids: pulumi.IntArray{
					pulumi.Int(76662385),
				},
			},
			OverrideUsers: &zia.URLFilteringRulesOverrideUsersArgs{
				Ids: pulumi.IntArray{
					pulumi.Int(45513075),
				},
			},
			Protocols: pulumi.StringArray{
				pulumi.String("ANY_RULE"),
			},
			RequestMethods: pulumi.StringArray{
				pulumi.String("CONNECT"),
				pulumi.String("DELETE"),
				pulumi.String("GET"),
				pulumi.String("HEAD"),
				pulumi.String("OPTIONS"),
				pulumi.String("OTHER"),
				pulumi.String("POST"),
				pulumi.String("PUT"),
				pulumi.String("TRACE"),
			},
			SizeQuota: pulumi.Int(10),
			State:     pulumi.String("ENABLED"),
			TimeQuota: pulumi.Int(15),
			UrlCategories: pulumi.StringArray{
				pulumi.String("ANY"),
			},
			UserAgentTypes: pulumi.StringArray{
				pulumi.String("OPERA"),
				pulumi.String("FIREFOX"),
				pulumi.String("MSIE"),
				pulumi.String("MSEDGE"),
				pulumi.String("CHROME"),
				pulumi.String("SAFARI"),
				pulumi.String("MSCHREDGE"),
			},
			ValidityEndTime:    pulumi.String("Tue, 17 Jun 2025 23:00:00 UTC"),
			ValidityStartTime:  pulumi.String("Mon, 17 Jun 2024 23:30:00 UTC"),
			ValidityTimeZoneId: pulumi.String("US/Pacific"),
		})
		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 @this = new Zia.URLFilteringRules("this", new()
    {
        Action = "BLOCK",
        BlockOverride = true,
        Description = "Example",
        DeviceTrustLevels = new[]
        {
            "UNKNOWN_DEVICETRUSTLEVEL",
            "LOW_TRUST",
            "MEDIUM_TRUST",
            "HIGH_TRUST",
        },
        EnforceTimeValidity = true,
        Order = 1,
        OverrideGroups = new Zia.Inputs.URLFilteringRulesOverrideGroupsArgs
        {
            Ids = new[]
            {
                76662385,
            },
        },
        OverrideUsers = new Zia.Inputs.URLFilteringRulesOverrideUsersArgs
        {
            Ids = new[]
            {
                45513075,
            },
        },
        Protocols = new[]
        {
            "ANY_RULE",
        },
        RequestMethods = new[]
        {
            "CONNECT",
            "DELETE",
            "GET",
            "HEAD",
            "OPTIONS",
            "OTHER",
            "POST",
            "PUT",
            "TRACE",
        },
        SizeQuota = 10,
        State = "ENABLED",
        TimeQuota = 15,
        UrlCategories = new[]
        {
            "ANY",
        },
        UserAgentTypes = new[]
        {
            "OPERA",
            "FIREFOX",
            "MSIE",
            "MSEDGE",
            "CHROME",
            "SAFARI",
            "MSCHREDGE",
        },
        ValidityEndTime = "Tue, 17 Jun 2025 23:00:00 UTC",
        ValidityStartTime = "Mon, 17 Jun 2024 23:30:00 UTC",
        ValidityTimeZoneId = "US/Pacific",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.URLFilteringRules;
import com.pulumi.zia.URLFilteringRulesArgs;
import com.pulumi.zia.inputs.URLFilteringRulesOverrideGroupsArgs;
import com.pulumi.zia.inputs.URLFilteringRulesOverrideUsersArgs;
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 this_ = new URLFilteringRules("this", URLFilteringRulesArgs.builder()
            .action("BLOCK")
            .blockOverride(true)
            .description("Example")
            .deviceTrustLevels(            
                "UNKNOWN_DEVICETRUSTLEVEL",
                "LOW_TRUST",
                "MEDIUM_TRUST",
                "HIGH_TRUST")
            .enforceTimeValidity(true)
            .order(1)
            .overrideGroups(URLFilteringRulesOverrideGroupsArgs.builder()
                .ids(76662385)
                .build())
            .overrideUsers(URLFilteringRulesOverrideUsersArgs.builder()
                .ids(45513075)
                .build())
            .protocols("ANY_RULE")
            .requestMethods(            
                "CONNECT",
                "DELETE",
                "GET",
                "HEAD",
                "OPTIONS",
                "OTHER",
                "POST",
                "PUT",
                "TRACE")
            .sizeQuota(10)
            .state("ENABLED")
            .timeQuota(15)
            .urlCategories("ANY")
            .userAgentTypes(            
                "OPERA",
                "FIREFOX",
                "MSIE",
                "MSEDGE",
                "CHROME",
                "SAFARI",
                "MSCHREDGE")
            .validityEndTime("Tue, 17 Jun 2025 23:00:00 UTC")
            .validityStartTime("Mon, 17 Jun 2024 23:30:00 UTC")
            .validityTimeZoneId("US/Pacific")
            .build());

    }
}
Copy
resources:
  this:
    type: zia:URLFilteringRules
    properties:
      action: BLOCK
      blockOverride: true
      description: Example
      deviceTrustLevels:
        - UNKNOWN_DEVICETRUSTLEVEL
        - LOW_TRUST
        - MEDIUM_TRUST
        - HIGH_TRUST
      enforceTimeValidity: true
      order: 1
      overrideGroups:
        ids:
          - 7.6662385e+07
      overrideUsers:
        ids:
          - 4.5513075e+07
      protocols:
        - ANY_RULE
      requestMethods:
        - CONNECT
        - DELETE
        - GET
        - HEAD
        - OPTIONS
        - OTHER
        - POST
        - PUT
        - TRACE
      sizeQuota: 10
      state: ENABLED
      timeQuota: 15
      urlCategories:
        - ANY
      userAgentTypes:
        - OPERA
        - FIREFOX
        - MSIE
        - MSEDGE
        - CHROME
        - SAFARI
        - MSCHREDGE
      validityEndTime: Tue, 17 Jun 2025 23:00:00 UTC
      validityStartTime: Mon, 17 Jun 2024 23:30:00 UTC
      validityTimeZoneId: US/Pacific
Copy

CAUTION ACTION

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

const _this = new zia.URLFilteringRules("this", {
    action: "CAUTION",
    description: "Example",
    deviceTrustLevels: [
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    endUserNotificationUrl: "https://caution.acme.com",
    enforceTimeValidity: true,
    order: 1,
    protocols: ["ANY_RULE"],
    requestMethods: [
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    sizeQuota: 10,
    state: "ENABLED",
    timeQuota: 15,
    urlCategories: ["ANY"],
    userAgentTypes: [
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ],
    validityEndTime: "Tue, 17 Jun 2025 23:00:00 UTC",
    validityStartTime: "Mon, 17 Jun 2024 23:30:00 UTC",
    validityTimeZoneId: "US/Pacific",
});
Copy
import pulumi
import zscaler_pulumi_zia as zia

this = zia.URLFilteringRules("this",
    action="CAUTION",
    description="Example",
    device_trust_levels=[
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    end_user_notification_url="https://caution.acme.com",
    enforce_time_validity=True,
    order=1,
    protocols=["ANY_RULE"],
    request_methods=[
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    size_quota=10,
    state="ENABLED",
    time_quota=15,
    url_categories=["ANY"],
    user_agent_types=[
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ],
    validity_end_time="Tue, 17 Jun 2025 23:00:00 UTC",
    validity_start_time="Mon, 17 Jun 2024 23:30:00 UTC",
    validity_time_zone_id="US/Pacific")
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.NewURLFilteringRules(ctx, "this", &zia.URLFilteringRulesArgs{
			Action:      pulumi.String("CAUTION"),
			Description: pulumi.String("Example"),
			DeviceTrustLevels: pulumi.StringArray{
				pulumi.String("UNKNOWN_DEVICETRUSTLEVEL"),
				pulumi.String("LOW_TRUST"),
				pulumi.String("MEDIUM_TRUST"),
				pulumi.String("HIGH_TRUST"),
			},
			EndUserNotificationUrl: pulumi.String("https://caution.acme.com"),
			EnforceTimeValidity:    pulumi.Bool(true),
			Order:                  pulumi.Int(1),
			Protocols: pulumi.StringArray{
				pulumi.String("ANY_RULE"),
			},
			RequestMethods: pulumi.StringArray{
				pulumi.String("CONNECT"),
				pulumi.String("DELETE"),
				pulumi.String("GET"),
				pulumi.String("HEAD"),
				pulumi.String("OPTIONS"),
				pulumi.String("OTHER"),
				pulumi.String("POST"),
				pulumi.String("PUT"),
				pulumi.String("TRACE"),
			},
			SizeQuota: pulumi.Int(10),
			State:     pulumi.String("ENABLED"),
			TimeQuota: pulumi.Int(15),
			UrlCategories: pulumi.StringArray{
				pulumi.String("ANY"),
			},
			UserAgentTypes: pulumi.StringArray{
				pulumi.String("OPERA"),
				pulumi.String("FIREFOX"),
				pulumi.String("MSIE"),
				pulumi.String("MSEDGE"),
				pulumi.String("CHROME"),
				pulumi.String("SAFARI"),
				pulumi.String("MSCHREDGE"),
			},
			ValidityEndTime:    pulumi.String("Tue, 17 Jun 2025 23:00:00 UTC"),
			ValidityStartTime:  pulumi.String("Mon, 17 Jun 2024 23:30:00 UTC"),
			ValidityTimeZoneId: pulumi.String("US/Pacific"),
		})
		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 @this = new Zia.URLFilteringRules("this", new()
    {
        Action = "CAUTION",
        Description = "Example",
        DeviceTrustLevels = new[]
        {
            "UNKNOWN_DEVICETRUSTLEVEL",
            "LOW_TRUST",
            "MEDIUM_TRUST",
            "HIGH_TRUST",
        },
        EndUserNotificationUrl = "https://caution.acme.com",
        EnforceTimeValidity = true,
        Order = 1,
        Protocols = new[]
        {
            "ANY_RULE",
        },
        RequestMethods = new[]
        {
            "CONNECT",
            "DELETE",
            "GET",
            "HEAD",
            "OPTIONS",
            "OTHER",
            "POST",
            "PUT",
            "TRACE",
        },
        SizeQuota = 10,
        State = "ENABLED",
        TimeQuota = 15,
        UrlCategories = new[]
        {
            "ANY",
        },
        UserAgentTypes = new[]
        {
            "OPERA",
            "FIREFOX",
            "MSIE",
            "MSEDGE",
            "CHROME",
            "SAFARI",
            "MSCHREDGE",
        },
        ValidityEndTime = "Tue, 17 Jun 2025 23:00:00 UTC",
        ValidityStartTime = "Mon, 17 Jun 2024 23:30:00 UTC",
        ValidityTimeZoneId = "US/Pacific",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.URLFilteringRules;
import com.pulumi.zia.URLFilteringRulesArgs;
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 this_ = new URLFilteringRules("this", URLFilteringRulesArgs.builder()
            .action("CAUTION")
            .description("Example")
            .deviceTrustLevels(            
                "UNKNOWN_DEVICETRUSTLEVEL",
                "LOW_TRUST",
                "MEDIUM_TRUST",
                "HIGH_TRUST")
            .endUserNotificationUrl("https://caution.acme.com")
            .enforceTimeValidity(true)
            .order(1)
            .protocols("ANY_RULE")
            .requestMethods(            
                "CONNECT",
                "DELETE",
                "GET",
                "HEAD",
                "OPTIONS",
                "OTHER",
                "POST",
                "PUT",
                "TRACE")
            .sizeQuota(10)
            .state("ENABLED")
            .timeQuota(15)
            .urlCategories("ANY")
            .userAgentTypes(            
                "OPERA",
                "FIREFOX",
                "MSIE",
                "MSEDGE",
                "CHROME",
                "SAFARI",
                "MSCHREDGE")
            .validityEndTime("Tue, 17 Jun 2025 23:00:00 UTC")
            .validityStartTime("Mon, 17 Jun 2024 23:30:00 UTC")
            .validityTimeZoneId("US/Pacific")
            .build());

    }
}
Copy
resources:
  this:
    type: zia:URLFilteringRules
    properties:
      action: CAUTION
      description: Example
      deviceTrustLevels:
        - UNKNOWN_DEVICETRUSTLEVEL
        - LOW_TRUST
        - MEDIUM_TRUST
        - HIGH_TRUST
      endUserNotificationUrl: https://caution.acme.com
      enforceTimeValidity: true
      order: 1
      protocols:
        - ANY_RULE
      requestMethods:
        - CONNECT
        - DELETE
        - GET
        - HEAD
        - OPTIONS
        - OTHER
        - POST
        - PUT
        - TRACE
      sizeQuota: 10
      state: ENABLED
      timeQuota: 15
      urlCategories:
        - ANY
      userAgentTypes:
        - OPERA
        - FIREFOX
        - MSIE
        - MSEDGE
        - CHROME
        - SAFARI
        - MSCHREDGE
      validityEndTime: Tue, 17 Jun 2025 23:00:00 UTC
      validityStartTime: Mon, 17 Jun 2024 23:30:00 UTC
      validityTimeZoneId: US/Pacific
Copy

ISOLATE ACTION

⚠️ WARNING 1:: Creating a URL Filtering rule with the action of ISOLATE requires the Cloud Browser Isolation subscription. To learn more, contact Zscaler Support or your local account team.

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

const thisCbiProfile = zia.getCbiProfile({
    name: "BD_SA_Profile1_ZIA",
});
const thisURLFilteringRules = new zia.URLFilteringRules("thisURLFilteringRules", {
    description: "Example",
    state: "ENABLED",
    action: "ISOLATE",
    order: 1,
    enforceTimeValidity: true,
    validityStartTime: "Mon, 17 Jun 2024 23:30:00 UTC",
    validityEndTime: "Tue, 17 Jun 2025 23:00:00 UTC",
    validityTimeZoneId: "US/Pacific",
    timeQuota: 15,
    sizeQuota: 10,
    urlCategories: ["ANY"],
    deviceTrustLevels: [
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    protocols: [
        "HTTPS_RULE",
        "HTTP_RULE",
    ],
    requestMethods: [
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    cbiProfiles: [{
        id: thisCbiProfile.then(thisCbiProfile => thisCbiProfile.id),
        name: thisCbiProfile.then(thisCbiProfile => thisCbiProfile.name),
        url: thisCbiProfile.then(thisCbiProfile => thisCbiProfile.url),
    }],
    userAgentTypes: [
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ],
});
Copy
import pulumi
import pulumi_zia as zia
import zscaler_pulumi_zia as zia

this_cbi_profile = zia.get_cbi_profile(name="BD_SA_Profile1_ZIA")
this_url_filtering_rules = zia.URLFilteringRules("thisURLFilteringRules",
    description="Example",
    state="ENABLED",
    action="ISOLATE",
    order=1,
    enforce_time_validity=True,
    validity_start_time="Mon, 17 Jun 2024 23:30:00 UTC",
    validity_end_time="Tue, 17 Jun 2025 23:00:00 UTC",
    validity_time_zone_id="US/Pacific",
    time_quota=15,
    size_quota=10,
    url_categories=["ANY"],
    device_trust_levels=[
        "UNKNOWN_DEVICETRUSTLEVEL",
        "LOW_TRUST",
        "MEDIUM_TRUST",
        "HIGH_TRUST",
    ],
    protocols=[
        "HTTPS_RULE",
        "HTTP_RULE",
    ],
    request_methods=[
        "CONNECT",
        "DELETE",
        "GET",
        "HEAD",
        "OPTIONS",
        "OTHER",
        "POST",
        "PUT",
        "TRACE",
    ],
    cbi_profiles=[zia.URLFilteringRulesCbiProfileArgs(
        id=this_cbi_profile.id,
        name=this_cbi_profile.name,
        url=this_cbi_profile.url,
    )],
    user_agent_types=[
        "OPERA",
        "FIREFOX",
        "MSIE",
        "MSEDGE",
        "CHROME",
        "SAFARI",
        "MSCHREDGE",
    ])
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 {
		thisCbiProfile, err := zia.GetCbiProfile(ctx, &zia.GetCbiProfileArgs{
			Name: pulumi.StringRef("BD_SA_Profile1_ZIA"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = zia.NewURLFilteringRules(ctx, "thisURLFilteringRules", &zia.URLFilteringRulesArgs{
			Description:         pulumi.String("Example"),
			State:               pulumi.String("ENABLED"),
			Action:              pulumi.String("ISOLATE"),
			Order:               pulumi.Int(1),
			EnforceTimeValidity: pulumi.Bool(true),
			ValidityStartTime:   pulumi.String("Mon, 17 Jun 2024 23:30:00 UTC"),
			ValidityEndTime:     pulumi.String("Tue, 17 Jun 2025 23:00:00 UTC"),
			ValidityTimeZoneId:  pulumi.String("US/Pacific"),
			TimeQuota:           pulumi.Int(15),
			SizeQuota:           pulumi.Int(10),
			UrlCategories: pulumi.StringArray{
				pulumi.String("ANY"),
			},
			DeviceTrustLevels: pulumi.StringArray{
				pulumi.String("UNKNOWN_DEVICETRUSTLEVEL"),
				pulumi.String("LOW_TRUST"),
				pulumi.String("MEDIUM_TRUST"),
				pulumi.String("HIGH_TRUST"),
			},
			Protocols: pulumi.StringArray{
				pulumi.String("HTTPS_RULE"),
				pulumi.String("HTTP_RULE"),
			},
			RequestMethods: pulumi.StringArray{
				pulumi.String("CONNECT"),
				pulumi.String("DELETE"),
				pulumi.String("GET"),
				pulumi.String("HEAD"),
				pulumi.String("OPTIONS"),
				pulumi.String("OTHER"),
				pulumi.String("POST"),
				pulumi.String("PUT"),
				pulumi.String("TRACE"),
			},
			CbiProfiles: zia.URLFilteringRulesCbiProfileArray{
				&zia.URLFilteringRulesCbiProfileArgs{
					Id:   pulumi.String(thisCbiProfile.Id),
					Name: pulumi.String(thisCbiProfile.Name),
					Url:  pulumi.String(thisCbiProfile.Url),
				},
			},
			UserAgentTypes: pulumi.StringArray{
				pulumi.String("OPERA"),
				pulumi.String("FIREFOX"),
				pulumi.String("MSIE"),
				pulumi.String("MSEDGE"),
				pulumi.String("CHROME"),
				pulumi.String("SAFARI"),
				pulumi.String("MSCHREDGE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = Pulumi.Zia;
using Zia = zscaler.PulumiPackage.Zia;

return await Deployment.RunAsync(() => 
{
    var thisCbiProfile = Zia.GetCbiProfile.Invoke(new()
    {
        Name = "BD_SA_Profile1_ZIA",
    });

    var thisURLFilteringRules = new Zia.URLFilteringRules("thisURLFilteringRules", new()
    {
        Description = "Example",
        State = "ENABLED",
        Action = "ISOLATE",
        Order = 1,
        EnforceTimeValidity = true,
        ValidityStartTime = "Mon, 17 Jun 2024 23:30:00 UTC",
        ValidityEndTime = "Tue, 17 Jun 2025 23:00:00 UTC",
        ValidityTimeZoneId = "US/Pacific",
        TimeQuota = 15,
        SizeQuota = 10,
        UrlCategories = new[]
        {
            "ANY",
        },
        DeviceTrustLevels = new[]
        {
            "UNKNOWN_DEVICETRUSTLEVEL",
            "LOW_TRUST",
            "MEDIUM_TRUST",
            "HIGH_TRUST",
        },
        Protocols = new[]
        {
            "HTTPS_RULE",
            "HTTP_RULE",
        },
        RequestMethods = new[]
        {
            "CONNECT",
            "DELETE",
            "GET",
            "HEAD",
            "OPTIONS",
            "OTHER",
            "POST",
            "PUT",
            "TRACE",
        },
        CbiProfiles = new[]
        {
            new Zia.Inputs.URLFilteringRulesCbiProfileArgs
            {
                Id = thisCbiProfile.Apply(getCbiProfileResult => getCbiProfileResult.Id),
                Name = thisCbiProfile.Apply(getCbiProfileResult => getCbiProfileResult.Name),
                Url = thisCbiProfile.Apply(getCbiProfileResult => getCbiProfileResult.Url),
            },
        },
        UserAgentTypes = new[]
        {
            "OPERA",
            "FIREFOX",
            "MSIE",
            "MSEDGE",
            "CHROME",
            "SAFARI",
            "MSCHREDGE",
        },
    });

});
Copy
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.GetCbiProfileArgs;
import com.pulumi.zia.URLFilteringRules;
import com.pulumi.zia.URLFilteringRulesArgs;
import com.pulumi.zia.inputs.URLFilteringRulesCbiProfileArgs;
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 thisCbiProfile = ZiaFunctions.getCbiProfile(GetCbiProfileArgs.builder()
            .name("BD_SA_Profile1_ZIA")
            .build());

        var thisURLFilteringRules = new URLFilteringRules("thisURLFilteringRules", URLFilteringRulesArgs.builder()
            .description("Example")
            .state("ENABLED")
            .action("ISOLATE")
            .order(1)
            .enforceTimeValidity(true)
            .validityStartTime("Mon, 17 Jun 2024 23:30:00 UTC")
            .validityEndTime("Tue, 17 Jun 2025 23:00:00 UTC")
            .validityTimeZoneId("US/Pacific")
            .timeQuota(15)
            .sizeQuota(10)
            .urlCategories("ANY")
            .deviceTrustLevels(            
                "UNKNOWN_DEVICETRUSTLEVEL",
                "LOW_TRUST",
                "MEDIUM_TRUST",
                "HIGH_TRUST")
            .protocols(            
                "HTTPS_RULE",
                "HTTP_RULE")
            .requestMethods(            
                "CONNECT",
                "DELETE",
                "GET",
                "HEAD",
                "OPTIONS",
                "OTHER",
                "POST",
                "PUT",
                "TRACE")
            .cbiProfiles(URLFilteringRulesCbiProfileArgs.builder()
                .id(thisCbiProfile.applyValue(getCbiProfileResult -> getCbiProfileResult.id()))
                .name(thisCbiProfile.applyValue(getCbiProfileResult -> getCbiProfileResult.name()))
                .url(thisCbiProfile.applyValue(getCbiProfileResult -> getCbiProfileResult.url()))
                .build())
            .userAgentTypes(            
                "OPERA",
                "FIREFOX",
                "MSIE",
                "MSEDGE",
                "CHROME",
                "SAFARI",
                "MSCHREDGE")
            .build());

    }
}
Copy
resources:
  thisURLFilteringRules:
    type: zia:URLFilteringRules
    properties:
      description: Example
      state: ENABLED
      action: ISOLATE
      order: 1
      enforceTimeValidity: true
      validityStartTime: Mon, 17 Jun 2024 23:30:00 UTC
      validityEndTime: Tue, 17 Jun 2025 23:00:00 UTC
      validityTimeZoneId: US/Pacific
      timeQuota: 15
      sizeQuota: 10
      urlCategories:
        - ANY
      deviceTrustLevels:
        - UNKNOWN_DEVICETRUSTLEVEL
        - LOW_TRUST
        - MEDIUM_TRUST
        - HIGH_TRUST
      protocols:
        - HTTPS_RULE
        - HTTP_RULE
      requestMethods:
        - CONNECT
        - DELETE
        - GET
        - HEAD
        - OPTIONS
        - OTHER
        - POST
        - PUT
        - TRACE
      cbiProfiles:
        - id: ${thisCbiProfile.id}
          name: ${thisCbiProfile.name}
          url: ${thisCbiProfile.url}
      userAgentTypes:
        - OPERA
        - FIREFOX
        - MSIE
        - MSEDGE
        - CHROME
        - SAFARI
        - MSCHREDGE
variables:
  thisCbiProfile:
    fn::invoke:
      Function: zia:getCbiProfile
      Arguments:
        name: BD_SA_Profile1_ZIA
Copy

Create URLFilteringRules Resource

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

Constructor syntax

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

@overload
def URLFilteringRules(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      protocols: Optional[Sequence[str]] = None,
                      order: Optional[int] = None,
                      devices: Optional[URLFilteringRulesDevicesArgs] = None,
                      ciparule: Optional[bool] = None,
                      departments: Optional[URLFilteringRulesDepartmentsArgs] = None,
                      override_groups: Optional[URLFilteringRulesOverrideGroupsArgs] = None,
                      device_groups: Optional[URLFilteringRulesDeviceGroupsArgs] = None,
                      device_trust_levels: Optional[Sequence[str]] = None,
                      override_users: Optional[URLFilteringRulesOverrideUsersArgs] = None,
                      end_user_notification_url: Optional[str] = None,
                      block_override: Optional[bool] = None,
                      groups: Optional[URLFilteringRulesGroupsArgs] = None,
                      labels: Optional[URLFilteringRulesLabelsArgs] = None,
                      location_groups: Optional[URLFilteringRulesLocationGroupsArgs] = None,
                      locations: Optional[URLFilteringRulesLocationsArgs] = None,
                      name: Optional[str] = None,
                      action: Optional[str] = None,
                      description: Optional[str] = None,
                      cbi_profiles: Optional[Sequence[URLFilteringRulesCbiProfileArgs]] = None,
                      enforce_time_validity: Optional[bool] = None,
                      rank: Optional[int] = None,
                      request_methods: Optional[Sequence[str]] = None,
                      size_quota: Optional[int] = None,
                      source_ip_groups: Optional[URLFilteringRulesSourceIpGroupsArgs] = None,
                      state: Optional[str] = None,
                      time_quota: Optional[int] = None,
                      time_windows: Optional[URLFilteringRulesTimeWindowsArgs] = None,
                      url_categories: Optional[Sequence[str]] = None,
                      user_agent_types: Optional[Sequence[str]] = None,
                      user_risk_score_levels: Optional[Sequence[str]] = None,
                      users: Optional[URLFilteringRulesUsersArgs] = None,
                      validity_end_time: Optional[str] = None,
                      validity_start_time: Optional[str] = None,
                      validity_time_zone_id: Optional[str] = None,
                      workload_groups: Optional[Sequence[URLFilteringRulesWorkloadGroupArgs]] = None)
func NewURLFilteringRules(ctx *Context, name string, args URLFilteringRulesArgs, opts ...ResourceOption) (*URLFilteringRules, error)
public URLFilteringRules(string name, URLFilteringRulesArgs args, CustomResourceOptions? opts = null)
public URLFilteringRules(String name, URLFilteringRulesArgs args)
public URLFilteringRules(String name, URLFilteringRulesArgs args, CustomResourceOptions options)

type: zia:URLFilteringRules
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 This property is required. URLFilteringRulesArgs
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 This property is required. URLFilteringRulesArgs
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 This property is required. URLFilteringRulesArgs
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 This property is required. URLFilteringRulesArgs
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. URLFilteringRulesArgs
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 urlfilteringRulesResource = new Zia.URLFilteringRules("urlfilteringRulesResource", new()
{
    Protocols = new[]
    {
        "string",
    },
    Order = 0,
    Devices = new Zia.Inputs.URLFilteringRulesDevicesArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Ciparule = false,
    Departments = new Zia.Inputs.URLFilteringRulesDepartmentsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    OverrideGroups = new Zia.Inputs.URLFilteringRulesOverrideGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    DeviceGroups = new Zia.Inputs.URLFilteringRulesDeviceGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    DeviceTrustLevels = new[]
    {
        "string",
    },
    OverrideUsers = new Zia.Inputs.URLFilteringRulesOverrideUsersArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    EndUserNotificationUrl = "string",
    BlockOverride = false,
    Groups = new Zia.Inputs.URLFilteringRulesGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Labels = new Zia.Inputs.URLFilteringRulesLabelsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    LocationGroups = new Zia.Inputs.URLFilteringRulesLocationGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Locations = new Zia.Inputs.URLFilteringRulesLocationsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Name = "string",
    Action = "string",
    Description = "string",
    CbiProfiles = new[]
    {
        new Zia.Inputs.URLFilteringRulesCbiProfileArgs
        {
            Id = "string",
            Name = "string",
            Url = "string",
        },
    },
    EnforceTimeValidity = false,
    Rank = 0,
    RequestMethods = new[]
    {
        "string",
    },
    SizeQuota = 0,
    SourceIpGroups = new Zia.Inputs.URLFilteringRulesSourceIpGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    State = "string",
    TimeQuota = 0,
    TimeWindows = new Zia.Inputs.URLFilteringRulesTimeWindowsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    UrlCategories = new[]
    {
        "string",
    },
    UserAgentTypes = new[]
    {
        "string",
    },
    UserRiskScoreLevels = new[]
    {
        "string",
    },
    Users = new Zia.Inputs.URLFilteringRulesUsersArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    ValidityEndTime = "string",
    ValidityStartTime = "string",
    ValidityTimeZoneId = "string",
    WorkloadGroups = new[]
    {
        new Zia.Inputs.URLFilteringRulesWorkloadGroupArgs
        {
            Id = 0,
            Name = "string",
        },
    },
});
Copy
example, err := zia.NewURLFilteringRules(ctx, "urlfilteringRulesResource", &zia.URLFilteringRulesArgs{
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	Order: pulumi.Int(0),
	Devices: &zia.URLFilteringRulesDevicesArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Ciparule: pulumi.Bool(false),
	Departments: &zia.URLFilteringRulesDepartmentsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	OverrideGroups: &zia.URLFilteringRulesOverrideGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	DeviceGroups: &zia.URLFilteringRulesDeviceGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	DeviceTrustLevels: pulumi.StringArray{
		pulumi.String("string"),
	},
	OverrideUsers: &zia.URLFilteringRulesOverrideUsersArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	EndUserNotificationUrl: pulumi.String("string"),
	BlockOverride:          pulumi.Bool(false),
	Groups: &zia.URLFilteringRulesGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Labels: &zia.URLFilteringRulesLabelsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	LocationGroups: &zia.URLFilteringRulesLocationGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Locations: &zia.URLFilteringRulesLocationsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Name:        pulumi.String("string"),
	Action:      pulumi.String("string"),
	Description: pulumi.String("string"),
	CbiProfiles: zia.URLFilteringRulesCbiProfileArray{
		&zia.URLFilteringRulesCbiProfileArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
			Url:  pulumi.String("string"),
		},
	},
	EnforceTimeValidity: pulumi.Bool(false),
	Rank:                pulumi.Int(0),
	RequestMethods: pulumi.StringArray{
		pulumi.String("string"),
	},
	SizeQuota: pulumi.Int(0),
	SourceIpGroups: &zia.URLFilteringRulesSourceIpGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	State:     pulumi.String("string"),
	TimeQuota: pulumi.Int(0),
	TimeWindows: &zia.URLFilteringRulesTimeWindowsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	UrlCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserAgentTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserRiskScoreLevels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Users: &zia.URLFilteringRulesUsersArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	ValidityEndTime:    pulumi.String("string"),
	ValidityStartTime:  pulumi.String("string"),
	ValidityTimeZoneId: pulumi.String("string"),
	WorkloadGroups: zia.URLFilteringRulesWorkloadGroupArray{
		&zia.URLFilteringRulesWorkloadGroupArgs{
			Id:   pulumi.Int(0),
			Name: pulumi.String("string"),
		},
	},
})
Copy
var urlfilteringRulesResource = new URLFilteringRules("urlfilteringRulesResource", URLFilteringRulesArgs.builder()
    .protocols("string")
    .order(0)
    .devices(URLFilteringRulesDevicesArgs.builder()
        .ids(0)
        .build())
    .ciparule(false)
    .departments(URLFilteringRulesDepartmentsArgs.builder()
        .ids(0)
        .build())
    .overrideGroups(URLFilteringRulesOverrideGroupsArgs.builder()
        .ids(0)
        .build())
    .deviceGroups(URLFilteringRulesDeviceGroupsArgs.builder()
        .ids(0)
        .build())
    .deviceTrustLevels("string")
    .overrideUsers(URLFilteringRulesOverrideUsersArgs.builder()
        .ids(0)
        .build())
    .endUserNotificationUrl("string")
    .blockOverride(false)
    .groups(URLFilteringRulesGroupsArgs.builder()
        .ids(0)
        .build())
    .labels(URLFilteringRulesLabelsArgs.builder()
        .ids(0)
        .build())
    .locationGroups(URLFilteringRulesLocationGroupsArgs.builder()
        .ids(0)
        .build())
    .locations(URLFilteringRulesLocationsArgs.builder()
        .ids(0)
        .build())
    .name("string")
    .action("string")
    .description("string")
    .cbiProfiles(URLFilteringRulesCbiProfileArgs.builder()
        .id("string")
        .name("string")
        .url("string")
        .build())
    .enforceTimeValidity(false)
    .rank(0)
    .requestMethods("string")
    .sizeQuota(0)
    .sourceIpGroups(URLFilteringRulesSourceIpGroupsArgs.builder()
        .ids(0)
        .build())
    .state("string")
    .timeQuota(0)
    .timeWindows(URLFilteringRulesTimeWindowsArgs.builder()
        .ids(0)
        .build())
    .urlCategories("string")
    .userAgentTypes("string")
    .userRiskScoreLevels("string")
    .users(URLFilteringRulesUsersArgs.builder()
        .ids(0)
        .build())
    .validityEndTime("string")
    .validityStartTime("string")
    .validityTimeZoneId("string")
    .workloadGroups(URLFilteringRulesWorkloadGroupArgs.builder()
        .id(0)
        .name("string")
        .build())
    .build());
Copy
urlfiltering_rules_resource = zia.URLFilteringRules("urlfilteringRulesResource",
    protocols=["string"],
    order=0,
    devices={
        "ids": [0],
    },
    ciparule=False,
    departments={
        "ids": [0],
    },
    override_groups={
        "ids": [0],
    },
    device_groups={
        "ids": [0],
    },
    device_trust_levels=["string"],
    override_users={
        "ids": [0],
    },
    end_user_notification_url="string",
    block_override=False,
    groups={
        "ids": [0],
    },
    labels={
        "ids": [0],
    },
    location_groups={
        "ids": [0],
    },
    locations={
        "ids": [0],
    },
    name="string",
    action="string",
    description="string",
    cbi_profiles=[{
        "id": "string",
        "name": "string",
        "url": "string",
    }],
    enforce_time_validity=False,
    rank=0,
    request_methods=["string"],
    size_quota=0,
    source_ip_groups={
        "ids": [0],
    },
    state="string",
    time_quota=0,
    time_windows={
        "ids": [0],
    },
    url_categories=["string"],
    user_agent_types=["string"],
    user_risk_score_levels=["string"],
    users={
        "ids": [0],
    },
    validity_end_time="string",
    validity_start_time="string",
    validity_time_zone_id="string",
    workload_groups=[{
        "id": 0,
        "name": "string",
    }])
Copy
const urlfilteringRulesResource = new zia.URLFilteringRules("urlfilteringRulesResource", {
    protocols: ["string"],
    order: 0,
    devices: {
        ids: [0],
    },
    ciparule: false,
    departments: {
        ids: [0],
    },
    overrideGroups: {
        ids: [0],
    },
    deviceGroups: {
        ids: [0],
    },
    deviceTrustLevels: ["string"],
    overrideUsers: {
        ids: [0],
    },
    endUserNotificationUrl: "string",
    blockOverride: false,
    groups: {
        ids: [0],
    },
    labels: {
        ids: [0],
    },
    locationGroups: {
        ids: [0],
    },
    locations: {
        ids: [0],
    },
    name: "string",
    action: "string",
    description: "string",
    cbiProfiles: [{
        id: "string",
        name: "string",
        url: "string",
    }],
    enforceTimeValidity: false,
    rank: 0,
    requestMethods: ["string"],
    sizeQuota: 0,
    sourceIpGroups: {
        ids: [0],
    },
    state: "string",
    timeQuota: 0,
    timeWindows: {
        ids: [0],
    },
    urlCategories: ["string"],
    userAgentTypes: ["string"],
    userRiskScoreLevels: ["string"],
    users: {
        ids: [0],
    },
    validityEndTime: "string",
    validityStartTime: "string",
    validityTimeZoneId: "string",
    workloadGroups: [{
        id: 0,
        name: "string",
    }],
});
Copy
type: zia:URLFilteringRules
properties:
    action: string
    blockOverride: false
    cbiProfiles:
        - id: string
          name: string
          url: string
    ciparule: false
    departments:
        ids:
            - 0
    description: string
    deviceGroups:
        ids:
            - 0
    deviceTrustLevels:
        - string
    devices:
        ids:
            - 0
    endUserNotificationUrl: string
    enforceTimeValidity: false
    groups:
        ids:
            - 0
    labels:
        ids:
            - 0
    locationGroups:
        ids:
            - 0
    locations:
        ids:
            - 0
    name: string
    order: 0
    overrideGroups:
        ids:
            - 0
    overrideUsers:
        ids:
            - 0
    protocols:
        - string
    rank: 0
    requestMethods:
        - string
    sizeQuota: 0
    sourceIpGroups:
        ids:
            - 0
    state: string
    timeQuota: 0
    timeWindows:
        ids:
            - 0
    urlCategories:
        - string
    userAgentTypes:
        - string
    userRiskScoreLevels:
        - string
    users:
        ids:
            - 0
    validityEndTime: string
    validityStartTime: string
    validityTimeZoneId: string
    workloadGroups:
        - id: 0
          name: string
Copy

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

Protocols This property is required. List<string>
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
Action string
Action taken when traffic matches rule criteria
BlockOverride bool
CbiProfiles List<zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesCbiProfile>
Ciparule bool
If set to true, the CIPA Compliance rule is enabled
Departments zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesDepartments
Name-ID pairs of departments for which rule must be applied
Description string
Additional information about the URL Filtering rule
DeviceGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesDeviceGroups
This field is applicable for devices that are managed using Zscaler Client Connector.
DeviceTrustLevels List<string>
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
Devices zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesDevices
Name-ID pairs of devices for which rule must be applied.
EndUserNotificationUrl string
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
EnforceTimeValidity bool
Enforce a set a validity time period for the URL Filtering rule.
Groups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesGroups
Name-ID pairs of groups for which rule must be applied
Labels zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesLabels
The URL Filtering rule's label.
LocationGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesLocationGroups
Name-ID pairs of the location groups to which the rule must be applied.
Locations zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesLocations
Name-ID pairs of locations for which rule must be applied
Name string
Name of the Firewall Filtering policy rule
Order int
Order of execution of rule with respect to other URL Filtering rules
OverrideGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesOverrideGroups
Name-ID pairs of groups for which this rule can be overridden.
OverrideUsers zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesOverrideUsers
Name-ID pairs of users for which this rule can be overridden.
Rank int
Admin rank of the Firewall Filtering policy rule
RequestMethods List<string>
Request method for which the rule must be applied. If not set, rule will be applied to all methods
SizeQuota int
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
SourceIpGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesSourceIpGroups
list of source ip groups
State string
TimeQuota int
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
TimeWindows zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesTimeWindows
Name-ID pairs of time interval during which rule must be enforced.
UrlCategories List<string>
List of URL categories for which rule must be applied
UserAgentTypes List<string>
Supported User Agent Types
UserRiskScoreLevels List<string>
Users zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesUsers
Name-ID pairs of users for which rule must be applied
ValidityEndTime string
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
ValidityStartTime string
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
ValidityTimeZoneId string
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
WorkloadGroups List<zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesWorkloadGroup>
The list of preconfigured workload groups to which the policy must be applied
Protocols This property is required. []string
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
Action string
Action taken when traffic matches rule criteria
BlockOverride bool
CbiProfiles []URLFilteringRulesCbiProfileArgs
Ciparule bool
If set to true, the CIPA Compliance rule is enabled
Departments URLFilteringRulesDepartmentsArgs
Name-ID pairs of departments for which rule must be applied
Description string
Additional information about the URL Filtering rule
DeviceGroups URLFilteringRulesDeviceGroupsArgs
This field is applicable for devices that are managed using Zscaler Client Connector.
DeviceTrustLevels []string
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
Devices URLFilteringRulesDevicesArgs
Name-ID pairs of devices for which rule must be applied.
EndUserNotificationUrl string
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
EnforceTimeValidity bool
Enforce a set a validity time period for the URL Filtering rule.
Groups URLFilteringRulesGroupsArgs
Name-ID pairs of groups for which rule must be applied
Labels URLFilteringRulesLabelsArgs
The URL Filtering rule's label.
LocationGroups URLFilteringRulesLocationGroupsArgs
Name-ID pairs of the location groups to which the rule must be applied.
Locations URLFilteringRulesLocationsArgs
Name-ID pairs of locations for which rule must be applied
Name string
Name of the Firewall Filtering policy rule
Order int
Order of execution of rule with respect to other URL Filtering rules
OverrideGroups URLFilteringRulesOverrideGroupsArgs
Name-ID pairs of groups for which this rule can be overridden.
OverrideUsers URLFilteringRulesOverrideUsersArgs
Name-ID pairs of users for which this rule can be overridden.
Rank int
Admin rank of the Firewall Filtering policy rule
RequestMethods []string
Request method for which the rule must be applied. If not set, rule will be applied to all methods
SizeQuota int
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
SourceIpGroups URLFilteringRulesSourceIpGroupsArgs
list of source ip groups
State string
TimeQuota int
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
TimeWindows URLFilteringRulesTimeWindowsArgs
Name-ID pairs of time interval during which rule must be enforced.
UrlCategories []string
List of URL categories for which rule must be applied
UserAgentTypes []string
Supported User Agent Types
UserRiskScoreLevels []string
Users URLFilteringRulesUsersArgs
Name-ID pairs of users for which rule must be applied
ValidityEndTime string
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
ValidityStartTime string
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
ValidityTimeZoneId string
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
WorkloadGroups []URLFilteringRulesWorkloadGroupArgs
The list of preconfigured workload groups to which the policy must be applied
protocols This property is required. List<String>
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
action String
Action taken when traffic matches rule criteria
blockOverride Boolean
cbiProfiles List<URLFilteringRulesCbiProfile>
ciparule Boolean
If set to true, the CIPA Compliance rule is enabled
departments URLFilteringRulesDepartments
Name-ID pairs of departments for which rule must be applied
description String
Additional information about the URL Filtering rule
deviceGroups URLFilteringRulesDeviceGroups
This field is applicable for devices that are managed using Zscaler Client Connector.
deviceTrustLevels List<String>
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices URLFilteringRulesDevices
Name-ID pairs of devices for which rule must be applied.
endUserNotificationUrl String
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforceTimeValidity Boolean
Enforce a set a validity time period for the URL Filtering rule.
groups URLFilteringRulesGroups
Name-ID pairs of groups for which rule must be applied
labels URLFilteringRulesLabels
The URL Filtering rule's label.
locationGroups URLFilteringRulesLocationGroups
Name-ID pairs of the location groups to which the rule must be applied.
locations URLFilteringRulesLocations
Name-ID pairs of locations for which rule must be applied
name String
Name of the Firewall Filtering policy rule
order Integer
Order of execution of rule with respect to other URL Filtering rules
overrideGroups URLFilteringRulesOverrideGroups
Name-ID pairs of groups for which this rule can be overridden.
overrideUsers URLFilteringRulesOverrideUsers
Name-ID pairs of users for which this rule can be overridden.
rank Integer
Admin rank of the Firewall Filtering policy rule
requestMethods List<String>
Request method for which the rule must be applied. If not set, rule will be applied to all methods
sizeQuota Integer
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
sourceIpGroups URLFilteringRulesSourceIpGroups
list of source ip groups
state String
timeQuota Integer
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
timeWindows URLFilteringRulesTimeWindows
Name-ID pairs of time interval during which rule must be enforced.
urlCategories List<String>
List of URL categories for which rule must be applied
userAgentTypes List<String>
Supported User Agent Types
userRiskScoreLevels List<String>
users URLFilteringRulesUsers
Name-ID pairs of users for which rule must be applied
validityEndTime String
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validityStartTime String
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validityTimeZoneId String
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workloadGroups List<URLFilteringRulesWorkloadGroup>
The list of preconfigured workload groups to which the policy must be applied
protocols This property is required. string[]
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
action string
Action taken when traffic matches rule criteria
blockOverride boolean
cbiProfiles URLFilteringRulesCbiProfile[]
ciparule boolean
If set to true, the CIPA Compliance rule is enabled
departments URLFilteringRulesDepartments
Name-ID pairs of departments for which rule must be applied
description string
Additional information about the URL Filtering rule
deviceGroups URLFilteringRulesDeviceGroups
This field is applicable for devices that are managed using Zscaler Client Connector.
deviceTrustLevels string[]
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices URLFilteringRulesDevices
Name-ID pairs of devices for which rule must be applied.
endUserNotificationUrl string
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforceTimeValidity boolean
Enforce a set a validity time period for the URL Filtering rule.
groups URLFilteringRulesGroups
Name-ID pairs of groups for which rule must be applied
labels URLFilteringRulesLabels
The URL Filtering rule's label.
locationGroups URLFilteringRulesLocationGroups
Name-ID pairs of the location groups to which the rule must be applied.
locations URLFilteringRulesLocations
Name-ID pairs of locations for which rule must be applied
name string
Name of the Firewall Filtering policy rule
order number
Order of execution of rule with respect to other URL Filtering rules
overrideGroups URLFilteringRulesOverrideGroups
Name-ID pairs of groups for which this rule can be overridden.
overrideUsers URLFilteringRulesOverrideUsers
Name-ID pairs of users for which this rule can be overridden.
rank number
Admin rank of the Firewall Filtering policy rule
requestMethods string[]
Request method for which the rule must be applied. If not set, rule will be applied to all methods
sizeQuota number
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
sourceIpGroups URLFilteringRulesSourceIpGroups
list of source ip groups
state string
timeQuota number
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
timeWindows URLFilteringRulesTimeWindows
Name-ID pairs of time interval during which rule must be enforced.
urlCategories string[]
List of URL categories for which rule must be applied
userAgentTypes string[]
Supported User Agent Types
userRiskScoreLevels string[]
users URLFilteringRulesUsers
Name-ID pairs of users for which rule must be applied
validityEndTime string
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validityStartTime string
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validityTimeZoneId string
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workloadGroups URLFilteringRulesWorkloadGroup[]
The list of preconfigured workload groups to which the policy must be applied
protocols This property is required. Sequence[str]
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
action str
Action taken when traffic matches rule criteria
block_override bool
cbi_profiles Sequence[URLFilteringRulesCbiProfileArgs]
ciparule bool
If set to true, the CIPA Compliance rule is enabled
departments URLFilteringRulesDepartmentsArgs
Name-ID pairs of departments for which rule must be applied
description str
Additional information about the URL Filtering rule
device_groups URLFilteringRulesDeviceGroupsArgs
This field is applicable for devices that are managed using Zscaler Client Connector.
device_trust_levels Sequence[str]
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices URLFilteringRulesDevicesArgs
Name-ID pairs of devices for which rule must be applied.
end_user_notification_url str
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforce_time_validity bool
Enforce a set a validity time period for the URL Filtering rule.
groups URLFilteringRulesGroupsArgs
Name-ID pairs of groups for which rule must be applied
labels URLFilteringRulesLabelsArgs
The URL Filtering rule's label.
location_groups URLFilteringRulesLocationGroupsArgs
Name-ID pairs of the location groups to which the rule must be applied.
locations URLFilteringRulesLocationsArgs
Name-ID pairs of locations for which rule must be applied
name str
Name of the Firewall Filtering policy rule
order int
Order of execution of rule with respect to other URL Filtering rules
override_groups URLFilteringRulesOverrideGroupsArgs
Name-ID pairs of groups for which this rule can be overridden.
override_users URLFilteringRulesOverrideUsersArgs
Name-ID pairs of users for which this rule can be overridden.
rank int
Admin rank of the Firewall Filtering policy rule
request_methods Sequence[str]
Request method for which the rule must be applied. If not set, rule will be applied to all methods
size_quota int
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
source_ip_groups URLFilteringRulesSourceIpGroupsArgs
list of source ip groups
state str
time_quota int
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
time_windows URLFilteringRulesTimeWindowsArgs
Name-ID pairs of time interval during which rule must be enforced.
url_categories Sequence[str]
List of URL categories for which rule must be applied
user_agent_types Sequence[str]
Supported User Agent Types
user_risk_score_levels Sequence[str]
users URLFilteringRulesUsersArgs
Name-ID pairs of users for which rule must be applied
validity_end_time str
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validity_start_time str
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validity_time_zone_id str
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workload_groups Sequence[URLFilteringRulesWorkloadGroupArgs]
The list of preconfigured workload groups to which the policy must be applied
protocols This property is required. List<String>
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
action String
Action taken when traffic matches rule criteria
blockOverride Boolean
cbiProfiles List<Property Map>
ciparule Boolean
If set to true, the CIPA Compliance rule is enabled
departments Property Map
Name-ID pairs of departments for which rule must be applied
description String
Additional information about the URL Filtering rule
deviceGroups Property Map
This field is applicable for devices that are managed using Zscaler Client Connector.
deviceTrustLevels List<String>
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices Property Map
Name-ID pairs of devices for which rule must be applied.
endUserNotificationUrl String
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforceTimeValidity Boolean
Enforce a set a validity time period for the URL Filtering rule.
groups Property Map
Name-ID pairs of groups for which rule must be applied
labels Property Map
The URL Filtering rule's label.
locationGroups Property Map
Name-ID pairs of the location groups to which the rule must be applied.
locations Property Map
Name-ID pairs of locations for which rule must be applied
name String
Name of the Firewall Filtering policy rule
order Number
Order of execution of rule with respect to other URL Filtering rules
overrideGroups Property Map
Name-ID pairs of groups for which this rule can be overridden.
overrideUsers Property Map
Name-ID pairs of users for which this rule can be overridden.
rank Number
Admin rank of the Firewall Filtering policy rule
requestMethods List<String>
Request method for which the rule must be applied. If not set, rule will be applied to all methods
sizeQuota Number
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
sourceIpGroups Property Map
list of source ip groups
state String
timeQuota Number
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
timeWindows Property Map
Name-ID pairs of time interval during which rule must be enforced.
urlCategories List<String>
List of URL categories for which rule must be applied
userAgentTypes List<String>
Supported User Agent Types
userRiskScoreLevels List<String>
users Property Map
Name-ID pairs of users for which rule must be applied
validityEndTime String
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validityStartTime String
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validityTimeZoneId String
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workloadGroups List<Property Map>
The list of preconfigured workload groups to which the policy must be applied

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
RuleId int
URL Filtering Rule ID
Id string
The provider-assigned unique ID for this managed resource.
RuleId int
URL Filtering Rule ID
id String
The provider-assigned unique ID for this managed resource.
ruleId Integer
URL Filtering Rule ID
id string
The provider-assigned unique ID for this managed resource.
ruleId number
URL Filtering Rule ID
id str
The provider-assigned unique ID for this managed resource.
rule_id int
URL Filtering Rule ID
id String
The provider-assigned unique ID for this managed resource.
ruleId Number
URL Filtering Rule ID

Look up Existing URLFilteringRules Resource

Get an existing URLFilteringRules 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?: URLFilteringRulesState, opts?: CustomResourceOptions): URLFilteringRules
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        block_override: Optional[bool] = None,
        cbi_profiles: Optional[Sequence[URLFilteringRulesCbiProfileArgs]] = None,
        ciparule: Optional[bool] = None,
        departments: Optional[URLFilteringRulesDepartmentsArgs] = None,
        description: Optional[str] = None,
        device_groups: Optional[URLFilteringRulesDeviceGroupsArgs] = None,
        device_trust_levels: Optional[Sequence[str]] = None,
        devices: Optional[URLFilteringRulesDevicesArgs] = None,
        end_user_notification_url: Optional[str] = None,
        enforce_time_validity: Optional[bool] = None,
        groups: Optional[URLFilteringRulesGroupsArgs] = None,
        labels: Optional[URLFilteringRulesLabelsArgs] = None,
        location_groups: Optional[URLFilteringRulesLocationGroupsArgs] = None,
        locations: Optional[URLFilteringRulesLocationsArgs] = None,
        name: Optional[str] = None,
        order: Optional[int] = None,
        override_groups: Optional[URLFilteringRulesOverrideGroupsArgs] = None,
        override_users: Optional[URLFilteringRulesOverrideUsersArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        rank: Optional[int] = None,
        request_methods: Optional[Sequence[str]] = None,
        rule_id: Optional[int] = None,
        size_quota: Optional[int] = None,
        source_ip_groups: Optional[URLFilteringRulesSourceIpGroupsArgs] = None,
        state: Optional[str] = None,
        time_quota: Optional[int] = None,
        time_windows: Optional[URLFilteringRulesTimeWindowsArgs] = None,
        url_categories: Optional[Sequence[str]] = None,
        user_agent_types: Optional[Sequence[str]] = None,
        user_risk_score_levels: Optional[Sequence[str]] = None,
        users: Optional[URLFilteringRulesUsersArgs] = None,
        validity_end_time: Optional[str] = None,
        validity_start_time: Optional[str] = None,
        validity_time_zone_id: Optional[str] = None,
        workload_groups: Optional[Sequence[URLFilteringRulesWorkloadGroupArgs]] = None) -> URLFilteringRules
func GetURLFilteringRules(ctx *Context, name string, id IDInput, state *URLFilteringRulesState, opts ...ResourceOption) (*URLFilteringRules, error)
public static URLFilteringRules Get(string name, Input<string> id, URLFilteringRulesState? state, CustomResourceOptions? opts = null)
public static URLFilteringRules get(String name, Output<String> id, URLFilteringRulesState state, CustomResourceOptions options)
resources:  _:    type: zia:URLFilteringRules    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:
Action string
Action taken when traffic matches rule criteria
BlockOverride bool
CbiProfiles List<zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesCbiProfile>
Ciparule bool
If set to true, the CIPA Compliance rule is enabled
Departments zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesDepartments
Name-ID pairs of departments for which rule must be applied
Description string
Additional information about the URL Filtering rule
DeviceGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesDeviceGroups
This field is applicable for devices that are managed using Zscaler Client Connector.
DeviceTrustLevels List<string>
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
Devices zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesDevices
Name-ID pairs of devices for which rule must be applied.
EndUserNotificationUrl string
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
EnforceTimeValidity bool
Enforce a set a validity time period for the URL Filtering rule.
Groups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesGroups
Name-ID pairs of groups for which rule must be applied
Labels zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesLabels
The URL Filtering rule's label.
LocationGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesLocationGroups
Name-ID pairs of the location groups to which the rule must be applied.
Locations zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesLocations
Name-ID pairs of locations for which rule must be applied
Name string
Name of the Firewall Filtering policy rule
Order int
Order of execution of rule with respect to other URL Filtering rules
OverrideGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesOverrideGroups
Name-ID pairs of groups for which this rule can be overridden.
OverrideUsers zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesOverrideUsers
Name-ID pairs of users for which this rule can be overridden.
Protocols List<string>
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
Rank int
Admin rank of the Firewall Filtering policy rule
RequestMethods List<string>
Request method for which the rule must be applied. If not set, rule will be applied to all methods
RuleId int
URL Filtering Rule ID
SizeQuota int
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
SourceIpGroups zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesSourceIpGroups
list of source ip groups
State string
TimeQuota int
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
TimeWindows zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesTimeWindows
Name-ID pairs of time interval during which rule must be enforced.
UrlCategories List<string>
List of URL categories for which rule must be applied
UserAgentTypes List<string>
Supported User Agent Types
UserRiskScoreLevels List<string>
Users zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesUsers
Name-ID pairs of users for which rule must be applied
ValidityEndTime string
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
ValidityStartTime string
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
ValidityTimeZoneId string
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
WorkloadGroups List<zscaler.PulumiPackage.Zia.Inputs.URLFilteringRulesWorkloadGroup>
The list of preconfigured workload groups to which the policy must be applied
Action string
Action taken when traffic matches rule criteria
BlockOverride bool
CbiProfiles []URLFilteringRulesCbiProfileArgs
Ciparule bool
If set to true, the CIPA Compliance rule is enabled
Departments URLFilteringRulesDepartmentsArgs
Name-ID pairs of departments for which rule must be applied
Description string
Additional information about the URL Filtering rule
DeviceGroups URLFilteringRulesDeviceGroupsArgs
This field is applicable for devices that are managed using Zscaler Client Connector.
DeviceTrustLevels []string
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
Devices URLFilteringRulesDevicesArgs
Name-ID pairs of devices for which rule must be applied.
EndUserNotificationUrl string
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
EnforceTimeValidity bool
Enforce a set a validity time period for the URL Filtering rule.
Groups URLFilteringRulesGroupsArgs
Name-ID pairs of groups for which rule must be applied
Labels URLFilteringRulesLabelsArgs
The URL Filtering rule's label.
LocationGroups URLFilteringRulesLocationGroupsArgs
Name-ID pairs of the location groups to which the rule must be applied.
Locations URLFilteringRulesLocationsArgs
Name-ID pairs of locations for which rule must be applied
Name string
Name of the Firewall Filtering policy rule
Order int
Order of execution of rule with respect to other URL Filtering rules
OverrideGroups URLFilteringRulesOverrideGroupsArgs
Name-ID pairs of groups for which this rule can be overridden.
OverrideUsers URLFilteringRulesOverrideUsersArgs
Name-ID pairs of users for which this rule can be overridden.
Protocols []string
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
Rank int
Admin rank of the Firewall Filtering policy rule
RequestMethods []string
Request method for which the rule must be applied. If not set, rule will be applied to all methods
RuleId int
URL Filtering Rule ID
SizeQuota int
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
SourceIpGroups URLFilteringRulesSourceIpGroupsArgs
list of source ip groups
State string
TimeQuota int
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
TimeWindows URLFilteringRulesTimeWindowsArgs
Name-ID pairs of time interval during which rule must be enforced.
UrlCategories []string
List of URL categories for which rule must be applied
UserAgentTypes []string
Supported User Agent Types
UserRiskScoreLevels []string
Users URLFilteringRulesUsersArgs
Name-ID pairs of users for which rule must be applied
ValidityEndTime string
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
ValidityStartTime string
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
ValidityTimeZoneId string
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
WorkloadGroups []URLFilteringRulesWorkloadGroupArgs
The list of preconfigured workload groups to which the policy must be applied
action String
Action taken when traffic matches rule criteria
blockOverride Boolean
cbiProfiles List<URLFilteringRulesCbiProfile>
ciparule Boolean
If set to true, the CIPA Compliance rule is enabled
departments URLFilteringRulesDepartments
Name-ID pairs of departments for which rule must be applied
description String
Additional information about the URL Filtering rule
deviceGroups URLFilteringRulesDeviceGroups
This field is applicable for devices that are managed using Zscaler Client Connector.
deviceTrustLevels List<String>
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices URLFilteringRulesDevices
Name-ID pairs of devices for which rule must be applied.
endUserNotificationUrl String
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforceTimeValidity Boolean
Enforce a set a validity time period for the URL Filtering rule.
groups URLFilteringRulesGroups
Name-ID pairs of groups for which rule must be applied
labels URLFilteringRulesLabels
The URL Filtering rule's label.
locationGroups URLFilteringRulesLocationGroups
Name-ID pairs of the location groups to which the rule must be applied.
locations URLFilteringRulesLocations
Name-ID pairs of locations for which rule must be applied
name String
Name of the Firewall Filtering policy rule
order Integer
Order of execution of rule with respect to other URL Filtering rules
overrideGroups URLFilteringRulesOverrideGroups
Name-ID pairs of groups for which this rule can be overridden.
overrideUsers URLFilteringRulesOverrideUsers
Name-ID pairs of users for which this rule can be overridden.
protocols List<String>
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
rank Integer
Admin rank of the Firewall Filtering policy rule
requestMethods List<String>
Request method for which the rule must be applied. If not set, rule will be applied to all methods
ruleId Integer
URL Filtering Rule ID
sizeQuota Integer
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
sourceIpGroups URLFilteringRulesSourceIpGroups
list of source ip groups
state String
timeQuota Integer
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
timeWindows URLFilteringRulesTimeWindows
Name-ID pairs of time interval during which rule must be enforced.
urlCategories List<String>
List of URL categories for which rule must be applied
userAgentTypes List<String>
Supported User Agent Types
userRiskScoreLevels List<String>
users URLFilteringRulesUsers
Name-ID pairs of users for which rule must be applied
validityEndTime String
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validityStartTime String
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validityTimeZoneId String
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workloadGroups List<URLFilteringRulesWorkloadGroup>
The list of preconfigured workload groups to which the policy must be applied
action string
Action taken when traffic matches rule criteria
blockOverride boolean
cbiProfiles URLFilteringRulesCbiProfile[]
ciparule boolean
If set to true, the CIPA Compliance rule is enabled
departments URLFilteringRulesDepartments
Name-ID pairs of departments for which rule must be applied
description string
Additional information about the URL Filtering rule
deviceGroups URLFilteringRulesDeviceGroups
This field is applicable for devices that are managed using Zscaler Client Connector.
deviceTrustLevels string[]
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices URLFilteringRulesDevices
Name-ID pairs of devices for which rule must be applied.
endUserNotificationUrl string
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforceTimeValidity boolean
Enforce a set a validity time period for the URL Filtering rule.
groups URLFilteringRulesGroups
Name-ID pairs of groups for which rule must be applied
labels URLFilteringRulesLabels
The URL Filtering rule's label.
locationGroups URLFilteringRulesLocationGroups
Name-ID pairs of the location groups to which the rule must be applied.
locations URLFilteringRulesLocations
Name-ID pairs of locations for which rule must be applied
name string
Name of the Firewall Filtering policy rule
order number
Order of execution of rule with respect to other URL Filtering rules
overrideGroups URLFilteringRulesOverrideGroups
Name-ID pairs of groups for which this rule can be overridden.
overrideUsers URLFilteringRulesOverrideUsers
Name-ID pairs of users for which this rule can be overridden.
protocols string[]
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
rank number
Admin rank of the Firewall Filtering policy rule
requestMethods string[]
Request method for which the rule must be applied. If not set, rule will be applied to all methods
ruleId number
URL Filtering Rule ID
sizeQuota number
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
sourceIpGroups URLFilteringRulesSourceIpGroups
list of source ip groups
state string
timeQuota number
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
timeWindows URLFilteringRulesTimeWindows
Name-ID pairs of time interval during which rule must be enforced.
urlCategories string[]
List of URL categories for which rule must be applied
userAgentTypes string[]
Supported User Agent Types
userRiskScoreLevels string[]
users URLFilteringRulesUsers
Name-ID pairs of users for which rule must be applied
validityEndTime string
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validityStartTime string
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validityTimeZoneId string
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workloadGroups URLFilteringRulesWorkloadGroup[]
The list of preconfigured workload groups to which the policy must be applied
action str
Action taken when traffic matches rule criteria
block_override bool
cbi_profiles Sequence[URLFilteringRulesCbiProfileArgs]
ciparule bool
If set to true, the CIPA Compliance rule is enabled
departments URLFilteringRulesDepartmentsArgs
Name-ID pairs of departments for which rule must be applied
description str
Additional information about the URL Filtering rule
device_groups URLFilteringRulesDeviceGroupsArgs
This field is applicable for devices that are managed using Zscaler Client Connector.
device_trust_levels Sequence[str]
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices URLFilteringRulesDevicesArgs
Name-ID pairs of devices for which rule must be applied.
end_user_notification_url str
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforce_time_validity bool
Enforce a set a validity time period for the URL Filtering rule.
groups URLFilteringRulesGroupsArgs
Name-ID pairs of groups for which rule must be applied
labels URLFilteringRulesLabelsArgs
The URL Filtering rule's label.
location_groups URLFilteringRulesLocationGroupsArgs
Name-ID pairs of the location groups to which the rule must be applied.
locations URLFilteringRulesLocationsArgs
Name-ID pairs of locations for which rule must be applied
name str
Name of the Firewall Filtering policy rule
order int
Order of execution of rule with respect to other URL Filtering rules
override_groups URLFilteringRulesOverrideGroupsArgs
Name-ID pairs of groups for which this rule can be overridden.
override_users URLFilteringRulesOverrideUsersArgs
Name-ID pairs of users for which this rule can be overridden.
protocols Sequence[str]
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
rank int
Admin rank of the Firewall Filtering policy rule
request_methods Sequence[str]
Request method for which the rule must be applied. If not set, rule will be applied to all methods
rule_id int
URL Filtering Rule ID
size_quota int
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
source_ip_groups URLFilteringRulesSourceIpGroupsArgs
list of source ip groups
state str
time_quota int
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
time_windows URLFilteringRulesTimeWindowsArgs
Name-ID pairs of time interval during which rule must be enforced.
url_categories Sequence[str]
List of URL categories for which rule must be applied
user_agent_types Sequence[str]
Supported User Agent Types
user_risk_score_levels Sequence[str]
users URLFilteringRulesUsersArgs
Name-ID pairs of users for which rule must be applied
validity_end_time str
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validity_start_time str
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validity_time_zone_id str
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workload_groups Sequence[URLFilteringRulesWorkloadGroupArgs]
The list of preconfigured workload groups to which the policy must be applied
action String
Action taken when traffic matches rule criteria
blockOverride Boolean
cbiProfiles List<Property Map>
ciparule Boolean
If set to true, the CIPA Compliance rule is enabled
departments Property Map
Name-ID pairs of departments for which rule must be applied
description String
Additional information about the URL Filtering rule
deviceGroups Property Map
This field is applicable for devices that are managed using Zscaler Client Connector.
deviceTrustLevels List<String>
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation.
devices Property Map
Name-ID pairs of devices for which rule must be applied.
endUserNotificationUrl String
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
enforceTimeValidity Boolean
Enforce a set a validity time period for the URL Filtering rule.
groups Property Map
Name-ID pairs of groups for which rule must be applied
labels Property Map
The URL Filtering rule's label.
locationGroups Property Map
Name-ID pairs of the location groups to which the rule must be applied.
locations Property Map
Name-ID pairs of locations for which rule must be applied
name String
Name of the Firewall Filtering policy rule
order Number
Order of execution of rule with respect to other URL Filtering rules
overrideGroups Property Map
Name-ID pairs of groups for which this rule can be overridden.
overrideUsers Property Map
Name-ID pairs of users for which this rule can be overridden.
protocols List<String>
Protocol criteria. Supported values: SMRULEF_ZPA_BROKERS_RULE, ANY_RULE, TCP_RULE, UDP_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, TUNNEL_RULE, WEBSOCKETSSL_RULE, WEBSOCKET_RULE,
rank Number
Admin rank of the Firewall Filtering policy rule
requestMethods List<String>
Request method for which the rule must be applied. If not set, rule will be applied to all methods
ruleId Number
URL Filtering Rule ID
sizeQuota Number
Size quota in KB beyond which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
sourceIpGroups Property Map
list of source ip groups
state String
timeQuota Number
Time quota in minutes, after which the URL Filtering rule is applied. If not set, no quota is enforced. If a policy rule action is set to 'BLOCK', this field is not applicable.
timeWindows Property Map
Name-ID pairs of time interval during which rule must be enforced.
urlCategories List<String>
List of URL categories for which rule must be applied
userAgentTypes List<String>
Supported User Agent Types
userRiskScoreLevels List<String>
users Property Map
Name-ID pairs of users for which rule must be applied
validityEndTime String
If enforceTimeValidity is set to true, the URL Filtering rule ceases to be valid on this end date and time.
validityStartTime String
If enforceTimeValidity is set to true, the URL Filtering rule is valid starting on this date and time.
validityTimeZoneId String
If enforceTimeValidity is set to true, the URL Filtering rule date and time is valid based on this time zone ID. Use IANA Format TimeZone.
workloadGroups List<Property Map>
The list of preconfigured workload groups to which the policy must be applied

Supporting Types

URLFilteringRulesCbiProfile
, URLFilteringRulesCbiProfileArgs

Id string
Name string
Name of the Firewall Filtering policy rule
Url string
The browser isolation profile URL
Id string
Name string
Name of the Firewall Filtering policy rule
Url string
The browser isolation profile URL
id String
name String
Name of the Firewall Filtering policy rule
url String
The browser isolation profile URL
id string
name string
Name of the Firewall Filtering policy rule
url string
The browser isolation profile URL
id str
name str
Name of the Firewall Filtering policy rule
url str
The browser isolation profile URL
id String
name String
Name of the Firewall Filtering policy rule
url String
The browser isolation profile URL

URLFilteringRulesDepartments
, URLFilteringRulesDepartmentsArgs

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

URLFilteringRulesDeviceGroups
, URLFilteringRulesDeviceGroupsArgs

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

URLFilteringRulesDevices
, URLFilteringRulesDevicesArgs

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

URLFilteringRulesGroups
, URLFilteringRulesGroupsArgs

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

URLFilteringRulesLabels
, URLFilteringRulesLabelsArgs

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

URLFilteringRulesLocationGroups
, URLFilteringRulesLocationGroupsArgs

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

URLFilteringRulesLocations
, URLFilteringRulesLocationsArgs

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

URLFilteringRulesOverrideGroups
, URLFilteringRulesOverrideGroupsArgs

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

URLFilteringRulesOverrideUsers
, URLFilteringRulesOverrideUsersArgs

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

URLFilteringRulesSourceIpGroups
, URLFilteringRulesSourceIpGroupsArgs

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

URLFilteringRulesTimeWindows
, URLFilteringRulesTimeWindowsArgs

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

URLFilteringRulesUsers
, URLFilteringRulesUsersArgs

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

URLFilteringRulesWorkloadGroup
, URLFilteringRulesWorkloadGroupArgs

Id This property is required. int
The unique identifier for the resource.
Name This property is required. string
Name of the Firewall Filtering policy rule
Id This property is required. int
The unique identifier for the resource.
Name This property is required. string
Name of the Firewall Filtering policy rule
id This property is required. Integer
The unique identifier for the resource.
name This property is required. String
Name of the Firewall Filtering policy rule
id This property is required. number
The unique identifier for the resource.
name This property is required. string
Name of the Firewall Filtering policy rule
id This property is required. int
The unique identifier for the resource.
name This property is required. str
Name of the Firewall Filtering policy rule
id This property is required. Number
The unique identifier for the resource.
name This property is required. String
Name of the Firewall Filtering policy rule

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_filtering_rules can be imported by using <RULE_ID> or <RULE_NAME> as the import ID.

For example:

$ pulumi import zia:index/uRLFilteringRules:URLFilteringRules example <rule_id>
Copy

or

$ pulumi import zia:index/uRLFilteringRules:URLFilteringRules example <rule_name>
Copy

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