zia.URLFilteringRules
Explore with Pulumi AI
The zia_url_filtering_rules resource creates and manages a URL filtering rules within the Zscaler Internet Access cloud.
Example Usage
BLOCK ACTION
import * as pulumi from "@pulumi/pulumi";
import * as zia from "@bdzscaler/pulumi-zia";
const _this = new zia.URLFilteringRules("this", {
action: "BLOCK",
description: "Example",
deviceTrustLevels: [
"UNKNOWN_DEVICETRUSTLEVEL",
"LOW_TRUST",
"MEDIUM_TRUST",
"HIGH_TRUST",
],
order: 1,
protocols: ["ANY_RULE"],
requestMethods: [
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"OTHER",
"POST",
"PUT",
"TRACE",
],
state: "ENABLED",
urlCategories: ["ANY"],
});
import pulumi
import zscaler_pulumi_zia as zia
this = zia.URLFilteringRules("this",
action="BLOCK",
description="Example",
device_trust_levels=[
"UNKNOWN_DEVICETRUSTLEVEL",
"LOW_TRUST",
"MEDIUM_TRUST",
"HIGH_TRUST",
],
order=1,
protocols=["ANY_RULE"],
request_methods=[
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"OTHER",
"POST",
"PUT",
"TRACE",
],
state="ENABLED",
url_categories=["ANY"])
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"),
Description: pulumi.String("Example"),
DeviceTrustLevels: pulumi.StringArray{
pulumi.String("UNKNOWN_DEVICETRUSTLEVEL"),
pulumi.String("LOW_TRUST"),
pulumi.String("MEDIUM_TRUST"),
pulumi.String("HIGH_TRUST"),
},
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"),
},
State: pulumi.String("ENABLED"),
UrlCategories: pulumi.StringArray{
pulumi.String("ANY"),
},
})
if err != nil {
return err
}
return nil
})
}
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",
Description = "Example",
DeviceTrustLevels = new[]
{
"UNKNOWN_DEVICETRUSTLEVEL",
"LOW_TRUST",
"MEDIUM_TRUST",
"HIGH_TRUST",
},
Order = 1,
Protocols = new[]
{
"ANY_RULE",
},
RequestMethods = new[]
{
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"OTHER",
"POST",
"PUT",
"TRACE",
},
State = "ENABLED",
UrlCategories = new[]
{
"ANY",
},
});
});
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("BLOCK")
.description("Example")
.deviceTrustLevels(
"UNKNOWN_DEVICETRUSTLEVEL",
"LOW_TRUST",
"MEDIUM_TRUST",
"HIGH_TRUST")
.order(1)
.protocols("ANY_RULE")
.requestMethods(
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"OTHER",
"POST",
"PUT",
"TRACE")
.state("ENABLED")
.urlCategories("ANY")
.build());
}
}
resources:
this:
type: zia:URLFilteringRules
properties:
action: BLOCK
description: Example
deviceTrustLevels:
- UNKNOWN_DEVICETRUSTLEVEL
- LOW_TRUST
- MEDIUM_TRUST
- HIGH_TRUST
order: 1
protocols:
- ANY_RULE
requestMethods:
- CONNECT
- DELETE
- GET
- HEAD
- OPTIONS
- OTHER
- POST
- PUT
- TRACE
state: ENABLED
urlCategories:
- ANY
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,
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",
],
});
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,
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",
])
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),
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
})
}
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,
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",
},
});
});
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)
.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());
}
}
resources:
thisURLFilteringRules:
type: zia:URLFilteringRules
properties:
description: Example
state: ENABLED
action: ISOLATE
order: 1
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
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,
override_groups: Optional[URLFilteringRulesOverrideGroupsArgs] = None,
description: Optional[str] = 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,
enforce_time_validity: Optional[bool] = None,
groups: Optional[URLFilteringRulesGroupsArgs] = None,
labels: Optional[URLFilteringRulesLabelsArgs] = None,
location_groups: Optional[URLFilteringRulesLocationGroupsArgs] = None,
block_override: Optional[bool] = None,
name: Optional[str] = None,
action: Optional[str] = None,
departments: Optional[URLFilteringRulesDepartmentsArgs] = None,
cbi_profiles: Optional[Sequence[URLFilteringRulesCbiProfileArgs]] = None,
locations: Optional[URLFilteringRulesLocationsArgs] = None,
rank: Optional[int] = None,
request_methods: Optional[Sequence[str]] = None,
size_quota: Optional[int] = 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[int] = None,
validity_start_time: Optional[int] = 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 string
- The unique name of the resource.
- args URLFilteringRulesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args URLFilteringRulesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args URLFilteringRulesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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,
OverrideGroups = new Zia.Inputs.URLFilteringRulesOverrideGroupsArgs
{
Ids = new[]
{
0,
},
},
Description = "string",
DeviceGroups = new Zia.Inputs.URLFilteringRulesDeviceGroupsArgs
{
Ids = new[]
{
0,
},
},
DeviceTrustLevels = new[]
{
"string",
},
OverrideUsers = new Zia.Inputs.URLFilteringRulesOverrideUsersArgs
{
Ids = new[]
{
0,
},
},
EndUserNotificationUrl = "string",
EnforceTimeValidity = 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,
},
},
BlockOverride = false,
Name = "string",
Action = "string",
Departments = new Zia.Inputs.URLFilteringRulesDepartmentsArgs
{
Ids = new[]
{
0,
},
},
CbiProfiles = new[]
{
new Zia.Inputs.URLFilteringRulesCbiProfileArgs
{
Id = "string",
Name = "string",
Url = "string",
},
},
Locations = new Zia.Inputs.URLFilteringRulesLocationsArgs
{
Ids = new[]
{
0,
},
},
Rank = 0,
RequestMethods = new[]
{
"string",
},
SizeQuota = 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 = 0,
ValidityStartTime = 0,
ValidityTimeZoneId = "string",
WorkloadGroups = new[]
{
new Zia.Inputs.URLFilteringRulesWorkloadGroupArgs
{
Id = 0,
Name = "string",
},
},
});
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),
OverrideGroups: &zia.URLFilteringRulesOverrideGroupsArgs{
Ids: pulumi.IntArray{
pulumi.Int(0),
},
},
Description: pulumi.String("string"),
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"),
EnforceTimeValidity: 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),
},
},
BlockOverride: pulumi.Bool(false),
Name: pulumi.String("string"),
Action: pulumi.String("string"),
Departments: &zia.URLFilteringRulesDepartmentsArgs{
Ids: pulumi.IntArray{
pulumi.Int(0),
},
},
CbiProfiles: zia.URLFilteringRulesCbiProfileArray{
&zia.URLFilteringRulesCbiProfileArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
Locations: &zia.URLFilteringRulesLocationsArgs{
Ids: pulumi.IntArray{
pulumi.Int(0),
},
},
Rank: pulumi.Int(0),
RequestMethods: pulumi.StringArray{
pulumi.String("string"),
},
SizeQuota: 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.Int(0),
ValidityStartTime: pulumi.Int(0),
ValidityTimeZoneId: pulumi.String("string"),
WorkloadGroups: zia.URLFilteringRulesWorkloadGroupArray{
&zia.URLFilteringRulesWorkloadGroupArgs{
Id: pulumi.Int(0),
Name: pulumi.String("string"),
},
},
})
var urlfilteringRulesResource = new URLFilteringRules("urlfilteringRulesResource", URLFilteringRulesArgs.builder()
.protocols("string")
.order(0)
.devices(URLFilteringRulesDevicesArgs.builder()
.ids(0)
.build())
.ciparule(false)
.overrideGroups(URLFilteringRulesOverrideGroupsArgs.builder()
.ids(0)
.build())
.description("string")
.deviceGroups(URLFilteringRulesDeviceGroupsArgs.builder()
.ids(0)
.build())
.deviceTrustLevels("string")
.overrideUsers(URLFilteringRulesOverrideUsersArgs.builder()
.ids(0)
.build())
.endUserNotificationUrl("string")
.enforceTimeValidity(false)
.groups(URLFilteringRulesGroupsArgs.builder()
.ids(0)
.build())
.labels(URLFilteringRulesLabelsArgs.builder()
.ids(0)
.build())
.locationGroups(URLFilteringRulesLocationGroupsArgs.builder()
.ids(0)
.build())
.blockOverride(false)
.name("string")
.action("string")
.departments(URLFilteringRulesDepartmentsArgs.builder()
.ids(0)
.build())
.cbiProfiles(URLFilteringRulesCbiProfileArgs.builder()
.id("string")
.name("string")
.url("string")
.build())
.locations(URLFilteringRulesLocationsArgs.builder()
.ids(0)
.build())
.rank(0)
.requestMethods("string")
.sizeQuota(0)
.state("string")
.timeQuota(0)
.timeWindows(URLFilteringRulesTimeWindowsArgs.builder()
.ids(0)
.build())
.urlCategories("string")
.userAgentTypes("string")
.userRiskScoreLevels("string")
.users(URLFilteringRulesUsersArgs.builder()
.ids(0)
.build())
.validityEndTime(0)
.validityStartTime(0)
.validityTimeZoneId("string")
.workloadGroups(URLFilteringRulesWorkloadGroupArgs.builder()
.id(0)
.name("string")
.build())
.build());
urlfiltering_rules_resource = zia.URLFilteringRules("urlfilteringRulesResource",
protocols=["string"],
order=0,
devices=zia.URLFilteringRulesDevicesArgs(
ids=[0],
),
ciparule=False,
override_groups=zia.URLFilteringRulesOverrideGroupsArgs(
ids=[0],
),
description="string",
device_groups=zia.URLFilteringRulesDeviceGroupsArgs(
ids=[0],
),
device_trust_levels=["string"],
override_users=zia.URLFilteringRulesOverrideUsersArgs(
ids=[0],
),
end_user_notification_url="string",
enforce_time_validity=False,
groups=zia.URLFilteringRulesGroupsArgs(
ids=[0],
),
labels=zia.URLFilteringRulesLabelsArgs(
ids=[0],
),
location_groups=zia.URLFilteringRulesLocationGroupsArgs(
ids=[0],
),
block_override=False,
name="string",
action="string",
departments=zia.URLFilteringRulesDepartmentsArgs(
ids=[0],
),
cbi_profiles=[zia.URLFilteringRulesCbiProfileArgs(
id="string",
name="string",
url="string",
)],
locations=zia.URLFilteringRulesLocationsArgs(
ids=[0],
),
rank=0,
request_methods=["string"],
size_quota=0,
state="string",
time_quota=0,
time_windows=zia.URLFilteringRulesTimeWindowsArgs(
ids=[0],
),
url_categories=["string"],
user_agent_types=["string"],
user_risk_score_levels=["string"],
users=zia.URLFilteringRulesUsersArgs(
ids=[0],
),
validity_end_time=0,
validity_start_time=0,
validity_time_zone_id="string",
workload_groups=[zia.URLFilteringRulesWorkloadGroupArgs(
id=0,
name="string",
)])
const urlfilteringRulesResource = new zia.URLFilteringRules("urlfilteringRulesResource", {
protocols: ["string"],
order: 0,
devices: {
ids: [0],
},
ciparule: false,
overrideGroups: {
ids: [0],
},
description: "string",
deviceGroups: {
ids: [0],
},
deviceTrustLevels: ["string"],
overrideUsers: {
ids: [0],
},
endUserNotificationUrl: "string",
enforceTimeValidity: false,
groups: {
ids: [0],
},
labels: {
ids: [0],
},
locationGroups: {
ids: [0],
},
blockOverride: false,
name: "string",
action: "string",
departments: {
ids: [0],
},
cbiProfiles: [{
id: "string",
name: "string",
url: "string",
}],
locations: {
ids: [0],
},
rank: 0,
requestMethods: ["string"],
sizeQuota: 0,
state: "string",
timeQuota: 0,
timeWindows: {
ids: [0],
},
urlCategories: ["string"],
userAgentTypes: ["string"],
userRiskScoreLevels: ["string"],
users: {
ids: [0],
},
validityEndTime: 0,
validityStartTime: 0,
validityTimeZoneId: "string",
workloadGroups: [{
id: 0,
name: "string",
}],
});
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
state: string
timeQuota: 0
timeWindows:
ids:
- 0
urlCategories:
- string
userAgentTypes:
- string
userRiskScoreLevels:
- string
users:
ids:
- 0
validityEndTime: 0
validityStartTime: 0
validityTimeZoneId: string
workloadGroups:
- id: 0
name: string
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
The URLFilteringRules resource accepts the following input properties:
- 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
, - Action string
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- Block
Override bool - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - Cbi
Profiles List<zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Cbi Profile> - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- Ciparule bool
- If set to true, the CIPA Compliance rule is enabled
- Departments
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Departments - The departments to which the Firewall Filtering policy rule applies
- Description string
- Additional information about the rule
- Device
Groups zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Device Groups - This field is applicable for devices that are managed using Zscaler Client Connector.
- Device
Trust List<string>Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- Devices
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Devices - Name-ID pairs of devices for which rule must be applied.
- End
User stringNotification Url - 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 boolValidity - Enforce a set a validity time period for the URL Filtering rule.
- Groups
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Groups - The groups to which the Firewall Filtering policy rule applies
- Labels
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Labels - The URL Filtering rule's label.
- Location
Groups zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Location Groups - The location groups to which the Firewall Filtering policy rule applies
- Locations
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Locations - The locations to which the Firewall Filtering policy rule applies
- Name string
- Name of the Firewall Filtering policy rule
- Order int
- Order of execution of rule with respect to other URL Filtering rules
- Override
Groups zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Override Groups - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - Override
Users zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Override Users - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - Rank int
- Admin rank of the admin who creates this rule
- Request
Methods List<string> - 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. - State string
- Rule State
- 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 zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Time Windows - The time interval in which the Firewall Filtering policy rule applies
- Url
Categories List<string> - List of URL categories for which rule must be applied
- User
Agent List<string>Types - Supported User Agent Types
- User
Risk List<string>Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- Users
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Users - The users to which the Firewall Filtering policy rule applies
- Validity
End intTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - Validity
Start intTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- Validity
Time stringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - Workload
Groups List<zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Workload Group> - The list of preconfigured workload groups to which the policy must be applied
- 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
, - Action string
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- Block
Override bool - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - Cbi
Profiles []URLFilteringRules Cbi Profile Args - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- Ciparule bool
- If set to true, the CIPA Compliance rule is enabled
- Departments
URLFiltering
Rules Departments Args - The departments to which the Firewall Filtering policy rule applies
- Description string
- Additional information about the rule
- Device
Groups URLFilteringRules Device Groups Args - This field is applicable for devices that are managed using Zscaler Client Connector.
- Device
Trust []stringLevels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- Devices
URLFiltering
Rules Devices Args - Name-ID pairs of devices for which rule must be applied.
- End
User stringNotification Url - 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 boolValidity - Enforce a set a validity time period for the URL Filtering rule.
- Groups
URLFiltering
Rules Groups Args - The groups to which the Firewall Filtering policy rule applies
- Labels
URLFiltering
Rules Labels Args - The URL Filtering rule's label.
- Location
Groups URLFilteringRules Location Groups Args - The location groups to which the Firewall Filtering policy rule applies
- Locations
URLFiltering
Rules Locations Args - The locations to which the Firewall Filtering policy rule applies
- Name string
- Name of the Firewall Filtering policy rule
- Order int
- Order of execution of rule with respect to other URL Filtering rules
- Override
Groups URLFilteringRules Override Groups Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - Override
Users URLFilteringRules Override Users Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - Rank int
- Admin rank of the admin who creates this rule
- Request
Methods []string - 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. - State string
- Rule State
- 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 URLFilteringRules Time Windows Args - The time interval in which the Firewall Filtering policy rule applies
- Url
Categories []string - List of URL categories for which rule must be applied
- User
Agent []stringTypes - Supported User Agent Types
- User
Risk []stringScore Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- Users
URLFiltering
Rules Users Args - The users to which the Firewall Filtering policy rule applies
- Validity
End intTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - Validity
Start intTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- Validity
Time stringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - Workload
Groups []URLFilteringRules Workload Group Args - The list of preconfigured workload groups to which the policy must be applied
- 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
, - action String
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block
Override Boolean - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi
Profiles List<URLFilteringRules Cbi Profile> - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule Boolean
- If set to true, the CIPA Compliance rule is enabled
- departments
URLFiltering
Rules Departments - The departments to which the Firewall Filtering policy rule applies
- description String
- Additional information about the rule
- device
Groups URLFilteringRules Device Groups - This field is applicable for devices that are managed using Zscaler Client Connector.
- device
Trust List<String>Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices
URLFiltering
Rules Devices - Name-ID pairs of devices for which rule must be applied.
- end
User StringNotification Url - 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 BooleanValidity - Enforce a set a validity time period for the URL Filtering rule.
- groups
URLFiltering
Rules Groups - The groups to which the Firewall Filtering policy rule applies
- labels
URLFiltering
Rules Labels - The URL Filtering rule's label.
- location
Groups URLFilteringRules Location Groups - The location groups to which the Firewall Filtering policy rule applies
- locations
URLFiltering
Rules Locations - The locations to which the Firewall Filtering policy rule applies
- name String
- Name of the Firewall Filtering policy rule
- order Integer
- Order of execution of rule with respect to other URL Filtering rules
- override
Groups URLFilteringRules Override Groups - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override
Users URLFilteringRules Override Users - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - rank Integer
- Admin rank of the admin who creates this rule
- request
Methods List<String> - Request method for which the rule must be applied. If not set, rule will be applied to all methods
- size
Quota 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. - state String
- Rule State
- time
Quota 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. - time
Windows URLFilteringRules Time Windows - The time interval in which the Firewall Filtering policy rule applies
- url
Categories List<String> - List of URL categories for which rule must be applied
- user
Agent List<String>Types - Supported User Agent Types
- user
Risk List<String>Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users
URLFiltering
Rules Users - The users to which the Firewall Filtering policy rule applies
- validity
End IntegerTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity
Start IntegerTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity
Time StringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload
Groups List<URLFilteringRules Workload Group> - The list of preconfigured workload groups to which the policy must be applied
- 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
, - action string
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block
Override boolean - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi
Profiles URLFilteringRules Cbi Profile[] - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule boolean
- If set to true, the CIPA Compliance rule is enabled
- departments
URLFiltering
Rules Departments - The departments to which the Firewall Filtering policy rule applies
- description string
- Additional information about the rule
- device
Groups URLFilteringRules Device Groups - This field is applicable for devices that are managed using Zscaler Client Connector.
- device
Trust string[]Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices
URLFiltering
Rules Devices - Name-ID pairs of devices for which rule must be applied.
- end
User stringNotification Url - 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 booleanValidity - Enforce a set a validity time period for the URL Filtering rule.
- groups
URLFiltering
Rules Groups - The groups to which the Firewall Filtering policy rule applies
- labels
URLFiltering
Rules Labels - The URL Filtering rule's label.
- location
Groups URLFilteringRules Location Groups - The location groups to which the Firewall Filtering policy rule applies
- locations
URLFiltering
Rules Locations - The locations to which the Firewall Filtering policy rule applies
- name string
- Name of the Firewall Filtering policy rule
- order number
- Order of execution of rule with respect to other URL Filtering rules
- override
Groups URLFilteringRules Override Groups - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override
Users URLFilteringRules Override Users - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - rank number
- Admin rank of the admin who creates this rule
- request
Methods string[] - Request method for which the rule must be applied. If not set, rule will be applied to all methods
- size
Quota 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. - state string
- Rule State
- time
Quota 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. - time
Windows URLFilteringRules Time Windows - The time interval in which the Firewall Filtering policy rule applies
- url
Categories string[] - List of URL categories for which rule must be applied
- user
Agent string[]Types - Supported User Agent Types
- user
Risk string[]Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users
URLFiltering
Rules Users - The users to which the Firewall Filtering policy rule applies
- validity
End numberTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity
Start numberTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity
Time stringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload
Groups URLFilteringRules Workload Group[] - The list of preconfigured workload groups to which the policy must be applied
- 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
, - action str
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block_
override bool - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi_
profiles Sequence[URLFilteringRules Cbi Profile Args] - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule bool
- If set to true, the CIPA Compliance rule is enabled
- departments
URLFiltering
Rules Departments Args - The departments to which the Firewall Filtering policy rule applies
- description str
- Additional information about the rule
- device_
groups URLFilteringRules Device Groups Args - This field is applicable for devices that are managed using Zscaler Client Connector.
- device_
trust_ Sequence[str]levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices
URLFiltering
Rules Devices Args - Name-ID pairs of devices for which rule must be applied.
- end_
user_ strnotification_ url - 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_ boolvalidity - Enforce a set a validity time period for the URL Filtering rule.
- groups
URLFiltering
Rules Groups Args - The groups to which the Firewall Filtering policy rule applies
- labels
URLFiltering
Rules Labels Args - The URL Filtering rule's label.
- location_
groups URLFilteringRules Location Groups Args - The location groups to which the Firewall Filtering policy rule applies
- locations
URLFiltering
Rules Locations Args - The locations to which the Firewall Filtering policy rule applies
- 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 URLFilteringRules Override Groups Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override_
users URLFilteringRules Override Users Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - rank int
- Admin rank of the admin who creates this 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. - state str
- Rule State
- 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 URLFilteringRules Time Windows Args - The time interval in which the Firewall Filtering policy rule applies
- url_
categories Sequence[str] - List of URL categories for which rule must be applied
- user_
agent_ Sequence[str]types - Supported User Agent Types
- user_
risk_ Sequence[str]score_ levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users
URLFiltering
Rules Users Args - The users to which the Firewall Filtering policy rule applies
- validity_
end_ inttime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity_
start_ inttime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity_
time_ strzone_ id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload_
groups Sequence[URLFilteringRules Workload Group Args] - The list of preconfigured workload groups to which the policy must be applied
- 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
, - action String
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block
Override Boolean - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi
Profiles List<Property Map> - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule Boolean
- If set to true, the CIPA Compliance rule is enabled
- departments Property Map
- The departments to which the Firewall Filtering policy rule applies
- description String
- Additional information about the rule
- device
Groups Property Map - This field is applicable for devices that are managed using Zscaler Client Connector.
- device
Trust List<String>Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices Property Map
- Name-ID pairs of devices for which rule must be applied.
- end
User StringNotification Url - 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 BooleanValidity - Enforce a set a validity time period for the URL Filtering rule.
- groups Property Map
- The groups to which the Firewall Filtering policy rule applies
- labels Property Map
- The URL Filtering rule's label.
- location
Groups Property Map - The location groups to which the Firewall Filtering policy rule applies
- locations Property Map
- The locations to which the Firewall Filtering policy rule applies
- name String
- Name of the Firewall Filtering policy rule
- order Number
- Order of execution of rule with respect to other URL Filtering rules
- override
Groups Property Map - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override
Users Property Map - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - rank Number
- Admin rank of the admin who creates this rule
- request
Methods List<String> - Request method for which the rule must be applied. If not set, rule will be applied to all methods
- size
Quota 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. - state String
- Rule State
- time
Quota 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. - time
Windows Property Map - The time interval in which the Firewall Filtering policy rule applies
- url
Categories List<String> - List of URL categories for which rule must be applied
- user
Agent List<String>Types - Supported User Agent Types
- user
Risk List<String>Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users Property Map
- The users to which the Firewall Filtering policy rule applies
- validity
End NumberTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity
Start NumberTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity
Time StringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload
Groups 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:
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,
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[int] = None,
validity_start_time: Optional[int] = 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Action string
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- Block
Override bool - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - Cbi
Profiles List<zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Cbi Profile> - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- Ciparule bool
- If set to true, the CIPA Compliance rule is enabled
- Departments
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Departments - The departments to which the Firewall Filtering policy rule applies
- Description string
- Additional information about the rule
- Device
Groups zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Device Groups - This field is applicable for devices that are managed using Zscaler Client Connector.
- Device
Trust List<string>Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- Devices
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Devices - Name-ID pairs of devices for which rule must be applied.
- End
User stringNotification Url - 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 boolValidity - Enforce a set a validity time period for the URL Filtering rule.
- Groups
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Groups - The groups to which the Firewall Filtering policy rule applies
- Labels
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Labels - The URL Filtering rule's label.
- Location
Groups zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Location Groups - The location groups to which the Firewall Filtering policy rule applies
- Locations
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Locations - The locations to which the Firewall Filtering policy rule applies
- Name string
- Name of the Firewall Filtering policy rule
- Order int
- Order of execution of rule with respect to other URL Filtering rules
- Override
Groups zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Override Groups - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - Override
Users zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Override Users - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - 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 admin who creates this rule
- Request
Methods List<string> - 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. - State string
- Rule State
- 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 zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Time Windows - The time interval in which the Firewall Filtering policy rule applies
- Url
Categories List<string> - List of URL categories for which rule must be applied
- User
Agent List<string>Types - Supported User Agent Types
- User
Risk List<string>Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- Users
zscaler.
Pulumi Package. Zia. Inputs. URLFiltering Rules Users - The users to which the Firewall Filtering policy rule applies
- Validity
End intTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - Validity
Start intTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- Validity
Time stringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - Workload
Groups List<zscaler.Pulumi Package. Zia. Inputs. URLFiltering Rules Workload Group> - The list of preconfigured workload groups to which the policy must be applied
- Action string
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- Block
Override bool - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - Cbi
Profiles []URLFilteringRules Cbi Profile Args - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- Ciparule bool
- If set to true, the CIPA Compliance rule is enabled
- Departments
URLFiltering
Rules Departments Args - The departments to which the Firewall Filtering policy rule applies
- Description string
- Additional information about the rule
- Device
Groups URLFilteringRules Device Groups Args - This field is applicable for devices that are managed using Zscaler Client Connector.
- Device
Trust []stringLevels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- Devices
URLFiltering
Rules Devices Args - Name-ID pairs of devices for which rule must be applied.
- End
User stringNotification Url - 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 boolValidity - Enforce a set a validity time period for the URL Filtering rule.
- Groups
URLFiltering
Rules Groups Args - The groups to which the Firewall Filtering policy rule applies
- Labels
URLFiltering
Rules Labels Args - The URL Filtering rule's label.
- Location
Groups URLFilteringRules Location Groups Args - The location groups to which the Firewall Filtering policy rule applies
- Locations
URLFiltering
Rules Locations Args - The locations to which the Firewall Filtering policy rule applies
- Name string
- Name of the Firewall Filtering policy rule
- Order int
- Order of execution of rule with respect to other URL Filtering rules
- Override
Groups URLFilteringRules Override Groups Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - Override
Users URLFilteringRules Override Users Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - 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 admin who creates this rule
- Request
Methods []string - 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. - State string
- Rule State
- 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 URLFilteringRules Time Windows Args - The time interval in which the Firewall Filtering policy rule applies
- Url
Categories []string - List of URL categories for which rule must be applied
- User
Agent []stringTypes - Supported User Agent Types
- User
Risk []stringScore Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- Users
URLFiltering
Rules Users Args - The users to which the Firewall Filtering policy rule applies
- Validity
End intTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - Validity
Start intTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- Validity
Time stringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - Workload
Groups []URLFilteringRules Workload Group Args - The list of preconfigured workload groups to which the policy must be applied
- action String
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block
Override Boolean - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi
Profiles List<URLFilteringRules Cbi Profile> - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule Boolean
- If set to true, the CIPA Compliance rule is enabled
- departments
URLFiltering
Rules Departments - The departments to which the Firewall Filtering policy rule applies
- description String
- Additional information about the rule
- device
Groups URLFilteringRules Device Groups - This field is applicable for devices that are managed using Zscaler Client Connector.
- device
Trust List<String>Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices
URLFiltering
Rules Devices - Name-ID pairs of devices for which rule must be applied.
- end
User StringNotification Url - 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 BooleanValidity - Enforce a set a validity time period for the URL Filtering rule.
- groups
URLFiltering
Rules Groups - The groups to which the Firewall Filtering policy rule applies
- labels
URLFiltering
Rules Labels - The URL Filtering rule's label.
- location
Groups URLFilteringRules Location Groups - The location groups to which the Firewall Filtering policy rule applies
- locations
URLFiltering
Rules Locations - The locations to which the Firewall Filtering policy rule applies
- name String
- Name of the Firewall Filtering policy rule
- order Integer
- Order of execution of rule with respect to other URL Filtering rules
- override
Groups URLFilteringRules Override Groups - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override
Users URLFilteringRules Override Users - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - 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 admin who creates this rule
- request
Methods List<String> - Request method for which the rule must be applied. If not set, rule will be applied to all methods
- rule
Id Integer - URL Filtering Rule ID
- size
Quota 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. - state String
- Rule State
- time
Quota 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. - time
Windows URLFilteringRules Time Windows - The time interval in which the Firewall Filtering policy rule applies
- url
Categories List<String> - List of URL categories for which rule must be applied
- user
Agent List<String>Types - Supported User Agent Types
- user
Risk List<String>Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users
URLFiltering
Rules Users - The users to which the Firewall Filtering policy rule applies
- validity
End IntegerTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity
Start IntegerTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity
Time StringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload
Groups List<URLFilteringRules Workload Group> - The list of preconfigured workload groups to which the policy must be applied
- action string
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block
Override boolean - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi
Profiles URLFilteringRules Cbi Profile[] - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule boolean
- If set to true, the CIPA Compliance rule is enabled
- departments
URLFiltering
Rules Departments - The departments to which the Firewall Filtering policy rule applies
- description string
- Additional information about the rule
- device
Groups URLFilteringRules Device Groups - This field is applicable for devices that are managed using Zscaler Client Connector.
- device
Trust string[]Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices
URLFiltering
Rules Devices - Name-ID pairs of devices for which rule must be applied.
- end
User stringNotification Url - 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 booleanValidity - Enforce a set a validity time period for the URL Filtering rule.
- groups
URLFiltering
Rules Groups - The groups to which the Firewall Filtering policy rule applies
- labels
URLFiltering
Rules Labels - The URL Filtering rule's label.
- location
Groups URLFilteringRules Location Groups - The location groups to which the Firewall Filtering policy rule applies
- locations
URLFiltering
Rules Locations - The locations to which the Firewall Filtering policy rule applies
- name string
- Name of the Firewall Filtering policy rule
- order number
- Order of execution of rule with respect to other URL Filtering rules
- override
Groups URLFilteringRules Override Groups - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override
Users URLFilteringRules Override Users - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - 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 admin who creates this rule
- request
Methods string[] - Request method for which the rule must be applied. If not set, rule will be applied to all methods
- rule
Id number - URL Filtering Rule ID
- size
Quota 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. - state string
- Rule State
- time
Quota 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. - time
Windows URLFilteringRules Time Windows - The time interval in which the Firewall Filtering policy rule applies
- url
Categories string[] - List of URL categories for which rule must be applied
- user
Agent string[]Types - Supported User Agent Types
- user
Risk string[]Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users
URLFiltering
Rules Users - The users to which the Firewall Filtering policy rule applies
- validity
End numberTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity
Start numberTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity
Time stringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload
Groups URLFilteringRules Workload Group[] - The list of preconfigured workload groups to which the policy must be applied
- action str
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block_
override bool - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi_
profiles Sequence[URLFilteringRules Cbi Profile Args] - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule bool
- If set to true, the CIPA Compliance rule is enabled
- departments
URLFiltering
Rules Departments Args - The departments to which the Firewall Filtering policy rule applies
- description str
- Additional information about the rule
- device_
groups URLFilteringRules Device Groups Args - This field is applicable for devices that are managed using Zscaler Client Connector.
- device_
trust_ Sequence[str]levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices
URLFiltering
Rules Devices Args - Name-ID pairs of devices for which rule must be applied.
- end_
user_ strnotification_ url - 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_ boolvalidity - Enforce a set a validity time period for the URL Filtering rule.
- groups
URLFiltering
Rules Groups Args - The groups to which the Firewall Filtering policy rule applies
- labels
URLFiltering
Rules Labels Args - The URL Filtering rule's label.
- location_
groups URLFilteringRules Location Groups Args - The location groups to which the Firewall Filtering policy rule applies
- locations
URLFiltering
Rules Locations Args - The locations to which the Firewall Filtering policy rule applies
- 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 URLFilteringRules Override Groups Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override_
users URLFilteringRules Override Users Args - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - 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 admin who creates this 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. - state str
- Rule State
- 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 URLFilteringRules Time Windows Args - The time interval in which the Firewall Filtering policy rule applies
- url_
categories Sequence[str] - List of URL categories for which rule must be applied
- user_
agent_ Sequence[str]types - Supported User Agent Types
- user_
risk_ Sequence[str]score_ levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users
URLFiltering
Rules Users Args - The users to which the Firewall Filtering policy rule applies
- validity_
end_ inttime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity_
start_ inttime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity_
time_ strzone_ id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload_
groups Sequence[URLFilteringRules Workload Group Args] - The list of preconfigured workload groups to which the policy must be applied
- action String
- Action taken when traffic matches rule criteria. Supported values:
ANY
,NONE
,BLOCK
,CAUTION
,ALLOW
,ICAP_RESPONSE
- block
Override Boolean - When set to true, a
BLOCK
action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, theBLOCK
triggered by this rule could be overridden for any users. If block_override is not set,BLOCK
action cannot be overridden. - cbi
Profiles List<Property Map> - The cloud browser isolation profile to which the ISOLATE action is applied in the URL Filtering Policy rules. This block is required when the attribute
action
is set toISOLATE
- ciparule Boolean
- If set to true, the CIPA Compliance rule is enabled
- departments Property Map
- The departments to which the Firewall Filtering policy rule applies
- description String
- Additional information about the rule
- device
Groups Property Map - This field is applicable for devices that are managed using Zscaler Client Connector.
- device
Trust List<String>Levels - 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. Supported values:
ANY
,UNKNOWN_DEVICETRUSTLEVEL
,LOW_TRUST
,MEDIUM_TRUST
,HIGH_TRUST
- devices Property Map
- Name-ID pairs of devices for which rule must be applied.
- end
User StringNotification Url - 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 BooleanValidity - Enforce a set a validity time period for the URL Filtering rule.
- groups Property Map
- The groups to which the Firewall Filtering policy rule applies
- labels Property Map
- The URL Filtering rule's label.
- location
Groups Property Map - The location groups to which the Firewall Filtering policy rule applies
- locations Property Map
- The locations to which the Firewall Filtering policy rule applies
- name String
- Name of the Firewall Filtering policy rule
- order Number
- Order of execution of rule with respect to other URL Filtering rules
- override
Groups Property Map - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any group. - override
Users Property Map - Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to
true
, action isBLOCK
and overrideGroups is not set.If this overrideUsers is not set,BLOCK
action can be overridden for any user. - 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 admin who creates this rule
- request
Methods List<String> - Request method for which the rule must be applied. If not set, rule will be applied to all methods
- rule
Id Number - URL Filtering Rule ID
- size
Quota 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. - state String
- Rule State
- time
Quota 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. - time
Windows Property Map - The time interval in which the Firewall Filtering policy rule applies
- url
Categories List<String> - List of URL categories for which rule must be applied
- user
Agent List<String>Types - Supported User Agent Types
- user
Risk List<String>Score Levels - Indicates the user risk score level selectedd for the DLP rule violation: Returned values are:
LOW
,MEDIUM
,HIGH
,CRITICAL
- users Property Map
- The users to which the Firewall Filtering policy rule applies
- validity
End NumberTime - If
enforceTimeValidity
is set to true, the URL Filtering rule will cease to be valid on this end date and time. - validity
Start NumberTime - If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
- validity
Time StringZone Id - If
enforceTimeValidity
is set to true, the URL Filtering rule date and time will be valid based on this time zone ID. - workload
Groups List<Property Map> - The list of preconfigured workload groups to which the policy must be applied
Supporting Types
URLFilteringRulesCbiProfile, URLFilteringRulesCbiProfileArgs
URLFilteringRulesDepartments, URLFilteringRulesDepartmentsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesDeviceGroups, URLFilteringRulesDeviceGroupsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesDevices, URLFilteringRulesDevicesArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesGroups, URLFilteringRulesGroupsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesLabels, URLFilteringRulesLabelsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesLocationGroups, URLFilteringRulesLocationGroupsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesLocations, URLFilteringRulesLocationsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesOverrideGroups, URLFilteringRulesOverrideGroupsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesOverrideUsers, URLFilteringRulesOverrideUsersArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesTimeWindows, URLFilteringRulesTimeWindowsArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesUsers, URLFilteringRulesUsersArgs
- Ids List<int>
- A unique identifier assigned to the workload group
- Ids []int
- A unique identifier assigned to the workload group
- ids List<Integer>
- A unique identifier assigned to the workload group
- ids number[]
- A unique identifier assigned to the workload group
- ids Sequence[int]
- A unique identifier assigned to the workload group
- ids List<Number>
- A unique identifier assigned to the workload group
URLFilteringRulesWorkloadGroup, URLFilteringRulesWorkloadGroupArgs
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>
or
$ pulumi import zia:index/uRLFilteringRules:URLFilteringRules example <rule_name>
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.