FirewallDnsRule
Firewall Dns Rule resource for Zscaler Internet Access.
Resource operations
This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments.
Quick Start
import zssdk
import logging
# Enable debug logging for FirewallDnsRule
logging.getLogger('zssdk.zia').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)
session = zssdk.Session(
vanity_domain="your-vanity-domain",
client_id="your-client-id",
client_secret="your-client-secret",
)
# Get a specific FirewallDnsRule
resource = session.zia.FirewallDnsRule(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
create()
Creates a new FirewallDnsRule. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | Yes | - |
application_groups | EntityReferenceWrapperCollection | No | - |
applications | ApplicationsEnumCollection | No | - |
block_response_code | string | No | - |
capture_PCAP | boolean | No | - |
default_dns_rule_name_used | boolean | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dns_gateway | EntityReference | No | - |
dns_rule_request_types | DnsRuleRequestTypesEnumCollection | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
edns_ecs_object | EntityReference | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | ThreatLevelEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
eun_template_id | integer | No | - |
exclude_context_shield_end_point | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
is_eun_enabled | boolean | Yes | - |
is_web_EUN_enabled | boolean | Yes | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
order | integer | No | - |
packet_capture_flag | string | No | - |
predefined | boolean | No | - |
protocols | ProtocolsEnumCollection | No | - |
rank | integer | No | - |
redirect_ip | string | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
zpa_ip_group | EntityReference | No | - |
Returns: FirewallDnsRule
Example:
resource = session.zia.FirewallDnsRule()
resource.action = "value"
resource.is_eun_enabled = True
resource.is_web_EUN_enabled = True
resource.name = "example-name"
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a FirewallDnsRule by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.FirewallDnsRule(id="your-resource-id")
resource.delete()
load()
Fetches an existing FirewallDnsRule by id. Only the id identifier is required; load() takes no other arguments.
Returns: FirewallDnsRule
Example:
resource = session.zia.FirewallDnsRule(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing FirewallDnsRule. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | Yes | - |
application_groups | EntityReferenceWrapperCollection | No | - |
applications | ApplicationsEnumCollection | No | - |
block_response_code | string | No | - |
capture_PCAP | boolean | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dns_gateway | EntityReference | No | - |
dns_rule_request_types | DnsRuleRequestTypesEnumCollection | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
edns_ecs_object | EntityReference | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | ThreatLevelEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
eun_template_id | integer | No | - |
exclude_context_shield_end_point | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
is_eun_enabled | boolean | Yes | - |
is_web_EUN_enabled | boolean | Yes | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
order | integer | No | - |
packet_capture_flag | string | No | - |
predefined | boolean | No | - |
protocols | ProtocolsEnumCollection | No | - |
rank | integer | No | - |
redirect_ip | string | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
zpa_ip_group | EntityReference | No | - |
Returns: FirewallDnsRule
Example:
resource = session.zia.FirewallDnsRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | Yes | - |
application_groups | EntityReferenceWrapperCollection | No | - |
applications | ApplicationsEnumCollection | No | - |
block_response_code | string | No | - |
capture_PCAP | boolean | No | - |
default_dns_rule_name_used | boolean | No | - |
default_rule | boolean | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dest_addresses | stringCollection | No | - |
dest_countries | DestCountriesEnumCollection | No | - |
dest_ip_categories | stringCollection | No | - |
dest_ip_groups | EntityReferenceWrapperCollection | No | - |
dest_ipv6_groups | EntityReferenceWrapperCollection | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dns_gateway | EntityReference | No | - |
dns_rule_request_types | DnsRuleRequestTypesEnumCollection | No | - |
ec_groups | EntityReferenceWrapperCollection | No | - |
edns_ecs_object | EntityReference | No | - |
end_point_application_groups | EndPointApplicationGroupWrapperCollection | No | - |
end_point_application_threat_levels | ThreatLevelEnumCollection | No | - |
end_point_applications | EndPointApplicationLiteWrapperCollection | No | - |
eun_template_id | integer | No | - |
exclude_context_shield_end_point | boolean | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | Yes | - |
is_eun_enabled | boolean | Yes | - |
is_web_EUN_enabled | boolean | Yes | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
location_groups | EntityReferenceWrapperCollection | No | - |
locations | EntityReferenceWrapperCollection | No | - |
name | string | Yes | - |
order | integer | No | - |
packet_capture_flag | string | No | - |
predefined | boolean | No | - |
protocols | ProtocolsEnumCollection | No | - |
rank | integer | No | - |
redirect_ip | string | No | - |
res_categories | stringCollection | No | - |
source_countries | DestCountriesEnumCollection | No | - |
src_ip_groups | EntityReferenceWrapperCollection | No | - |
src_ips | stringCollection | No | - |
src_ipv6_groups | EntityReferenceWrapperCollection | No | - |
state | string | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
zpa_ip_group | EntityReference | No | - |
Related
- FirewallDnsRule - Data structure definition
- Logging guide - enable verbose logs while debugging this resource