code
stringlengths 501
5.19M
| package
stringlengths 2
81
| path
stringlengths 9
304
| filename
stringlengths 4
145
|
|---|---|---|---|
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'FirewallFilteringNetworkServicesDestTcpPortArgs',
'FirewallFilteringNetworkServicesDestUdpPortArgs',
'FirewallFilteringNetworkServicesSrcTcpPortArgs',
'FirewallFilteringNetworkServicesSrcUdpPortArgs',
'FirewallFilteringRuleAppServiceGroupsArgs',
'FirewallFilteringRuleAppServicesArgs',
'FirewallFilteringRuleDepartmentsArgs',
'FirewallFilteringRuleDestIpGroupsArgs',
'FirewallFilteringRuleGroupsArgs',
'FirewallFilteringRuleLabelsArgs',
'FirewallFilteringRuleLastModifiedByArgs',
'FirewallFilteringRuleLocationGroupsArgs',
'FirewallFilteringRuleLocationsArgs',
'FirewallFilteringRuleNwApplicationGroupsArgs',
'FirewallFilteringRuleNwServiceGroupsArgs',
'FirewallFilteringRuleNwServicesArgs',
'FirewallFilteringRuleSrcIpGroupsArgs',
'FirewallFilteringRuleTimeWindowsArgs',
'FirewallFilteringRuleUsersArgs',
'FirewallFilteringServiceGroupsServiceArgs',
]
@pulumi.input_type
class FirewallFilteringNetworkServicesDestTcpPortArgs:
def __init__(__self__, *,
end: Optional[pulumi.Input[int]] = None,
start: Optional[pulumi.Input[int]] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "end")
@end.setter
def end(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "end", value)
@property
@pulumi.getter
def start(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "start")
@start.setter
def start(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "start", value)
@pulumi.input_type
class FirewallFilteringNetworkServicesDestUdpPortArgs:
def __init__(__self__, *,
end: Optional[pulumi.Input[int]] = None,
start: Optional[pulumi.Input[int]] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "end")
@end.setter
def end(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "end", value)
@property
@pulumi.getter
def start(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "start")
@start.setter
def start(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "start", value)
@pulumi.input_type
class FirewallFilteringNetworkServicesSrcTcpPortArgs:
def __init__(__self__, *,
end: Optional[pulumi.Input[int]] = None,
start: Optional[pulumi.Input[int]] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "end")
@end.setter
def end(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "end", value)
@property
@pulumi.getter
def start(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "start")
@start.setter
def start(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "start", value)
@pulumi.input_type
class FirewallFilteringNetworkServicesSrcUdpPortArgs:
def __init__(__self__, *,
end: Optional[pulumi.Input[int]] = None,
start: Optional[pulumi.Input[int]] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "end")
@end.setter
def end(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "end", value)
@property
@pulumi.getter
def start(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "start")
@start.setter
def start(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "start", value)
@pulumi.input_type
class FirewallFilteringRuleAppServiceGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleAppServicesArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleDepartmentsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleDestIpGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleLabelsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleLastModifiedByArgs:
def __init__(__self__, *,
extensions: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[int]] = None):
"""
:param pulumi.Input[int] id: Identifier that uniquely identifies an entity
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
@property
@pulumi.getter
def extensions(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@pulumi.input_type
class FirewallFilteringRuleLocationGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleLocationsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleNwApplicationGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleNwServiceGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleNwServicesArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleSrcIpGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleTimeWindowsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringRuleUsersArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class FirewallFilteringServiceGroupsServiceArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['FirewallFilteringServiceGroupsArgs', 'FirewallFilteringServiceGroups']
@pulumi.input_type
class FirewallFilteringServiceGroupsArgs:
def __init__(__self__, *,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
services: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]]] = None):
"""
The set of arguments for constructing a FirewallFilteringServiceGroups resource.
:param pulumi.Input[str] description: Description of the network services group
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]] services: Any number of network services ID to be added to the group
"""
if description is not None:
pulumi.set(__self__, "description", description)
if name is not None:
pulumi.set(__self__, "name", name)
if services is not None:
pulumi.set(__self__, "services", services)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the network services group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the network service group
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def services(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]]]:
"""
Any number of network services ID to be added to the group
"""
return pulumi.get(self, "services")
@services.setter
def services(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]]]):
pulumi.set(self, "services", value)
@pulumi.input_type
class _FirewallFilteringServiceGroupsState:
def __init__(__self__, *,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
network_service_group_id: Optional[pulumi.Input[int]] = None,
services: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]]] = None):
"""
Input properties used for looking up and filtering FirewallFilteringServiceGroups resources.
:param pulumi.Input[str] description: Description of the network services group
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]] services: Any number of network services ID to be added to the group
"""
if description is not None:
pulumi.set(__self__, "description", description)
if name is not None:
pulumi.set(__self__, "name", name)
if network_service_group_id is not None:
pulumi.set(__self__, "network_service_group_id", network_service_group_id)
if services is not None:
pulumi.set(__self__, "services", services)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the network services group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the network service group
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="networkServiceGroupId")
def network_service_group_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "network_service_group_id")
@network_service_group_id.setter
def network_service_group_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "network_service_group_id", value)
@property
@pulumi.getter
def services(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]]]:
"""
Any number of network services ID to be added to the group
"""
return pulumi.get(self, "services")
@services.setter
def services(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringServiceGroupsServiceArgs']]]]):
pulumi.set(self, "services", value)
class FirewallFilteringServiceGroups(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
services: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringServiceGroupsServiceArgs']]]]] = None,
__props__=None):
"""
The **zia_firewall_filtering_network_service_groups** resource allows the creation and management of ZIA Cloud Firewall IP network service groups in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
import zscaler_pulumi_zia as zia
example1 = zia.Firewall.get_firewall_filtering_network_services(name="FTP")
example2 = zia.Firewall.get_firewall_filtering_network_services(name="NETBIOS")
example3 = zia.Firewall.get_firewall_filtering_network_services(name="DNS")
# Add network services to a network services group
example = zia.firewall.FirewallFilteringServiceGroups("example",
description="example",
services=[zia.firewall.FirewallFilteringServiceGroupsServiceArgs(
ids=[
example1.id,
example2.id,
example3.id,
],
)])
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the network services group
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringServiceGroupsServiceArgs']]]] services: Any number of network services ID to be added to the group
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[FirewallFilteringServiceGroupsArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_firewall_filtering_network_service_groups** resource allows the creation and management of ZIA Cloud Firewall IP network service groups in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
import zscaler_pulumi_zia as zia
example1 = zia.Firewall.get_firewall_filtering_network_services(name="FTP")
example2 = zia.Firewall.get_firewall_filtering_network_services(name="NETBIOS")
example3 = zia.Firewall.get_firewall_filtering_network_services(name="DNS")
# Add network services to a network services group
example = zia.firewall.FirewallFilteringServiceGroups("example",
description="example",
services=[zia.firewall.FirewallFilteringServiceGroupsServiceArgs(
ids=[
example1.id,
example2.id,
example3.id,
],
)])
```
:param str resource_name: The name of the resource.
:param FirewallFilteringServiceGroupsArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(FirewallFilteringServiceGroupsArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
services: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringServiceGroupsServiceArgs']]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = FirewallFilteringServiceGroupsArgs.__new__(FirewallFilteringServiceGroupsArgs)
__props__.__dict__["description"] = description
__props__.__dict__["name"] = name
__props__.__dict__["services"] = services
__props__.__dict__["network_service_group_id"] = None
super(FirewallFilteringServiceGroups, __self__).__init__(
'zia:Firewall/firewallFilteringServiceGroups:FirewallFilteringServiceGroups',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
network_service_group_id: Optional[pulumi.Input[int]] = None,
services: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringServiceGroupsServiceArgs']]]]] = None) -> 'FirewallFilteringServiceGroups':
"""
Get an existing FirewallFilteringServiceGroups resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the network services group
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringServiceGroupsServiceArgs']]]] services: Any number of network services ID to be added to the group
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _FirewallFilteringServiceGroupsState.__new__(_FirewallFilteringServiceGroupsState)
__props__.__dict__["description"] = description
__props__.__dict__["name"] = name
__props__.__dict__["network_service_group_id"] = network_service_group_id
__props__.__dict__["services"] = services
return FirewallFilteringServiceGroups(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Description of the network services group
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the network service group
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="networkServiceGroupId")
def network_service_group_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "network_service_group_id")
@property
@pulumi.getter
def services(self) -> pulumi.Output[Sequence['outputs.FirewallFilteringServiceGroupsService']]:
"""
Any number of network services ID to be added to the group
"""
return pulumi.get(self, "services") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/firewall_filtering_service_groups.py | firewall_filtering_service_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetFirewallFilteringNetworkServiceGroupsResult',
'AwaitableGetFirewallFilteringNetworkServiceGroupsResult',
'get_firewall_filtering_network_service_groups',
'get_firewall_filtering_network_service_groups_output',
]
@pulumi.output_type
class GetFirewallFilteringNetworkServiceGroupsResult:
"""
A collection of values returned by getFirewallFilteringNetworkServiceGroups.
"""
def __init__(__self__, description=None, id=None, name=None, services=None):
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if services and not isinstance(services, list):
raise TypeError("Expected argument 'services' to be a list")
pulumi.set(__self__, "services", services)
@property
@pulumi.getter
def description(self) -> str:
"""
(String)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
(String)
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def services(self) -> Sequence['outputs.GetFirewallFilteringNetworkServiceGroupsServiceResult']:
"""
(Number) The ID of this resource.
"""
return pulumi.get(self, "services")
class AwaitableGetFirewallFilteringNetworkServiceGroupsResult(GetFirewallFilteringNetworkServiceGroupsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetFirewallFilteringNetworkServiceGroupsResult(
description=self.description,
id=self.id,
name=self.name,
services=self.services)
def get_firewall_filtering_network_service_groups(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFirewallFilteringNetworkServiceGroupsResult:
"""
Use the **zia_firewall_filtering_network_service_groups** data source to get information about a network service groups available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network service rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_network_service_groups(name="Corporate Custom SSH TCP_10022")
```
:param int id: The ID of the ip source group to be exported.
:param str name: The name of the ip source group to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Firewall/getFirewallFilteringNetworkServiceGroups:getFirewallFilteringNetworkServiceGroups', __args__, opts=opts, typ=GetFirewallFilteringNetworkServiceGroupsResult).value
return AwaitableGetFirewallFilteringNetworkServiceGroupsResult(
description=__ret__.description,
id=__ret__.id,
name=__ret__.name,
services=__ret__.services)
@_utilities.lift_output_func(get_firewall_filtering_network_service_groups)
def get_firewall_filtering_network_service_groups_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFirewallFilteringNetworkServiceGroupsResult]:
"""
Use the **zia_firewall_filtering_network_service_groups** data source to get information about a network service groups available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network service rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_network_service_groups(name="Corporate Custom SSH TCP_10022")
```
:param int id: The ID of the ip source group to be exported.
:param str name: The name of the ip source group to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/get_firewall_filtering_network_service_groups.py | get_firewall_filtering_network_service_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetFirewallFilteringApplicationResult',
'AwaitableGetFirewallFilteringApplicationResult',
'get_firewall_filtering_application',
'get_firewall_filtering_application_output',
]
@pulumi.output_type
class GetFirewallFilteringApplicationResult:
"""
A collection of values returned by getFirewallFilteringApplication.
"""
def __init__(__self__, deprecated=None, description=None, id=None, locale=None, parent_category=None):
if deprecated and not isinstance(deprecated, bool):
raise TypeError("Expected argument 'deprecated' to be a bool")
pulumi.set(__self__, "deprecated", deprecated)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if locale and not isinstance(locale, str):
raise TypeError("Expected argument 'locale' to be a str")
pulumi.set(__self__, "locale", locale)
if parent_category and not isinstance(parent_category, str):
raise TypeError("Expected argument 'parent_category' to be a str")
pulumi.set(__self__, "parent_category", parent_category)
@property
@pulumi.getter
def deprecated(self) -> bool:
"""
(Boolean)
"""
return pulumi.get(self, "deprecated")
@property
@pulumi.getter
def description(self) -> str:
"""
(String)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter
def locale(self) -> Optional[str]:
return pulumi.get(self, "locale")
@property
@pulumi.getter(name="parentCategory")
def parent_category(self) -> str:
"""
(String)
"""
return pulumi.get(self, "parent_category")
class AwaitableGetFirewallFilteringApplicationResult(GetFirewallFilteringApplicationResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetFirewallFilteringApplicationResult(
deprecated=self.deprecated,
description=self.description,
id=self.id,
locale=self.locale,
parent_category=self.parent_category)
def get_firewall_filtering_application(id: Optional[str] = None,
locale: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFirewallFilteringApplicationResult:
"""
Use the **zia_firewall_filtering_network_application** data source to get information about a network application available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network application rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
apns = zia.Firewall.get_firewall_filtering_application(id="APNS",
locale="en-US")
```
```python
import pulumi
import pulumi_zia as zia
dict = zia.Firewall.get_firewall_filtering_application(id="DICT")
```
:param str id: The name of the ip source group to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['locale'] = locale
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Firewall/getFirewallFilteringApplication:getFirewallFilteringApplication', __args__, opts=opts, typ=GetFirewallFilteringApplicationResult).value
return AwaitableGetFirewallFilteringApplicationResult(
deprecated=__ret__.deprecated,
description=__ret__.description,
id=__ret__.id,
locale=__ret__.locale,
parent_category=__ret__.parent_category)
@_utilities.lift_output_func(get_firewall_filtering_application)
def get_firewall_filtering_application_output(id: Optional[pulumi.Input[Optional[str]]] = None,
locale: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFirewallFilteringApplicationResult]:
"""
Use the **zia_firewall_filtering_network_application** data source to get information about a network application available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network application rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
apns = zia.Firewall.get_firewall_filtering_application(id="APNS",
locale="en-US")
```
```python
import pulumi
import pulumi_zia as zia
dict = zia.Firewall.get_firewall_filtering_application(id="DICT")
```
:param str id: The name of the ip source group to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/get_firewall_filtering_application.py | get_firewall_filtering_application.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = ['FirewallFilteringApplicationGroupsArgs', 'FirewallFilteringApplicationGroups']
@pulumi.input_type
class FirewallFilteringApplicationGroupsArgs:
def __init__(__self__, *,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
network_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
The set of arguments for constructing a FirewallFilteringApplicationGroups resource.
:param pulumi.Input[str] description: Description of the network application group
:param pulumi.Input[str] name: Network application group name
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_applications: Any number of applications to be added to the group
* Refer to the Zscaler API Swagger for the complete list of applications [ZIA API Guide](https://help.zscaler.com/zia/firewall-policies#/networkApplicationGroups-get)
"""
if description is not None:
pulumi.set(__self__, "description", description)
if name is not None:
pulumi.set(__self__, "name", name)
if network_applications is not None:
pulumi.set(__self__, "network_applications", network_applications)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the network application group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Network application group name
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="networkApplications")
def network_applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Any number of applications to be added to the group
* Refer to the Zscaler API Swagger for the complete list of applications [ZIA API Guide](https://help.zscaler.com/zia/firewall-policies#/networkApplicationGroups-get)
"""
return pulumi.get(self, "network_applications")
@network_applications.setter
def network_applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "network_applications", value)
@pulumi.input_type
class _FirewallFilteringApplicationGroupsState:
def __init__(__self__, *,
app_id: Optional[pulumi.Input[int]] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
network_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
Input properties used for looking up and filtering FirewallFilteringApplicationGroups resources.
:param pulumi.Input[str] description: Description of the network application group
:param pulumi.Input[str] name: Network application group name
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_applications: Any number of applications to be added to the group
* Refer to the Zscaler API Swagger for the complete list of applications [ZIA API Guide](https://help.zscaler.com/zia/firewall-policies#/networkApplicationGroups-get)
"""
if app_id is not None:
pulumi.set(__self__, "app_id", app_id)
if description is not None:
pulumi.set(__self__, "description", description)
if name is not None:
pulumi.set(__self__, "name", name)
if network_applications is not None:
pulumi.set(__self__, "network_applications", network_applications)
@property
@pulumi.getter(name="appId")
def app_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "app_id")
@app_id.setter
def app_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "app_id", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the network application group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Network application group name
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="networkApplications")
def network_applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Any number of applications to be added to the group
* Refer to the Zscaler API Swagger for the complete list of applications [ZIA API Guide](https://help.zscaler.com/zia/firewall-policies#/networkApplicationGroups-get)
"""
return pulumi.get(self, "network_applications")
@network_applications.setter
def network_applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "network_applications", value)
class FirewallFilteringApplicationGroups(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
network_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
"""
The **zia_firewall_filtering_network_application_groups** resource allows the creation and management of ZIA Cloud Firewall IP source groups in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add applications to a network application group
example = zia.firewall.FirewallFilteringApplicationGroups("example",
description="Example",
network_applications=[
"LDAP",
"LDAPS",
"SRVLOC",
])
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the network application group
:param pulumi.Input[str] name: Network application group name
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_applications: Any number of applications to be added to the group
* Refer to the Zscaler API Swagger for the complete list of applications [ZIA API Guide](https://help.zscaler.com/zia/firewall-policies#/networkApplicationGroups-get)
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[FirewallFilteringApplicationGroupsArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_firewall_filtering_network_application_groups** resource allows the creation and management of ZIA Cloud Firewall IP source groups in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add applications to a network application group
example = zia.firewall.FirewallFilteringApplicationGroups("example",
description="Example",
network_applications=[
"LDAP",
"LDAPS",
"SRVLOC",
])
```
:param str resource_name: The name of the resource.
:param FirewallFilteringApplicationGroupsArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(FirewallFilteringApplicationGroupsArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
network_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = FirewallFilteringApplicationGroupsArgs.__new__(FirewallFilteringApplicationGroupsArgs)
__props__.__dict__["description"] = description
__props__.__dict__["name"] = name
__props__.__dict__["network_applications"] = network_applications
__props__.__dict__["app_id"] = None
super(FirewallFilteringApplicationGroups, __self__).__init__(
'zia:Firewall/firewallFilteringApplicationGroups:FirewallFilteringApplicationGroups',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
app_id: Optional[pulumi.Input[int]] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
network_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'FirewallFilteringApplicationGroups':
"""
Get an existing FirewallFilteringApplicationGroups resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the network application group
:param pulumi.Input[str] name: Network application group name
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_applications: Any number of applications to be added to the group
* Refer to the Zscaler API Swagger for the complete list of applications [ZIA API Guide](https://help.zscaler.com/zia/firewall-policies#/networkApplicationGroups-get)
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _FirewallFilteringApplicationGroupsState.__new__(_FirewallFilteringApplicationGroupsState)
__props__.__dict__["app_id"] = app_id
__props__.__dict__["description"] = description
__props__.__dict__["name"] = name
__props__.__dict__["network_applications"] = network_applications
return FirewallFilteringApplicationGroups(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="appId")
def app_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "app_id")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Description of the network application group
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Network application group name
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="networkApplications")
def network_applications(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
Any number of applications to be added to the group
* Refer to the Zscaler API Swagger for the complete list of applications [ZIA API Guide](https://help.zscaler.com/zia/firewall-policies#/networkApplicationGroups-get)
"""
return pulumi.get(self, "network_applications") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/firewall_filtering_application_groups.py | firewall_filtering_application_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetFirewallFilteringApplicationGroupsResult',
'AwaitableGetFirewallFilteringApplicationGroupsResult',
'get_firewall_filtering_application_groups',
'get_firewall_filtering_application_groups_output',
]
@pulumi.output_type
class GetFirewallFilteringApplicationGroupsResult:
"""
A collection of values returned by getFirewallFilteringApplicationGroups.
"""
def __init__(__self__, description=None, id=None, name=None, network_applications=None):
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if network_applications and not isinstance(network_applications, list):
raise TypeError("Expected argument 'network_applications' to be a list")
pulumi.set(__self__, "network_applications", network_applications)
@property
@pulumi.getter
def description(self) -> str:
"""
(String)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of this resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="networkApplications")
def network_applications(self) -> Sequence[str]:
"""
(List of String)
"""
return pulumi.get(self, "network_applications")
class AwaitableGetFirewallFilteringApplicationGroupsResult(GetFirewallFilteringApplicationGroupsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetFirewallFilteringApplicationGroupsResult(
description=self.description,
id=self.id,
name=self.name,
network_applications=self.network_applications)
def get_firewall_filtering_application_groups(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFirewallFilteringApplicationGroupsResult:
"""
Use the **zia_firewall_filtering_network_application_groups** data source to get information about a network application group available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network application rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_application_groups(name="example")
```
:param int id: The ID of the ip source group resource.
:param str name: The name of the ip source group to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Firewall/getFirewallFilteringApplicationGroups:getFirewallFilteringApplicationGroups', __args__, opts=opts, typ=GetFirewallFilteringApplicationGroupsResult).value
return AwaitableGetFirewallFilteringApplicationGroupsResult(
description=__ret__.description,
id=__ret__.id,
name=__ret__.name,
network_applications=__ret__.network_applications)
@_utilities.lift_output_func(get_firewall_filtering_application_groups)
def get_firewall_filtering_application_groups_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFirewallFilteringApplicationGroupsResult]:
"""
Use the **zia_firewall_filtering_network_application_groups** data source to get information about a network application group available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network application rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_application_groups(name="example")
```
:param int id: The ID of the ip source group resource.
:param str name: The name of the ip source group to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/get_firewall_filtering_application_groups.py | get_firewall_filtering_application_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'FirewallFilteringNetworkServicesDestTcpPort',
'FirewallFilteringNetworkServicesDestUdpPort',
'FirewallFilteringNetworkServicesSrcTcpPort',
'FirewallFilteringNetworkServicesSrcUdpPort',
'FirewallFilteringRuleAppServiceGroups',
'FirewallFilteringRuleAppServices',
'FirewallFilteringRuleDepartments',
'FirewallFilteringRuleDestIpGroups',
'FirewallFilteringRuleGroups',
'FirewallFilteringRuleLabels',
'FirewallFilteringRuleLastModifiedBy',
'FirewallFilteringRuleLocationGroups',
'FirewallFilteringRuleLocations',
'FirewallFilteringRuleNwApplicationGroups',
'FirewallFilteringRuleNwServiceGroups',
'FirewallFilteringRuleNwServices',
'FirewallFilteringRuleSrcIpGroups',
'FirewallFilteringRuleTimeWindows',
'FirewallFilteringRuleUsers',
'FirewallFilteringServiceGroupsService',
'GetFirewallFilteringNetworkServiceGroupsServiceResult',
'GetFirewallFilteringNetworkServicesDestTcpPortResult',
'GetFirewallFilteringNetworkServicesDestUdpPortResult',
'GetFirewallFilteringNetworkServicesSrcTcpPortResult',
'GetFirewallFilteringNetworkServicesSrcUdpPortResult',
'GetFirewallFilteringRuleAppServiceResult',
'GetFirewallFilteringRuleAppServiceGroupResult',
'GetFirewallFilteringRuleDepartmentResult',
'GetFirewallFilteringRuleGroupResult',
'GetFirewallFilteringRuleLabelResult',
'GetFirewallFilteringRuleLastModifiedByResult',
'GetFirewallFilteringRuleLocationResult',
'GetFirewallFilteringRuleLocationGroupResult',
'GetFirewallFilteringRuleNwApplicationGroupResult',
'GetFirewallFilteringRuleNwServiceResult',
'GetFirewallFilteringRuleNwServiceGroupResult',
'GetFirewallFilteringRuleTimeWindowResult',
'GetFirewallFilteringRuleUserResult',
]
@pulumi.output_type
class FirewallFilteringNetworkServicesDestTcpPort(dict):
def __init__(__self__, *,
end: Optional[int] = None,
start: Optional[int] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[int]:
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> Optional[int]:
return pulumi.get(self, "start")
@pulumi.output_type
class FirewallFilteringNetworkServicesDestUdpPort(dict):
def __init__(__self__, *,
end: Optional[int] = None,
start: Optional[int] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[int]:
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> Optional[int]:
return pulumi.get(self, "start")
@pulumi.output_type
class FirewallFilteringNetworkServicesSrcTcpPort(dict):
def __init__(__self__, *,
end: Optional[int] = None,
start: Optional[int] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[int]:
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> Optional[int]:
return pulumi.get(self, "start")
@pulumi.output_type
class FirewallFilteringNetworkServicesSrcUdpPort(dict):
def __init__(__self__, *,
end: Optional[int] = None,
start: Optional[int] = None):
if end is not None:
pulumi.set(__self__, "end", end)
if start is not None:
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> Optional[int]:
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> Optional[int]:
return pulumi.get(self, "start")
@pulumi.output_type
class FirewallFilteringRuleAppServiceGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleAppServices(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleDepartments(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleDestIpGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleLabels(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleLastModifiedBy(dict):
def __init__(__self__, *,
extensions: Optional[Mapping[str, str]] = None,
id: Optional[int] = None):
"""
:param int id: Identifier that uniquely identifies an entity
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
@property
@pulumi.getter
def extensions(self) -> Optional[Mapping[str, str]]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@pulumi.output_type
class FirewallFilteringRuleLocationGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleLocations(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleNwApplicationGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleNwServiceGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleNwServices(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleSrcIpGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleTimeWindows(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringRuleUsers(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class FirewallFilteringServiceGroupsService(dict):
def __init__(__self__, *,
ids: Sequence[int]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
return pulumi.get(self, "ids")
@pulumi.output_type
class GetFirewallFilteringNetworkServiceGroupsServiceResult(dict):
def __init__(__self__, *,
description: str,
id: int,
is_name_l10n_tag: bool,
name: Optional[str] = None):
"""
:param str description: (String)
:param int id: The ID of the ip source group to be exported.
:param bool is_name_l10n_tag: (Bool) - Default: false
:param str name: The name of the ip source group to be exported.
"""
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "is_name_l10n_tag", is_name_l10n_tag)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def description(self) -> str:
"""
(String)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of the ip source group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="isNameL10nTag")
def is_name_l10n_tag(self) -> bool:
"""
(Bool) - Default: false
"""
return pulumi.get(self, "is_name_l10n_tag")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
The name of the ip source group to be exported.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringNetworkServicesDestTcpPortResult(dict):
def __init__(__self__, *,
end: int,
start: int):
"""
:param int end: (Number)
:param int start: (Number)
"""
pulumi.set(__self__, "end", end)
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "start")
@pulumi.output_type
class GetFirewallFilteringNetworkServicesDestUdpPortResult(dict):
def __init__(__self__, *,
end: int,
start: int):
"""
:param int end: (Number)
:param int start: (Number)
"""
pulumi.set(__self__, "end", end)
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "start")
@pulumi.output_type
class GetFirewallFilteringNetworkServicesSrcTcpPortResult(dict):
def __init__(__self__, *,
end: int,
start: int):
"""
:param int end: (Number)
:param int start: (Number)
"""
pulumi.set(__self__, "end", end)
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "start")
@pulumi.output_type
class GetFirewallFilteringNetworkServicesSrcUdpPortResult(dict):
def __init__(__self__, *,
end: int,
start: int):
"""
:param int end: (Number)
:param int start: (Number)
"""
pulumi.set(__self__, "end", end)
pulumi.set(__self__, "start", start)
@property
@pulumi.getter
def end(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "end")
@property
@pulumi.getter
def start(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "start")
@pulumi.output_type
class GetFirewallFilteringRuleAppServiceResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleAppServiceGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleDepartmentResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleLabelResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleLastModifiedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleLocationResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleLocationGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleNwApplicationGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleNwServiceResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleNwServiceGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleTimeWindowResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetFirewallFilteringRuleUserResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the Firewall Filtering policy rule
:param str name: Name of the Firewall Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the Firewall Filtering policy rule
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['FirewallFilteringRuleArgs', 'FirewallFilteringRule']
@pulumi.input_type
class FirewallFilteringRuleArgs:
def __init__(__self__, *,
access_control: Optional[pulumi.Input[str]] = None,
action: Optional[pulumi.Input[str]] = None,
app_service_groups: Optional[pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs']] = None,
app_services: Optional[pulumi.Input['FirewallFilteringRuleAppServicesArgs']] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input['FirewallFilteringRuleDepartmentsArgs']] = None,
description: Optional[pulumi.Input[str]] = None,
dest_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_groups: Optional[pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs']] = None,
enable_full_logging: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input['FirewallFilteringRuleGroupsArgs']] = None,
labels: Optional[pulumi.Input['FirewallFilteringRuleLabelsArgs']] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringRuleLastModifiedByArgs']]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input['FirewallFilteringRuleLocationGroupsArgs']] = None,
locations: Optional[pulumi.Input['FirewallFilteringRuleLocationsArgs']] = None,
name: Optional[pulumi.Input[str]] = None,
nw_application_groups: Optional[pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs']] = None,
nw_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
nw_service_groups: Optional[pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs']] = None,
nw_services: Optional[pulumi.Input['FirewallFilteringRuleNwServicesArgs']] = None,
order: Optional[pulumi.Input[int]] = None,
predefined: Optional[pulumi.Input[bool]] = None,
rank: Optional[pulumi.Input[int]] = None,
src_ip_groups: Optional[pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs']] = None,
src_ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
state: Optional[pulumi.Input[str]] = None,
time_windows: Optional[pulumi.Input['FirewallFilteringRuleTimeWindowsArgs']] = None,
users: Optional[pulumi.Input['FirewallFilteringRuleUsersArgs']] = None):
"""
The set of arguments for constructing a FirewallFilteringRule resource.
:param pulumi.Input[str] action: Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
:param pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs'] app_service_groups: Application service groups on which this rule is applied
:param pulumi.Input['FirewallFilteringRuleAppServicesArgs'] app_services: Application services on which this rule is applied
:param pulumi.Input[bool] default_rule: If set to true, the default rule is applied
:param pulumi.Input['FirewallFilteringRuleDepartmentsArgs'] departments: Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
:param pulumi.Input[str] description: Enter additional notes or information. The description cannot exceed 10,240 characters.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_addresses: ** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_countries: ** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_ip_categories: ** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
:param pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs'] dest_ip_groups: ** - (Optional) Any number of destination IP address groups that you want to control with this rule.
:param pulumi.Input['FirewallFilteringRuleGroupsArgs'] groups: You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input['FirewallFilteringRuleLabelsArgs'] labels: Labels that are applicable to the rule.
:param pulumi.Input['FirewallFilteringRuleLocationGroupsArgs'] location_groups: You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
:param pulumi.Input['FirewallFilteringRuleLocationsArgs'] locations: You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs'] nw_application_groups: Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
:param pulumi.Input[Sequence[pulumi.Input[str]]] nw_applications: When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
:param pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs'] nw_service_groups: Any number of predefined or custom network service groups to which the rule applies.
:param pulumi.Input['FirewallFilteringRuleNwServicesArgs'] nw_services: When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
:param pulumi.Input[int] order: Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
:param pulumi.Input[bool] predefined: If set to true, a predefined rule is applied
:param pulumi.Input[int] rank: By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
:param pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs'] src_ip_groups: Any number of source IP address groups that you want to control with this rule.
:param pulumi.Input[Sequence[pulumi.Input[str]]] src_ips: You can enter individual IP addresses, subnets, or address ranges.
:param pulumi.Input[str] state: An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
:param pulumi.Input['FirewallFilteringRuleTimeWindowsArgs'] time_windows: You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
:param pulumi.Input['FirewallFilteringRuleUsersArgs'] users: You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
if access_control is not None:
pulumi.set(__self__, "access_control", access_control)
if action is not None:
pulumi.set(__self__, "action", action)
if app_service_groups is not None:
pulumi.set(__self__, "app_service_groups", app_service_groups)
if app_services is not None:
pulumi.set(__self__, "app_services", app_services)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if departments is not None:
pulumi.set(__self__, "departments", departments)
if description is not None:
pulumi.set(__self__, "description", description)
if dest_addresses is not None:
pulumi.set(__self__, "dest_addresses", dest_addresses)
if dest_countries is not None:
pulumi.set(__self__, "dest_countries", dest_countries)
if dest_ip_categories is not None:
pulumi.set(__self__, "dest_ip_categories", dest_ip_categories)
if dest_ip_groups is not None:
pulumi.set(__self__, "dest_ip_groups", dest_ip_groups)
if enable_full_logging is not None:
pulumi.set(__self__, "enable_full_logging", enable_full_logging)
if groups is not None:
pulumi.set(__self__, "groups", groups)
if labels is not None:
pulumi.set(__self__, "labels", labels)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time is not None:
pulumi.set(__self__, "last_modified_time", last_modified_time)
if location_groups is not None:
pulumi.set(__self__, "location_groups", location_groups)
if locations is not None:
pulumi.set(__self__, "locations", locations)
if name is not None:
pulumi.set(__self__, "name", name)
if nw_application_groups is not None:
pulumi.set(__self__, "nw_application_groups", nw_application_groups)
if nw_applications is not None:
pulumi.set(__self__, "nw_applications", nw_applications)
if nw_service_groups is not None:
pulumi.set(__self__, "nw_service_groups", nw_service_groups)
if nw_services is not None:
pulumi.set(__self__, "nw_services", nw_services)
if order is not None:
pulumi.set(__self__, "order", order)
if predefined is not None:
pulumi.set(__self__, "predefined", predefined)
if rank is not None:
pulumi.set(__self__, "rank", rank)
if src_ip_groups is not None:
pulumi.set(__self__, "src_ip_groups", src_ip_groups)
if src_ips is not None:
pulumi.set(__self__, "src_ips", src_ips)
if state is not None:
pulumi.set(__self__, "state", state)
if time_windows is not None:
pulumi.set(__self__, "time_windows", time_windows)
if users is not None:
pulumi.set(__self__, "users", users)
@property
@pulumi.getter(name="accessControl")
def access_control(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "access_control")
@access_control.setter
def access_control(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "access_control", value)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="appServiceGroups")
def app_service_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs']]:
"""
Application service groups on which this rule is applied
"""
return pulumi.get(self, "app_service_groups")
@app_service_groups.setter
def app_service_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs']]):
pulumi.set(self, "app_service_groups", value)
@property
@pulumi.getter(name="appServices")
def app_services(self) -> Optional[pulumi.Input['FirewallFilteringRuleAppServicesArgs']]:
"""
Application services on which this rule is applied
"""
return pulumi.get(self, "app_services")
@app_services.setter
def app_services(self, value: Optional[pulumi.Input['FirewallFilteringRuleAppServicesArgs']]):
pulumi.set(self, "app_services", value)
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[pulumi.Input[bool]]:
"""
If set to true, the default rule is applied
"""
return pulumi.get(self, "default_rule")
@default_rule.setter
def default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "default_rule", value)
@property
@pulumi.getter
def departments(self) -> Optional[pulumi.Input['FirewallFilteringRuleDepartmentsArgs']]:
"""
Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
"""
return pulumi.get(self, "departments")
@departments.setter
def departments(self, value: Optional[pulumi.Input['FirewallFilteringRuleDepartmentsArgs']]):
pulumi.set(self, "departments", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Enter additional notes or information. The description cannot exceed 10,240 characters.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="destAddresses")
def dest_addresses(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
"""
return pulumi.get(self, "dest_addresses")
@dest_addresses.setter
def dest_addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "dest_addresses", value)
@property
@pulumi.getter(name="destCountries")
def dest_countries(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
"""
return pulumi.get(self, "dest_countries")
@dest_countries.setter
def dest_countries(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "dest_countries", value)
@property
@pulumi.getter(name="destIpCategories")
def dest_ip_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
"""
return pulumi.get(self, "dest_ip_categories")
@dest_ip_categories.setter
def dest_ip_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "dest_ip_categories", value)
@property
@pulumi.getter(name="destIpGroups")
def dest_ip_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs']]:
"""
** - (Optional) Any number of destination IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "dest_ip_groups")
@dest_ip_groups.setter
def dest_ip_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs']]):
pulumi.set(self, "dest_ip_groups", value)
@property
@pulumi.getter(name="enableFullLogging")
def enable_full_logging(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "enable_full_logging")
@enable_full_logging.setter
def enable_full_logging(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enable_full_logging", value)
@property
@pulumi.getter
def groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleGroupsArgs']]:
"""
You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "groups")
@groups.setter
def groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleGroupsArgs']]):
pulumi.set(self, "groups", value)
@property
@pulumi.getter
def labels(self) -> Optional[pulumi.Input['FirewallFilteringRuleLabelsArgs']]:
"""
Labels that are applicable to the rule.
"""
return pulumi.get(self, "labels")
@labels.setter
def labels(self, value: Optional[pulumi.Input['FirewallFilteringRuleLabelsArgs']]):
pulumi.set(self, "labels", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringRuleLastModifiedByArgs']]]]:
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringRuleLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "last_modified_time")
@last_modified_time.setter
def last_modified_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "last_modified_time", value)
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleLocationGroupsArgs']]:
"""
You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
"""
return pulumi.get(self, "location_groups")
@location_groups.setter
def location_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleLocationGroupsArgs']]):
pulumi.set(self, "location_groups", value)
@property
@pulumi.getter
def locations(self) -> Optional[pulumi.Input['FirewallFilteringRuleLocationsArgs']]:
"""
You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "locations")
@locations.setter
def locations(self, value: Optional[pulumi.Input['FirewallFilteringRuleLocationsArgs']]):
pulumi.set(self, "locations", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the network service group
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="nwApplicationGroups")
def nw_application_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs']]:
"""
Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
"""
return pulumi.get(self, "nw_application_groups")
@nw_application_groups.setter
def nw_application_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs']]):
pulumi.set(self, "nw_application_groups", value)
@property
@pulumi.getter(name="nwApplications")
def nw_applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
"""
return pulumi.get(self, "nw_applications")
@nw_applications.setter
def nw_applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "nw_applications", value)
@property
@pulumi.getter(name="nwServiceGroups")
def nw_service_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs']]:
"""
Any number of predefined or custom network service groups to which the rule applies.
"""
return pulumi.get(self, "nw_service_groups")
@nw_service_groups.setter
def nw_service_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs']]):
pulumi.set(self, "nw_service_groups", value)
@property
@pulumi.getter(name="nwServices")
def nw_services(self) -> Optional[pulumi.Input['FirewallFilteringRuleNwServicesArgs']]:
"""
When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
"""
return pulumi.get(self, "nw_services")
@nw_services.setter
def nw_services(self, value: Optional[pulumi.Input['FirewallFilteringRuleNwServicesArgs']]):
pulumi.set(self, "nw_services", value)
@property
@pulumi.getter
def order(self) -> Optional[pulumi.Input[int]]:
"""
Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
"""
return pulumi.get(self, "order")
@order.setter
def order(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "order", value)
@property
@pulumi.getter
def predefined(self) -> Optional[pulumi.Input[bool]]:
"""
If set to true, a predefined rule is applied
"""
return pulumi.get(self, "predefined")
@predefined.setter
def predefined(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "predefined", value)
@property
@pulumi.getter
def rank(self) -> Optional[pulumi.Input[int]]:
"""
By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
"""
return pulumi.get(self, "rank")
@rank.setter
def rank(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "rank", value)
@property
@pulumi.getter(name="srcIpGroups")
def src_ip_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs']]:
"""
Any number of source IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "src_ip_groups")
@src_ip_groups.setter
def src_ip_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs']]):
pulumi.set(self, "src_ip_groups", value)
@property
@pulumi.getter(name="srcIps")
def src_ips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
You can enter individual IP addresses, subnets, or address ranges.
"""
return pulumi.get(self, "src_ips")
@src_ips.setter
def src_ips(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "src_ips", value)
@property
@pulumi.getter
def state(self) -> Optional[pulumi.Input[str]]:
"""
An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
"""
return pulumi.get(self, "state")
@state.setter
def state(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "state", value)
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> Optional[pulumi.Input['FirewallFilteringRuleTimeWindowsArgs']]:
"""
You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
"""
return pulumi.get(self, "time_windows")
@time_windows.setter
def time_windows(self, value: Optional[pulumi.Input['FirewallFilteringRuleTimeWindowsArgs']]):
pulumi.set(self, "time_windows", value)
@property
@pulumi.getter
def users(self) -> Optional[pulumi.Input['FirewallFilteringRuleUsersArgs']]:
"""
You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
return pulumi.get(self, "users")
@users.setter
def users(self, value: Optional[pulumi.Input['FirewallFilteringRuleUsersArgs']]):
pulumi.set(self, "users", value)
@pulumi.input_type
class _FirewallFilteringRuleState:
def __init__(__self__, *,
access_control: Optional[pulumi.Input[str]] = None,
action: Optional[pulumi.Input[str]] = None,
app_service_groups: Optional[pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs']] = None,
app_services: Optional[pulumi.Input['FirewallFilteringRuleAppServicesArgs']] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input['FirewallFilteringRuleDepartmentsArgs']] = None,
description: Optional[pulumi.Input[str]] = None,
dest_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_groups: Optional[pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs']] = None,
enable_full_logging: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input['FirewallFilteringRuleGroupsArgs']] = None,
labels: Optional[pulumi.Input['FirewallFilteringRuleLabelsArgs']] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringRuleLastModifiedByArgs']]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input['FirewallFilteringRuleLocationGroupsArgs']] = None,
locations: Optional[pulumi.Input['FirewallFilteringRuleLocationsArgs']] = None,
name: Optional[pulumi.Input[str]] = None,
nw_application_groups: Optional[pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs']] = None,
nw_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
nw_service_groups: Optional[pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs']] = None,
nw_services: Optional[pulumi.Input['FirewallFilteringRuleNwServicesArgs']] = None,
order: Optional[pulumi.Input[int]] = None,
predefined: Optional[pulumi.Input[bool]] = None,
rank: Optional[pulumi.Input[int]] = None,
rule_id: Optional[pulumi.Input[int]] = None,
src_ip_groups: Optional[pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs']] = None,
src_ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
state: Optional[pulumi.Input[str]] = None,
time_windows: Optional[pulumi.Input['FirewallFilteringRuleTimeWindowsArgs']] = None,
users: Optional[pulumi.Input['FirewallFilteringRuleUsersArgs']] = None):
"""
Input properties used for looking up and filtering FirewallFilteringRule resources.
:param pulumi.Input[str] action: Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
:param pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs'] app_service_groups: Application service groups on which this rule is applied
:param pulumi.Input['FirewallFilteringRuleAppServicesArgs'] app_services: Application services on which this rule is applied
:param pulumi.Input[bool] default_rule: If set to true, the default rule is applied
:param pulumi.Input['FirewallFilteringRuleDepartmentsArgs'] departments: Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
:param pulumi.Input[str] description: Enter additional notes or information. The description cannot exceed 10,240 characters.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_addresses: ** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_countries: ** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_ip_categories: ** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
:param pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs'] dest_ip_groups: ** - (Optional) Any number of destination IP address groups that you want to control with this rule.
:param pulumi.Input['FirewallFilteringRuleGroupsArgs'] groups: You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input['FirewallFilteringRuleLabelsArgs'] labels: Labels that are applicable to the rule.
:param pulumi.Input['FirewallFilteringRuleLocationGroupsArgs'] location_groups: You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
:param pulumi.Input['FirewallFilteringRuleLocationsArgs'] locations: You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs'] nw_application_groups: Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
:param pulumi.Input[Sequence[pulumi.Input[str]]] nw_applications: When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
:param pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs'] nw_service_groups: Any number of predefined or custom network service groups to which the rule applies.
:param pulumi.Input['FirewallFilteringRuleNwServicesArgs'] nw_services: When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
:param pulumi.Input[int] order: Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
:param pulumi.Input[bool] predefined: If set to true, a predefined rule is applied
:param pulumi.Input[int] rank: By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
:param pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs'] src_ip_groups: Any number of source IP address groups that you want to control with this rule.
:param pulumi.Input[Sequence[pulumi.Input[str]]] src_ips: You can enter individual IP addresses, subnets, or address ranges.
:param pulumi.Input[str] state: An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
:param pulumi.Input['FirewallFilteringRuleTimeWindowsArgs'] time_windows: You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
:param pulumi.Input['FirewallFilteringRuleUsersArgs'] users: You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
if access_control is not None:
pulumi.set(__self__, "access_control", access_control)
if action is not None:
pulumi.set(__self__, "action", action)
if app_service_groups is not None:
pulumi.set(__self__, "app_service_groups", app_service_groups)
if app_services is not None:
pulumi.set(__self__, "app_services", app_services)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if departments is not None:
pulumi.set(__self__, "departments", departments)
if description is not None:
pulumi.set(__self__, "description", description)
if dest_addresses is not None:
pulumi.set(__self__, "dest_addresses", dest_addresses)
if dest_countries is not None:
pulumi.set(__self__, "dest_countries", dest_countries)
if dest_ip_categories is not None:
pulumi.set(__self__, "dest_ip_categories", dest_ip_categories)
if dest_ip_groups is not None:
pulumi.set(__self__, "dest_ip_groups", dest_ip_groups)
if enable_full_logging is not None:
pulumi.set(__self__, "enable_full_logging", enable_full_logging)
if groups is not None:
pulumi.set(__self__, "groups", groups)
if labels is not None:
pulumi.set(__self__, "labels", labels)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time is not None:
pulumi.set(__self__, "last_modified_time", last_modified_time)
if location_groups is not None:
pulumi.set(__self__, "location_groups", location_groups)
if locations is not None:
pulumi.set(__self__, "locations", locations)
if name is not None:
pulumi.set(__self__, "name", name)
if nw_application_groups is not None:
pulumi.set(__self__, "nw_application_groups", nw_application_groups)
if nw_applications is not None:
pulumi.set(__self__, "nw_applications", nw_applications)
if nw_service_groups is not None:
pulumi.set(__self__, "nw_service_groups", nw_service_groups)
if nw_services is not None:
pulumi.set(__self__, "nw_services", nw_services)
if order is not None:
pulumi.set(__self__, "order", order)
if predefined is not None:
pulumi.set(__self__, "predefined", predefined)
if rank is not None:
pulumi.set(__self__, "rank", rank)
if rule_id is not None:
pulumi.set(__self__, "rule_id", rule_id)
if src_ip_groups is not None:
pulumi.set(__self__, "src_ip_groups", src_ip_groups)
if src_ips is not None:
pulumi.set(__self__, "src_ips", src_ips)
if state is not None:
pulumi.set(__self__, "state", state)
if time_windows is not None:
pulumi.set(__self__, "time_windows", time_windows)
if users is not None:
pulumi.set(__self__, "users", users)
@property
@pulumi.getter(name="accessControl")
def access_control(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "access_control")
@access_control.setter
def access_control(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "access_control", value)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="appServiceGroups")
def app_service_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs']]:
"""
Application service groups on which this rule is applied
"""
return pulumi.get(self, "app_service_groups")
@app_service_groups.setter
def app_service_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleAppServiceGroupsArgs']]):
pulumi.set(self, "app_service_groups", value)
@property
@pulumi.getter(name="appServices")
def app_services(self) -> Optional[pulumi.Input['FirewallFilteringRuleAppServicesArgs']]:
"""
Application services on which this rule is applied
"""
return pulumi.get(self, "app_services")
@app_services.setter
def app_services(self, value: Optional[pulumi.Input['FirewallFilteringRuleAppServicesArgs']]):
pulumi.set(self, "app_services", value)
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[pulumi.Input[bool]]:
"""
If set to true, the default rule is applied
"""
return pulumi.get(self, "default_rule")
@default_rule.setter
def default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "default_rule", value)
@property
@pulumi.getter
def departments(self) -> Optional[pulumi.Input['FirewallFilteringRuleDepartmentsArgs']]:
"""
Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
"""
return pulumi.get(self, "departments")
@departments.setter
def departments(self, value: Optional[pulumi.Input['FirewallFilteringRuleDepartmentsArgs']]):
pulumi.set(self, "departments", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Enter additional notes or information. The description cannot exceed 10,240 characters.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="destAddresses")
def dest_addresses(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
"""
return pulumi.get(self, "dest_addresses")
@dest_addresses.setter
def dest_addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "dest_addresses", value)
@property
@pulumi.getter(name="destCountries")
def dest_countries(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
"""
return pulumi.get(self, "dest_countries")
@dest_countries.setter
def dest_countries(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "dest_countries", value)
@property
@pulumi.getter(name="destIpCategories")
def dest_ip_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
"""
return pulumi.get(self, "dest_ip_categories")
@dest_ip_categories.setter
def dest_ip_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "dest_ip_categories", value)
@property
@pulumi.getter(name="destIpGroups")
def dest_ip_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs']]:
"""
** - (Optional) Any number of destination IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "dest_ip_groups")
@dest_ip_groups.setter
def dest_ip_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleDestIpGroupsArgs']]):
pulumi.set(self, "dest_ip_groups", value)
@property
@pulumi.getter(name="enableFullLogging")
def enable_full_logging(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "enable_full_logging")
@enable_full_logging.setter
def enable_full_logging(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enable_full_logging", value)
@property
@pulumi.getter
def groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleGroupsArgs']]:
"""
You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "groups")
@groups.setter
def groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleGroupsArgs']]):
pulumi.set(self, "groups", value)
@property
@pulumi.getter
def labels(self) -> Optional[pulumi.Input['FirewallFilteringRuleLabelsArgs']]:
"""
Labels that are applicable to the rule.
"""
return pulumi.get(self, "labels")
@labels.setter
def labels(self, value: Optional[pulumi.Input['FirewallFilteringRuleLabelsArgs']]):
pulumi.set(self, "labels", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringRuleLastModifiedByArgs']]]]:
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringRuleLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "last_modified_time")
@last_modified_time.setter
def last_modified_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "last_modified_time", value)
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleLocationGroupsArgs']]:
"""
You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
"""
return pulumi.get(self, "location_groups")
@location_groups.setter
def location_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleLocationGroupsArgs']]):
pulumi.set(self, "location_groups", value)
@property
@pulumi.getter
def locations(self) -> Optional[pulumi.Input['FirewallFilteringRuleLocationsArgs']]:
"""
You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "locations")
@locations.setter
def locations(self, value: Optional[pulumi.Input['FirewallFilteringRuleLocationsArgs']]):
pulumi.set(self, "locations", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the network service group
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="nwApplicationGroups")
def nw_application_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs']]:
"""
Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
"""
return pulumi.get(self, "nw_application_groups")
@nw_application_groups.setter
def nw_application_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleNwApplicationGroupsArgs']]):
pulumi.set(self, "nw_application_groups", value)
@property
@pulumi.getter(name="nwApplications")
def nw_applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
"""
return pulumi.get(self, "nw_applications")
@nw_applications.setter
def nw_applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "nw_applications", value)
@property
@pulumi.getter(name="nwServiceGroups")
def nw_service_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs']]:
"""
Any number of predefined or custom network service groups to which the rule applies.
"""
return pulumi.get(self, "nw_service_groups")
@nw_service_groups.setter
def nw_service_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleNwServiceGroupsArgs']]):
pulumi.set(self, "nw_service_groups", value)
@property
@pulumi.getter(name="nwServices")
def nw_services(self) -> Optional[pulumi.Input['FirewallFilteringRuleNwServicesArgs']]:
"""
When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
"""
return pulumi.get(self, "nw_services")
@nw_services.setter
def nw_services(self, value: Optional[pulumi.Input['FirewallFilteringRuleNwServicesArgs']]):
pulumi.set(self, "nw_services", value)
@property
@pulumi.getter
def order(self) -> Optional[pulumi.Input[int]]:
"""
Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
"""
return pulumi.get(self, "order")
@order.setter
def order(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "order", value)
@property
@pulumi.getter
def predefined(self) -> Optional[pulumi.Input[bool]]:
"""
If set to true, a predefined rule is applied
"""
return pulumi.get(self, "predefined")
@predefined.setter
def predefined(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "predefined", value)
@property
@pulumi.getter
def rank(self) -> Optional[pulumi.Input[int]]:
"""
By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
"""
return pulumi.get(self, "rank")
@rank.setter
def rank(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "rank", value)
@property
@pulumi.getter(name="ruleId")
def rule_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "rule_id")
@rule_id.setter
def rule_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "rule_id", value)
@property
@pulumi.getter(name="srcIpGroups")
def src_ip_groups(self) -> Optional[pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs']]:
"""
Any number of source IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "src_ip_groups")
@src_ip_groups.setter
def src_ip_groups(self, value: Optional[pulumi.Input['FirewallFilteringRuleSrcIpGroupsArgs']]):
pulumi.set(self, "src_ip_groups", value)
@property
@pulumi.getter(name="srcIps")
def src_ips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
You can enter individual IP addresses, subnets, or address ranges.
"""
return pulumi.get(self, "src_ips")
@src_ips.setter
def src_ips(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "src_ips", value)
@property
@pulumi.getter
def state(self) -> Optional[pulumi.Input[str]]:
"""
An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
"""
return pulumi.get(self, "state")
@state.setter
def state(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "state", value)
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> Optional[pulumi.Input['FirewallFilteringRuleTimeWindowsArgs']]:
"""
You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
"""
return pulumi.get(self, "time_windows")
@time_windows.setter
def time_windows(self, value: Optional[pulumi.Input['FirewallFilteringRuleTimeWindowsArgs']]):
pulumi.set(self, "time_windows", value)
@property
@pulumi.getter
def users(self) -> Optional[pulumi.Input['FirewallFilteringRuleUsersArgs']]:
"""
You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
return pulumi.get(self, "users")
@users.setter
def users(self, value: Optional[pulumi.Input['FirewallFilteringRuleUsersArgs']]):
pulumi.set(self, "users", value)
class FirewallFilteringRule(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
access_control: Optional[pulumi.Input[str]] = None,
action: Optional[pulumi.Input[str]] = None,
app_service_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServiceGroupsArgs']]] = None,
app_services: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServicesArgs']]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleDepartmentsArgs']]] = None,
description: Optional[pulumi.Input[str]] = None,
dest_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleDestIpGroupsArgs']]] = None,
enable_full_logging: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleGroupsArgs']]] = None,
labels: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLabelsArgs']]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLastModifiedByArgs']]]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationGroupsArgs']]] = None,
locations: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
nw_application_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwApplicationGroupsArgs']]] = None,
nw_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
nw_service_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServiceGroupsArgs']]] = None,
nw_services: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServicesArgs']]] = None,
order: Optional[pulumi.Input[int]] = None,
predefined: Optional[pulumi.Input[bool]] = None,
rank: Optional[pulumi.Input[int]] = None,
src_ip_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleSrcIpGroupsArgs']]] = None,
src_ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
state: Optional[pulumi.Input[str]] = None,
time_windows: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleTimeWindowsArgs']]] = None,
users: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleUsersArgs']]] = None,
__props__=None):
"""
The **zia_firewall_filtering_rule** resource allows the creation and management of ZIA Cloud Firewall filtering rules in the Zscaler Internet Access.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
import zscaler_pulumi_zia as zia
zscaler_proxy_nw_services = zia.Firewall.get_firewall_filtering_network_services(name="ZSCALER_PROXY_NW_SERVICES")
engineering = zia.Departments.get_department_management(name="Engineering")
normal_internet = zia.Groups.get_group_management(name="Normal_Internet")
work_hours = zia.TimeWindow.get_time_window(name="Work hours")
example = zia.firewall.FirewallFilteringRule("example",
description="Example",
action="ALLOW",
state="ENABLED",
order=1,
enable_full_logging=True,
nw_services=zia.firewall.FirewallFilteringRuleNwServicesArgs(
ids=[zscaler_proxy_nw_services.id],
),
departments=zia.firewall.FirewallFilteringRuleDepartmentsArgs(
ids=[engineering.id],
),
groups=zia.firewall.FirewallFilteringRuleGroupsArgs(
ids=[normal_internet.id],
),
time_windows=zia.firewall.FirewallFilteringRuleTimeWindowsArgs(
ids=[work_hours.id],
))
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServiceGroupsArgs']] app_service_groups: Application service groups on which this rule is applied
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServicesArgs']] app_services: Application services on which this rule is applied
:param pulumi.Input[bool] default_rule: If set to true, the default rule is applied
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleDepartmentsArgs']] departments: Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
:param pulumi.Input[str] description: Enter additional notes or information. The description cannot exceed 10,240 characters.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_addresses: ** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_countries: ** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_ip_categories: ** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleDestIpGroupsArgs']] dest_ip_groups: ** - (Optional) Any number of destination IP address groups that you want to control with this rule.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleGroupsArgs']] groups: You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleLabelsArgs']] labels: Labels that are applicable to the rule.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationGroupsArgs']] location_groups: You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationsArgs']] locations: You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwApplicationGroupsArgs']] nw_application_groups: Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
:param pulumi.Input[Sequence[pulumi.Input[str]]] nw_applications: When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServiceGroupsArgs']] nw_service_groups: Any number of predefined or custom network service groups to which the rule applies.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServicesArgs']] nw_services: When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
:param pulumi.Input[int] order: Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
:param pulumi.Input[bool] predefined: If set to true, a predefined rule is applied
:param pulumi.Input[int] rank: By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleSrcIpGroupsArgs']] src_ip_groups: Any number of source IP address groups that you want to control with this rule.
:param pulumi.Input[Sequence[pulumi.Input[str]]] src_ips: You can enter individual IP addresses, subnets, or address ranges.
:param pulumi.Input[str] state: An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleTimeWindowsArgs']] time_windows: You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleUsersArgs']] users: You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[FirewallFilteringRuleArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_firewall_filtering_rule** resource allows the creation and management of ZIA Cloud Firewall filtering rules in the Zscaler Internet Access.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
import zscaler_pulumi_zia as zia
zscaler_proxy_nw_services = zia.Firewall.get_firewall_filtering_network_services(name="ZSCALER_PROXY_NW_SERVICES")
engineering = zia.Departments.get_department_management(name="Engineering")
normal_internet = zia.Groups.get_group_management(name="Normal_Internet")
work_hours = zia.TimeWindow.get_time_window(name="Work hours")
example = zia.firewall.FirewallFilteringRule("example",
description="Example",
action="ALLOW",
state="ENABLED",
order=1,
enable_full_logging=True,
nw_services=zia.firewall.FirewallFilteringRuleNwServicesArgs(
ids=[zscaler_proxy_nw_services.id],
),
departments=zia.firewall.FirewallFilteringRuleDepartmentsArgs(
ids=[engineering.id],
),
groups=zia.firewall.FirewallFilteringRuleGroupsArgs(
ids=[normal_internet.id],
),
time_windows=zia.firewall.FirewallFilteringRuleTimeWindowsArgs(
ids=[work_hours.id],
))
```
:param str resource_name: The name of the resource.
:param FirewallFilteringRuleArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(FirewallFilteringRuleArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
access_control: Optional[pulumi.Input[str]] = None,
action: Optional[pulumi.Input[str]] = None,
app_service_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServiceGroupsArgs']]] = None,
app_services: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServicesArgs']]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleDepartmentsArgs']]] = None,
description: Optional[pulumi.Input[str]] = None,
dest_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleDestIpGroupsArgs']]] = None,
enable_full_logging: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleGroupsArgs']]] = None,
labels: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLabelsArgs']]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLastModifiedByArgs']]]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationGroupsArgs']]] = None,
locations: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
nw_application_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwApplicationGroupsArgs']]] = None,
nw_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
nw_service_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServiceGroupsArgs']]] = None,
nw_services: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServicesArgs']]] = None,
order: Optional[pulumi.Input[int]] = None,
predefined: Optional[pulumi.Input[bool]] = None,
rank: Optional[pulumi.Input[int]] = None,
src_ip_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleSrcIpGroupsArgs']]] = None,
src_ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
state: Optional[pulumi.Input[str]] = None,
time_windows: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleTimeWindowsArgs']]] = None,
users: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleUsersArgs']]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = FirewallFilteringRuleArgs.__new__(FirewallFilteringRuleArgs)
__props__.__dict__["access_control"] = access_control
__props__.__dict__["action"] = action
__props__.__dict__["app_service_groups"] = app_service_groups
__props__.__dict__["app_services"] = app_services
__props__.__dict__["default_rule"] = default_rule
__props__.__dict__["departments"] = departments
__props__.__dict__["description"] = description
__props__.__dict__["dest_addresses"] = dest_addresses
__props__.__dict__["dest_countries"] = dest_countries
__props__.__dict__["dest_ip_categories"] = dest_ip_categories
__props__.__dict__["dest_ip_groups"] = dest_ip_groups
__props__.__dict__["enable_full_logging"] = enable_full_logging
__props__.__dict__["groups"] = groups
__props__.__dict__["labels"] = labels
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["last_modified_time"] = last_modified_time
__props__.__dict__["location_groups"] = location_groups
__props__.__dict__["locations"] = locations
__props__.__dict__["name"] = name
__props__.__dict__["nw_application_groups"] = nw_application_groups
__props__.__dict__["nw_applications"] = nw_applications
__props__.__dict__["nw_service_groups"] = nw_service_groups
__props__.__dict__["nw_services"] = nw_services
__props__.__dict__["order"] = order
__props__.__dict__["predefined"] = predefined
__props__.__dict__["rank"] = rank
__props__.__dict__["src_ip_groups"] = src_ip_groups
__props__.__dict__["src_ips"] = src_ips
__props__.__dict__["state"] = state
__props__.__dict__["time_windows"] = time_windows
__props__.__dict__["users"] = users
__props__.__dict__["rule_id"] = None
super(FirewallFilteringRule, __self__).__init__(
'zia:Firewall/firewallFilteringRule:FirewallFilteringRule',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
access_control: Optional[pulumi.Input[str]] = None,
action: Optional[pulumi.Input[str]] = None,
app_service_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServiceGroupsArgs']]] = None,
app_services: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServicesArgs']]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleDepartmentsArgs']]] = None,
description: Optional[pulumi.Input[str]] = None,
dest_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
dest_ip_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleDestIpGroupsArgs']]] = None,
enable_full_logging: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleGroupsArgs']]] = None,
labels: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLabelsArgs']]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLastModifiedByArgs']]]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationGroupsArgs']]] = None,
locations: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
nw_application_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwApplicationGroupsArgs']]] = None,
nw_applications: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
nw_service_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServiceGroupsArgs']]] = None,
nw_services: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServicesArgs']]] = None,
order: Optional[pulumi.Input[int]] = None,
predefined: Optional[pulumi.Input[bool]] = None,
rank: Optional[pulumi.Input[int]] = None,
rule_id: Optional[pulumi.Input[int]] = None,
src_ip_groups: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleSrcIpGroupsArgs']]] = None,
src_ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
state: Optional[pulumi.Input[str]] = None,
time_windows: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleTimeWindowsArgs']]] = None,
users: Optional[pulumi.Input[pulumi.InputType['FirewallFilteringRuleUsersArgs']]] = None) -> 'FirewallFilteringRule':
"""
Get an existing FirewallFilteringRule resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServiceGroupsArgs']] app_service_groups: Application service groups on which this rule is applied
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleAppServicesArgs']] app_services: Application services on which this rule is applied
:param pulumi.Input[bool] default_rule: If set to true, the default rule is applied
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleDepartmentsArgs']] departments: Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
:param pulumi.Input[str] description: Enter additional notes or information. The description cannot exceed 10,240 characters.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_addresses: ** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_countries: ** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
:param pulumi.Input[Sequence[pulumi.Input[str]]] dest_ip_categories: ** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleDestIpGroupsArgs']] dest_ip_groups: ** - (Optional) Any number of destination IP address groups that you want to control with this rule.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleGroupsArgs']] groups: You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleLabelsArgs']] labels: Labels that are applicable to the rule.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationGroupsArgs']] location_groups: You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleLocationsArgs']] locations: You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
:param pulumi.Input[str] name: Name of the network service group
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwApplicationGroupsArgs']] nw_application_groups: Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
:param pulumi.Input[Sequence[pulumi.Input[str]]] nw_applications: When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServiceGroupsArgs']] nw_service_groups: Any number of predefined or custom network service groups to which the rule applies.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleNwServicesArgs']] nw_services: When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
:param pulumi.Input[int] order: Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
:param pulumi.Input[bool] predefined: If set to true, a predefined rule is applied
:param pulumi.Input[int] rank: By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleSrcIpGroupsArgs']] src_ip_groups: Any number of source IP address groups that you want to control with this rule.
:param pulumi.Input[Sequence[pulumi.Input[str]]] src_ips: You can enter individual IP addresses, subnets, or address ranges.
:param pulumi.Input[str] state: An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleTimeWindowsArgs']] time_windows: You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
:param pulumi.Input[pulumi.InputType['FirewallFilteringRuleUsersArgs']] users: You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _FirewallFilteringRuleState.__new__(_FirewallFilteringRuleState)
__props__.__dict__["access_control"] = access_control
__props__.__dict__["action"] = action
__props__.__dict__["app_service_groups"] = app_service_groups
__props__.__dict__["app_services"] = app_services
__props__.__dict__["default_rule"] = default_rule
__props__.__dict__["departments"] = departments
__props__.__dict__["description"] = description
__props__.__dict__["dest_addresses"] = dest_addresses
__props__.__dict__["dest_countries"] = dest_countries
__props__.__dict__["dest_ip_categories"] = dest_ip_categories
__props__.__dict__["dest_ip_groups"] = dest_ip_groups
__props__.__dict__["enable_full_logging"] = enable_full_logging
__props__.__dict__["groups"] = groups
__props__.__dict__["labels"] = labels
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["last_modified_time"] = last_modified_time
__props__.__dict__["location_groups"] = location_groups
__props__.__dict__["locations"] = locations
__props__.__dict__["name"] = name
__props__.__dict__["nw_application_groups"] = nw_application_groups
__props__.__dict__["nw_applications"] = nw_applications
__props__.__dict__["nw_service_groups"] = nw_service_groups
__props__.__dict__["nw_services"] = nw_services
__props__.__dict__["order"] = order
__props__.__dict__["predefined"] = predefined
__props__.__dict__["rank"] = rank
__props__.__dict__["rule_id"] = rule_id
__props__.__dict__["src_ip_groups"] = src_ip_groups
__props__.__dict__["src_ips"] = src_ips
__props__.__dict__["state"] = state
__props__.__dict__["time_windows"] = time_windows
__props__.__dict__["users"] = users
return FirewallFilteringRule(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="accessControl")
def access_control(self) -> pulumi.Output[str]:
return pulumi.get(self, "access_control")
@property
@pulumi.getter
def action(self) -> pulumi.Output[str]:
"""
Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
"""
return pulumi.get(self, "action")
@property
@pulumi.getter(name="appServiceGroups")
def app_service_groups(self) -> pulumi.Output['outputs.FirewallFilteringRuleAppServiceGroups']:
"""
Application service groups on which this rule is applied
"""
return pulumi.get(self, "app_service_groups")
@property
@pulumi.getter(name="appServices")
def app_services(self) -> pulumi.Output['outputs.FirewallFilteringRuleAppServices']:
"""
Application services on which this rule is applied
"""
return pulumi.get(self, "app_services")
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> pulumi.Output[bool]:
"""
If set to true, the default rule is applied
"""
return pulumi.get(self, "default_rule")
@property
@pulumi.getter
def departments(self) -> pulumi.Output['outputs.FirewallFilteringRuleDepartments']:
"""
Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
"""
return pulumi.get(self, "departments")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Enter additional notes or information. The description cannot exceed 10,240 characters.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="destAddresses")
def dest_addresses(self) -> pulumi.Output[Sequence[str]]:
"""
** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
"""
return pulumi.get(self, "dest_addresses")
@property
@pulumi.getter(name="destCountries")
def dest_countries(self) -> pulumi.Output[Sequence[str]]:
"""
** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
"""
return pulumi.get(self, "dest_countries")
@property
@pulumi.getter(name="destIpCategories")
def dest_ip_categories(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
"""
return pulumi.get(self, "dest_ip_categories")
@property
@pulumi.getter(name="destIpGroups")
def dest_ip_groups(self) -> pulumi.Output['outputs.FirewallFilteringRuleDestIpGroups']:
"""
** - (Optional) Any number of destination IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "dest_ip_groups")
@property
@pulumi.getter(name="enableFullLogging")
def enable_full_logging(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "enable_full_logging")
@property
@pulumi.getter
def groups(self) -> pulumi.Output['outputs.FirewallFilteringRuleGroups']:
"""
You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "groups")
@property
@pulumi.getter
def labels(self) -> pulumi.Output['outputs.FirewallFilteringRuleLabels']:
"""
Labels that are applicable to the rule.
"""
return pulumi.get(self, "labels")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> pulumi.Output[Sequence['outputs.FirewallFilteringRuleLastModifiedBy']]:
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> pulumi.Output[int]:
return pulumi.get(self, "last_modified_time")
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> pulumi.Output['outputs.FirewallFilteringRuleLocationGroups']:
"""
You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
"""
return pulumi.get(self, "location_groups")
@property
@pulumi.getter
def locations(self) -> pulumi.Output['outputs.FirewallFilteringRuleLocations']:
"""
You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "locations")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the network service group
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="nwApplicationGroups")
def nw_application_groups(self) -> pulumi.Output['outputs.FirewallFilteringRuleNwApplicationGroups']:
"""
Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
"""
return pulumi.get(self, "nw_application_groups")
@property
@pulumi.getter(name="nwApplications")
def nw_applications(self) -> pulumi.Output[Sequence[str]]:
"""
When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
"""
return pulumi.get(self, "nw_applications")
@property
@pulumi.getter(name="nwServiceGroups")
def nw_service_groups(self) -> pulumi.Output['outputs.FirewallFilteringRuleNwServiceGroups']:
"""
Any number of predefined or custom network service groups to which the rule applies.
"""
return pulumi.get(self, "nw_service_groups")
@property
@pulumi.getter(name="nwServices")
def nw_services(self) -> pulumi.Output['outputs.FirewallFilteringRuleNwServices']:
"""
When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
"""
return pulumi.get(self, "nw_services")
@property
@pulumi.getter
def order(self) -> pulumi.Output[int]:
"""
Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
"""
return pulumi.get(self, "order")
@property
@pulumi.getter
def predefined(self) -> pulumi.Output[bool]:
"""
If set to true, a predefined rule is applied
"""
return pulumi.get(self, "predefined")
@property
@pulumi.getter
def rank(self) -> pulumi.Output[int]:
"""
By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
"""
return pulumi.get(self, "rank")
@property
@pulumi.getter(name="ruleId")
def rule_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "rule_id")
@property
@pulumi.getter(name="srcIpGroups")
def src_ip_groups(self) -> pulumi.Output['outputs.FirewallFilteringRuleSrcIpGroups']:
"""
Any number of source IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "src_ip_groups")
@property
@pulumi.getter(name="srcIps")
def src_ips(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
You can enter individual IP addresses, subnets, or address ranges.
"""
return pulumi.get(self, "src_ips")
@property
@pulumi.getter
def state(self) -> pulumi.Output[str]:
"""
An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
"""
return pulumi.get(self, "state")
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> pulumi.Output['outputs.FirewallFilteringRuleTimeWindows']:
"""
You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
"""
return pulumi.get(self, "time_windows")
@property
@pulumi.getter
def users(self) -> pulumi.Output['outputs.FirewallFilteringRuleUsers']:
"""
You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
return pulumi.get(self, "users") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/firewall_filtering_rule.py | firewall_filtering_rule.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetFirewallFilteringSourceIPGroupsResult',
'AwaitableGetFirewallFilteringSourceIPGroupsResult',
'get_firewall_filtering_source_ip_groups',
'get_firewall_filtering_source_ip_groups_output',
]
@pulumi.output_type
class GetFirewallFilteringSourceIPGroupsResult:
"""
A collection of values returned by getFirewallFilteringSourceIPGroups.
"""
def __init__(__self__, description=None, id=None, ip_addresses=None, name=None):
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if ip_addresses and not isinstance(ip_addresses, list):
raise TypeError("Expected argument 'ip_addresses' to be a list")
pulumi.set(__self__, "ip_addresses", ip_addresses)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def description(self) -> str:
"""
(String)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of this resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> Sequence[str]:
"""
(List of String)
"""
return pulumi.get(self, "ip_addresses")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
class AwaitableGetFirewallFilteringSourceIPGroupsResult(GetFirewallFilteringSourceIPGroupsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetFirewallFilteringSourceIPGroupsResult(
description=self.description,
id=self.id,
ip_addresses=self.ip_addresses,
name=self.name)
def get_firewall_filtering_source_ip_groups(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFirewallFilteringSourceIPGroupsResult:
"""
Use the **zia_firewall_filtering_ip_source_groups** data source to get information about ip source groups available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_source_ip_groups(name="example")
```
:param int id: The ID of the ip source group resource.
:param str name: The name of the ip source group to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Firewall/getFirewallFilteringSourceIPGroups:getFirewallFilteringSourceIPGroups', __args__, opts=opts, typ=GetFirewallFilteringSourceIPGroupsResult).value
return AwaitableGetFirewallFilteringSourceIPGroupsResult(
description=__ret__.description,
id=__ret__.id,
ip_addresses=__ret__.ip_addresses,
name=__ret__.name)
@_utilities.lift_output_func(get_firewall_filtering_source_ip_groups)
def get_firewall_filtering_source_ip_groups_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFirewallFilteringSourceIPGroupsResult]:
"""
Use the **zia_firewall_filtering_ip_source_groups** data source to get information about ip source groups available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_source_ip_groups(name="example")
```
:param int id: The ID of the ip source group resource.
:param str name: The name of the ip source group to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/get_firewall_filtering_source_ip_groups.py | get_firewall_filtering_source_ip_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = ['FirewallFilteringDestinationGroupsArgs', 'FirewallFilteringDestinationGroups']
@pulumi.input_type
class FirewallFilteringDestinationGroupsArgs:
def __init__(__self__, *,
addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a FirewallFilteringDestinationGroups resource.
:param pulumi.Input[Sequence[pulumi.Input[str]]] addresses: Destination IP addresses within the group
:param pulumi.Input[Sequence[pulumi.Input[str]]] countries: Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination
countries.
:param pulumi.Input[str] description: Additional information about the destination IP group
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_categories: List of URL categories for which rule must be applied
:param pulumi.Input[str] name: Destination IP group name
:param pulumi.Input[str] type: Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
if addresses is not None:
pulumi.set(__self__, "addresses", addresses)
if countries is not None:
pulumi.set(__self__, "countries", countries)
if description is not None:
pulumi.set(__self__, "description", description)
if ip_categories is not None:
pulumi.set(__self__, "ip_categories", ip_categories)
if name is not None:
pulumi.set(__self__, "name", name)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def addresses(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Destination IP addresses within the group
"""
return pulumi.get(self, "addresses")
@addresses.setter
def addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "addresses", value)
@property
@pulumi.getter
def countries(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination
countries.
"""
return pulumi.get(self, "countries")
@countries.setter
def countries(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "countries", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about the destination IP group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="ipCategories")
def ip_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of URL categories for which rule must be applied
"""
return pulumi.get(self, "ip_categories")
@ip_categories.setter
def ip_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_categories", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Destination IP group name
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
@pulumi.input_type
class _FirewallFilteringDestinationGroupsState:
def __init__(__self__, *,
addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_destination_id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering FirewallFilteringDestinationGroups resources.
:param pulumi.Input[Sequence[pulumi.Input[str]]] addresses: Destination IP addresses within the group
:param pulumi.Input[Sequence[pulumi.Input[str]]] countries: Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination
countries.
:param pulumi.Input[str] description: Additional information about the destination IP group
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_categories: List of URL categories for which rule must be applied
:param pulumi.Input[int] ip_destination_id: Unique identifer for the destination IP group
:param pulumi.Input[str] name: Destination IP group name
:param pulumi.Input[str] type: Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
if addresses is not None:
pulumi.set(__self__, "addresses", addresses)
if countries is not None:
pulumi.set(__self__, "countries", countries)
if description is not None:
pulumi.set(__self__, "description", description)
if ip_categories is not None:
pulumi.set(__self__, "ip_categories", ip_categories)
if ip_destination_id is not None:
pulumi.set(__self__, "ip_destination_id", ip_destination_id)
if name is not None:
pulumi.set(__self__, "name", name)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def addresses(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Destination IP addresses within the group
"""
return pulumi.get(self, "addresses")
@addresses.setter
def addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "addresses", value)
@property
@pulumi.getter
def countries(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination
countries.
"""
return pulumi.get(self, "countries")
@countries.setter
def countries(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "countries", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about the destination IP group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="ipCategories")
def ip_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of URL categories for which rule must be applied
"""
return pulumi.get(self, "ip_categories")
@ip_categories.setter
def ip_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_categories", value)
@property
@pulumi.getter(name="ipDestinationId")
def ip_destination_id(self) -> Optional[pulumi.Input[int]]:
"""
Unique identifer for the destination IP group
"""
return pulumi.get(self, "ip_destination_id")
@ip_destination_id.setter
def ip_destination_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "ip_destination_id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Destination IP group name
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
class FirewallFilteringDestinationGroups(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
Create a FirewallFilteringDestinationGroups resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[Sequence[pulumi.Input[str]]] addresses: Destination IP addresses within the group
:param pulumi.Input[Sequence[pulumi.Input[str]]] countries: Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination
countries.
:param pulumi.Input[str] description: Additional information about the destination IP group
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_categories: List of URL categories for which rule must be applied
:param pulumi.Input[str] name: Destination IP group name
:param pulumi.Input[str] type: Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[FirewallFilteringDestinationGroupsArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
Create a FirewallFilteringDestinationGroups resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param FirewallFilteringDestinationGroupsArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(FirewallFilteringDestinationGroupsArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = FirewallFilteringDestinationGroupsArgs.__new__(FirewallFilteringDestinationGroupsArgs)
__props__.__dict__["addresses"] = addresses
__props__.__dict__["countries"] = countries
__props__.__dict__["description"] = description
__props__.__dict__["ip_categories"] = ip_categories
__props__.__dict__["name"] = name
__props__.__dict__["type"] = type
__props__.__dict__["ip_destination_id"] = None
super(FirewallFilteringDestinationGroups, __self__).__init__(
'zia:Firewall/firewallFilteringDestinationGroups:FirewallFilteringDestinationGroups',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
countries: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
ip_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_destination_id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None) -> 'FirewallFilteringDestinationGroups':
"""
Get an existing FirewallFilteringDestinationGroups resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[Sequence[pulumi.Input[str]]] addresses: Destination IP addresses within the group
:param pulumi.Input[Sequence[pulumi.Input[str]]] countries: Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination
countries.
:param pulumi.Input[str] description: Additional information about the destination IP group
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_categories: List of URL categories for which rule must be applied
:param pulumi.Input[int] ip_destination_id: Unique identifer for the destination IP group
:param pulumi.Input[str] name: Destination IP group name
:param pulumi.Input[str] type: Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _FirewallFilteringDestinationGroupsState.__new__(_FirewallFilteringDestinationGroupsState)
__props__.__dict__["addresses"] = addresses
__props__.__dict__["countries"] = countries
__props__.__dict__["description"] = description
__props__.__dict__["ip_categories"] = ip_categories
__props__.__dict__["ip_destination_id"] = ip_destination_id
__props__.__dict__["name"] = name
__props__.__dict__["type"] = type
return FirewallFilteringDestinationGroups(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def addresses(self) -> pulumi.Output[Sequence[str]]:
"""
Destination IP addresses within the group
"""
return pulumi.get(self, "addresses")
@property
@pulumi.getter
def countries(self) -> pulumi.Output[Sequence[str]]:
"""
Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination
countries.
"""
return pulumi.get(self, "countries")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Additional information about the destination IP group
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="ipCategories")
def ip_categories(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
List of URL categories for which rule must be applied
"""
return pulumi.get(self, "ip_categories")
@property
@pulumi.getter(name="ipDestinationId")
def ip_destination_id(self) -> pulumi.Output[int]:
"""
Unique identifer for the destination IP group
"""
return pulumi.get(self, "ip_destination_id")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Destination IP group name
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def type(self) -> pulumi.Output[str]:
"""
Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
return pulumi.get(self, "type") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/firewall_filtering_destination_groups.py | firewall_filtering_destination_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = ['FirewallFilteringSourceGroupsArgs', 'FirewallFilteringSourceGroups']
@pulumi.input_type
class FirewallFilteringSourceGroupsArgs:
def __init__(__self__, *,
ip_addresses: pulumi.Input[Sequence[pulumi.Input[str]]],
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a FirewallFilteringSourceGroups resource.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: Source IP addresses to be added to the group. Enter any number of IP addresses. You can enter:
* An IP address (198.51.100.100)
* A range of IP addresses 192.0.2.1-192.0.2.10
* An IP address with a netmask 203.0.113.0/24
:param pulumi.Input[str] description: Description of the source IP group
:param pulumi.Input[str] name: Source IP group name
"""
pulumi.set(__self__, "ip_addresses", ip_addresses)
if description is not None:
pulumi.set(__self__, "description", description)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
"""
Source IP addresses to be added to the group. Enter any number of IP addresses. You can enter:
* An IP address (198.51.100.100)
* A range of IP addresses 192.0.2.1-192.0.2.10
* An IP address with a netmask 203.0.113.0/24
"""
return pulumi.get(self, "ip_addresses")
@ip_addresses.setter
def ip_addresses(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "ip_addresses", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the source IP group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Source IP group name
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class _FirewallFilteringSourceGroupsState:
def __init__(__self__, *,
description: Optional[pulumi.Input[str]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_source_group_id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering FirewallFilteringSourceGroups resources.
:param pulumi.Input[str] description: Description of the source IP group
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: Source IP addresses to be added to the group. Enter any number of IP addresses. You can enter:
* An IP address (198.51.100.100)
* A range of IP addresses 192.0.2.1-192.0.2.10
* An IP address with a netmask 203.0.113.0/24
:param pulumi.Input[str] name: Source IP group name
"""
if description is not None:
pulumi.set(__self__, "description", description)
if ip_addresses is not None:
pulumi.set(__self__, "ip_addresses", ip_addresses)
if ip_source_group_id is not None:
pulumi.set(__self__, "ip_source_group_id", ip_source_group_id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the source IP group
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Source IP addresses to be added to the group. Enter any number of IP addresses. You can enter:
* An IP address (198.51.100.100)
* A range of IP addresses 192.0.2.1-192.0.2.10
* An IP address with a netmask 203.0.113.0/24
"""
return pulumi.get(self, "ip_addresses")
@ip_addresses.setter
def ip_addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_addresses", value)
@property
@pulumi.getter(name="ipSourceGroupId")
def ip_source_group_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "ip_source_group_id")
@ip_source_group_id.setter
def ip_source_group_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "ip_source_group_id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Source IP group name
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
class FirewallFilteringSourceGroups(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The **zia_firewall_filtering_ip_source_groups** resource allows the creation and management of ZIA Cloud Firewall IP source groups in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add an IP address or addresses to a new IP Source Group
example = zia.firewall.FirewallFilteringSourceGroups("example",
description="Example",
ip_addresses=[
"192.168.100.1",
"192.168.100.2",
"192.168.100.3",
])
```
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add an IP address range(s) to a new IP Source Group
example = zia.firewall.FirewallFilteringSourceGroups("example",
description="Example",
ip_addresses=["192.0.2.1-192.0.2.10"])
```
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add subnet to a new IP Source Group
example = zia.firewall.FirewallFilteringSourceGroups("example",
description="Example",
ip_addresses=["203.0.113.0/24"])
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the source IP group
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: Source IP addresses to be added to the group. Enter any number of IP addresses. You can enter:
* An IP address (198.51.100.100)
* A range of IP addresses 192.0.2.1-192.0.2.10
* An IP address with a netmask 203.0.113.0/24
:param pulumi.Input[str] name: Source IP group name
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: FirewallFilteringSourceGroupsArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_firewall_filtering_ip_source_groups** resource allows the creation and management of ZIA Cloud Firewall IP source groups in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add an IP address or addresses to a new IP Source Group
example = zia.firewall.FirewallFilteringSourceGroups("example",
description="Example",
ip_addresses=[
"192.168.100.1",
"192.168.100.2",
"192.168.100.3",
])
```
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add an IP address range(s) to a new IP Source Group
example = zia.firewall.FirewallFilteringSourceGroups("example",
description="Example",
ip_addresses=["192.0.2.1-192.0.2.10"])
```
```python
import pulumi
import zscaler_pulumi_zia as zia
# Add subnet to a new IP Source Group
example = zia.firewall.FirewallFilteringSourceGroups("example",
description="Example",
ip_addresses=["203.0.113.0/24"])
```
:param str resource_name: The name of the resource.
:param FirewallFilteringSourceGroupsArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(FirewallFilteringSourceGroupsArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = FirewallFilteringSourceGroupsArgs.__new__(FirewallFilteringSourceGroupsArgs)
__props__.__dict__["description"] = description
if ip_addresses is None and not opts.urn:
raise TypeError("Missing required property 'ip_addresses'")
__props__.__dict__["ip_addresses"] = ip_addresses
__props__.__dict__["name"] = name
__props__.__dict__["ip_source_group_id"] = None
super(FirewallFilteringSourceGroups, __self__).__init__(
'zia:Firewall/firewallFilteringSourceGroups:FirewallFilteringSourceGroups',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_source_group_id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None) -> 'FirewallFilteringSourceGroups':
"""
Get an existing FirewallFilteringSourceGroups resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the source IP group
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: Source IP addresses to be added to the group. Enter any number of IP addresses. You can enter:
* An IP address (198.51.100.100)
* A range of IP addresses 192.0.2.1-192.0.2.10
* An IP address with a netmask 203.0.113.0/24
:param pulumi.Input[str] name: Source IP group name
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _FirewallFilteringSourceGroupsState.__new__(_FirewallFilteringSourceGroupsState)
__props__.__dict__["description"] = description
__props__.__dict__["ip_addresses"] = ip_addresses
__props__.__dict__["ip_source_group_id"] = ip_source_group_id
__props__.__dict__["name"] = name
return FirewallFilteringSourceGroups(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Description of the source IP group
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> pulumi.Output[Sequence[str]]:
"""
Source IP addresses to be added to the group. Enter any number of IP addresses. You can enter:
* An IP address (198.51.100.100)
* A range of IP addresses 192.0.2.1-192.0.2.10
* An IP address with a netmask 203.0.113.0/24
"""
return pulumi.get(self, "ip_addresses")
@property
@pulumi.getter(name="ipSourceGroupId")
def ip_source_group_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "ip_source_group_id")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Source IP group name
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/firewall_filtering_source_groups.py | firewall_filtering_source_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetFirewallFilteringNetworkServicesResult',
'AwaitableGetFirewallFilteringNetworkServicesResult',
'get_firewall_filtering_network_services',
'get_firewall_filtering_network_services_output',
]
@pulumi.output_type
class GetFirewallFilteringNetworkServicesResult:
"""
A collection of values returned by getFirewallFilteringNetworkServices.
"""
def __init__(__self__, description=None, dest_tcp_ports=None, dest_udp_ports=None, id=None, is_name_l10n_tag=None, name=None, src_tcp_ports=None, src_udp_ports=None, tag=None, type=None):
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if dest_tcp_ports and not isinstance(dest_tcp_ports, list):
raise TypeError("Expected argument 'dest_tcp_ports' to be a list")
pulumi.set(__self__, "dest_tcp_ports", dest_tcp_ports)
if dest_udp_ports and not isinstance(dest_udp_ports, list):
raise TypeError("Expected argument 'dest_udp_ports' to be a list")
pulumi.set(__self__, "dest_udp_ports", dest_udp_ports)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if is_name_l10n_tag and not isinstance(is_name_l10n_tag, bool):
raise TypeError("Expected argument 'is_name_l10n_tag' to be a bool")
pulumi.set(__self__, "is_name_l10n_tag", is_name_l10n_tag)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if src_tcp_ports and not isinstance(src_tcp_ports, list):
raise TypeError("Expected argument 'src_tcp_ports' to be a list")
pulumi.set(__self__, "src_tcp_ports", src_tcp_ports)
if src_udp_ports and not isinstance(src_udp_ports, list):
raise TypeError("Expected argument 'src_udp_ports' to be a list")
pulumi.set(__self__, "src_udp_ports", src_udp_ports)
if tag and not isinstance(tag, str):
raise TypeError("Expected argument 'tag' to be a str")
pulumi.set(__self__, "tag", tag)
if type and not isinstance(type, str):
raise TypeError("Expected argument 'type' to be a str")
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def description(self) -> str:
"""
(String) (Optional) Enter additional notes or information. The description cannot exceed 10240 characters.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="destTcpPorts")
def dest_tcp_ports(self) -> Sequence['outputs.GetFirewallFilteringNetworkServicesDestTcpPortResult']:
"""
(Required) The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_tcp_ports")
@property
@pulumi.getter(name="destUdpPorts")
def dest_udp_ports(self) -> Sequence['outputs.GetFirewallFilteringNetworkServicesDestUdpPortResult']:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_udp_ports")
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="isNameL10nTag")
def is_name_l10n_tag(self) -> bool:
"""
(Bool) - Default: false
"""
return pulumi.get(self, "is_name_l10n_tag")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="srcTcpPorts")
def src_tcp_ports(self) -> Sequence['outputs.GetFirewallFilteringNetworkServicesSrcTcpPortResult']:
"""
(Optional) The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
"""
return pulumi.get(self, "src_tcp_ports")
@property
@pulumi.getter(name="srcUdpPorts")
def src_udp_ports(self) -> Sequence['outputs.GetFirewallFilteringNetworkServicesSrcUdpPortResult']:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "src_udp_ports")
@property
@pulumi.getter
def tag(self) -> str:
return pulumi.get(self, "tag")
@property
@pulumi.getter
def type(self) -> str:
"""
(String) - Supported values are: `STANDARD`, `PREDEFINED` and `CUSTOM`
"""
return pulumi.get(self, "type")
class AwaitableGetFirewallFilteringNetworkServicesResult(GetFirewallFilteringNetworkServicesResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetFirewallFilteringNetworkServicesResult(
description=self.description,
dest_tcp_ports=self.dest_tcp_ports,
dest_udp_ports=self.dest_udp_ports,
id=self.id,
is_name_l10n_tag=self.is_name_l10n_tag,
name=self.name,
src_tcp_ports=self.src_tcp_ports,
src_udp_ports=self.src_udp_ports,
tag=self.tag,
type=self.type)
def get_firewall_filtering_network_services(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFirewallFilteringNetworkServicesResult:
"""
The **zia_firewall_filtering_network_service** data source to get information about a network service available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network service rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_network_services(name="ICMP_ANY")
```
:param int id: The ID of the application layer service to be exported.
:param str name: Name of the application layer service that you want to control. It can include any character and spaces.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Firewall/getFirewallFilteringNetworkServices:getFirewallFilteringNetworkServices', __args__, opts=opts, typ=GetFirewallFilteringNetworkServicesResult).value
return AwaitableGetFirewallFilteringNetworkServicesResult(
description=__ret__.description,
dest_tcp_ports=__ret__.dest_tcp_ports,
dest_udp_ports=__ret__.dest_udp_ports,
id=__ret__.id,
is_name_l10n_tag=__ret__.is_name_l10n_tag,
name=__ret__.name,
src_tcp_ports=__ret__.src_tcp_ports,
src_udp_ports=__ret__.src_udp_ports,
tag=__ret__.tag,
type=__ret__.type)
@_utilities.lift_output_func(get_firewall_filtering_network_services)
def get_firewall_filtering_network_services_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFirewallFilteringNetworkServicesResult]:
"""
The **zia_firewall_filtering_network_service** data source to get information about a network service available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering network service rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_network_services(name="ICMP_ANY")
```
:param int id: The ID of the application layer service to be exported.
:param str name: Name of the application layer service that you want to control. It can include any character and spaces.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/get_firewall_filtering_network_services.py | get_firewall_filtering_network_services.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetFirewallFilteringDestinationGroupsResult',
'AwaitableGetFirewallFilteringDestinationGroupsResult',
'get_firewall_filtering_destination_groups',
'get_firewall_filtering_destination_groups_output',
]
@pulumi.output_type
class GetFirewallFilteringDestinationGroupsResult:
"""
A collection of values returned by getFirewallFilteringDestinationGroups.
"""
def __init__(__self__, addresses=None, countries=None, description=None, id=None, ip_categories=None, name=None, type=None):
if addresses and not isinstance(addresses, list):
raise TypeError("Expected argument 'addresses' to be a list")
pulumi.set(__self__, "addresses", addresses)
if countries and not isinstance(countries, list):
raise TypeError("Expected argument 'countries' to be a list")
pulumi.set(__self__, "countries", countries)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if ip_categories and not isinstance(ip_categories, list):
raise TypeError("Expected argument 'ip_categories' to be a list")
pulumi.set(__self__, "ip_categories", ip_categories)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if type and not isinstance(type, str):
raise TypeError("Expected argument 'type' to be a str")
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def addresses(self) -> Sequence[str]:
"""
(List of String) Destination IP addresses within the group
"""
return pulumi.get(self, "addresses")
@property
@pulumi.getter
def countries(self) -> Sequence[str]:
"""
(List of String) Destination IP address counties. You can identify destinations based on the location of a server.
"""
return pulumi.get(self, "countries")
@property
@pulumi.getter
def description(self) -> str:
"""
(String) Additional information about the destination IP group
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipCategories")
def ip_categories(self) -> Sequence[str]:
"""
(List of String) Destination IP address URL categories. You can identify destinations based on the URL category of the domain.
"""
return pulumi.get(self, "ip_categories")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@property
@pulumi.getter
def type(self) -> str:
"""
(String) Destination IP group type (i.e., the group can contain destination IP addresses or FQDNs)
"""
return pulumi.get(self, "type")
class AwaitableGetFirewallFilteringDestinationGroupsResult(GetFirewallFilteringDestinationGroupsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetFirewallFilteringDestinationGroupsResult(
addresses=self.addresses,
countries=self.countries,
description=self.description,
id=self.id,
ip_categories=self.ip_categories,
name=self.name,
type=self.type)
def get_firewall_filtering_destination_groups(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFirewallFilteringDestinationGroupsResult:
"""
Use the **zia_firewall_filtering_destination_groups** data source to get information about IP destination groups option available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_destination_groups(name="example")
```
:param int id: The ID of the destination group resource.
:param str name: The name of the destination group to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Firewall/getFirewallFilteringDestinationGroups:getFirewallFilteringDestinationGroups', __args__, opts=opts, typ=GetFirewallFilteringDestinationGroupsResult).value
return AwaitableGetFirewallFilteringDestinationGroupsResult(
addresses=__ret__.addresses,
countries=__ret__.countries,
description=__ret__.description,
id=__ret__.id,
ip_categories=__ret__.ip_categories,
name=__ret__.name,
type=__ret__.type)
@_utilities.lift_output_func(get_firewall_filtering_destination_groups)
def get_firewall_filtering_destination_groups_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFirewallFilteringDestinationGroupsResult]:
"""
Use the **zia_firewall_filtering_destination_groups** data source to get information about IP destination groups option available in the Zscaler Internet Access cloud firewall. This data source can then be associated with a ZIA firewall filtering rule.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_destination_groups(name="example")
```
:param int id: The ID of the destination group resource.
:param str name: The name of the destination group to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/get_firewall_filtering_destination_groups.py | get_firewall_filtering_destination_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['FirewallFilteringNetworkServicesArgs', 'FirewallFilteringNetworkServices']
@pulumi.input_type
class FirewallFilteringNetworkServicesArgs:
def __init__(__self__, *,
description: Optional[pulumi.Input[str]] = None,
dest_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]]] = None,
dest_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]]] = None,
is_name_l10n_tag: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
src_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]] = None,
src_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]] = None,
tag: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a FirewallFilteringNetworkServices resource.
:param pulumi.Input[str] description: Description of the service
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]] dest_tcp_ports: The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]] dest_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[bool] is_name_l10n_tag: (Optional
:param pulumi.Input[str] name: Name of the service
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]] src_tcp_ports: The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]] src_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[str] tag: The following values are supported: `"ICMP_ANY`, `"UDP_ANY"`, `"TCP_ANY"`, `"OTHER_NETWORK_SERVICE"`, `"DNS"`, `"NETBIOS"`, `"FTP"`, `"GNUTELLA"`, `"H_323"`, `"HTTP"`, `"HTTPS"`, `"IKE"`, `"IMAP"`, `"ILS"`, `"IKE_NAT"`, `"IRC"`, `"LDAP"`, `"QUIC"`, `"TDS"`, `"NETMEETING"`, `"NFS"`, `"NTP"`, `"SIP"`, `"SNMP"`, `"SMB"`, `"SMTP"`, `"SSH"`, `"SYSLOG"`, `"TELNET"`, `"TRACEROUTE"`, `"POP3"`, `"PPTP"`, `"RADIUS"`, `"REAL_MEDIA"`, `"RTSP"`, `"VNC"`, `"WHOIS"`, `"KERBEROS_SEC"`, `"TACACS"`, `"SNMPTRAP"`, `"NMAP"`, `"RSYNC"`, `"L2TP"`, `"HTTP_PROXY"`, `"PC_ANYWHERE"`, `"MSN"`, `"ECHO"`, `"AIM"`, `"IDENT"`, `"YMSG"`, `"SCCP"`, `"MGCP_UA"`, `"MGCP_CA"`, `"VDO_LIVE"`, `"OPENVPN"`, `"TFTP"`, `"FTPS_IMPLICIT"`, `"ZSCALER_PROXY_NW_SERVICES"`, `"GRE_PROTOCOL"`, `"ESP_PROTOCOL"`, `"DHCP"`
:param pulumi.Input[str] type: Supported values: `STANDARD`, `PREDEFINED`, `CUSTOM`
"""
if description is not None:
pulumi.set(__self__, "description", description)
if dest_tcp_ports is not None:
pulumi.set(__self__, "dest_tcp_ports", dest_tcp_ports)
if dest_udp_ports is not None:
pulumi.set(__self__, "dest_udp_ports", dest_udp_ports)
if is_name_l10n_tag is not None:
pulumi.set(__self__, "is_name_l10n_tag", is_name_l10n_tag)
if name is not None:
pulumi.set(__self__, "name", name)
if src_tcp_ports is not None:
pulumi.set(__self__, "src_tcp_ports", src_tcp_ports)
if src_udp_ports is not None:
pulumi.set(__self__, "src_udp_ports", src_udp_ports)
if tag is not None:
pulumi.set(__self__, "tag", tag)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the service
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="destTcpPorts")
def dest_tcp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]]]:
"""
The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_tcp_ports")
@dest_tcp_ports.setter
def dest_tcp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]]]):
pulumi.set(self, "dest_tcp_ports", value)
@property
@pulumi.getter(name="destUdpPorts")
def dest_udp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]]]:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_udp_ports")
@dest_udp_ports.setter
def dest_udp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]]]):
pulumi.set(self, "dest_udp_ports", value)
@property
@pulumi.getter(name="isNameL10nTag")
def is_name_l10n_tag(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional
"""
return pulumi.get(self, "is_name_l10n_tag")
@is_name_l10n_tag.setter
def is_name_l10n_tag(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_name_l10n_tag", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the service
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="srcTcpPorts")
def src_tcp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]]:
"""
The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
"""
return pulumi.get(self, "src_tcp_ports")
@src_tcp_ports.setter
def src_tcp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]]):
pulumi.set(self, "src_tcp_ports", value)
@property
@pulumi.getter(name="srcUdpPorts")
def src_udp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]]:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "src_udp_ports")
@src_udp_ports.setter
def src_udp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]]):
pulumi.set(self, "src_udp_ports", value)
@property
@pulumi.getter
def tag(self) -> Optional[pulumi.Input[str]]:
"""
The following values are supported: `"ICMP_ANY`, `"UDP_ANY"`, `"TCP_ANY"`, `"OTHER_NETWORK_SERVICE"`, `"DNS"`, `"NETBIOS"`, `"FTP"`, `"GNUTELLA"`, `"H_323"`, `"HTTP"`, `"HTTPS"`, `"IKE"`, `"IMAP"`, `"ILS"`, `"IKE_NAT"`, `"IRC"`, `"LDAP"`, `"QUIC"`, `"TDS"`, `"NETMEETING"`, `"NFS"`, `"NTP"`, `"SIP"`, `"SNMP"`, `"SMB"`, `"SMTP"`, `"SSH"`, `"SYSLOG"`, `"TELNET"`, `"TRACEROUTE"`, `"POP3"`, `"PPTP"`, `"RADIUS"`, `"REAL_MEDIA"`, `"RTSP"`, `"VNC"`, `"WHOIS"`, `"KERBEROS_SEC"`, `"TACACS"`, `"SNMPTRAP"`, `"NMAP"`, `"RSYNC"`, `"L2TP"`, `"HTTP_PROXY"`, `"PC_ANYWHERE"`, `"MSN"`, `"ECHO"`, `"AIM"`, `"IDENT"`, `"YMSG"`, `"SCCP"`, `"MGCP_UA"`, `"MGCP_CA"`, `"VDO_LIVE"`, `"OPENVPN"`, `"TFTP"`, `"FTPS_IMPLICIT"`, `"ZSCALER_PROXY_NW_SERVICES"`, `"GRE_PROTOCOL"`, `"ESP_PROTOCOL"`, `"DHCP"`
"""
return pulumi.get(self, "tag")
@tag.setter
def tag(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "tag", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
Supported values: `STANDARD`, `PREDEFINED`, `CUSTOM`
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
@pulumi.input_type
class _FirewallFilteringNetworkServicesState:
def __init__(__self__, *,
description: Optional[pulumi.Input[str]] = None,
dest_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]]] = None,
dest_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]]] = None,
is_name_l10n_tag: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
network_service_id: Optional[pulumi.Input[int]] = None,
src_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]] = None,
src_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]] = None,
tag: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering FirewallFilteringNetworkServices resources.
:param pulumi.Input[str] description: Description of the service
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]] dest_tcp_ports: The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]] dest_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[bool] is_name_l10n_tag: (Optional
:param pulumi.Input[str] name: Name of the service
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]] src_tcp_ports: The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
:param pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]] src_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[str] tag: The following values are supported: `"ICMP_ANY`, `"UDP_ANY"`, `"TCP_ANY"`, `"OTHER_NETWORK_SERVICE"`, `"DNS"`, `"NETBIOS"`, `"FTP"`, `"GNUTELLA"`, `"H_323"`, `"HTTP"`, `"HTTPS"`, `"IKE"`, `"IMAP"`, `"ILS"`, `"IKE_NAT"`, `"IRC"`, `"LDAP"`, `"QUIC"`, `"TDS"`, `"NETMEETING"`, `"NFS"`, `"NTP"`, `"SIP"`, `"SNMP"`, `"SMB"`, `"SMTP"`, `"SSH"`, `"SYSLOG"`, `"TELNET"`, `"TRACEROUTE"`, `"POP3"`, `"PPTP"`, `"RADIUS"`, `"REAL_MEDIA"`, `"RTSP"`, `"VNC"`, `"WHOIS"`, `"KERBEROS_SEC"`, `"TACACS"`, `"SNMPTRAP"`, `"NMAP"`, `"RSYNC"`, `"L2TP"`, `"HTTP_PROXY"`, `"PC_ANYWHERE"`, `"MSN"`, `"ECHO"`, `"AIM"`, `"IDENT"`, `"YMSG"`, `"SCCP"`, `"MGCP_UA"`, `"MGCP_CA"`, `"VDO_LIVE"`, `"OPENVPN"`, `"TFTP"`, `"FTPS_IMPLICIT"`, `"ZSCALER_PROXY_NW_SERVICES"`, `"GRE_PROTOCOL"`, `"ESP_PROTOCOL"`, `"DHCP"`
:param pulumi.Input[str] type: Supported values: `STANDARD`, `PREDEFINED`, `CUSTOM`
"""
if description is not None:
pulumi.set(__self__, "description", description)
if dest_tcp_ports is not None:
pulumi.set(__self__, "dest_tcp_ports", dest_tcp_ports)
if dest_udp_ports is not None:
pulumi.set(__self__, "dest_udp_ports", dest_udp_ports)
if is_name_l10n_tag is not None:
pulumi.set(__self__, "is_name_l10n_tag", is_name_l10n_tag)
if name is not None:
pulumi.set(__self__, "name", name)
if network_service_id is not None:
pulumi.set(__self__, "network_service_id", network_service_id)
if src_tcp_ports is not None:
pulumi.set(__self__, "src_tcp_ports", src_tcp_ports)
if src_udp_ports is not None:
pulumi.set(__self__, "src_udp_ports", src_udp_ports)
if tag is not None:
pulumi.set(__self__, "tag", tag)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the service
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="destTcpPorts")
def dest_tcp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]]]:
"""
The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_tcp_ports")
@dest_tcp_ports.setter
def dest_tcp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestTcpPortArgs']]]]):
pulumi.set(self, "dest_tcp_ports", value)
@property
@pulumi.getter(name="destUdpPorts")
def dest_udp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]]]:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_udp_ports")
@dest_udp_ports.setter
def dest_udp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesDestUdpPortArgs']]]]):
pulumi.set(self, "dest_udp_ports", value)
@property
@pulumi.getter(name="isNameL10nTag")
def is_name_l10n_tag(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional
"""
return pulumi.get(self, "is_name_l10n_tag")
@is_name_l10n_tag.setter
def is_name_l10n_tag(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_name_l10n_tag", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the service
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="networkServiceId")
def network_service_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "network_service_id")
@network_service_id.setter
def network_service_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "network_service_id", value)
@property
@pulumi.getter(name="srcTcpPorts")
def src_tcp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]]:
"""
The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
"""
return pulumi.get(self, "src_tcp_ports")
@src_tcp_ports.setter
def src_tcp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]]):
pulumi.set(self, "src_tcp_ports", value)
@property
@pulumi.getter(name="srcUdpPorts")
def src_udp_ports(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]]:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "src_udp_ports")
@src_udp_ports.setter
def src_udp_ports(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]]):
pulumi.set(self, "src_udp_ports", value)
@property
@pulumi.getter
def tag(self) -> Optional[pulumi.Input[str]]:
"""
The following values are supported: `"ICMP_ANY`, `"UDP_ANY"`, `"TCP_ANY"`, `"OTHER_NETWORK_SERVICE"`, `"DNS"`, `"NETBIOS"`, `"FTP"`, `"GNUTELLA"`, `"H_323"`, `"HTTP"`, `"HTTPS"`, `"IKE"`, `"IMAP"`, `"ILS"`, `"IKE_NAT"`, `"IRC"`, `"LDAP"`, `"QUIC"`, `"TDS"`, `"NETMEETING"`, `"NFS"`, `"NTP"`, `"SIP"`, `"SNMP"`, `"SMB"`, `"SMTP"`, `"SSH"`, `"SYSLOG"`, `"TELNET"`, `"TRACEROUTE"`, `"POP3"`, `"PPTP"`, `"RADIUS"`, `"REAL_MEDIA"`, `"RTSP"`, `"VNC"`, `"WHOIS"`, `"KERBEROS_SEC"`, `"TACACS"`, `"SNMPTRAP"`, `"NMAP"`, `"RSYNC"`, `"L2TP"`, `"HTTP_PROXY"`, `"PC_ANYWHERE"`, `"MSN"`, `"ECHO"`, `"AIM"`, `"IDENT"`, `"YMSG"`, `"SCCP"`, `"MGCP_UA"`, `"MGCP_CA"`, `"VDO_LIVE"`, `"OPENVPN"`, `"TFTP"`, `"FTPS_IMPLICIT"`, `"ZSCALER_PROXY_NW_SERVICES"`, `"GRE_PROTOCOL"`, `"ESP_PROTOCOL"`, `"DHCP"`
"""
return pulumi.get(self, "tag")
@tag.setter
def tag(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "tag", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
Supported values: `STANDARD`, `PREDEFINED`, `CUSTOM`
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
class FirewallFilteringNetworkServices(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
dest_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestTcpPortArgs']]]]] = None,
dest_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestUdpPortArgs']]]]] = None,
is_name_l10n_tag: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
src_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]]] = None,
src_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]]] = None,
tag: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The **zia_firewall_filtering_network_service** resource allows the creation and management of ZIA Cloud Firewall IP network services in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule and network service group resources.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
example = zia.firewall.FirewallFilteringNetworkServices("example",
description="example",
dest_tcp_ports=[
zia.firewall.FirewallFilteringNetworkServicesDestTcpPortArgs(
start=5000,
),
zia.firewall.FirewallFilteringNetworkServicesDestTcpPortArgs(
start=5001,
),
zia.firewall.FirewallFilteringNetworkServicesDestTcpPortArgs(
end=5005,
start=5003,
),
],
src_tcp_ports=[
zia.firewall.FirewallFilteringNetworkServicesSrcTcpPortArgs(
start=5000,
),
zia.firewall.FirewallFilteringNetworkServicesSrcTcpPortArgs(
start=5001,
),
zia.firewall.FirewallFilteringNetworkServicesSrcTcpPortArgs(
end=5005,
start=5002,
),
],
type="CUSTOM")
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the service
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestTcpPortArgs']]]] dest_tcp_ports: The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestUdpPortArgs']]]] dest_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[bool] is_name_l10n_tag: (Optional
:param pulumi.Input[str] name: Name of the service
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]] src_tcp_ports: The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]] src_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[str] tag: The following values are supported: `"ICMP_ANY`, `"UDP_ANY"`, `"TCP_ANY"`, `"OTHER_NETWORK_SERVICE"`, `"DNS"`, `"NETBIOS"`, `"FTP"`, `"GNUTELLA"`, `"H_323"`, `"HTTP"`, `"HTTPS"`, `"IKE"`, `"IMAP"`, `"ILS"`, `"IKE_NAT"`, `"IRC"`, `"LDAP"`, `"QUIC"`, `"TDS"`, `"NETMEETING"`, `"NFS"`, `"NTP"`, `"SIP"`, `"SNMP"`, `"SMB"`, `"SMTP"`, `"SSH"`, `"SYSLOG"`, `"TELNET"`, `"TRACEROUTE"`, `"POP3"`, `"PPTP"`, `"RADIUS"`, `"REAL_MEDIA"`, `"RTSP"`, `"VNC"`, `"WHOIS"`, `"KERBEROS_SEC"`, `"TACACS"`, `"SNMPTRAP"`, `"NMAP"`, `"RSYNC"`, `"L2TP"`, `"HTTP_PROXY"`, `"PC_ANYWHERE"`, `"MSN"`, `"ECHO"`, `"AIM"`, `"IDENT"`, `"YMSG"`, `"SCCP"`, `"MGCP_UA"`, `"MGCP_CA"`, `"VDO_LIVE"`, `"OPENVPN"`, `"TFTP"`, `"FTPS_IMPLICIT"`, `"ZSCALER_PROXY_NW_SERVICES"`, `"GRE_PROTOCOL"`, `"ESP_PROTOCOL"`, `"DHCP"`
:param pulumi.Input[str] type: Supported values: `STANDARD`, `PREDEFINED`, `CUSTOM`
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[FirewallFilteringNetworkServicesArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_firewall_filtering_network_service** resource allows the creation and management of ZIA Cloud Firewall IP network services in the Zscaler Internet Access. This resource can then be associated with a ZIA cloud firewall filtering rule and network service group resources.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
example = zia.firewall.FirewallFilteringNetworkServices("example",
description="example",
dest_tcp_ports=[
zia.firewall.FirewallFilteringNetworkServicesDestTcpPortArgs(
start=5000,
),
zia.firewall.FirewallFilteringNetworkServicesDestTcpPortArgs(
start=5001,
),
zia.firewall.FirewallFilteringNetworkServicesDestTcpPortArgs(
end=5005,
start=5003,
),
],
src_tcp_ports=[
zia.firewall.FirewallFilteringNetworkServicesSrcTcpPortArgs(
start=5000,
),
zia.firewall.FirewallFilteringNetworkServicesSrcTcpPortArgs(
start=5001,
),
zia.firewall.FirewallFilteringNetworkServicesSrcTcpPortArgs(
end=5005,
start=5002,
),
],
type="CUSTOM")
```
:param str resource_name: The name of the resource.
:param FirewallFilteringNetworkServicesArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(FirewallFilteringNetworkServicesArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
dest_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestTcpPortArgs']]]]] = None,
dest_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestUdpPortArgs']]]]] = None,
is_name_l10n_tag: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
src_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]]] = None,
src_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]]] = None,
tag: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = FirewallFilteringNetworkServicesArgs.__new__(FirewallFilteringNetworkServicesArgs)
__props__.__dict__["description"] = description
__props__.__dict__["dest_tcp_ports"] = dest_tcp_ports
__props__.__dict__["dest_udp_ports"] = dest_udp_ports
__props__.__dict__["is_name_l10n_tag"] = is_name_l10n_tag
__props__.__dict__["name"] = name
__props__.__dict__["src_tcp_ports"] = src_tcp_ports
__props__.__dict__["src_udp_ports"] = src_udp_ports
__props__.__dict__["tag"] = tag
__props__.__dict__["type"] = type
__props__.__dict__["network_service_id"] = None
super(FirewallFilteringNetworkServices, __self__).__init__(
'zia:Firewall/firewallFilteringNetworkServices:FirewallFilteringNetworkServices',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
dest_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestTcpPortArgs']]]]] = None,
dest_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestUdpPortArgs']]]]] = None,
is_name_l10n_tag: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
network_service_id: Optional[pulumi.Input[int]] = None,
src_tcp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]]] = None,
src_udp_ports: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]]] = None,
tag: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None) -> 'FirewallFilteringNetworkServices':
"""
Get an existing FirewallFilteringNetworkServices resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: Description of the service
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestTcpPortArgs']]]] dest_tcp_ports: The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesDestUdpPortArgs']]]] dest_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[bool] is_name_l10n_tag: (Optional
:param pulumi.Input[str] name: Name of the service
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcTcpPortArgs']]]] src_tcp_ports: The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['FirewallFilteringNetworkServicesSrcUdpPortArgs']]]] src_udp_ports: The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
:param pulumi.Input[str] tag: The following values are supported: `"ICMP_ANY`, `"UDP_ANY"`, `"TCP_ANY"`, `"OTHER_NETWORK_SERVICE"`, `"DNS"`, `"NETBIOS"`, `"FTP"`, `"GNUTELLA"`, `"H_323"`, `"HTTP"`, `"HTTPS"`, `"IKE"`, `"IMAP"`, `"ILS"`, `"IKE_NAT"`, `"IRC"`, `"LDAP"`, `"QUIC"`, `"TDS"`, `"NETMEETING"`, `"NFS"`, `"NTP"`, `"SIP"`, `"SNMP"`, `"SMB"`, `"SMTP"`, `"SSH"`, `"SYSLOG"`, `"TELNET"`, `"TRACEROUTE"`, `"POP3"`, `"PPTP"`, `"RADIUS"`, `"REAL_MEDIA"`, `"RTSP"`, `"VNC"`, `"WHOIS"`, `"KERBEROS_SEC"`, `"TACACS"`, `"SNMPTRAP"`, `"NMAP"`, `"RSYNC"`, `"L2TP"`, `"HTTP_PROXY"`, `"PC_ANYWHERE"`, `"MSN"`, `"ECHO"`, `"AIM"`, `"IDENT"`, `"YMSG"`, `"SCCP"`, `"MGCP_UA"`, `"MGCP_CA"`, `"VDO_LIVE"`, `"OPENVPN"`, `"TFTP"`, `"FTPS_IMPLICIT"`, `"ZSCALER_PROXY_NW_SERVICES"`, `"GRE_PROTOCOL"`, `"ESP_PROTOCOL"`, `"DHCP"`
:param pulumi.Input[str] type: Supported values: `STANDARD`, `PREDEFINED`, `CUSTOM`
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _FirewallFilteringNetworkServicesState.__new__(_FirewallFilteringNetworkServicesState)
__props__.__dict__["description"] = description
__props__.__dict__["dest_tcp_ports"] = dest_tcp_ports
__props__.__dict__["dest_udp_ports"] = dest_udp_ports
__props__.__dict__["is_name_l10n_tag"] = is_name_l10n_tag
__props__.__dict__["name"] = name
__props__.__dict__["network_service_id"] = network_service_id
__props__.__dict__["src_tcp_ports"] = src_tcp_ports
__props__.__dict__["src_udp_ports"] = src_udp_ports
__props__.__dict__["tag"] = tag
__props__.__dict__["type"] = type
return FirewallFilteringNetworkServices(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Description of the service
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="destTcpPorts")
def dest_tcp_ports(self) -> pulumi.Output[Optional[Sequence['outputs.FirewallFilteringNetworkServicesDestTcpPort']]]:
"""
The TCP destination port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_tcp_ports")
@property
@pulumi.getter(name="destUdpPorts")
def dest_udp_ports(self) -> pulumi.Output[Optional[Sequence['outputs.FirewallFilteringNetworkServicesDestUdpPort']]]:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "dest_udp_ports")
@property
@pulumi.getter(name="isNameL10nTag")
def is_name_l10n_tag(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional
"""
return pulumi.get(self, "is_name_l10n_tag")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the service
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="networkServiceId")
def network_service_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "network_service_id")
@property
@pulumi.getter(name="srcTcpPorts")
def src_tcp_ports(self) -> pulumi.Output[Optional[Sequence['outputs.FirewallFilteringNetworkServicesSrcTcpPort']]]:
"""
The TCP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service
"""
return pulumi.get(self, "src_tcp_ports")
@property
@pulumi.getter(name="srcUdpPorts")
def src_udp_ports(self) -> pulumi.Output[Optional[Sequence['outputs.FirewallFilteringNetworkServicesSrcUdpPort']]]:
"""
The UDP source port number (example: 50) or port number range (example: 1000-1050), if any, that is used by the network service.
"""
return pulumi.get(self, "src_udp_ports")
@property
@pulumi.getter
def tag(self) -> pulumi.Output[str]:
"""
The following values are supported: `"ICMP_ANY`, `"UDP_ANY"`, `"TCP_ANY"`, `"OTHER_NETWORK_SERVICE"`, `"DNS"`, `"NETBIOS"`, `"FTP"`, `"GNUTELLA"`, `"H_323"`, `"HTTP"`, `"HTTPS"`, `"IKE"`, `"IMAP"`, `"ILS"`, `"IKE_NAT"`, `"IRC"`, `"LDAP"`, `"QUIC"`, `"TDS"`, `"NETMEETING"`, `"NFS"`, `"NTP"`, `"SIP"`, `"SNMP"`, `"SMB"`, `"SMTP"`, `"SSH"`, `"SYSLOG"`, `"TELNET"`, `"TRACEROUTE"`, `"POP3"`, `"PPTP"`, `"RADIUS"`, `"REAL_MEDIA"`, `"RTSP"`, `"VNC"`, `"WHOIS"`, `"KERBEROS_SEC"`, `"TACACS"`, `"SNMPTRAP"`, `"NMAP"`, `"RSYNC"`, `"L2TP"`, `"HTTP_PROXY"`, `"PC_ANYWHERE"`, `"MSN"`, `"ECHO"`, `"AIM"`, `"IDENT"`, `"YMSG"`, `"SCCP"`, `"MGCP_UA"`, `"MGCP_CA"`, `"VDO_LIVE"`, `"OPENVPN"`, `"TFTP"`, `"FTPS_IMPLICIT"`, `"ZSCALER_PROXY_NW_SERVICES"`, `"GRE_PROTOCOL"`, `"ESP_PROTOCOL"`, `"DHCP"`
"""
return pulumi.get(self, "tag")
@property
@pulumi.getter
def type(self) -> pulumi.Output[Optional[str]]:
"""
Supported values: `STANDARD`, `PREDEFINED`, `CUSTOM`
"""
return pulumi.get(self, "type") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/firewall_filtering_network_services.py | firewall_filtering_network_services.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetFirewallFilteringRuleResult',
'AwaitableGetFirewallFilteringRuleResult',
'get_firewall_filtering_rule',
'get_firewall_filtering_rule_output',
]
@pulumi.output_type
class GetFirewallFilteringRuleResult:
"""
A collection of values returned by getFirewallFilteringRule.
"""
def __init__(__self__, access_control=None, action=None, app_service_groups=None, app_services=None, default_rule=None, departments=None, description=None, dest_addresses=None, dest_countries=None, dest_ip_categories=None, dest_ip_groups=None, enable_full_logging=None, groups=None, id=None, labels=None, last_modified_bies=None, last_modified_time=None, location_groups=None, locations=None, name=None, nw_application_groups=None, nw_applications=None, nw_service_groups=None, nw_services=None, order=None, predefined=None, rank=None, src_ip_groups=None, src_ips=None, state=None, time_windows=None, users=None):
if access_control and not isinstance(access_control, str):
raise TypeError("Expected argument 'access_control' to be a str")
pulumi.set(__self__, "access_control", access_control)
if action and not isinstance(action, str):
raise TypeError("Expected argument 'action' to be a str")
pulumi.set(__self__, "action", action)
if app_service_groups and not isinstance(app_service_groups, list):
raise TypeError("Expected argument 'app_service_groups' to be a list")
pulumi.set(__self__, "app_service_groups", app_service_groups)
if app_services and not isinstance(app_services, list):
raise TypeError("Expected argument 'app_services' to be a list")
pulumi.set(__self__, "app_services", app_services)
if default_rule and not isinstance(default_rule, bool):
raise TypeError("Expected argument 'default_rule' to be a bool")
pulumi.set(__self__, "default_rule", default_rule)
if departments and not isinstance(departments, list):
raise TypeError("Expected argument 'departments' to be a list")
pulumi.set(__self__, "departments", departments)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if dest_addresses and not isinstance(dest_addresses, list):
raise TypeError("Expected argument 'dest_addresses' to be a list")
pulumi.set(__self__, "dest_addresses", dest_addresses)
if dest_countries and not isinstance(dest_countries, list):
raise TypeError("Expected argument 'dest_countries' to be a list")
pulumi.set(__self__, "dest_countries", dest_countries)
if dest_ip_categories and not isinstance(dest_ip_categories, list):
raise TypeError("Expected argument 'dest_ip_categories' to be a list")
pulumi.set(__self__, "dest_ip_categories", dest_ip_categories)
if dest_ip_groups and not isinstance(dest_ip_groups, list):
raise TypeError("Expected argument 'dest_ip_groups' to be a list")
pulumi.set(__self__, "dest_ip_groups", dest_ip_groups)
if enable_full_logging and not isinstance(enable_full_logging, bool):
raise TypeError("Expected argument 'enable_full_logging' to be a bool")
pulumi.set(__self__, "enable_full_logging", enable_full_logging)
if groups and not isinstance(groups, list):
raise TypeError("Expected argument 'groups' to be a list")
pulumi.set(__self__, "groups", groups)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if labels and not isinstance(labels, list):
raise TypeError("Expected argument 'labels' to be a list")
pulumi.set(__self__, "labels", labels)
if last_modified_bies and not isinstance(last_modified_bies, list):
raise TypeError("Expected argument 'last_modified_bies' to be a list")
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time and not isinstance(last_modified_time, int):
raise TypeError("Expected argument 'last_modified_time' to be a int")
pulumi.set(__self__, "last_modified_time", last_modified_time)
if location_groups and not isinstance(location_groups, list):
raise TypeError("Expected argument 'location_groups' to be a list")
pulumi.set(__self__, "location_groups", location_groups)
if locations and not isinstance(locations, list):
raise TypeError("Expected argument 'locations' to be a list")
pulumi.set(__self__, "locations", locations)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if nw_application_groups and not isinstance(nw_application_groups, list):
raise TypeError("Expected argument 'nw_application_groups' to be a list")
pulumi.set(__self__, "nw_application_groups", nw_application_groups)
if nw_applications and not isinstance(nw_applications, list):
raise TypeError("Expected argument 'nw_applications' to be a list")
pulumi.set(__self__, "nw_applications", nw_applications)
if nw_service_groups and not isinstance(nw_service_groups, list):
raise TypeError("Expected argument 'nw_service_groups' to be a list")
pulumi.set(__self__, "nw_service_groups", nw_service_groups)
if nw_services and not isinstance(nw_services, list):
raise TypeError("Expected argument 'nw_services' to be a list")
pulumi.set(__self__, "nw_services", nw_services)
if order and not isinstance(order, int):
raise TypeError("Expected argument 'order' to be a int")
pulumi.set(__self__, "order", order)
if predefined and not isinstance(predefined, bool):
raise TypeError("Expected argument 'predefined' to be a bool")
pulumi.set(__self__, "predefined", predefined)
if rank and not isinstance(rank, int):
raise TypeError("Expected argument 'rank' to be a int")
pulumi.set(__self__, "rank", rank)
if src_ip_groups and not isinstance(src_ip_groups, list):
raise TypeError("Expected argument 'src_ip_groups' to be a list")
pulumi.set(__self__, "src_ip_groups", src_ip_groups)
if src_ips and not isinstance(src_ips, list):
raise TypeError("Expected argument 'src_ips' to be a list")
pulumi.set(__self__, "src_ips", src_ips)
if state and not isinstance(state, str):
raise TypeError("Expected argument 'state' to be a str")
pulumi.set(__self__, "state", state)
if time_windows and not isinstance(time_windows, list):
raise TypeError("Expected argument 'time_windows' to be a list")
pulumi.set(__self__, "time_windows", time_windows)
if users and not isinstance(users, list):
raise TypeError("Expected argument 'users' to be a list")
pulumi.set(__self__, "users", users)
@property
@pulumi.getter(name="accessControl")
def access_control(self) -> str:
"""
(String)
"""
return pulumi.get(self, "access_control")
@property
@pulumi.getter
def action(self) -> Optional[str]:
"""
(Optional) Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
"""
return pulumi.get(self, "action")
@property
@pulumi.getter(name="appServiceGroups")
def app_service_groups(self) -> Sequence['outputs.GetFirewallFilteringRuleAppServiceGroupResult']:
"""
Application service groups on which this rule is applied
"""
return pulumi.get(self, "app_service_groups")
@property
@pulumi.getter(name="appServices")
def app_services(self) -> Sequence['outputs.GetFirewallFilteringRuleAppServiceResult']:
"""
Application services on which this rule is applied
"""
return pulumi.get(self, "app_services")
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> bool:
"""
(Boolean)
"""
return pulumi.get(self, "default_rule")
@property
@pulumi.getter
def departments(self) -> Sequence['outputs.GetFirewallFilteringRuleDepartmentResult']:
"""
(Optional) Apply to any number of departments When not used it implies `Any` to apply the rule to all departments.
"""
return pulumi.get(self, "departments")
@property
@pulumi.getter
def description(self) -> Optional[str]:
"""
(Optional) Enter additional notes or information. The description cannot exceed 10,240 characters.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="destAddresses")
def dest_addresses(self) -> Sequence[str]:
"""
** - (Optional) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
"""
return pulumi.get(self, "dest_addresses")
@property
@pulumi.getter(name="destCountries")
def dest_countries(self) -> Sequence[str]:
"""
** - (Optional) Identify destinations based on the location of a server, select Any to apply the rule to all countries or select the countries to which you want to control traffic.
"""
return pulumi.get(self, "dest_countries")
@property
@pulumi.getter(name="destIpCategories")
def dest_ip_categories(self) -> Sequence[str]:
"""
** - (Optional) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
"""
return pulumi.get(self, "dest_ip_categories")
@property
@pulumi.getter(name="destIpGroups")
def dest_ip_groups(self) -> Sequence[str]:
"""
** - (Optional) Any number of destination IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "dest_ip_groups")
@property
@pulumi.getter(name="enableFullLogging")
def enable_full_logging(self) -> bool:
"""
(Boolean)
"""
return pulumi.get(self, "enable_full_logging")
@property
@pulumi.getter
def groups(self) -> Sequence['outputs.GetFirewallFilteringRuleGroupResult']:
"""
(Optional) You can manually select up to `8` groups. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "groups")
@property
@pulumi.getter
def id(self) -> int:
"""
(Number) The ID of this resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def labels(self) -> Sequence['outputs.GetFirewallFilteringRuleLabelResult']:
"""
Labels that are applicable to the rule.
"""
return pulumi.get(self, "labels")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Sequence['outputs.GetFirewallFilteringRuleLastModifiedByResult']:
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> Optional[int]:
"""
(Number)
"""
return pulumi.get(self, "last_modified_time")
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> Sequence['outputs.GetFirewallFilteringRuleLocationGroupResult']:
"""
(Optional) You can manually select up to `32` location groups. When not used it implies `Any` to apply the rule to all location groups.
"""
return pulumi.get(self, "location_groups")
@property
@pulumi.getter
def locations(self) -> Sequence['outputs.GetFirewallFilteringRuleLocationResult']:
"""
(Optional) You can manually select up to `8` locations. When not used it implies `Any` to apply the rule to all groups.
"""
return pulumi.get(self, "locations")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="nwApplicationGroups")
def nw_application_groups(self) -> Sequence['outputs.GetFirewallFilteringRuleNwApplicationGroupResult']:
"""
(Optional) Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
"""
return pulumi.get(self, "nw_application_groups")
@property
@pulumi.getter(name="nwApplications")
def nw_applications(self) -> Sequence[str]:
"""
(Optional) When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
"""
return pulumi.get(self, "nw_applications")
@property
@pulumi.getter(name="nwServiceGroups")
def nw_service_groups(self) -> Sequence['outputs.GetFirewallFilteringRuleNwServiceGroupResult']:
"""
(Optional) Any number of predefined or custom network service groups to which the rule applies.
"""
return pulumi.get(self, "nw_service_groups")
@property
@pulumi.getter(name="nwServices")
def nw_services(self) -> Sequence['outputs.GetFirewallFilteringRuleNwServiceResult']:
"""
(Optional) When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to `1,024` additional custom services.
"""
return pulumi.get(self, "nw_services")
@property
@pulumi.getter
def order(self) -> int:
"""
(Required) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
"""
return pulumi.get(self, "order")
@property
@pulumi.getter
def predefined(self) -> bool:
"""
(Boolean)
"""
return pulumi.get(self, "predefined")
@property
@pulumi.getter
def rank(self) -> int:
"""
(Optional) By default, the admin ranking is disabled. To use this feature, you must enable admin rank. The default value is `7`.
"""
return pulumi.get(self, "rank")
@property
@pulumi.getter(name="srcIpGroups")
def src_ip_groups(self) -> Sequence[str]:
"""
(Optional) Any number of source IP address groups that you want to control with this rule.
"""
return pulumi.get(self, "src_ip_groups")
@property
@pulumi.getter(name="srcIps")
def src_ips(self) -> Sequence[str]:
"""
(Optional) You can enter individual IP addresses, subnets, or address ranges.
"""
return pulumi.get(self, "src_ips")
@property
@pulumi.getter
def state(self) -> Optional[str]:
"""
(Optional) An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
"""
return pulumi.get(self, "state")
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> Sequence['outputs.GetFirewallFilteringRuleTimeWindowResult']:
"""
(Optional) You can manually select up to `2` time intervals. When not used it implies `always` to apply the rule to all time intervals.
"""
return pulumi.get(self, "time_windows")
@property
@pulumi.getter
def users(self) -> Sequence['outputs.GetFirewallFilteringRuleUserResult']:
"""
(Optional) You can manually select up to `4` general and/or special users. When not used it implies `Any` to apply the rule to all users.
"""
return pulumi.get(self, "users")
class AwaitableGetFirewallFilteringRuleResult(GetFirewallFilteringRuleResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetFirewallFilteringRuleResult(
access_control=self.access_control,
action=self.action,
app_service_groups=self.app_service_groups,
app_services=self.app_services,
default_rule=self.default_rule,
departments=self.departments,
description=self.description,
dest_addresses=self.dest_addresses,
dest_countries=self.dest_countries,
dest_ip_categories=self.dest_ip_categories,
dest_ip_groups=self.dest_ip_groups,
enable_full_logging=self.enable_full_logging,
groups=self.groups,
id=self.id,
labels=self.labels,
last_modified_bies=self.last_modified_bies,
last_modified_time=self.last_modified_time,
location_groups=self.location_groups,
locations=self.locations,
name=self.name,
nw_application_groups=self.nw_application_groups,
nw_applications=self.nw_applications,
nw_service_groups=self.nw_service_groups,
nw_services=self.nw_services,
order=self.order,
predefined=self.predefined,
rank=self.rank,
src_ip_groups=self.src_ip_groups,
src_ips=self.src_ips,
state=self.state,
time_windows=self.time_windows,
users=self.users)
def get_firewall_filtering_rule(action: Optional[str] = None,
description: Optional[str] = None,
id: Optional[int] = None,
last_modified_time: Optional[int] = None,
name: Optional[str] = None,
state: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetFirewallFilteringRuleResult:
"""
Use the **zia_firewall_filtering_rule** data source to get information about a cloud firewall rule available in the Zscaler Internet Access cloud firewall.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_rule(name="Office 365 One Click Rule")
```
:param str action: (Optional) Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
:param str description: (Optional) Enter additional notes or information. The description cannot exceed 10,240 characters.
:param int id: Unique identifier for the Firewall Filtering policy rule
:param int last_modified_time: (Number)
:param str name: Name of the Firewall Filtering policy rule
:param str state: (Optional) An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
"""
__args__ = dict()
__args__['action'] = action
__args__['description'] = description
__args__['id'] = id
__args__['lastModifiedTime'] = last_modified_time
__args__['name'] = name
__args__['state'] = state
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Firewall/getFirewallFilteringRule:getFirewallFilteringRule', __args__, opts=opts, typ=GetFirewallFilteringRuleResult).value
return AwaitableGetFirewallFilteringRuleResult(
access_control=__ret__.access_control,
action=__ret__.action,
app_service_groups=__ret__.app_service_groups,
app_services=__ret__.app_services,
default_rule=__ret__.default_rule,
departments=__ret__.departments,
description=__ret__.description,
dest_addresses=__ret__.dest_addresses,
dest_countries=__ret__.dest_countries,
dest_ip_categories=__ret__.dest_ip_categories,
dest_ip_groups=__ret__.dest_ip_groups,
enable_full_logging=__ret__.enable_full_logging,
groups=__ret__.groups,
id=__ret__.id,
labels=__ret__.labels,
last_modified_bies=__ret__.last_modified_bies,
last_modified_time=__ret__.last_modified_time,
location_groups=__ret__.location_groups,
locations=__ret__.locations,
name=__ret__.name,
nw_application_groups=__ret__.nw_application_groups,
nw_applications=__ret__.nw_applications,
nw_service_groups=__ret__.nw_service_groups,
nw_services=__ret__.nw_services,
order=__ret__.order,
predefined=__ret__.predefined,
rank=__ret__.rank,
src_ip_groups=__ret__.src_ip_groups,
src_ips=__ret__.src_ips,
state=__ret__.state,
time_windows=__ret__.time_windows,
users=__ret__.users)
@_utilities.lift_output_func(get_firewall_filtering_rule)
def get_firewall_filtering_rule_output(action: Optional[pulumi.Input[Optional[str]]] = None,
description: Optional[pulumi.Input[Optional[str]]] = None,
id: Optional[pulumi.Input[Optional[int]]] = None,
last_modified_time: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
state: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetFirewallFilteringRuleResult]:
"""
Use the **zia_firewall_filtering_rule** data source to get information about a cloud firewall rule available in the Zscaler Internet Access cloud firewall.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.Firewall.get_firewall_filtering_rule(name="Office 365 One Click Rule")
```
:param str action: (Optional) Choose the action of the service when packets match the rule. The following actions are accepted: `ALLOW`, `BLOCK_DROP`, `BLOCK_RESET`, `BLOCK_ICMP`, `EVAL_NWAPP`
:param str description: (Optional) Enter additional notes or information. The description cannot exceed 10,240 characters.
:param int id: Unique identifier for the Firewall Filtering policy rule
:param int last_modified_time: (Number)
:param str name: Name of the Firewall Filtering policy rule
:param str state: (Optional) An enabled rule is actively enforced. A disabled rule is not actively enforced but does not lose its place in the Rule Order. The service skips it and moves to the next rule.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/firewall/get_firewall_filtering_rule.py | get_firewall_filtering_rule.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'RuleLabelsCreatedByArgs',
'RuleLabelsLastModifiedByArgs',
]
@pulumi.input_type
class RuleLabelsCreatedByArgs:
def __init__(__self__, *,
extensions: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[str] name: The name of the devices to be created.
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
The name of the devices to be created.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class RuleLabelsLastModifiedByArgs:
def __init__(__self__, *,
extensions: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[str] name: The name of the devices to be created.
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
The name of the devices to be created.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/rulelabels/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['RuleLabelsArgs', 'RuleLabels']
@pulumi.input_type
class RuleLabelsArgs:
def __init__(__self__, *,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a RuleLabels resource.
:param pulumi.Input[str] description: The rule label description.
:param pulumi.Input[str] name: The name of the devices to be created.
"""
if description is not None:
pulumi.set(__self__, "description", description)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
The rule label description.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
The name of the devices to be created.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class _RuleLabelsState:
def __init__(__self__, *,
created_bies: Optional[pulumi.Input[Sequence[pulumi.Input['RuleLabelsCreatedByArgs']]]] = None,
description: Optional[pulumi.Input[str]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['RuleLabelsLastModifiedByArgs']]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
referenced_rule_count: Optional[pulumi.Input[int]] = None,
rule_label_id: Optional[pulumi.Input[int]] = None):
"""
Input properties used for looking up and filtering RuleLabels resources.
:param pulumi.Input[Sequence[pulumi.Input['RuleLabelsCreatedByArgs']]] created_bies: The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
:param pulumi.Input[str] description: The rule label description.
:param pulumi.Input[Sequence[pulumi.Input['RuleLabelsLastModifiedByArgs']]] last_modified_bies: The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
:param pulumi.Input[int] last_modified_time: Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
:param pulumi.Input[str] name: The name of the devices to be created.
"""
if created_bies is not None:
pulumi.set(__self__, "created_bies", created_bies)
if description is not None:
pulumi.set(__self__, "description", description)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time is not None:
pulumi.set(__self__, "last_modified_time", last_modified_time)
if name is not None:
pulumi.set(__self__, "name", name)
if referenced_rule_count is not None:
pulumi.set(__self__, "referenced_rule_count", referenced_rule_count)
if rule_label_id is not None:
pulumi.set(__self__, "rule_label_id", rule_label_id)
@property
@pulumi.getter(name="createdBies")
def created_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['RuleLabelsCreatedByArgs']]]]:
"""
The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
"""
return pulumi.get(self, "created_bies")
@created_bies.setter
def created_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['RuleLabelsCreatedByArgs']]]]):
pulumi.set(self, "created_bies", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
The rule label description.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['RuleLabelsLastModifiedByArgs']]]]:
"""
The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
"""
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['RuleLabelsLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> Optional[pulumi.Input[int]]:
"""
Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
"""
return pulumi.get(self, "last_modified_time")
@last_modified_time.setter
def last_modified_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "last_modified_time", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
The name of the devices to be created.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="referencedRuleCount")
def referenced_rule_count(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "referenced_rule_count")
@referenced_rule_count.setter
def referenced_rule_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "referenced_rule_count", value)
@property
@pulumi.getter(name="ruleLabelId")
def rule_label_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "rule_label_id")
@rule_label_id.setter
def rule_label_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "rule_label_id", value)
class RuleLabels(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The **zia_rule_labels** resource allows the creation and management of rule labels in the Zscaler Internet Access cloud or via the API. This resource can then be associated with resources such as: Firewall Rules and URL filtering rules
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Rule Labels Resource
example = zia.rule_labels.RuleLabels("example", description="Example")
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] description: The rule label description.
:param pulumi.Input[str] name: The name of the devices to be created.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[RuleLabelsArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_rule_labels** resource allows the creation and management of rule labels in the Zscaler Internet Access cloud or via the API. This resource can then be associated with resources such as: Firewall Rules and URL filtering rules
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Rule Labels Resource
example = zia.rule_labels.RuleLabels("example", description="Example")
```
:param str resource_name: The name of the resource.
:param RuleLabelsArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(RuleLabelsArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
description: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = RuleLabelsArgs.__new__(RuleLabelsArgs)
__props__.__dict__["description"] = description
__props__.__dict__["name"] = name
__props__.__dict__["created_bies"] = None
__props__.__dict__["last_modified_bies"] = None
__props__.__dict__["last_modified_time"] = None
__props__.__dict__["referenced_rule_count"] = None
__props__.__dict__["rule_label_id"] = None
super(RuleLabels, __self__).__init__(
'zia:RuleLabels/ruleLabels:RuleLabels',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
created_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RuleLabelsCreatedByArgs']]]]] = None,
description: Optional[pulumi.Input[str]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RuleLabelsLastModifiedByArgs']]]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
referenced_rule_count: Optional[pulumi.Input[int]] = None,
rule_label_id: Optional[pulumi.Input[int]] = None) -> 'RuleLabels':
"""
Get an existing RuleLabels resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RuleLabelsCreatedByArgs']]]] created_bies: The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
:param pulumi.Input[str] description: The rule label description.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['RuleLabelsLastModifiedByArgs']]]] last_modified_bies: The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
:param pulumi.Input[int] last_modified_time: Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
:param pulumi.Input[str] name: The name of the devices to be created.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _RuleLabelsState.__new__(_RuleLabelsState)
__props__.__dict__["created_bies"] = created_bies
__props__.__dict__["description"] = description
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["last_modified_time"] = last_modified_time
__props__.__dict__["name"] = name
__props__.__dict__["referenced_rule_count"] = referenced_rule_count
__props__.__dict__["rule_label_id"] = rule_label_id
return RuleLabels(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="createdBies")
def created_bies(self) -> pulumi.Output[Sequence['outputs.RuleLabelsCreatedBy']]:
"""
The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
"""
return pulumi.get(self, "created_bies")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
The rule label description.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> pulumi.Output[Sequence['outputs.RuleLabelsLastModifiedBy']]:
"""
The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
"""
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> pulumi.Output[int]:
"""
Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
"""
return pulumi.get(self, "last_modified_time")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
The name of the devices to be created.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="referencedRuleCount")
def referenced_rule_count(self) -> pulumi.Output[int]:
return pulumi.get(self, "referenced_rule_count")
@property
@pulumi.getter(name="ruleLabelId")
def rule_label_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "rule_label_id") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/rulelabels/rule_labels.py | rule_labels.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'RuleLabelsCreatedBy',
'RuleLabelsLastModifiedBy',
'GetRuleLabelsCreatedByResult',
'GetRuleLabelsLastModifiedByResult',
]
@pulumi.output_type
class RuleLabelsCreatedBy(dict):
def __init__(__self__, *,
extensions: Optional[Mapping[str, str]] = None,
id: Optional[int] = None,
name: Optional[str] = None):
"""
:param str name: The name of the devices to be created.
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[Mapping[str, str]]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> Optional[int]:
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
The name of the devices to be created.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class RuleLabelsLastModifiedBy(dict):
def __init__(__self__, *,
extensions: Optional[Mapping[str, str]] = None,
id: Optional[int] = None,
name: Optional[str] = None):
"""
:param str name: The name of the devices to be created.
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[Mapping[str, str]]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> Optional[int]:
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
The name of the devices to be created.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetRuleLabelsCreatedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param int id: The unique identifer for the device group.
:param str name: The name of the rule label to be exported.
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
The unique identifer for the device group.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the rule label to be exported.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetRuleLabelsLastModifiedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param int id: The unique identifer for the device group.
:param str name: The name of the rule label to be exported.
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
The unique identifer for the device group.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the rule label to be exported.
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/rulelabels/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetRuleLabelsResult',
'AwaitableGetRuleLabelsResult',
'get_rule_labels',
'get_rule_labels_output',
]
@pulumi.output_type
class GetRuleLabelsResult:
"""
A collection of values returned by getRuleLabels.
"""
def __init__(__self__, created_bies=None, description=None, id=None, last_modified_bies=None, last_modified_time=None, name=None, referenced_rule_count=None):
if created_bies and not isinstance(created_bies, list):
raise TypeError("Expected argument 'created_bies' to be a list")
pulumi.set(__self__, "created_bies", created_bies)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if last_modified_bies and not isinstance(last_modified_bies, list):
raise TypeError("Expected argument 'last_modified_bies' to be a list")
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time and not isinstance(last_modified_time, int):
raise TypeError("Expected argument 'last_modified_time' to be a int")
pulumi.set(__self__, "last_modified_time", last_modified_time)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if referenced_rule_count and not isinstance(referenced_rule_count, int):
raise TypeError("Expected argument 'referenced_rule_count' to be a int")
pulumi.set(__self__, "referenced_rule_count", referenced_rule_count)
@property
@pulumi.getter(name="createdBies")
def created_bies(self) -> Sequence['outputs.GetRuleLabelsCreatedByResult']:
"""
(String) The admin that created the rule label. This is a read-only field. Ignored by PUT requests.
"""
return pulumi.get(self, "created_bies")
@property
@pulumi.getter
def description(self) -> str:
"""
(String) The rule label description.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Sequence['outputs.GetRuleLabelsLastModifiedByResult']:
"""
(String) The admin that modified the rule label last. This is a read-only field. Ignored by PUT requests.
"""
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> int:
"""
(String) Timestamp when the rule lable was last modified. This is a read-only field. Ignored by PUT and DELETE requests.
"""
return pulumi.get(self, "last_modified_time")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="referencedRuleCount")
def referenced_rule_count(self) -> int:
"""
(int) The number of rules that reference the label.
"""
return pulumi.get(self, "referenced_rule_count")
class AwaitableGetRuleLabelsResult(GetRuleLabelsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetRuleLabelsResult(
created_bies=self.created_bies,
description=self.description,
id=self.id,
last_modified_bies=self.last_modified_bies,
last_modified_time=self.last_modified_time,
name=self.name,
referenced_rule_count=self.referenced_rule_count)
def get_rule_labels(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetRuleLabelsResult:
"""
Use the **zia_rule_labels** data source to get information about a rule label resource in the Zscaler Internet Access cloud or via the API. This data source can then be associated with resources such as: Firewall Rules and URL filtering rules
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.RuleLabels.get_rule_labels(name="Example")
```
:param int id: The unique identifer for the device group.
:param str name: The name of the rule label to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:RuleLabels/getRuleLabels:getRuleLabels', __args__, opts=opts, typ=GetRuleLabelsResult).value
return AwaitableGetRuleLabelsResult(
created_bies=__ret__.created_bies,
description=__ret__.description,
id=__ret__.id,
last_modified_bies=__ret__.last_modified_bies,
last_modified_time=__ret__.last_modified_time,
name=__ret__.name,
referenced_rule_count=__ret__.referenced_rule_count)
@_utilities.lift_output_func(get_rule_labels)
def get_rule_labels_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetRuleLabelsResult]:
"""
Use the **zia_rule_labels** data source to get information about a rule label resource in the Zscaler Internet Access cloud or via the API. This data source can then be associated with resources such as: Firewall Rules and URL filtering rules
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.RuleLabels.get_rule_labels(name="Example")
```
:param int id: The unique identifer for the device group.
:param str name: The name of the rule label to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/rulelabels/get_rule_labels.py | get_rule_labels.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'UserManagementDepartmentArgs',
'UserManagementGroupsArgs',
]
@pulumi.input_type
class UserManagementDepartmentArgs:
def __init__(__self__, *,
comments: Optional[pulumi.Input[str]] = None,
deleted: Optional[pulumi.Input[bool]] = None,
id: Optional[pulumi.Input[int]] = None,
idp_id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[int] id: Department ID
:param pulumi.Input[str] name: User name. This appears when choosing users for policies.
"""
if comments is not None:
pulumi.set(__self__, "comments", comments)
if deleted is not None:
pulumi.set(__self__, "deleted", deleted)
if id is not None:
pulumi.set(__self__, "id", id)
if idp_id is not None:
pulumi.set(__self__, "idp_id", idp_id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def comments(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "comments")
@comments.setter
def comments(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comments", value)
@property
@pulumi.getter
def deleted(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "deleted")
@deleted.setter
def deleted(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "deleted", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
"""
Department ID
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "idp_id")
@idp_id.setter
def idp_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "idp_id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
User name. This appears when choosing users for policies.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class UserManagementGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Department ID
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Department ID
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/users/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['UserManagementArgs', 'UserManagement']
@pulumi.input_type
class UserManagementArgs:
def __init__(__self__, *,
email: pulumi.Input[str],
password: pulumi.Input[str],
comments: Optional[pulumi.Input[str]] = None,
department: Optional[pulumi.Input['UserManagementDepartmentArgs']] = None,
groups: Optional[pulumi.Input['UserManagementGroupsArgs']] = None,
name: Optional[pulumi.Input[str]] = None,
temp_auth_email: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a UserManagement resource.
:param pulumi.Input[str] email: User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
:param pulumi.Input[str] password: User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
:param pulumi.Input[str] comments: Additional information about this user.
:param pulumi.Input['UserManagementDepartmentArgs'] department: Department a user belongs to
:param pulumi.Input['UserManagementGroupsArgs'] groups: List of Groups a user belongs to. Groups are used in policies.
:param pulumi.Input[str] name: User name. This appears when choosing users for policies.
:param pulumi.Input[str] temp_auth_email: Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
pulumi.set(__self__, "email", email)
pulumi.set(__self__, "password", password)
if comments is not None:
pulumi.set(__self__, "comments", comments)
if department is not None:
pulumi.set(__self__, "department", department)
if groups is not None:
pulumi.set(__self__, "groups", groups)
if name is not None:
pulumi.set(__self__, "name", name)
if temp_auth_email is not None:
pulumi.set(__self__, "temp_auth_email", temp_auth_email)
@property
@pulumi.getter
def email(self) -> pulumi.Input[str]:
"""
User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
"""
return pulumi.get(self, "email")
@email.setter
def email(self, value: pulumi.Input[str]):
pulumi.set(self, "email", value)
@property
@pulumi.getter
def password(self) -> pulumi.Input[str]:
"""
User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
"""
return pulumi.get(self, "password")
@password.setter
def password(self, value: pulumi.Input[str]):
pulumi.set(self, "password", value)
@property
@pulumi.getter
def comments(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this user.
"""
return pulumi.get(self, "comments")
@comments.setter
def comments(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comments", value)
@property
@pulumi.getter
def department(self) -> Optional[pulumi.Input['UserManagementDepartmentArgs']]:
"""
Department a user belongs to
"""
return pulumi.get(self, "department")
@department.setter
def department(self, value: Optional[pulumi.Input['UserManagementDepartmentArgs']]):
pulumi.set(self, "department", value)
@property
@pulumi.getter
def groups(self) -> Optional[pulumi.Input['UserManagementGroupsArgs']]:
"""
List of Groups a user belongs to. Groups are used in policies.
"""
return pulumi.get(self, "groups")
@groups.setter
def groups(self, value: Optional[pulumi.Input['UserManagementGroupsArgs']]):
pulumi.set(self, "groups", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
User name. This appears when choosing users for policies.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="tempAuthEmail")
def temp_auth_email(self) -> Optional[pulumi.Input[str]]:
"""
Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
return pulumi.get(self, "temp_auth_email")
@temp_auth_email.setter
def temp_auth_email(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "temp_auth_email", value)
@pulumi.input_type
class _UserManagementState:
def __init__(__self__, *,
comments: Optional[pulumi.Input[str]] = None,
department: Optional[pulumi.Input['UserManagementDepartmentArgs']] = None,
email: Optional[pulumi.Input[str]] = None,
groups: Optional[pulumi.Input['UserManagementGroupsArgs']] = None,
name: Optional[pulumi.Input[str]] = None,
password: Optional[pulumi.Input[str]] = None,
temp_auth_email: Optional[pulumi.Input[str]] = None,
user_id: Optional[pulumi.Input[int]] = None):
"""
Input properties used for looking up and filtering UserManagement resources.
:param pulumi.Input[str] comments: Additional information about this user.
:param pulumi.Input['UserManagementDepartmentArgs'] department: Department a user belongs to
:param pulumi.Input[str] email: User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
:param pulumi.Input['UserManagementGroupsArgs'] groups: List of Groups a user belongs to. Groups are used in policies.
:param pulumi.Input[str] name: User name. This appears when choosing users for policies.
:param pulumi.Input[str] password: User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
:param pulumi.Input[str] temp_auth_email: Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
if comments is not None:
pulumi.set(__self__, "comments", comments)
if department is not None:
pulumi.set(__self__, "department", department)
if email is not None:
pulumi.set(__self__, "email", email)
if groups is not None:
pulumi.set(__self__, "groups", groups)
if name is not None:
pulumi.set(__self__, "name", name)
if password is not None:
pulumi.set(__self__, "password", password)
if temp_auth_email is not None:
pulumi.set(__self__, "temp_auth_email", temp_auth_email)
if user_id is not None:
pulumi.set(__self__, "user_id", user_id)
@property
@pulumi.getter
def comments(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this user.
"""
return pulumi.get(self, "comments")
@comments.setter
def comments(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comments", value)
@property
@pulumi.getter
def department(self) -> Optional[pulumi.Input['UserManagementDepartmentArgs']]:
"""
Department a user belongs to
"""
return pulumi.get(self, "department")
@department.setter
def department(self, value: Optional[pulumi.Input['UserManagementDepartmentArgs']]):
pulumi.set(self, "department", value)
@property
@pulumi.getter
def email(self) -> Optional[pulumi.Input[str]]:
"""
User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
"""
return pulumi.get(self, "email")
@email.setter
def email(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "email", value)
@property
@pulumi.getter
def groups(self) -> Optional[pulumi.Input['UserManagementGroupsArgs']]:
"""
List of Groups a user belongs to. Groups are used in policies.
"""
return pulumi.get(self, "groups")
@groups.setter
def groups(self, value: Optional[pulumi.Input['UserManagementGroupsArgs']]):
pulumi.set(self, "groups", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
User name. This appears when choosing users for policies.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def password(self) -> Optional[pulumi.Input[str]]:
"""
User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
"""
return pulumi.get(self, "password")
@password.setter
def password(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "password", value)
@property
@pulumi.getter(name="tempAuthEmail")
def temp_auth_email(self) -> Optional[pulumi.Input[str]]:
"""
Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
return pulumi.get(self, "temp_auth_email")
@temp_auth_email.setter
def temp_auth_email(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "temp_auth_email", value)
@property
@pulumi.getter(name="userId")
def user_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "user_id")
@user_id.setter
def user_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "user_id", value)
class UserManagement(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comments: Optional[pulumi.Input[str]] = None,
department: Optional[pulumi.Input[pulumi.InputType['UserManagementDepartmentArgs']]] = None,
email: Optional[pulumi.Input[str]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['UserManagementGroupsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
password: Optional[pulumi.Input[str]] = None,
temp_auth_email: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The **zia_user_management** resource allows the creation and management of local user account in the Zscaler Internet Access cloud. The user account resource can then be associated with several different types of resource within the ZIA tenant.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
import zscaler_pulumi_zia as zia
normal_internet = zia.Groups.get_group_management(name="Normal_Internet")
engineering = zia.Departments.get_department_management(name="Engineering")
# ZIA Local User Account
john_ashcroft = zia.users.UserManagement("johnAshcroft",
email="[email protected]",
password="P@ssw0rd123*",
groups=zia.users.UserManagementGroupsArgs(
ids=normal_internet.id,
),
department=zia.users.UserManagementDepartmentArgs(
id=engineering.id,
))
```
## Optional
The following attributes are supported:
* `comments` - (Optional) Additional information about this user.
* `temp_auth_email` - (Optional) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comments: Additional information about this user.
:param pulumi.Input[pulumi.InputType['UserManagementDepartmentArgs']] department: Department a user belongs to
:param pulumi.Input[str] email: User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
:param pulumi.Input[pulumi.InputType['UserManagementGroupsArgs']] groups: List of Groups a user belongs to. Groups are used in policies.
:param pulumi.Input[str] name: User name. This appears when choosing users for policies.
:param pulumi.Input[str] password: User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
:param pulumi.Input[str] temp_auth_email: Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: UserManagementArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_user_management** resource allows the creation and management of local user account in the Zscaler Internet Access cloud. The user account resource can then be associated with several different types of resource within the ZIA tenant.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
import zscaler_pulumi_zia as zia
normal_internet = zia.Groups.get_group_management(name="Normal_Internet")
engineering = zia.Departments.get_department_management(name="Engineering")
# ZIA Local User Account
john_ashcroft = zia.users.UserManagement("johnAshcroft",
email="[email protected]",
password="P@ssw0rd123*",
groups=zia.users.UserManagementGroupsArgs(
ids=normal_internet.id,
),
department=zia.users.UserManagementDepartmentArgs(
id=engineering.id,
))
```
## Optional
The following attributes are supported:
* `comments` - (Optional) Additional information about this user.
* `temp_auth_email` - (Optional) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
:param str resource_name: The name of the resource.
:param UserManagementArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(UserManagementArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comments: Optional[pulumi.Input[str]] = None,
department: Optional[pulumi.Input[pulumi.InputType['UserManagementDepartmentArgs']]] = None,
email: Optional[pulumi.Input[str]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['UserManagementGroupsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
password: Optional[pulumi.Input[str]] = None,
temp_auth_email: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = UserManagementArgs.__new__(UserManagementArgs)
__props__.__dict__["comments"] = comments
__props__.__dict__["department"] = department
if email is None and not opts.urn:
raise TypeError("Missing required property 'email'")
__props__.__dict__["email"] = email
__props__.__dict__["groups"] = groups
__props__.__dict__["name"] = name
if password is None and not opts.urn:
raise TypeError("Missing required property 'password'")
__props__.__dict__["password"] = None if password is None else pulumi.Output.secret(password)
__props__.__dict__["temp_auth_email"] = temp_auth_email
__props__.__dict__["user_id"] = None
secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["password"])
opts = pulumi.ResourceOptions.merge(opts, secret_opts)
super(UserManagement, __self__).__init__(
'zia:Users/userManagement:UserManagement',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
comments: Optional[pulumi.Input[str]] = None,
department: Optional[pulumi.Input[pulumi.InputType['UserManagementDepartmentArgs']]] = None,
email: Optional[pulumi.Input[str]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['UserManagementGroupsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
password: Optional[pulumi.Input[str]] = None,
temp_auth_email: Optional[pulumi.Input[str]] = None,
user_id: Optional[pulumi.Input[int]] = None) -> 'UserManagement':
"""
Get an existing UserManagement resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comments: Additional information about this user.
:param pulumi.Input[pulumi.InputType['UserManagementDepartmentArgs']] department: Department a user belongs to
:param pulumi.Input[str] email: User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
:param pulumi.Input[pulumi.InputType['UserManagementGroupsArgs']] groups: List of Groups a user belongs to. Groups are used in policies.
:param pulumi.Input[str] name: User name. This appears when choosing users for policies.
:param pulumi.Input[str] password: User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
:param pulumi.Input[str] temp_auth_email: Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _UserManagementState.__new__(_UserManagementState)
__props__.__dict__["comments"] = comments
__props__.__dict__["department"] = department
__props__.__dict__["email"] = email
__props__.__dict__["groups"] = groups
__props__.__dict__["name"] = name
__props__.__dict__["password"] = password
__props__.__dict__["temp_auth_email"] = temp_auth_email
__props__.__dict__["user_id"] = user_id
return UserManagement(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def comments(self) -> pulumi.Output[Optional[str]]:
"""
Additional information about this user.
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def department(self) -> pulumi.Output[Optional['outputs.UserManagementDepartment']]:
"""
Department a user belongs to
"""
return pulumi.get(self, "department")
@property
@pulumi.getter
def email(self) -> pulumi.Output[str]:
"""
User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
"""
return pulumi.get(self, "email")
@property
@pulumi.getter
def groups(self) -> pulumi.Output['outputs.UserManagementGroups']:
"""
List of Groups a user belongs to. Groups are used in policies.
"""
return pulumi.get(self, "groups")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
User name. This appears when choosing users for policies.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def password(self) -> pulumi.Output[str]:
"""
User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
"""
return pulumi.get(self, "password")
@property
@pulumi.getter(name="tempAuthEmail")
def temp_auth_email(self) -> pulumi.Output[Optional[str]]:
"""
Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
return pulumi.get(self, "temp_auth_email")
@property
@pulumi.getter(name="userId")
def user_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "user_id") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/users/user_management.py | user_management.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetUserManagementResult',
'AwaitableGetUserManagementResult',
'get_user_management',
'get_user_management_output',
]
@pulumi.output_type
class GetUserManagementResult:
"""
A collection of values returned by getUserManagement.
"""
def __init__(__self__, admin_user=None, comments=None, departments=None, email=None, groups=None, id=None, is_auditor=None, name=None, temp_auth_email=None, type=None):
if admin_user and not isinstance(admin_user, bool):
raise TypeError("Expected argument 'admin_user' to be a bool")
pulumi.set(__self__, "admin_user", admin_user)
if comments and not isinstance(comments, str):
raise TypeError("Expected argument 'comments' to be a str")
pulumi.set(__self__, "comments", comments)
if departments and not isinstance(departments, list):
raise TypeError("Expected argument 'departments' to be a list")
pulumi.set(__self__, "departments", departments)
if email and not isinstance(email, str):
raise TypeError("Expected argument 'email' to be a str")
pulumi.set(__self__, "email", email)
if groups and not isinstance(groups, list):
raise TypeError("Expected argument 'groups' to be a list")
pulumi.set(__self__, "groups", groups)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if is_auditor and not isinstance(is_auditor, str):
raise TypeError("Expected argument 'is_auditor' to be a str")
pulumi.set(__self__, "is_auditor", is_auditor)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if temp_auth_email and not isinstance(temp_auth_email, str):
raise TypeError("Expected argument 'temp_auth_email' to be a str")
pulumi.set(__self__, "temp_auth_email", temp_auth_email)
if type and not isinstance(type, str):
raise TypeError("Expected argument 'type' to be a str")
pulumi.set(__self__, "type", type)
@property
@pulumi.getter(name="adminUser")
def admin_user(self) -> bool:
"""
(Optional) True if this user is an Admin user. readOnly: `true` default: `false`
"""
return pulumi.get(self, "admin_user")
@property
@pulumi.getter
def comments(self) -> str:
"""
(String) Additional information about the group
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def departments(self) -> Sequence['outputs.GetUserManagementDepartmentResult']:
"""
(Required) Department a user belongs to
"""
return pulumi.get(self, "departments")
@property
@pulumi.getter
def email(self) -> str:
"""
(Required) User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization
"""
return pulumi.get(self, "email")
@property
@pulumi.getter
def groups(self) -> Sequence['outputs.GetUserManagementGroupResult']:
"""
(Required) List of Groups a user belongs to. Groups are used in policies.
"""
return pulumi.get(self, "groups")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
(Number) Unique identfier for the group
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="isAuditor")
def is_auditor(self) -> str:
return pulumi.get(self, "is_auditor")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
(String) Group name
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="tempAuthEmail")
def temp_auth_email(self) -> str:
"""
(String) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
"""
return pulumi.get(self, "temp_auth_email")
@property
@pulumi.getter
def type(self) -> str:
"""
(String) User type. Provided only if this user is not an end user. The supported types are:
"""
return pulumi.get(self, "type")
class AwaitableGetUserManagementResult(GetUserManagementResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetUserManagementResult(
admin_user=self.admin_user,
comments=self.comments,
departments=self.departments,
email=self.email,
groups=self.groups,
id=self.id,
is_auditor=self.is_auditor,
name=self.name,
temp_auth_email=self.temp_auth_email,
type=self.type)
def get_user_management(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetUserManagementResult:
"""
Use the **zia_user_management** data source to get information about a user account that may have been created in the Zscaler Internet Access portal or via API. This data source can then be associated with a ZIA cloud firewall filtering rule, and URL filtering rules.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
adam_ashcroft = zia.Users.get_user_management(name="Adam Ashcroft")
```
:param int id: The ID of the time window resource.
:param str name: User name. This appears when choosing users for policies.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:Users/getUserManagement:getUserManagement', __args__, opts=opts, typ=GetUserManagementResult).value
return AwaitableGetUserManagementResult(
admin_user=__ret__.admin_user,
comments=__ret__.comments,
departments=__ret__.departments,
email=__ret__.email,
groups=__ret__.groups,
id=__ret__.id,
is_auditor=__ret__.is_auditor,
name=__ret__.name,
temp_auth_email=__ret__.temp_auth_email,
type=__ret__.type)
@_utilities.lift_output_func(get_user_management)
def get_user_management_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetUserManagementResult]:
"""
Use the **zia_user_management** data source to get information about a user account that may have been created in the Zscaler Internet Access portal or via API. This data source can then be associated with a ZIA cloud firewall filtering rule, and URL filtering rules.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
adam_ashcroft = zia.Users.get_user_management(name="Adam Ashcroft")
```
:param int id: The ID of the time window resource.
:param str name: User name. This appears when choosing users for policies.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/users/get_user_management.py | get_user_management.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'UserManagementDepartment',
'UserManagementGroups',
'GetUserManagementDepartmentResult',
'GetUserManagementGroupResult',
]
@pulumi.output_type
class UserManagementDepartment(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "idpId":
suggest = "idp_id"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in UserManagementDepartment. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
UserManagementDepartment.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
UserManagementDepartment.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
comments: Optional[str] = None,
deleted: Optional[bool] = None,
id: Optional[int] = None,
idp_id: Optional[int] = None,
name: Optional[str] = None):
"""
:param int id: Department ID
:param str name: User name. This appears when choosing users for policies.
"""
if comments is not None:
pulumi.set(__self__, "comments", comments)
if deleted is not None:
pulumi.set(__self__, "deleted", deleted)
if id is not None:
pulumi.set(__self__, "id", id)
if idp_id is not None:
pulumi.set(__self__, "idp_id", idp_id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def comments(self) -> Optional[str]:
return pulumi.get(self, "comments")
@property
@pulumi.getter
def deleted(self) -> Optional[bool]:
return pulumi.get(self, "deleted")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
Department ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> Optional[int]:
return pulumi.get(self, "idp_id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
User name. This appears when choosing users for policies.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class UserManagementGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Department ID
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Department ID
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class GetUserManagementDepartmentResult(dict):
def __init__(__self__, *,
comments: str,
deleted: bool,
id: int,
idp_id: int,
name: str):
"""
:param str comments: (String) Additional information about the group
:param bool deleted: (Boolean) default: `false`
:param int id: The ID of the time window resource.
:param int idp_id: (Number) Unique identfier for the identity provider (IdP)
:param str name: User name. This appears when choosing users for policies.
"""
pulumi.set(__self__, "comments", comments)
pulumi.set(__self__, "deleted", deleted)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "idp_id", idp_id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def comments(self) -> str:
"""
(String) Additional information about the group
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def deleted(self) -> bool:
"""
(Boolean) default: `false`
"""
return pulumi.get(self, "deleted")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of the time window resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> int:
"""
(Number) Unique identfier for the identity provider (IdP)
"""
return pulumi.get(self, "idp_id")
@property
@pulumi.getter
def name(self) -> str:
"""
User name. This appears when choosing users for policies.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetUserManagementGroupResult(dict):
def __init__(__self__, *,
comments: str,
id: int,
idp_id: int,
name: str):
"""
:param str comments: (String) Additional information about the group
:param int id: The ID of the time window resource.
:param int idp_id: (Number) Unique identfier for the identity provider (IdP)
:param str name: User name. This appears when choosing users for policies.
"""
pulumi.set(__self__, "comments", comments)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "idp_id", idp_id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def comments(self) -> str:
"""
(String) Additional information about the group
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of the time window resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> int:
"""
(Number) Unique identfier for the identity provider (IdP)
"""
return pulumi.get(self, "idp_id")
@property
@pulumi.getter
def name(self) -> str:
"""
User name. This appears when choosing users for policies.
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/users/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'TrafficForwardingGRETunnelLastModifiedByArgs',
'TrafficForwardingGRETunnelPrimaryDestVipArgs',
'TrafficForwardingGRETunnelSecondaryDestVipArgs',
'TrafficForwardingStaticIPLastModifiedByArgs',
'TrafficForwardingStaticIPManagedByArgs',
]
@pulumi.input_type
class TrafficForwardingGRETunnelLastModifiedByArgs:
def __init__(__self__, *,
extensions: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[int] id: Unique identifer of the GRE virtual IP address (VIP)
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class TrafficForwardingGRETunnelPrimaryDestVipArgs:
def __init__(__self__, *,
datacenter: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[int]] = None,
private_service_edge: Optional[pulumi.Input[bool]] = None,
virtual_ip: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[int] id: Unique identifer of the GRE virtual IP address (VIP)
:param pulumi.Input[str] virtual_ip: GRE cluster virtual IP address (VIP)
"""
if datacenter is not None:
pulumi.set(__self__, "datacenter", datacenter)
if id is not None:
pulumi.set(__self__, "id", id)
if private_service_edge is not None:
pulumi.set(__self__, "private_service_edge", private_service_edge)
if virtual_ip is not None:
pulumi.set(__self__, "virtual_ip", virtual_ip)
@property
@pulumi.getter
def datacenter(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "datacenter")
@datacenter.setter
def datacenter(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "datacenter", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="privateServiceEdge")
def private_service_edge(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "private_service_edge")
@private_service_edge.setter
def private_service_edge(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "private_service_edge", value)
@property
@pulumi.getter(name="virtualIp")
def virtual_ip(self) -> Optional[pulumi.Input[str]]:
"""
GRE cluster virtual IP address (VIP)
"""
return pulumi.get(self, "virtual_ip")
@virtual_ip.setter
def virtual_ip(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "virtual_ip", value)
@pulumi.input_type
class TrafficForwardingGRETunnelSecondaryDestVipArgs:
def __init__(__self__, *,
datacenter: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[int]] = None,
private_service_edge: Optional[pulumi.Input[bool]] = None,
virtual_ip: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[int] id: Unique identifer of the GRE virtual IP address (VIP)
:param pulumi.Input[str] virtual_ip: GRE cluster virtual IP address (VIP)
"""
if datacenter is not None:
pulumi.set(__self__, "datacenter", datacenter)
if id is not None:
pulumi.set(__self__, "id", id)
if private_service_edge is not None:
pulumi.set(__self__, "private_service_edge", private_service_edge)
if virtual_ip is not None:
pulumi.set(__self__, "virtual_ip", virtual_ip)
@property
@pulumi.getter
def datacenter(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "datacenter")
@datacenter.setter
def datacenter(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "datacenter", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="privateServiceEdge")
def private_service_edge(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "private_service_edge")
@private_service_edge.setter
def private_service_edge(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "private_service_edge", value)
@property
@pulumi.getter(name="virtualIp")
def virtual_ip(self) -> Optional[pulumi.Input[str]]:
"""
GRE cluster virtual IP address (VIP)
"""
return pulumi.get(self, "virtual_ip")
@virtual_ip.setter
def virtual_ip(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "virtual_ip", value)
@pulumi.input_type
class TrafficForwardingStaticIPLastModifiedByArgs:
def __init__(__self__, *,
extensions: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class TrafficForwardingStaticIPManagedByArgs:
def __init__(__self__, *,
extensions: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['TrafficForwardingStaticIPArgs', 'TrafficForwardingStaticIP']
@pulumi.input_type
class TrafficForwardingStaticIPArgs:
def __init__(__self__, *,
ip_address: pulumi.Input[str],
comment: Optional[pulumi.Input[str]] = None,
geo_override: Optional[pulumi.Input[bool]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]]] = None,
latitude: Optional[pulumi.Input[float]] = None,
longitude: Optional[pulumi.Input[float]] = None,
managed_bies: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]]] = None,
routable_ip: Optional[pulumi.Input[bool]] = None):
"""
The set of arguments for constructing a TrafficForwardingStaticIP resource.
:param pulumi.Input[str] ip_address: The static IP address
:param pulumi.Input[str] comment: Additional information about this static IP address
:param pulumi.Input[bool] geo_override: If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]] last_modified_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[float] latitude: Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
:param pulumi.Input[float] longitude: Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]] managed_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[bool] routable_ip: Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
"""
pulumi.set(__self__, "ip_address", ip_address)
if comment is not None:
pulumi.set(__self__, "comment", comment)
if geo_override is not None:
pulumi.set(__self__, "geo_override", geo_override)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if latitude is not None:
pulumi.set(__self__, "latitude", latitude)
if longitude is not None:
pulumi.set(__self__, "longitude", longitude)
if managed_bies is not None:
pulumi.set(__self__, "managed_bies", managed_bies)
if routable_ip is not None:
pulumi.set(__self__, "routable_ip", routable_ip)
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> pulumi.Input[str]:
"""
The static IP address
"""
return pulumi.get(self, "ip_address")
@ip_address.setter
def ip_address(self, value: pulumi.Input[str]):
pulumi.set(self, "ip_address", value)
@property
@pulumi.getter
def comment(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this static IP address
"""
return pulumi.get(self, "comment")
@comment.setter
def comment(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comment", value)
@property
@pulumi.getter(name="geoOverride")
def geo_override(self) -> Optional[pulumi.Input[bool]]:
"""
If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
"""
return pulumi.get(self, "geo_override")
@geo_override.setter
def geo_override(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "geo_override", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]]]:
"""
This is an immutable reference to an entity. which mainly consists of id and name
"""
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter
def latitude(self) -> Optional[pulumi.Input[float]]:
"""
Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
"""
return pulumi.get(self, "latitude")
@latitude.setter
def latitude(self, value: Optional[pulumi.Input[float]]):
pulumi.set(self, "latitude", value)
@property
@pulumi.getter
def longitude(self) -> Optional[pulumi.Input[float]]:
"""
Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
"""
return pulumi.get(self, "longitude")
@longitude.setter
def longitude(self, value: Optional[pulumi.Input[float]]):
pulumi.set(self, "longitude", value)
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]]]:
"""
This is an immutable reference to an entity. which mainly consists of id and name
"""
return pulumi.get(self, "managed_bies")
@managed_bies.setter
def managed_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]]]):
pulumi.set(self, "managed_bies", value)
@property
@pulumi.getter(name="routableIp")
def routable_ip(self) -> Optional[pulumi.Input[bool]]:
"""
Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
"""
return pulumi.get(self, "routable_ip")
@routable_ip.setter
def routable_ip(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "routable_ip", value)
@pulumi.input_type
class _TrafficForwardingStaticIPState:
def __init__(__self__, *,
comment: Optional[pulumi.Input[str]] = None,
geo_override: Optional[pulumi.Input[bool]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]]] = None,
latitude: Optional[pulumi.Input[float]] = None,
longitude: Optional[pulumi.Input[float]] = None,
managed_bies: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]]] = None,
routable_ip: Optional[pulumi.Input[bool]] = None,
static_ip_id: Optional[pulumi.Input[int]] = None):
"""
Input properties used for looking up and filtering TrafficForwardingStaticIP resources.
:param pulumi.Input[str] comment: Additional information about this static IP address
:param pulumi.Input[bool] geo_override: If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
:param pulumi.Input[str] ip_address: The static IP address
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]] last_modified_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[float] latitude: Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
:param pulumi.Input[float] longitude: Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]] managed_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[bool] routable_ip: Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
:param pulumi.Input[int] static_ip_id: The ID of the Static IP.
"""
if comment is not None:
pulumi.set(__self__, "comment", comment)
if geo_override is not None:
pulumi.set(__self__, "geo_override", geo_override)
if ip_address is not None:
pulumi.set(__self__, "ip_address", ip_address)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if latitude is not None:
pulumi.set(__self__, "latitude", latitude)
if longitude is not None:
pulumi.set(__self__, "longitude", longitude)
if managed_bies is not None:
pulumi.set(__self__, "managed_bies", managed_bies)
if routable_ip is not None:
pulumi.set(__self__, "routable_ip", routable_ip)
if static_ip_id is not None:
pulumi.set(__self__, "static_ip_id", static_ip_id)
@property
@pulumi.getter
def comment(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this static IP address
"""
return pulumi.get(self, "comment")
@comment.setter
def comment(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comment", value)
@property
@pulumi.getter(name="geoOverride")
def geo_override(self) -> Optional[pulumi.Input[bool]]:
"""
If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
"""
return pulumi.get(self, "geo_override")
@geo_override.setter
def geo_override(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "geo_override", value)
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> Optional[pulumi.Input[str]]:
"""
The static IP address
"""
return pulumi.get(self, "ip_address")
@ip_address.setter
def ip_address(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ip_address", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]]]:
"""
This is an immutable reference to an entity. which mainly consists of id and name
"""
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter
def latitude(self) -> Optional[pulumi.Input[float]]:
"""
Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
"""
return pulumi.get(self, "latitude")
@latitude.setter
def latitude(self, value: Optional[pulumi.Input[float]]):
pulumi.set(self, "latitude", value)
@property
@pulumi.getter
def longitude(self) -> Optional[pulumi.Input[float]]:
"""
Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
"""
return pulumi.get(self, "longitude")
@longitude.setter
def longitude(self, value: Optional[pulumi.Input[float]]):
pulumi.set(self, "longitude", value)
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]]]:
"""
This is an immutable reference to an entity. which mainly consists of id and name
"""
return pulumi.get(self, "managed_bies")
@managed_bies.setter
def managed_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingStaticIPManagedByArgs']]]]):
pulumi.set(self, "managed_bies", value)
@property
@pulumi.getter(name="routableIp")
def routable_ip(self) -> Optional[pulumi.Input[bool]]:
"""
Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
"""
return pulumi.get(self, "routable_ip")
@routable_ip.setter
def routable_ip(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "routable_ip", value)
@property
@pulumi.getter(name="staticIpId")
def static_ip_id(self) -> Optional[pulumi.Input[int]]:
"""
The ID of the Static IP.
"""
return pulumi.get(self, "static_ip_id")
@static_ip_id.setter
def static_ip_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "static_ip_id", value)
class TrafficForwardingStaticIP(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comment: Optional[pulumi.Input[str]] = None,
geo_override: Optional[pulumi.Input[bool]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPLastModifiedByArgs']]]]] = None,
latitude: Optional[pulumi.Input[float]] = None,
longitude: Optional[pulumi.Input[float]] = None,
managed_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPManagedByArgs']]]]] = None,
routable_ip: Optional[pulumi.Input[bool]] = None,
__props__=None):
"""
The **zia_traffic_forwarding_static_ip** resource allows the creation and management of static ip addresses in the Zscaler Internet Access cloud. The resource, can then be associated with other resources such as:
* VPN Credentials of type `IP`
* Location Management
* GRE Tunnel
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - Static IP
example = zia.traffic_forwarding.TrafficForwardingStaticIP("example",
comment="Example",
geo_override=True,
ip_address="1.1.1.1",
latitude=-36.848461,
longitude=174.763336,
routable_ip=True)
```
## Import
Static IP resources can be imported by using `<STATIC IP ID>` or `<IP ADDRESS>`as the import ID.
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingStaticIP:TrafficForwardingStaticIP example <static_ip_id>
```
or
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingStaticIP:TrafficForwardingStaticIP example <ip_address>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comment: Additional information about this static IP address
:param pulumi.Input[bool] geo_override: If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
:param pulumi.Input[str] ip_address: The static IP address
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPLastModifiedByArgs']]]] last_modified_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[float] latitude: Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
:param pulumi.Input[float] longitude: Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPManagedByArgs']]]] managed_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[bool] routable_ip: Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: TrafficForwardingStaticIPArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_traffic_forwarding_static_ip** resource allows the creation and management of static ip addresses in the Zscaler Internet Access cloud. The resource, can then be associated with other resources such as:
* VPN Credentials of type `IP`
* Location Management
* GRE Tunnel
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - Static IP
example = zia.traffic_forwarding.TrafficForwardingStaticIP("example",
comment="Example",
geo_override=True,
ip_address="1.1.1.1",
latitude=-36.848461,
longitude=174.763336,
routable_ip=True)
```
## Import
Static IP resources can be imported by using `<STATIC IP ID>` or `<IP ADDRESS>`as the import ID.
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingStaticIP:TrafficForwardingStaticIP example <static_ip_id>
```
or
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingStaticIP:TrafficForwardingStaticIP example <ip_address>
```
:param str resource_name: The name of the resource.
:param TrafficForwardingStaticIPArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(TrafficForwardingStaticIPArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comment: Optional[pulumi.Input[str]] = None,
geo_override: Optional[pulumi.Input[bool]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPLastModifiedByArgs']]]]] = None,
latitude: Optional[pulumi.Input[float]] = None,
longitude: Optional[pulumi.Input[float]] = None,
managed_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPManagedByArgs']]]]] = None,
routable_ip: Optional[pulumi.Input[bool]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = TrafficForwardingStaticIPArgs.__new__(TrafficForwardingStaticIPArgs)
__props__.__dict__["comment"] = comment
__props__.__dict__["geo_override"] = geo_override
if ip_address is None and not opts.urn:
raise TypeError("Missing required property 'ip_address'")
__props__.__dict__["ip_address"] = ip_address
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["latitude"] = latitude
__props__.__dict__["longitude"] = longitude
__props__.__dict__["managed_bies"] = managed_bies
__props__.__dict__["routable_ip"] = routable_ip
__props__.__dict__["static_ip_id"] = None
super(TrafficForwardingStaticIP, __self__).__init__(
'zia:TrafficForwarding/trafficForwardingStaticIP:TrafficForwardingStaticIP',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
comment: Optional[pulumi.Input[str]] = None,
geo_override: Optional[pulumi.Input[bool]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPLastModifiedByArgs']]]]] = None,
latitude: Optional[pulumi.Input[float]] = None,
longitude: Optional[pulumi.Input[float]] = None,
managed_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPManagedByArgs']]]]] = None,
routable_ip: Optional[pulumi.Input[bool]] = None,
static_ip_id: Optional[pulumi.Input[int]] = None) -> 'TrafficForwardingStaticIP':
"""
Get an existing TrafficForwardingStaticIP resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comment: Additional information about this static IP address
:param pulumi.Input[bool] geo_override: If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
:param pulumi.Input[str] ip_address: The static IP address
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPLastModifiedByArgs']]]] last_modified_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[float] latitude: Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
:param pulumi.Input[float] longitude: Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingStaticIPManagedByArgs']]]] managed_bies: This is an immutable reference to an entity. which mainly consists of id and name
:param pulumi.Input[bool] routable_ip: Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
:param pulumi.Input[int] static_ip_id: The ID of the Static IP.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _TrafficForwardingStaticIPState.__new__(_TrafficForwardingStaticIPState)
__props__.__dict__["comment"] = comment
__props__.__dict__["geo_override"] = geo_override
__props__.__dict__["ip_address"] = ip_address
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["latitude"] = latitude
__props__.__dict__["longitude"] = longitude
__props__.__dict__["managed_bies"] = managed_bies
__props__.__dict__["routable_ip"] = routable_ip
__props__.__dict__["static_ip_id"] = static_ip_id
return TrafficForwardingStaticIP(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def comment(self) -> pulumi.Output[Optional[str]]:
"""
Additional information about this static IP address
"""
return pulumi.get(self, "comment")
@property
@pulumi.getter(name="geoOverride")
def geo_override(self) -> pulumi.Output[bool]:
"""
If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
"""
return pulumi.get(self, "geo_override")
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> pulumi.Output[str]:
"""
The static IP address
"""
return pulumi.get(self, "ip_address")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> pulumi.Output[Sequence['outputs.TrafficForwardingStaticIPLastModifiedBy']]:
"""
This is an immutable reference to an entity. which mainly consists of id and name
"""
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter
def latitude(self) -> pulumi.Output[float]:
"""
Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.
"""
return pulumi.get(self, "latitude")
@property
@pulumi.getter
def longitude(self) -> pulumi.Output[float]:
"""
Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.
"""
return pulumi.get(self, "longitude")
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> pulumi.Output[Sequence['outputs.TrafficForwardingStaticIPManagedBy']]:
"""
This is an immutable reference to an entity. which mainly consists of id and name
"""
return pulumi.get(self, "managed_bies")
@property
@pulumi.getter(name="routableIp")
def routable_ip(self) -> pulumi.Output[bool]:
"""
Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
"""
return pulumi.get(self, "routable_ip")
@property
@pulumi.getter(name="staticIpId")
def static_ip_id(self) -> pulumi.Output[int]:
"""
The ID of the Static IP.
"""
return pulumi.get(self, "static_ip_id") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/traffic_forwarding_static_ip.py | traffic_forwarding_static_ip.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetTrafficForwardingGRETunnelResult',
'AwaitableGetTrafficForwardingGRETunnelResult',
'get_traffic_forwarding_gre_tunnel',
'get_traffic_forwarding_gre_tunnel_output',
]
@pulumi.output_type
class GetTrafficForwardingGRETunnelResult:
"""
A collection of values returned by getTrafficForwardingGRETunnel.
"""
def __init__(__self__, comment=None, id=None, internal_ip_range=None, ip_unnumbered=None, last_modification_time=None, last_modified_bies=None, managed_bies=None, primary_dest_vips=None, secondary_dest_vips=None, source_ip=None, within_country=None):
if comment and not isinstance(comment, str):
raise TypeError("Expected argument 'comment' to be a str")
pulumi.set(__self__, "comment", comment)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if internal_ip_range and not isinstance(internal_ip_range, str):
raise TypeError("Expected argument 'internal_ip_range' to be a str")
pulumi.set(__self__, "internal_ip_range", internal_ip_range)
if ip_unnumbered and not isinstance(ip_unnumbered, bool):
raise TypeError("Expected argument 'ip_unnumbered' to be a bool")
pulumi.set(__self__, "ip_unnumbered", ip_unnumbered)
if last_modification_time and not isinstance(last_modification_time, int):
raise TypeError("Expected argument 'last_modification_time' to be a int")
pulumi.set(__self__, "last_modification_time", last_modification_time)
if last_modified_bies and not isinstance(last_modified_bies, list):
raise TypeError("Expected argument 'last_modified_bies' to be a list")
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if managed_bies and not isinstance(managed_bies, list):
raise TypeError("Expected argument 'managed_bies' to be a list")
pulumi.set(__self__, "managed_bies", managed_bies)
if primary_dest_vips and not isinstance(primary_dest_vips, list):
raise TypeError("Expected argument 'primary_dest_vips' to be a list")
pulumi.set(__self__, "primary_dest_vips", primary_dest_vips)
if secondary_dest_vips and not isinstance(secondary_dest_vips, list):
raise TypeError("Expected argument 'secondary_dest_vips' to be a list")
pulumi.set(__self__, "secondary_dest_vips", secondary_dest_vips)
if source_ip and not isinstance(source_ip, str):
raise TypeError("Expected argument 'source_ip' to be a str")
pulumi.set(__self__, "source_ip", source_ip)
if within_country and not isinstance(within_country, bool):
raise TypeError("Expected argument 'within_country' to be a bool")
pulumi.set(__self__, "within_country", within_country)
@property
@pulumi.getter
def comment(self) -> str:
return pulumi.get(self, "comment")
@property
@pulumi.getter
def id(self) -> Optional[int]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="internalIpRange")
def internal_ip_range(self) -> str:
return pulumi.get(self, "internal_ip_range")
@property
@pulumi.getter(name="ipUnnumbered")
def ip_unnumbered(self) -> bool:
return pulumi.get(self, "ip_unnumbered")
@property
@pulumi.getter(name="lastModificationTime")
def last_modification_time(self) -> int:
return pulumi.get(self, "last_modification_time")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Sequence['outputs.GetTrafficForwardingGRETunnelLastModifiedByResult']:
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Sequence['outputs.GetTrafficForwardingGRETunnelManagedByResult']:
return pulumi.get(self, "managed_bies")
@property
@pulumi.getter(name="primaryDestVips")
def primary_dest_vips(self) -> Sequence['outputs.GetTrafficForwardingGRETunnelPrimaryDestVipResult']:
return pulumi.get(self, "primary_dest_vips")
@property
@pulumi.getter(name="secondaryDestVips")
def secondary_dest_vips(self) -> Sequence['outputs.GetTrafficForwardingGRETunnelSecondaryDestVipResult']:
return pulumi.get(self, "secondary_dest_vips")
@property
@pulumi.getter(name="sourceIp")
def source_ip(self) -> Optional[str]:
return pulumi.get(self, "source_ip")
@property
@pulumi.getter(name="withinCountry")
def within_country(self) -> bool:
return pulumi.get(self, "within_country")
class AwaitableGetTrafficForwardingGRETunnelResult(GetTrafficForwardingGRETunnelResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrafficForwardingGRETunnelResult(
comment=self.comment,
id=self.id,
internal_ip_range=self.internal_ip_range,
ip_unnumbered=self.ip_unnumbered,
last_modification_time=self.last_modification_time,
last_modified_bies=self.last_modified_bies,
managed_bies=self.managed_bies,
primary_dest_vips=self.primary_dest_vips,
secondary_dest_vips=self.secondary_dest_vips,
source_ip=self.source_ip,
within_country=self.within_country)
def get_traffic_forwarding_gre_tunnel(id: Optional[int] = None,
source_ip: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficForwardingGRETunnelResult:
"""
Use this data source to access information about an existing resource.
"""
__args__ = dict()
__args__['id'] = id
__args__['sourceIp'] = source_ip
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:TrafficForwarding/getTrafficForwardingGRETunnel:getTrafficForwardingGRETunnel', __args__, opts=opts, typ=GetTrafficForwardingGRETunnelResult).value
return AwaitableGetTrafficForwardingGRETunnelResult(
comment=__ret__.comment,
id=__ret__.id,
internal_ip_range=__ret__.internal_ip_range,
ip_unnumbered=__ret__.ip_unnumbered,
last_modification_time=__ret__.last_modification_time,
last_modified_bies=__ret__.last_modified_bies,
managed_bies=__ret__.managed_bies,
primary_dest_vips=__ret__.primary_dest_vips,
secondary_dest_vips=__ret__.secondary_dest_vips,
source_ip=__ret__.source_ip,
within_country=__ret__.within_country)
@_utilities.lift_output_func(get_traffic_forwarding_gre_tunnel)
def get_traffic_forwarding_gre_tunnel_output(id: Optional[pulumi.Input[Optional[int]]] = None,
source_ip: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrafficForwardingGRETunnelResult]:
"""
Use this data source to access information about an existing resource.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/get_traffic_forwarding_gre_tunnel.py | get_traffic_forwarding_gre_tunnel.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetTrafficForwardingNodeVIPsResult',
'AwaitableGetTrafficForwardingNodeVIPsResult',
'get_traffic_forwarding_node_vips',
'get_traffic_forwarding_node_vips_output',
]
@pulumi.output_type
class GetTrafficForwardingNodeVIPsResult:
"""
A collection of values returned by getTrafficForwardingNodeVIPs.
"""
def __init__(__self__, city=None, cloud_name=None, datacenter=None, gre_domain_name=None, gre_ips=None, id=None, location=None, pac_domain_name=None, pac_ips=None, region=None, vpn_domain_name=None, vpn_ips=None):
if city and not isinstance(city, str):
raise TypeError("Expected argument 'city' to be a str")
pulumi.set(__self__, "city", city)
if cloud_name and not isinstance(cloud_name, str):
raise TypeError("Expected argument 'cloud_name' to be a str")
pulumi.set(__self__, "cloud_name", cloud_name)
if datacenter and not isinstance(datacenter, str):
raise TypeError("Expected argument 'datacenter' to be a str")
pulumi.set(__self__, "datacenter", datacenter)
if gre_domain_name and not isinstance(gre_domain_name, str):
raise TypeError("Expected argument 'gre_domain_name' to be a str")
pulumi.set(__self__, "gre_domain_name", gre_domain_name)
if gre_ips and not isinstance(gre_ips, list):
raise TypeError("Expected argument 'gre_ips' to be a list")
pulumi.set(__self__, "gre_ips", gre_ips)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if location and not isinstance(location, str):
raise TypeError("Expected argument 'location' to be a str")
pulumi.set(__self__, "location", location)
if pac_domain_name and not isinstance(pac_domain_name, str):
raise TypeError("Expected argument 'pac_domain_name' to be a str")
pulumi.set(__self__, "pac_domain_name", pac_domain_name)
if pac_ips and not isinstance(pac_ips, list):
raise TypeError("Expected argument 'pac_ips' to be a list")
pulumi.set(__self__, "pac_ips", pac_ips)
if region and not isinstance(region, str):
raise TypeError("Expected argument 'region' to be a str")
pulumi.set(__self__, "region", region)
if vpn_domain_name and not isinstance(vpn_domain_name, str):
raise TypeError("Expected argument 'vpn_domain_name' to be a str")
pulumi.set(__self__, "vpn_domain_name", vpn_domain_name)
if vpn_ips and not isinstance(vpn_ips, list):
raise TypeError("Expected argument 'vpn_ips' to be a list")
pulumi.set(__self__, "vpn_ips", vpn_ips)
@property
@pulumi.getter
def city(self) -> str:
return pulumi.get(self, "city")
@property
@pulumi.getter(name="cloudName")
def cloud_name(self) -> str:
return pulumi.get(self, "cloud_name")
@property
@pulumi.getter
def datacenter(self) -> Optional[str]:
return pulumi.get(self, "datacenter")
@property
@pulumi.getter(name="greDomainName")
def gre_domain_name(self) -> str:
return pulumi.get(self, "gre_domain_name")
@property
@pulumi.getter(name="greIps")
def gre_ips(self) -> Sequence[str]:
return pulumi.get(self, "gre_ips")
@property
@pulumi.getter
def id(self) -> str:
"""
The provider-assigned unique ID for this managed resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def location(self) -> str:
return pulumi.get(self, "location")
@property
@pulumi.getter(name="pacDomainName")
def pac_domain_name(self) -> str:
return pulumi.get(self, "pac_domain_name")
@property
@pulumi.getter(name="pacIps")
def pac_ips(self) -> Sequence[str]:
return pulumi.get(self, "pac_ips")
@property
@pulumi.getter
def region(self) -> str:
return pulumi.get(self, "region")
@property
@pulumi.getter(name="vpnDomainName")
def vpn_domain_name(self) -> str:
return pulumi.get(self, "vpn_domain_name")
@property
@pulumi.getter(name="vpnIps")
def vpn_ips(self) -> Sequence[str]:
return pulumi.get(self, "vpn_ips")
class AwaitableGetTrafficForwardingNodeVIPsResult(GetTrafficForwardingNodeVIPsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrafficForwardingNodeVIPsResult(
city=self.city,
cloud_name=self.cloud_name,
datacenter=self.datacenter,
gre_domain_name=self.gre_domain_name,
gre_ips=self.gre_ips,
id=self.id,
location=self.location,
pac_domain_name=self.pac_domain_name,
pac_ips=self.pac_ips,
region=self.region,
vpn_domain_name=self.vpn_domain_name,
vpn_ips=self.vpn_ips)
def get_traffic_forwarding_node_vips(datacenter: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficForwardingNodeVIPsResult:
"""
Use the **zia_traffic_forwarding_public_node_vips** data source to retrieve a paginated list of virtual IP addresses (VIPs) available in the Zscaler cloud.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
yvr1 = zia.TrafficForwarding.get_traffic_forwarding_node_vips(datacenter="YVR1")
pulumi.export("ziaTrafficForwardingPublicNodeVipsYvr1", yvr1)
```
:param str datacenter: Data-center Name
"""
__args__ = dict()
__args__['datacenter'] = datacenter
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:TrafficForwarding/getTrafficForwardingNodeVIPs:getTrafficForwardingNodeVIPs', __args__, opts=opts, typ=GetTrafficForwardingNodeVIPsResult).value
return AwaitableGetTrafficForwardingNodeVIPsResult(
city=__ret__.city,
cloud_name=__ret__.cloud_name,
datacenter=__ret__.datacenter,
gre_domain_name=__ret__.gre_domain_name,
gre_ips=__ret__.gre_ips,
id=__ret__.id,
location=__ret__.location,
pac_domain_name=__ret__.pac_domain_name,
pac_ips=__ret__.pac_ips,
region=__ret__.region,
vpn_domain_name=__ret__.vpn_domain_name,
vpn_ips=__ret__.vpn_ips)
@_utilities.lift_output_func(get_traffic_forwarding_node_vips)
def get_traffic_forwarding_node_vips_output(datacenter: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrafficForwardingNodeVIPsResult]:
"""
Use the **zia_traffic_forwarding_public_node_vips** data source to retrieve a paginated list of virtual IP addresses (VIPs) available in the Zscaler cloud.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
yvr1 = zia.TrafficForwarding.get_traffic_forwarding_node_vips(datacenter="YVR1")
pulumi.export("ziaTrafficForwardingPublicNodeVipsYvr1", yvr1)
```
:param str datacenter: Data-center Name
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/get_traffic_forwarding_node_vips.py | get_traffic_forwarding_node_vips.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'TrafficForwardingGRETunnelLastModifiedBy',
'TrafficForwardingGRETunnelPrimaryDestVip',
'TrafficForwardingGRETunnelSecondaryDestVip',
'TrafficForwardingStaticIPLastModifiedBy',
'TrafficForwardingStaticIPManagedBy',
'GetTrafficForwardingGREInternalIPRangeListResult',
'GetTrafficForwardingGRETunnelLastModifiedByResult',
'GetTrafficForwardingGRETunnelManagedByResult',
'GetTrafficForwardingGRETunnelPrimaryDestVipResult',
'GetTrafficForwardingGRETunnelSecondaryDestVipResult',
'GetTrafficForwardingStaticIPLastModifiedByResult',
'GetTrafficForwardingStaticIPManagedByResult',
'GetTrafficForwardingVIPRecommendedListListResult',
'GetTrafficForwardingVPNCredentialsLocationResult',
'GetTrafficForwardingVPNCredentialsManagedByResult',
]
@pulumi.output_type
class TrafficForwardingGRETunnelLastModifiedBy(dict):
def __init__(__self__, *,
extensions: Optional[Mapping[str, str]] = None,
id: Optional[int] = None,
name: Optional[str] = None):
"""
:param int id: Unique identifer of the GRE virtual IP address (VIP)
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[Mapping[str, str]]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@pulumi.output_type
class TrafficForwardingGRETunnelPrimaryDestVip(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "privateServiceEdge":
suggest = "private_service_edge"
elif key == "virtualIp":
suggest = "virtual_ip"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in TrafficForwardingGRETunnelPrimaryDestVip. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
TrafficForwardingGRETunnelPrimaryDestVip.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
TrafficForwardingGRETunnelPrimaryDestVip.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
datacenter: Optional[str] = None,
id: Optional[int] = None,
private_service_edge: Optional[bool] = None,
virtual_ip: Optional[str] = None):
"""
:param int id: Unique identifer of the GRE virtual IP address (VIP)
:param str virtual_ip: GRE cluster virtual IP address (VIP)
"""
if datacenter is not None:
pulumi.set(__self__, "datacenter", datacenter)
if id is not None:
pulumi.set(__self__, "id", id)
if private_service_edge is not None:
pulumi.set(__self__, "private_service_edge", private_service_edge)
if virtual_ip is not None:
pulumi.set(__self__, "virtual_ip", virtual_ip)
@property
@pulumi.getter
def datacenter(self) -> Optional[str]:
return pulumi.get(self, "datacenter")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="privateServiceEdge")
def private_service_edge(self) -> Optional[bool]:
return pulumi.get(self, "private_service_edge")
@property
@pulumi.getter(name="virtualIp")
def virtual_ip(self) -> Optional[str]:
"""
GRE cluster virtual IP address (VIP)
"""
return pulumi.get(self, "virtual_ip")
@pulumi.output_type
class TrafficForwardingGRETunnelSecondaryDestVip(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "privateServiceEdge":
suggest = "private_service_edge"
elif key == "virtualIp":
suggest = "virtual_ip"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in TrafficForwardingGRETunnelSecondaryDestVip. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
TrafficForwardingGRETunnelSecondaryDestVip.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
TrafficForwardingGRETunnelSecondaryDestVip.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
datacenter: Optional[str] = None,
id: Optional[int] = None,
private_service_edge: Optional[bool] = None,
virtual_ip: Optional[str] = None):
"""
:param int id: Unique identifer of the GRE virtual IP address (VIP)
:param str virtual_ip: GRE cluster virtual IP address (VIP)
"""
if datacenter is not None:
pulumi.set(__self__, "datacenter", datacenter)
if id is not None:
pulumi.set(__self__, "id", id)
if private_service_edge is not None:
pulumi.set(__self__, "private_service_edge", private_service_edge)
if virtual_ip is not None:
pulumi.set(__self__, "virtual_ip", virtual_ip)
@property
@pulumi.getter
def datacenter(self) -> Optional[str]:
return pulumi.get(self, "datacenter")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="privateServiceEdge")
def private_service_edge(self) -> Optional[bool]:
return pulumi.get(self, "private_service_edge")
@property
@pulumi.getter(name="virtualIp")
def virtual_ip(self) -> Optional[str]:
"""
GRE cluster virtual IP address (VIP)
"""
return pulumi.get(self, "virtual_ip")
@pulumi.output_type
class TrafficForwardingStaticIPLastModifiedBy(dict):
def __init__(__self__, *,
extensions: Optional[Mapping[str, str]] = None,
id: Optional[int] = None,
name: Optional[str] = None):
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[Mapping[str, str]]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> Optional[int]:
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@pulumi.output_type
class TrafficForwardingStaticIPManagedBy(dict):
def __init__(__self__, *,
extensions: Optional[Mapping[str, str]] = None,
id: Optional[int] = None,
name: Optional[str] = None):
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[Mapping[str, str]]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> Optional[int]:
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@pulumi.output_type
class GetTrafficForwardingGREInternalIPRangeListResult(dict):
def __init__(__self__, *,
end_ip_address: str,
start_ip_address: str):
pulumi.set(__self__, "end_ip_address", end_ip_address)
pulumi.set(__self__, "start_ip_address", start_ip_address)
@property
@pulumi.getter(name="endIpAddress")
def end_ip_address(self) -> str:
return pulumi.get(self, "end_ip_address")
@property
@pulumi.getter(name="startIpAddress")
def start_ip_address(self) -> str:
return pulumi.get(self, "start_ip_address")
@pulumi.output_type
class GetTrafficForwardingGRETunnelLastModifiedByResult(dict):
def __init__(__self__, *,
id: int,
name: str):
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@pulumi.output_type
class GetTrafficForwardingGRETunnelManagedByResult(dict):
def __init__(__self__, *,
id: int,
name: str):
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@pulumi.output_type
class GetTrafficForwardingGRETunnelPrimaryDestVipResult(dict):
def __init__(__self__, *,
city: str,
country_code: str,
datacenter: str,
id: int,
latitude: int,
longitude: int,
private_service_edge: bool,
region: str,
virtual_ip: str):
pulumi.set(__self__, "city", city)
pulumi.set(__self__, "country_code", country_code)
pulumi.set(__self__, "datacenter", datacenter)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "latitude", latitude)
pulumi.set(__self__, "longitude", longitude)
pulumi.set(__self__, "private_service_edge", private_service_edge)
pulumi.set(__self__, "region", region)
pulumi.set(__self__, "virtual_ip", virtual_ip)
@property
@pulumi.getter
def city(self) -> str:
return pulumi.get(self, "city")
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> str:
return pulumi.get(self, "country_code")
@property
@pulumi.getter
def datacenter(self) -> str:
return pulumi.get(self, "datacenter")
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter
def latitude(self) -> int:
return pulumi.get(self, "latitude")
@property
@pulumi.getter
def longitude(self) -> int:
return pulumi.get(self, "longitude")
@property
@pulumi.getter(name="privateServiceEdge")
def private_service_edge(self) -> bool:
return pulumi.get(self, "private_service_edge")
@property
@pulumi.getter
def region(self) -> str:
return pulumi.get(self, "region")
@property
@pulumi.getter(name="virtualIp")
def virtual_ip(self) -> str:
return pulumi.get(self, "virtual_ip")
@pulumi.output_type
class GetTrafficForwardingGRETunnelSecondaryDestVipResult(dict):
def __init__(__self__, *,
city: str,
country_code: str,
datacenter: str,
id: int,
latitude: int,
longitude: int,
private_service_edge: bool,
region: str,
virtual_ip: str):
pulumi.set(__self__, "city", city)
pulumi.set(__self__, "country_code", country_code)
pulumi.set(__self__, "datacenter", datacenter)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "latitude", latitude)
pulumi.set(__self__, "longitude", longitude)
pulumi.set(__self__, "private_service_edge", private_service_edge)
pulumi.set(__self__, "region", region)
pulumi.set(__self__, "virtual_ip", virtual_ip)
@property
@pulumi.getter
def city(self) -> str:
return pulumi.get(self, "city")
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> str:
return pulumi.get(self, "country_code")
@property
@pulumi.getter
def datacenter(self) -> str:
return pulumi.get(self, "datacenter")
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter
def latitude(self) -> int:
return pulumi.get(self, "latitude")
@property
@pulumi.getter
def longitude(self) -> int:
return pulumi.get(self, "longitude")
@property
@pulumi.getter(name="privateServiceEdge")
def private_service_edge(self) -> bool:
return pulumi.get(self, "private_service_edge")
@property
@pulumi.getter
def region(self) -> str:
return pulumi.get(self, "region")
@property
@pulumi.getter(name="virtualIp")
def virtual_ip(self) -> str:
return pulumi.get(self, "virtual_ip")
@pulumi.output_type
class GetTrafficForwardingStaticIPLastModifiedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: The unique identifier for the static IP address
:param str name: (String) The configured name of the entity
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
The unique identifier for the static IP address
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetTrafficForwardingStaticIPManagedByResult(dict):
def __init__(__self__, *,
id: int,
name: str):
"""
:param int id: The unique identifier for the static IP address
:param str name: (String) The configured name of the entity
"""
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def id(self) -> int:
"""
The unique identifier for the static IP address
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetTrafficForwardingVIPRecommendedListListResult(dict):
def __init__(__self__, *,
datacenter: Optional[str] = None,
id: Optional[int] = None,
private_service_edge: Optional[bool] = None,
virtual_ip: Optional[str] = None):
"""
:param str datacenter: (String) Data center information
:param int id: Unique identifer of the GRE virtual IP address (VIP)
:param bool private_service_edge: (Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
:param str virtual_ip: (String) GRE cluster virtual IP address (VIP)
"""
if datacenter is not None:
pulumi.set(__self__, "datacenter", datacenter)
if id is not None:
pulumi.set(__self__, "id", id)
if private_service_edge is not None:
pulumi.set(__self__, "private_service_edge", private_service_edge)
if virtual_ip is not None:
pulumi.set(__self__, "virtual_ip", virtual_ip)
@property
@pulumi.getter
def datacenter(self) -> Optional[str]:
"""
(String) Data center information
"""
return pulumi.get(self, "datacenter")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="privateServiceEdge")
def private_service_edge(self) -> Optional[bool]:
"""
(Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
"""
return pulumi.get(self, "private_service_edge")
@property
@pulumi.getter(name="virtualIp")
def virtual_ip(self) -> Optional[str]:
"""
(String) GRE cluster virtual IP address (VIP)
"""
return pulumi.get(self, "virtual_ip")
@pulumi.output_type
class GetTrafficForwardingVPNCredentialsLocationResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifer of the GRE virtual IP address (VIP)
:param str name: (String) The configured name of the entity
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetTrafficForwardingVPNCredentialsManagedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifer of the GRE virtual IP address (VIP)
:param str name: (String) The configured name of the entity
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifer of the GRE virtual IP address (VIP)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetTrafficForwardingGREInternalIPRangeResult',
'AwaitableGetTrafficForwardingGREInternalIPRangeResult',
'get_traffic_forwarding_gre_internal_ip_range',
'get_traffic_forwarding_gre_internal_ip_range_output',
]
@pulumi.output_type
class GetTrafficForwardingGREInternalIPRangeResult:
"""
A collection of values returned by getTrafficForwardingGREInternalIPRange.
"""
def __init__(__self__, id=None, lists=None, required_count=None):
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if lists and not isinstance(lists, list):
raise TypeError("Expected argument 'lists' to be a list")
pulumi.set(__self__, "lists", lists)
if required_count and not isinstance(required_count, int):
raise TypeError("Expected argument 'required_count' to be a int")
pulumi.set(__self__, "required_count", required_count)
@property
@pulumi.getter
def id(self) -> str:
"""
The provider-assigned unique ID for this managed resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def lists(self) -> Sequence['outputs.GetTrafficForwardingGREInternalIPRangeListResult']:
return pulumi.get(self, "lists")
@property
@pulumi.getter(name="requiredCount")
def required_count(self) -> Optional[int]:
return pulumi.get(self, "required_count")
class AwaitableGetTrafficForwardingGREInternalIPRangeResult(GetTrafficForwardingGREInternalIPRangeResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrafficForwardingGREInternalIPRangeResult(
id=self.id,
lists=self.lists,
required_count=self.required_count)
def get_traffic_forwarding_gre_internal_ip_range(required_count: Optional[int] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficForwardingGREInternalIPRangeResult:
"""
Use this data source to access information about an existing resource.
"""
__args__ = dict()
__args__['requiredCount'] = required_count
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:TrafficForwarding/getTrafficForwardingGREInternalIPRange:getTrafficForwardingGREInternalIPRange', __args__, opts=opts, typ=GetTrafficForwardingGREInternalIPRangeResult).value
return AwaitableGetTrafficForwardingGREInternalIPRangeResult(
id=__ret__.id,
lists=__ret__.lists,
required_count=__ret__.required_count)
@_utilities.lift_output_func(get_traffic_forwarding_gre_internal_ip_range)
def get_traffic_forwarding_gre_internal_ip_range_output(required_count: Optional[pulumi.Input[Optional[int]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrafficForwardingGREInternalIPRangeResult]:
"""
Use this data source to access information about an existing resource.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/get_traffic_forwarding_gre_internal_ip_range.py | get_traffic_forwarding_gre_internal_ip_range.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetTrafficForwardingVPNCredentialsResult',
'AwaitableGetTrafficForwardingVPNCredentialsResult',
'get_traffic_forwarding_vpn_credentials',
'get_traffic_forwarding_vpn_credentials_output',
]
@pulumi.output_type
class GetTrafficForwardingVPNCredentialsResult:
"""
A collection of values returned by getTrafficForwardingVPNCredentials.
"""
def __init__(__self__, comments=None, fqdn=None, id=None, ip_address=None, locations=None, managed_bies=None, pre_shared_key=None, type=None):
if comments and not isinstance(comments, str):
raise TypeError("Expected argument 'comments' to be a str")
pulumi.set(__self__, "comments", comments)
if fqdn and not isinstance(fqdn, str):
raise TypeError("Expected argument 'fqdn' to be a str")
pulumi.set(__self__, "fqdn", fqdn)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if ip_address and not isinstance(ip_address, str):
raise TypeError("Expected argument 'ip_address' to be a str")
pulumi.set(__self__, "ip_address", ip_address)
if locations and not isinstance(locations, list):
raise TypeError("Expected argument 'locations' to be a list")
pulumi.set(__self__, "locations", locations)
if managed_bies and not isinstance(managed_bies, list):
raise TypeError("Expected argument 'managed_bies' to be a list")
pulumi.set(__self__, "managed_bies", managed_bies)
if pre_shared_key and not isinstance(pre_shared_key, str):
raise TypeError("Expected argument 'pre_shared_key' to be a str")
pulumi.set(__self__, "pre_shared_key", pre_shared_key)
if type and not isinstance(type, str):
raise TypeError("Expected argument 'type' to be a str")
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def comments(self) -> str:
"""
(String) Additional information about this VPN credential.
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def fqdn(self) -> Optional[str]:
"""
(String) Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
"""
return pulumi.get(self, "fqdn")
@property
@pulumi.getter
def id(self) -> int:
"""
(Number) Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> Optional[str]:
return pulumi.get(self, "ip_address")
@property
@pulumi.getter
def locations(self) -> Sequence['outputs.GetTrafficForwardingVPNCredentialsLocationResult']:
"""
(Set of Object) Location that is associated to this VPN credential. Non-existence means not associated to any location.
"""
return pulumi.get(self, "locations")
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Sequence['outputs.GetTrafficForwardingVPNCredentialsManagedByResult']:
"""
(Set of Object) SD-WAN Partner that manages the location. If a partner does not manage the locaton, this is set to Self.
"""
return pulumi.get(self, "managed_bies")
@property
@pulumi.getter(name="preSharedKey")
def pre_shared_key(self) -> str:
"""
(String) Pre-shared key. This is a required field for `UFQDN` and `IP` auth type.
"""
return pulumi.get(self, "pre_shared_key")
@property
@pulumi.getter
def type(self) -> str:
"""
(String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
"""
return pulumi.get(self, "type")
class AwaitableGetTrafficForwardingVPNCredentialsResult(GetTrafficForwardingVPNCredentialsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrafficForwardingVPNCredentialsResult(
comments=self.comments,
fqdn=self.fqdn,
id=self.id,
ip_address=self.ip_address,
locations=self.locations,
managed_bies=self.managed_bies,
pre_shared_key=self.pre_shared_key,
type=self.type)
def get_traffic_forwarding_vpn_credentials(fqdn: Optional[str] = None,
id: Optional[int] = None,
ip_address: Optional[str] = None,
type: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficForwardingVPNCredentialsResult:
"""
Use the **zia_traffic_forwarding_vpn_credentials** data source to get information about VPN credentials that can be associated to locations. VPN is one way to route traffic from customer locations to the cloud. Site-to-Site IPSec VPN credentials can be identified by the cloud through one of the following methods:
* Common Name (CN) of IPSec Certificate
* VPN User FQDN - requires VPN_SITE_TO_SITE subscription
* VPN IP Address - requires VPN_SITE_TO_SITE subscription
* Extended Authentication (XAUTH) or hosted mobile UserID - requires VPN_MOBILE subscription
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_vpn_credentials(fqdn="[email protected]")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_vpn_credentials(ip_address="1.1.1.1")
```
:param str fqdn: (String) Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
:param int id: Unique identifer of the GRE virtual IP address (VIP)
:param str ip_address: Filter based on an IP address range.
:param str type: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
"""
__args__ = dict()
__args__['fqdn'] = fqdn
__args__['id'] = id
__args__['ipAddress'] = ip_address
__args__['type'] = type
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:TrafficForwarding/getTrafficForwardingVPNCredentials:getTrafficForwardingVPNCredentials', __args__, opts=opts, typ=GetTrafficForwardingVPNCredentialsResult).value
return AwaitableGetTrafficForwardingVPNCredentialsResult(
comments=__ret__.comments,
fqdn=__ret__.fqdn,
id=__ret__.id,
ip_address=__ret__.ip_address,
locations=__ret__.locations,
managed_bies=__ret__.managed_bies,
pre_shared_key=__ret__.pre_shared_key,
type=__ret__.type)
@_utilities.lift_output_func(get_traffic_forwarding_vpn_credentials)
def get_traffic_forwarding_vpn_credentials_output(fqdn: Optional[pulumi.Input[Optional[str]]] = None,
id: Optional[pulumi.Input[Optional[int]]] = None,
ip_address: Optional[pulumi.Input[Optional[str]]] = None,
type: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrafficForwardingVPNCredentialsResult]:
"""
Use the **zia_traffic_forwarding_vpn_credentials** data source to get information about VPN credentials that can be associated to locations. VPN is one way to route traffic from customer locations to the cloud. Site-to-Site IPSec VPN credentials can be identified by the cloud through one of the following methods:
* Common Name (CN) of IPSec Certificate
* VPN User FQDN - requires VPN_SITE_TO_SITE subscription
* VPN IP Address - requires VPN_SITE_TO_SITE subscription
* Extended Authentication (XAUTH) or hosted mobile UserID - requires VPN_MOBILE subscription
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_vpn_credentials(fqdn="[email protected]")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_vpn_credentials(ip_address="1.1.1.1")
```
:param str fqdn: (String) Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
:param int id: Unique identifer of the GRE virtual IP address (VIP)
:param str ip_address: Filter based on an IP address range.
:param str type: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/get_traffic_forwarding_vpn_credentials.py | get_traffic_forwarding_vpn_credentials.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetTrafficForwardingVIPRecommendedListResult',
'AwaitableGetTrafficForwardingVIPRecommendedListResult',
'get_traffic_forwarding_vip_recommended_list',
'get_traffic_forwarding_vip_recommended_list_output',
]
@pulumi.output_type
class GetTrafficForwardingVIPRecommendedListResult:
"""
A collection of values returned by getTrafficForwardingVIPRecommendedList.
"""
def __init__(__self__, geo_override=None, id=None, lists=None, required_count=None, routable_ip=None, source_ip=None):
if geo_override and not isinstance(geo_override, bool):
raise TypeError("Expected argument 'geo_override' to be a bool")
pulumi.set(__self__, "geo_override", geo_override)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if lists and not isinstance(lists, list):
raise TypeError("Expected argument 'lists' to be a list")
pulumi.set(__self__, "lists", lists)
if required_count and not isinstance(required_count, int):
raise TypeError("Expected argument 'required_count' to be a int")
pulumi.set(__self__, "required_count", required_count)
if routable_ip and not isinstance(routable_ip, bool):
raise TypeError("Expected argument 'routable_ip' to be a bool")
pulumi.set(__self__, "routable_ip", routable_ip)
if source_ip and not isinstance(source_ip, str):
raise TypeError("Expected argument 'source_ip' to be a str")
pulumi.set(__self__, "source_ip", source_ip)
@property
@pulumi.getter(name="geoOverride")
def geo_override(self) -> Optional[bool]:
return pulumi.get(self, "geo_override")
@property
@pulumi.getter
def id(self) -> str:
"""
The provider-assigned unique ID for this managed resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def lists(self) -> Sequence['outputs.GetTrafficForwardingVIPRecommendedListListResult']:
return pulumi.get(self, "lists")
@property
@pulumi.getter(name="requiredCount")
def required_count(self) -> Optional[int]:
return pulumi.get(self, "required_count")
@property
@pulumi.getter(name="routableIp")
def routable_ip(self) -> Optional[bool]:
return pulumi.get(self, "routable_ip")
@property
@pulumi.getter(name="sourceIp")
def source_ip(self) -> Optional[str]:
"""
(String) The public source IP address.
"""
return pulumi.get(self, "source_ip")
class AwaitableGetTrafficForwardingVIPRecommendedListResult(GetTrafficForwardingVIPRecommendedListResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrafficForwardingVIPRecommendedListResult(
geo_override=self.geo_override,
id=self.id,
lists=self.lists,
required_count=self.required_count,
routable_ip=self.routable_ip,
source_ip=self.source_ip)
def get_traffic_forwarding_vip_recommended_list(geo_override: Optional[bool] = None,
required_count: Optional[int] = None,
routable_ip: Optional[bool] = None,
source_ip: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficForwardingVIPRecommendedListResult:
"""
Use the **zia_gre_vip_recommended_list** data source to get information about a list of recommended GRE tunnel virtual IP addresses (VIPs), based on source IP address or latitude/longitude coordinates.
:param str source_ip: (String) The public source IP address.
"""
__args__ = dict()
__args__['geoOverride'] = geo_override
__args__['requiredCount'] = required_count
__args__['routableIp'] = routable_ip
__args__['sourceIp'] = source_ip
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:TrafficForwarding/getTrafficForwardingVIPRecommendedList:getTrafficForwardingVIPRecommendedList', __args__, opts=opts, typ=GetTrafficForwardingVIPRecommendedListResult).value
return AwaitableGetTrafficForwardingVIPRecommendedListResult(
geo_override=__ret__.geo_override,
id=__ret__.id,
lists=__ret__.lists,
required_count=__ret__.required_count,
routable_ip=__ret__.routable_ip,
source_ip=__ret__.source_ip)
@_utilities.lift_output_func(get_traffic_forwarding_vip_recommended_list)
def get_traffic_forwarding_vip_recommended_list_output(geo_override: Optional[pulumi.Input[Optional[bool]]] = None,
required_count: Optional[pulumi.Input[Optional[int]]] = None,
routable_ip: Optional[pulumi.Input[Optional[bool]]] = None,
source_ip: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrafficForwardingVIPRecommendedListResult]:
"""
Use the **zia_gre_vip_recommended_list** data source to get information about a list of recommended GRE tunnel virtual IP addresses (VIPs), based on source IP address or latitude/longitude coordinates.
:param str source_ip: (String) The public source IP address.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/get_traffic_forwarding_vip_recommended_list.py | get_traffic_forwarding_vip_recommended_list.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['TrafficForwardingGRETunnelArgs', 'TrafficForwardingGRETunnel']
@pulumi.input_type
class TrafficForwardingGRETunnelArgs:
def __init__(__self__, *,
source_ip: pulumi.Input[str],
comment: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
internal_ip_range: Optional[pulumi.Input[str]] = None,
ip_unnumbered: Optional[pulumi.Input[bool]] = None,
primary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]] = None,
secondary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]] = None,
within_country: Optional[pulumi.Input[bool]] = None):
"""
The set of arguments for constructing a TrafficForwardingGRETunnel resource.
:param pulumi.Input[str] source_ip: The source IP address of the GRE tunnel. This is typically a static IP address in the organization or SD-WAN. This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.
:param pulumi.Input[str] comment: Additional information about this GRE tunnel
:param pulumi.Input[str] country_code: When within_country is enabled, you must set this to the country code.
:param pulumi.Input[str] internal_ip_range: The start of the internal IP address in /29 CIDR range. Automatically set by the provider if `ip_unnumbered` is set to `false`.
:param pulumi.Input[bool] ip_unnumbered: This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]] primary_dest_vips: **` (Optional) The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]] secondary_dest_vips: The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[bool] within_country: Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address
"""
pulumi.set(__self__, "source_ip", source_ip)
if comment is not None:
pulumi.set(__self__, "comment", comment)
if country_code is not None:
pulumi.set(__self__, "country_code", country_code)
if internal_ip_range is not None:
pulumi.set(__self__, "internal_ip_range", internal_ip_range)
if ip_unnumbered is not None:
pulumi.set(__self__, "ip_unnumbered", ip_unnumbered)
if primary_dest_vips is not None:
pulumi.set(__self__, "primary_dest_vips", primary_dest_vips)
if secondary_dest_vips is not None:
pulumi.set(__self__, "secondary_dest_vips", secondary_dest_vips)
if within_country is not None:
pulumi.set(__self__, "within_country", within_country)
@property
@pulumi.getter(name="sourceIp")
def source_ip(self) -> pulumi.Input[str]:
"""
The source IP address of the GRE tunnel. This is typically a static IP address in the organization or SD-WAN. This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.
"""
return pulumi.get(self, "source_ip")
@source_ip.setter
def source_ip(self, value: pulumi.Input[str]):
pulumi.set(self, "source_ip", value)
@property
@pulumi.getter
def comment(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this GRE tunnel
"""
return pulumi.get(self, "comment")
@comment.setter
def comment(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comment", value)
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> Optional[pulumi.Input[str]]:
"""
When within_country is enabled, you must set this to the country code.
"""
return pulumi.get(self, "country_code")
@country_code.setter
def country_code(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "country_code", value)
@property
@pulumi.getter(name="internalIpRange")
def internal_ip_range(self) -> Optional[pulumi.Input[str]]:
"""
The start of the internal IP address in /29 CIDR range. Automatically set by the provider if `ip_unnumbered` is set to `false`.
"""
return pulumi.get(self, "internal_ip_range")
@internal_ip_range.setter
def internal_ip_range(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "internal_ip_range", value)
@property
@pulumi.getter(name="ipUnnumbered")
def ip_unnumbered(self) -> Optional[pulumi.Input[bool]]:
"""
This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null
"""
return pulumi.get(self, "ip_unnumbered")
@ip_unnumbered.setter
def ip_unnumbered(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_unnumbered", value)
@property
@pulumi.getter(name="primaryDestVips")
def primary_dest_vips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]]:
"""
**` (Optional) The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
"""
return pulumi.get(self, "primary_dest_vips")
@primary_dest_vips.setter
def primary_dest_vips(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]]):
pulumi.set(self, "primary_dest_vips", value)
@property
@pulumi.getter(name="secondaryDestVips")
def secondary_dest_vips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]]:
"""
The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
"""
return pulumi.get(self, "secondary_dest_vips")
@secondary_dest_vips.setter
def secondary_dest_vips(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]]):
pulumi.set(self, "secondary_dest_vips", value)
@property
@pulumi.getter(name="withinCountry")
def within_country(self) -> Optional[pulumi.Input[bool]]:
"""
Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address
"""
return pulumi.get(self, "within_country")
@within_country.setter
def within_country(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "within_country", value)
@pulumi.input_type
class _TrafficForwardingGRETunnelState:
def __init__(__self__, *,
comment: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
internal_ip_range: Optional[pulumi.Input[str]] = None,
ip_unnumbered: Optional[pulumi.Input[bool]] = None,
last_modification_time: Optional[pulumi.Input[int]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelLastModifiedByArgs']]]] = None,
primary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]] = None,
secondary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]] = None,
source_ip: Optional[pulumi.Input[str]] = None,
tunnel_id: Optional[pulumi.Input[int]] = None,
within_country: Optional[pulumi.Input[bool]] = None):
"""
Input properties used for looking up and filtering TrafficForwardingGRETunnel resources.
:param pulumi.Input[str] comment: Additional information about this GRE tunnel
:param pulumi.Input[str] country_code: When within_country is enabled, you must set this to the country code.
:param pulumi.Input[str] internal_ip_range: The start of the internal IP address in /29 CIDR range. Automatically set by the provider if `ip_unnumbered` is set to `false`.
:param pulumi.Input[bool] ip_unnumbered: This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]] primary_dest_vips: **` (Optional) The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]] secondary_dest_vips: The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[str] source_ip: The source IP address of the GRE tunnel. This is typically a static IP address in the organization or SD-WAN. This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.
:param pulumi.Input[int] tunnel_id: The ID of the GRE tunnel.
:param pulumi.Input[bool] within_country: Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address
"""
if comment is not None:
pulumi.set(__self__, "comment", comment)
if country_code is not None:
pulumi.set(__self__, "country_code", country_code)
if internal_ip_range is not None:
pulumi.set(__self__, "internal_ip_range", internal_ip_range)
if ip_unnumbered is not None:
pulumi.set(__self__, "ip_unnumbered", ip_unnumbered)
if last_modification_time is not None:
pulumi.set(__self__, "last_modification_time", last_modification_time)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if primary_dest_vips is not None:
pulumi.set(__self__, "primary_dest_vips", primary_dest_vips)
if secondary_dest_vips is not None:
pulumi.set(__self__, "secondary_dest_vips", secondary_dest_vips)
if source_ip is not None:
pulumi.set(__self__, "source_ip", source_ip)
if tunnel_id is not None:
pulumi.set(__self__, "tunnel_id", tunnel_id)
if within_country is not None:
pulumi.set(__self__, "within_country", within_country)
@property
@pulumi.getter
def comment(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this GRE tunnel
"""
return pulumi.get(self, "comment")
@comment.setter
def comment(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comment", value)
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> Optional[pulumi.Input[str]]:
"""
When within_country is enabled, you must set this to the country code.
"""
return pulumi.get(self, "country_code")
@country_code.setter
def country_code(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "country_code", value)
@property
@pulumi.getter(name="internalIpRange")
def internal_ip_range(self) -> Optional[pulumi.Input[str]]:
"""
The start of the internal IP address in /29 CIDR range. Automatically set by the provider if `ip_unnumbered` is set to `false`.
"""
return pulumi.get(self, "internal_ip_range")
@internal_ip_range.setter
def internal_ip_range(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "internal_ip_range", value)
@property
@pulumi.getter(name="ipUnnumbered")
def ip_unnumbered(self) -> Optional[pulumi.Input[bool]]:
"""
This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null
"""
return pulumi.get(self, "ip_unnumbered")
@ip_unnumbered.setter
def ip_unnumbered(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_unnumbered", value)
@property
@pulumi.getter(name="lastModificationTime")
def last_modification_time(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "last_modification_time")
@last_modification_time.setter
def last_modification_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "last_modification_time", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelLastModifiedByArgs']]]]:
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter(name="primaryDestVips")
def primary_dest_vips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]]:
"""
**` (Optional) The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
"""
return pulumi.get(self, "primary_dest_vips")
@primary_dest_vips.setter
def primary_dest_vips(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]]):
pulumi.set(self, "primary_dest_vips", value)
@property
@pulumi.getter(name="secondaryDestVips")
def secondary_dest_vips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]]:
"""
The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
"""
return pulumi.get(self, "secondary_dest_vips")
@secondary_dest_vips.setter
def secondary_dest_vips(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]]):
pulumi.set(self, "secondary_dest_vips", value)
@property
@pulumi.getter(name="sourceIp")
def source_ip(self) -> Optional[pulumi.Input[str]]:
"""
The source IP address of the GRE tunnel. This is typically a static IP address in the organization or SD-WAN. This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.
"""
return pulumi.get(self, "source_ip")
@source_ip.setter
def source_ip(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "source_ip", value)
@property
@pulumi.getter(name="tunnelId")
def tunnel_id(self) -> Optional[pulumi.Input[int]]:
"""
The ID of the GRE tunnel.
"""
return pulumi.get(self, "tunnel_id")
@tunnel_id.setter
def tunnel_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "tunnel_id", value)
@property
@pulumi.getter(name="withinCountry")
def within_country(self) -> Optional[pulumi.Input[bool]]:
"""
Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address
"""
return pulumi.get(self, "within_country")
@within_country.setter
def within_country(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "within_country", value)
class TrafficForwardingGRETunnel(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comment: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
internal_ip_range: Optional[pulumi.Input[str]] = None,
ip_unnumbered: Optional[pulumi.Input[bool]] = None,
primary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]]] = None,
secondary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]]] = None,
source_ip: Optional[pulumi.Input[str]] = None,
within_country: Optional[pulumi.Input[bool]] = None,
__props__=None):
"""
The **zia_traffic_forwarding_gre_tunnel** resource allows the creation and management of GRE tunnel configuration in the Zscaler Internet Access (ZIA) portal.
> **Note:** The provider automatically query the Zscaler cloud for the primary and secondary destination datacenter and virtual IP address (VIP) of the GRE tunnel. The parameter can be overriden if needed by setting the parameters: `primary_dest_vip` and `secondary_dest_vip`.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - Static IP
example_traffic_forwarding_static_ip = zia.traffic_forwarding.TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP",
ip_address="1.1.1.1",
routable_ip=True,
comment="Example",
geo_override=True,
latitude=37.418171,
longitude=-121.95314)
# Creates a numbered GRE Tunnel
example_traffic_forwarding_gre_tunnel = zia.traffic_forwarding.TrafficForwardingGRETunnel("exampleTrafficForwardingGRETunnel",
source_ip=example_traffic_forwarding_static_ip.ip_address,
comment="Example",
within_country=True,
country_code="US",
ip_unnumbered=False,
opts=pulumi.ResourceOptions(depends_on=[example_traffic_forwarding_static_ip]))
```
> **Note:** The provider will automatically query and set the Zscaler cloud for the next available `/29` internal IP range to be used in a numbered GRE tunnel.
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - Static IP
example = zia.traffic_forwarding.TrafficForwardingStaticIP("example",
ip_address="1.1.1.1",
routable_ip=True,
comment="Example",
geo_override=True,
latitude=37.418171,
longitude=-121.95314)
# Creates an unnumbered GRE Tunnel
telus_home_internet01_gre01 = zia.traffic_forwarding.TrafficForwardingGRETunnel("telusHomeInternet01Gre01",
source_ip=example.ip_address,
comment="Example",
within_country=True,
country_code="CA",
ip_unnumbered=True,
opts=pulumi.ResourceOptions(depends_on=[example]))
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comment: Additional information about this GRE tunnel
:param pulumi.Input[str] country_code: When within_country is enabled, you must set this to the country code.
:param pulumi.Input[str] internal_ip_range: The start of the internal IP address in /29 CIDR range. Automatically set by the provider if `ip_unnumbered` is set to `false`.
:param pulumi.Input[bool] ip_unnumbered: This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]] primary_dest_vips: **` (Optional) The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]] secondary_dest_vips: The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[str] source_ip: The source IP address of the GRE tunnel. This is typically a static IP address in the organization or SD-WAN. This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.
:param pulumi.Input[bool] within_country: Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: TrafficForwardingGRETunnelArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_traffic_forwarding_gre_tunnel** resource allows the creation and management of GRE tunnel configuration in the Zscaler Internet Access (ZIA) portal.
> **Note:** The provider automatically query the Zscaler cloud for the primary and secondary destination datacenter and virtual IP address (VIP) of the GRE tunnel. The parameter can be overriden if needed by setting the parameters: `primary_dest_vip` and `secondary_dest_vip`.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - Static IP
example_traffic_forwarding_static_ip = zia.traffic_forwarding.TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP",
ip_address="1.1.1.1",
routable_ip=True,
comment="Example",
geo_override=True,
latitude=37.418171,
longitude=-121.95314)
# Creates a numbered GRE Tunnel
example_traffic_forwarding_gre_tunnel = zia.traffic_forwarding.TrafficForwardingGRETunnel("exampleTrafficForwardingGRETunnel",
source_ip=example_traffic_forwarding_static_ip.ip_address,
comment="Example",
within_country=True,
country_code="US",
ip_unnumbered=False,
opts=pulumi.ResourceOptions(depends_on=[example_traffic_forwarding_static_ip]))
```
> **Note:** The provider will automatically query and set the Zscaler cloud for the next available `/29` internal IP range to be used in a numbered GRE tunnel.
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - Static IP
example = zia.traffic_forwarding.TrafficForwardingStaticIP("example",
ip_address="1.1.1.1",
routable_ip=True,
comment="Example",
geo_override=True,
latitude=37.418171,
longitude=-121.95314)
# Creates an unnumbered GRE Tunnel
telus_home_internet01_gre01 = zia.traffic_forwarding.TrafficForwardingGRETunnel("telusHomeInternet01Gre01",
source_ip=example.ip_address,
comment="Example",
within_country=True,
country_code="CA",
ip_unnumbered=True,
opts=pulumi.ResourceOptions(depends_on=[example]))
```
:param str resource_name: The name of the resource.
:param TrafficForwardingGRETunnelArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(TrafficForwardingGRETunnelArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comment: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
internal_ip_range: Optional[pulumi.Input[str]] = None,
ip_unnumbered: Optional[pulumi.Input[bool]] = None,
primary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]]] = None,
secondary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]]] = None,
source_ip: Optional[pulumi.Input[str]] = None,
within_country: Optional[pulumi.Input[bool]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = TrafficForwardingGRETunnelArgs.__new__(TrafficForwardingGRETunnelArgs)
__props__.__dict__["comment"] = comment
__props__.__dict__["country_code"] = country_code
__props__.__dict__["internal_ip_range"] = internal_ip_range
__props__.__dict__["ip_unnumbered"] = ip_unnumbered
__props__.__dict__["primary_dest_vips"] = primary_dest_vips
__props__.__dict__["secondary_dest_vips"] = secondary_dest_vips
if source_ip is None and not opts.urn:
raise TypeError("Missing required property 'source_ip'")
__props__.__dict__["source_ip"] = source_ip
__props__.__dict__["within_country"] = within_country
__props__.__dict__["last_modification_time"] = None
__props__.__dict__["last_modified_bies"] = None
__props__.__dict__["tunnel_id"] = None
super(TrafficForwardingGRETunnel, __self__).__init__(
'zia:TrafficForwarding/trafficForwardingGRETunnel:TrafficForwardingGRETunnel',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
comment: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
internal_ip_range: Optional[pulumi.Input[str]] = None,
ip_unnumbered: Optional[pulumi.Input[bool]] = None,
last_modification_time: Optional[pulumi.Input[int]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelLastModifiedByArgs']]]]] = None,
primary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]]] = None,
secondary_dest_vips: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]]] = None,
source_ip: Optional[pulumi.Input[str]] = None,
tunnel_id: Optional[pulumi.Input[int]] = None,
within_country: Optional[pulumi.Input[bool]] = None) -> 'TrafficForwardingGRETunnel':
"""
Get an existing TrafficForwardingGRETunnel resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comment: Additional information about this GRE tunnel
:param pulumi.Input[str] country_code: When within_country is enabled, you must set this to the country code.
:param pulumi.Input[str] internal_ip_range: The start of the internal IP address in /29 CIDR range. Automatically set by the provider if `ip_unnumbered` is set to `false`.
:param pulumi.Input[bool] ip_unnumbered: This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelPrimaryDestVipArgs']]]] primary_dest_vips: **` (Optional) The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['TrafficForwardingGRETunnelSecondaryDestVipArgs']]]] secondary_dest_vips: The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
:param pulumi.Input[str] source_ip: The source IP address of the GRE tunnel. This is typically a static IP address in the organization or SD-WAN. This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.
:param pulumi.Input[int] tunnel_id: The ID of the GRE tunnel.
:param pulumi.Input[bool] within_country: Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _TrafficForwardingGRETunnelState.__new__(_TrafficForwardingGRETunnelState)
__props__.__dict__["comment"] = comment
__props__.__dict__["country_code"] = country_code
__props__.__dict__["internal_ip_range"] = internal_ip_range
__props__.__dict__["ip_unnumbered"] = ip_unnumbered
__props__.__dict__["last_modification_time"] = last_modification_time
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["primary_dest_vips"] = primary_dest_vips
__props__.__dict__["secondary_dest_vips"] = secondary_dest_vips
__props__.__dict__["source_ip"] = source_ip
__props__.__dict__["tunnel_id"] = tunnel_id
__props__.__dict__["within_country"] = within_country
return TrafficForwardingGRETunnel(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def comment(self) -> pulumi.Output[Optional[str]]:
"""
Additional information about this GRE tunnel
"""
return pulumi.get(self, "comment")
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> pulumi.Output[str]:
"""
When within_country is enabled, you must set this to the country code.
"""
return pulumi.get(self, "country_code")
@property
@pulumi.getter(name="internalIpRange")
def internal_ip_range(self) -> pulumi.Output[str]:
"""
The start of the internal IP address in /29 CIDR range. Automatically set by the provider if `ip_unnumbered` is set to `false`.
"""
return pulumi.get(self, "internal_ip_range")
@property
@pulumi.getter(name="ipUnnumbered")
def ip_unnumbered(self) -> pulumi.Output[bool]:
"""
This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null
"""
return pulumi.get(self, "ip_unnumbered")
@property
@pulumi.getter(name="lastModificationTime")
def last_modification_time(self) -> pulumi.Output[int]:
return pulumi.get(self, "last_modification_time")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> pulumi.Output[Sequence['outputs.TrafficForwardingGRETunnelLastModifiedBy']]:
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="primaryDestVips")
def primary_dest_vips(self) -> pulumi.Output[Sequence['outputs.TrafficForwardingGRETunnelPrimaryDestVip']]:
"""
**` (Optional) The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
"""
return pulumi.get(self, "primary_dest_vips")
@property
@pulumi.getter(name="secondaryDestVips")
def secondary_dest_vips(self) -> pulumi.Output[Sequence['outputs.TrafficForwardingGRETunnelSecondaryDestVip']]:
"""
The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
"""
return pulumi.get(self, "secondary_dest_vips")
@property
@pulumi.getter(name="sourceIp")
def source_ip(self) -> pulumi.Output[str]:
"""
The source IP address of the GRE tunnel. This is typically a static IP address in the organization or SD-WAN. This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.
"""
return pulumi.get(self, "source_ip")
@property
@pulumi.getter(name="tunnelId")
def tunnel_id(self) -> pulumi.Output[int]:
"""
The ID of the GRE tunnel.
"""
return pulumi.get(self, "tunnel_id")
@property
@pulumi.getter(name="withinCountry")
def within_country(self) -> pulumi.Output[bool]:
"""
Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address
"""
return pulumi.get(self, "within_country") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/traffic_forwarding_gre_tunnel.py | traffic_forwarding_gre_tunnel.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = ['TrafficForwardingVPNCredentialsArgs', 'TrafficForwardingVPNCredentials']
@pulumi.input_type
class TrafficForwardingVPNCredentialsArgs:
def __init__(__self__, *,
comments: Optional[pulumi.Input[str]] = None,
fqdn: Optional[pulumi.Input[str]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
pre_shared_key: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a TrafficForwardingVPNCredentials resource.
:param pulumi.Input[str] comments: Additional information about this VPN credential.
:param pulumi.Input[str] fqdn: Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
:param pulumi.Input[str] ip_address: IP Address for the VON credentials. The parameter becomes required if `type = IP`
:param pulumi.Input[str] pre_shared_key: Pre-shared key. This is a required field for UFQDN and IP auth type.
:param pulumi.Input[str] type: VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are: `UFQDN` and `IP`
"""
if comments is not None:
pulumi.set(__self__, "comments", comments)
if fqdn is not None:
pulumi.set(__self__, "fqdn", fqdn)
if ip_address is not None:
pulumi.set(__self__, "ip_address", ip_address)
if pre_shared_key is not None:
pulumi.set(__self__, "pre_shared_key", pre_shared_key)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def comments(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this VPN credential.
"""
return pulumi.get(self, "comments")
@comments.setter
def comments(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comments", value)
@property
@pulumi.getter
def fqdn(self) -> Optional[pulumi.Input[str]]:
"""
Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
"""
return pulumi.get(self, "fqdn")
@fqdn.setter
def fqdn(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "fqdn", value)
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> Optional[pulumi.Input[str]]:
"""
IP Address for the VON credentials. The parameter becomes required if `type = IP`
"""
return pulumi.get(self, "ip_address")
@ip_address.setter
def ip_address(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ip_address", value)
@property
@pulumi.getter(name="preSharedKey")
def pre_shared_key(self) -> Optional[pulumi.Input[str]]:
"""
Pre-shared key. This is a required field for UFQDN and IP auth type.
"""
return pulumi.get(self, "pre_shared_key")
@pre_shared_key.setter
def pre_shared_key(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "pre_shared_key", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are: `UFQDN` and `IP`
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
@pulumi.input_type
class _TrafficForwardingVPNCredentialsState:
def __init__(__self__, *,
comments: Optional[pulumi.Input[str]] = None,
fqdn: Optional[pulumi.Input[str]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
pre_shared_key: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
vpn_credental_id: Optional[pulumi.Input[int]] = None):
"""
Input properties used for looking up and filtering TrafficForwardingVPNCredentials resources.
:param pulumi.Input[str] comments: Additional information about this VPN credential.
:param pulumi.Input[str] fqdn: Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
:param pulumi.Input[str] ip_address: IP Address for the VON credentials. The parameter becomes required if `type = IP`
:param pulumi.Input[str] pre_shared_key: Pre-shared key. This is a required field for UFQDN and IP auth type.
:param pulumi.Input[str] type: VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are: `UFQDN` and `IP`
"""
if comments is not None:
pulumi.set(__self__, "comments", comments)
if fqdn is not None:
pulumi.set(__self__, "fqdn", fqdn)
if ip_address is not None:
pulumi.set(__self__, "ip_address", ip_address)
if pre_shared_key is not None:
pulumi.set(__self__, "pre_shared_key", pre_shared_key)
if type is not None:
pulumi.set(__self__, "type", type)
if vpn_credental_id is not None:
pulumi.set(__self__, "vpn_credental_id", vpn_credental_id)
@property
@pulumi.getter
def comments(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about this VPN credential.
"""
return pulumi.get(self, "comments")
@comments.setter
def comments(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comments", value)
@property
@pulumi.getter
def fqdn(self) -> Optional[pulumi.Input[str]]:
"""
Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
"""
return pulumi.get(self, "fqdn")
@fqdn.setter
def fqdn(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "fqdn", value)
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> Optional[pulumi.Input[str]]:
"""
IP Address for the VON credentials. The parameter becomes required if `type = IP`
"""
return pulumi.get(self, "ip_address")
@ip_address.setter
def ip_address(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ip_address", value)
@property
@pulumi.getter(name="preSharedKey")
def pre_shared_key(self) -> Optional[pulumi.Input[str]]:
"""
Pre-shared key. This is a required field for UFQDN and IP auth type.
"""
return pulumi.get(self, "pre_shared_key")
@pre_shared_key.setter
def pre_shared_key(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "pre_shared_key", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are: `UFQDN` and `IP`
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
@property
@pulumi.getter(name="vpnCredentalId")
def vpn_credental_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "vpn_credental_id")
@vpn_credental_id.setter
def vpn_credental_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "vpn_credental_id", value)
class TrafficForwardingVPNCredentials(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comments: Optional[pulumi.Input[str]] = None,
fqdn: Optional[pulumi.Input[str]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
pre_shared_key: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The **zia_traffic_forwarding_vpn_credentials** creates and manages VPN credentials that can be associated to locations. VPN is one way to route traffic from customer locations to the cloud. Site-to-site IPSec VPN credentials can be identified by the cloud through one of the following methods:
* Common Name (CN) of IPSec Certificate
* VPN User FQDN - requires VPN_SITE_TO_SITE subscription
* VPN IP Address - requires VPN_SITE_TO_SITE subscription
* Extended Authentication (XAUTH) or hosted mobile UserID - requires VPN_MOBILE subscription
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - VPN Credentials (UFQDN)
example = zia.traffic_forwarding.TrafficForwardingVPNCredentials("example",
comments="Example",
fqdn="[email protected]",
pre_shared_key="newPassword123!",
type="UFQDN")
```
```python
import pulumi
import zscaler_pulumi_zia as zia
example_traffic_forwarding_static_ip = zia.traffic_forwarding.TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP",
ip_address="1.1.1.1",
routable_ip=True,
comment="Example",
geo_override=True,
latitude=-36.848461,
longitude=174.763336)
# ZIA Traffic Forwarding - VPN Credentials (IP)
example_traffic_forwarding_vpn_credentials = zia.traffic_forwarding.TrafficForwardingVPNCredentials("exampleTrafficForwardingVPNCredentials",
type="IP",
ip_address=example_traffic_forwarding_static_ip.ip_address,
comments="Example",
pre_shared_key="newPassword123!",
opts=pulumi.ResourceOptions(depends_on=[example_traffic_forwarding_static_ip]))
```
> **NOTE** For VPN Credentials of Type `IP` a static IP resource must be created first.
## Import
Static IP resources can be imported by using `<STATIC IP ID>` or `<IP ADDRESS>`as the import ID.
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials example <static_ip_id>
```
or
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials example <ip_address>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comments: Additional information about this VPN credential.
:param pulumi.Input[str] fqdn: Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
:param pulumi.Input[str] ip_address: IP Address for the VON credentials. The parameter becomes required if `type = IP`
:param pulumi.Input[str] pre_shared_key: Pre-shared key. This is a required field for UFQDN and IP auth type.
:param pulumi.Input[str] type: VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are: `UFQDN` and `IP`
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[TrafficForwardingVPNCredentialsArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_traffic_forwarding_vpn_credentials** creates and manages VPN credentials that can be associated to locations. VPN is one way to route traffic from customer locations to the cloud. Site-to-site IPSec VPN credentials can be identified by the cloud through one of the following methods:
* Common Name (CN) of IPSec Certificate
* VPN User FQDN - requires VPN_SITE_TO_SITE subscription
* VPN IP Address - requires VPN_SITE_TO_SITE subscription
* Extended Authentication (XAUTH) or hosted mobile UserID - requires VPN_MOBILE subscription
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# ZIA Traffic Forwarding - VPN Credentials (UFQDN)
example = zia.traffic_forwarding.TrafficForwardingVPNCredentials("example",
comments="Example",
fqdn="[email protected]",
pre_shared_key="newPassword123!",
type="UFQDN")
```
```python
import pulumi
import zscaler_pulumi_zia as zia
example_traffic_forwarding_static_ip = zia.traffic_forwarding.TrafficForwardingStaticIP("exampleTrafficForwardingStaticIP",
ip_address="1.1.1.1",
routable_ip=True,
comment="Example",
geo_override=True,
latitude=-36.848461,
longitude=174.763336)
# ZIA Traffic Forwarding - VPN Credentials (IP)
example_traffic_forwarding_vpn_credentials = zia.traffic_forwarding.TrafficForwardingVPNCredentials("exampleTrafficForwardingVPNCredentials",
type="IP",
ip_address=example_traffic_forwarding_static_ip.ip_address,
comments="Example",
pre_shared_key="newPassword123!",
opts=pulumi.ResourceOptions(depends_on=[example_traffic_forwarding_static_ip]))
```
> **NOTE** For VPN Credentials of Type `IP` a static IP resource must be created first.
## Import
Static IP resources can be imported by using `<STATIC IP ID>` or `<IP ADDRESS>`as the import ID.
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials example <static_ip_id>
```
or
```sh
$ pulumi import zia:TrafficForwarding/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials example <ip_address>
```
:param str resource_name: The name of the resource.
:param TrafficForwardingVPNCredentialsArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(TrafficForwardingVPNCredentialsArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
comments: Optional[pulumi.Input[str]] = None,
fqdn: Optional[pulumi.Input[str]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
pre_shared_key: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = TrafficForwardingVPNCredentialsArgs.__new__(TrafficForwardingVPNCredentialsArgs)
__props__.__dict__["comments"] = comments
__props__.__dict__["fqdn"] = fqdn
__props__.__dict__["ip_address"] = ip_address
__props__.__dict__["pre_shared_key"] = None if pre_shared_key is None else pulumi.Output.secret(pre_shared_key)
__props__.__dict__["type"] = type
__props__.__dict__["vpn_credental_id"] = None
secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["preSharedKey"])
opts = pulumi.ResourceOptions.merge(opts, secret_opts)
super(TrafficForwardingVPNCredentials, __self__).__init__(
'zia:TrafficForwarding/trafficForwardingVPNCredentials:TrafficForwardingVPNCredentials',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
comments: Optional[pulumi.Input[str]] = None,
fqdn: Optional[pulumi.Input[str]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
pre_shared_key: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
vpn_credental_id: Optional[pulumi.Input[int]] = None) -> 'TrafficForwardingVPNCredentials':
"""
Get an existing TrafficForwardingVPNCredentials resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] comments: Additional information about this VPN credential.
:param pulumi.Input[str] fqdn: Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
:param pulumi.Input[str] ip_address: IP Address for the VON credentials. The parameter becomes required if `type = IP`
:param pulumi.Input[str] pre_shared_key: Pre-shared key. This is a required field for UFQDN and IP auth type.
:param pulumi.Input[str] type: VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are: `UFQDN` and `IP`
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _TrafficForwardingVPNCredentialsState.__new__(_TrafficForwardingVPNCredentialsState)
__props__.__dict__["comments"] = comments
__props__.__dict__["fqdn"] = fqdn
__props__.__dict__["ip_address"] = ip_address
__props__.__dict__["pre_shared_key"] = pre_shared_key
__props__.__dict__["type"] = type
__props__.__dict__["vpn_credental_id"] = vpn_credental_id
return TrafficForwardingVPNCredentials(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def comments(self) -> pulumi.Output[Optional[str]]:
"""
Additional information about this VPN credential.
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def fqdn(self) -> pulumi.Output[Optional[str]]:
"""
Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
"""
return pulumi.get(self, "fqdn")
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> pulumi.Output[Optional[str]]:
"""
IP Address for the VON credentials. The parameter becomes required if `type = IP`
"""
return pulumi.get(self, "ip_address")
@property
@pulumi.getter(name="preSharedKey")
def pre_shared_key(self) -> pulumi.Output[Optional[str]]:
"""
Pre-shared key. This is a required field for UFQDN and IP auth type.
"""
return pulumi.get(self, "pre_shared_key")
@property
@pulumi.getter
def type(self) -> pulumi.Output[Optional[str]]:
"""
VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created. The supported values are: `UFQDN` and `IP`
"""
return pulumi.get(self, "type")
@property
@pulumi.getter(name="vpnCredentalId")
def vpn_credental_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "vpn_credental_id") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/traffic_forwarding_vpn_credentials.py | traffic_forwarding_vpn_credentials.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetTrafficForwardingStaticIPResult',
'AwaitableGetTrafficForwardingStaticIPResult',
'get_traffic_forwarding_static_ip',
'get_traffic_forwarding_static_ip_output',
]
@pulumi.output_type
class GetTrafficForwardingStaticIPResult:
"""
A collection of values returned by getTrafficForwardingStaticIP.
"""
def __init__(__self__, comment=None, geo_override=None, id=None, ip_address=None, last_modification_time=None, last_modified_bies=None, latitude=None, longitude=None, managed_bies=None, routable_ip=None):
if comment and not isinstance(comment, str):
raise TypeError("Expected argument 'comment' to be a str")
pulumi.set(__self__, "comment", comment)
if geo_override and not isinstance(geo_override, bool):
raise TypeError("Expected argument 'geo_override' to be a bool")
pulumi.set(__self__, "geo_override", geo_override)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if ip_address and not isinstance(ip_address, str):
raise TypeError("Expected argument 'ip_address' to be a str")
pulumi.set(__self__, "ip_address", ip_address)
if last_modification_time and not isinstance(last_modification_time, int):
raise TypeError("Expected argument 'last_modification_time' to be a int")
pulumi.set(__self__, "last_modification_time", last_modification_time)
if last_modified_bies and not isinstance(last_modified_bies, list):
raise TypeError("Expected argument 'last_modified_bies' to be a list")
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if latitude and not isinstance(latitude, int):
raise TypeError("Expected argument 'latitude' to be a int")
pulumi.set(__self__, "latitude", latitude)
if longitude and not isinstance(longitude, int):
raise TypeError("Expected argument 'longitude' to be a int")
pulumi.set(__self__, "longitude", longitude)
if managed_bies and not isinstance(managed_bies, list):
raise TypeError("Expected argument 'managed_bies' to be a list")
pulumi.set(__self__, "managed_bies", managed_bies)
if routable_ip and not isinstance(routable_ip, bool):
raise TypeError("Expected argument 'routable_ip' to be a bool")
pulumi.set(__self__, "routable_ip", routable_ip)
@property
@pulumi.getter
def comment(self) -> Optional[str]:
"""
(String) Additional information about this static IP address
"""
return pulumi.get(self, "comment")
@property
@pulumi.getter(name="geoOverride")
def geo_override(self) -> bool:
"""
(Boolean) If not set, geographic coordinates and city are automatically determined from the IP address. Otherwise, the latitude and longitude coordinates must be provided.
"""
return pulumi.get(self, "geo_override")
@property
@pulumi.getter
def id(self) -> int:
"""
(String) Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> str:
"""
(String) The static IP address
"""
return pulumi.get(self, "ip_address")
@property
@pulumi.getter(name="lastModificationTime")
def last_modification_time(self) -> int:
"""
(Number) When the static IP address was last modified
"""
return pulumi.get(self, "last_modification_time")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Sequence['outputs.GetTrafficForwardingStaticIPLastModifiedByResult']:
"""
(Set of Object)
"""
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter
def latitude(self) -> int:
"""
(Number) Required only if the geoOverride attribute is set. Latitude with 7 digit precision after decimal point, ranges between `-90` and `90` degrees.
"""
return pulumi.get(self, "latitude")
@property
@pulumi.getter
def longitude(self) -> int:
"""
(Number) Required only if the geoOverride attribute is set. Longitude with 7 digit precision after decimal point, ranges between `-180` and `180` degrees.
"""
return pulumi.get(self, "longitude")
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Sequence['outputs.GetTrafficForwardingStaticIPManagedByResult']:
"""
(Set of Object)
"""
return pulumi.get(self, "managed_bies")
@property
@pulumi.getter(name="routableIp")
def routable_ip(self) -> bool:
"""
(Boolean) Indicates whether a non-RFC 1918 IP address is publicly routable. This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.
"""
return pulumi.get(self, "routable_ip")
class AwaitableGetTrafficForwardingStaticIPResult(GetTrafficForwardingStaticIPResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrafficForwardingStaticIPResult(
comment=self.comment,
geo_override=self.geo_override,
id=self.id,
ip_address=self.ip_address,
last_modification_time=self.last_modification_time,
last_modified_bies=self.last_modified_bies,
latitude=self.latitude,
longitude=self.longitude,
managed_bies=self.managed_bies,
routable_ip=self.routable_ip)
def get_traffic_forwarding_static_ip(comment: Optional[str] = None,
id: Optional[int] = None,
ip_address: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficForwardingStaticIPResult:
"""
Use the **zia_traffic_forwarding_static_ip** data source to get information about all provisioned static IP addresses. This resource can then be utilized when creating a GRE Tunnel or VPN Credential resource of Type `IP`
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_static_ip(ip_address="1.1.1.1")
```
:param str comment: (String) Additional information about this static IP address
:param int id: The unique identifier for the static IP address
:param str ip_address: The static IP address
"""
__args__ = dict()
__args__['comment'] = comment
__args__['id'] = id
__args__['ipAddress'] = ip_address
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:TrafficForwarding/getTrafficForwardingStaticIP:getTrafficForwardingStaticIP', __args__, opts=opts, typ=GetTrafficForwardingStaticIPResult).value
return AwaitableGetTrafficForwardingStaticIPResult(
comment=__ret__.comment,
geo_override=__ret__.geo_override,
id=__ret__.id,
ip_address=__ret__.ip_address,
last_modification_time=__ret__.last_modification_time,
last_modified_bies=__ret__.last_modified_bies,
latitude=__ret__.latitude,
longitude=__ret__.longitude,
managed_bies=__ret__.managed_bies,
routable_ip=__ret__.routable_ip)
@_utilities.lift_output_func(get_traffic_forwarding_static_ip)
def get_traffic_forwarding_static_ip_output(comment: Optional[pulumi.Input[Optional[str]]] = None,
id: Optional[pulumi.Input[Optional[int]]] = None,
ip_address: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrafficForwardingStaticIPResult]:
"""
Use the **zia_traffic_forwarding_static_ip** data source to get information about all provisioned static IP addresses. This resource can then be utilized when creating a GRE Tunnel or VPN Credential resource of Type `IP`
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_static_ip(ip_address="1.1.1.1")
```
:param str comment: (String) Additional information about this static IP address
:param int id: The unique identifier for the static IP address
:param str ip_address: The static IP address
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/get_traffic_forwarding_static_ip.py | get_traffic_forwarding_static_ip.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetTrafficForwardingGRETunnelInfoResult',
'AwaitableGetTrafficForwardingGRETunnelInfoResult',
'get_traffic_forwarding_gre_tunnel_info',
'get_traffic_forwarding_gre_tunnel_info_output',
]
@pulumi.output_type
class GetTrafficForwardingGRETunnelInfoResult:
"""
A collection of values returned by getTrafficForwardingGRETunnelInfo.
"""
def __init__(__self__, gre_enabled=None, gre_range_primary=None, gre_range_secondary=None, gre_tunnel_ip=None, id=None, ip_address=None, primary_gw=None, secondary_gw=None, tun_id=None):
if gre_enabled and not isinstance(gre_enabled, bool):
raise TypeError("Expected argument 'gre_enabled' to be a bool")
pulumi.set(__self__, "gre_enabled", gre_enabled)
if gre_range_primary and not isinstance(gre_range_primary, str):
raise TypeError("Expected argument 'gre_range_primary' to be a str")
pulumi.set(__self__, "gre_range_primary", gre_range_primary)
if gre_range_secondary and not isinstance(gre_range_secondary, str):
raise TypeError("Expected argument 'gre_range_secondary' to be a str")
pulumi.set(__self__, "gre_range_secondary", gre_range_secondary)
if gre_tunnel_ip and not isinstance(gre_tunnel_ip, str):
raise TypeError("Expected argument 'gre_tunnel_ip' to be a str")
pulumi.set(__self__, "gre_tunnel_ip", gre_tunnel_ip)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if ip_address and not isinstance(ip_address, str):
raise TypeError("Expected argument 'ip_address' to be a str")
pulumi.set(__self__, "ip_address", ip_address)
if primary_gw and not isinstance(primary_gw, str):
raise TypeError("Expected argument 'primary_gw' to be a str")
pulumi.set(__self__, "primary_gw", primary_gw)
if secondary_gw and not isinstance(secondary_gw, str):
raise TypeError("Expected argument 'secondary_gw' to be a str")
pulumi.set(__self__, "secondary_gw", secondary_gw)
if tun_id and not isinstance(tun_id, int):
raise TypeError("Expected argument 'tun_id' to be a int")
pulumi.set(__self__, "tun_id", tun_id)
@property
@pulumi.getter(name="greEnabled")
def gre_enabled(self) -> Optional[bool]:
return pulumi.get(self, "gre_enabled")
@property
@pulumi.getter(name="greRangePrimary")
def gre_range_primary(self) -> str:
"""
(String)
"""
return pulumi.get(self, "gre_range_primary")
@property
@pulumi.getter(name="greRangeSecondary")
def gre_range_secondary(self) -> str:
"""
(String)
"""
return pulumi.get(self, "gre_range_secondary")
@property
@pulumi.getter(name="greTunnelIp")
def gre_tunnel_ip(self) -> str:
"""
(String) The start of the internal IP address in /29 CIDR range
"""
return pulumi.get(self, "gre_tunnel_ip")
@property
@pulumi.getter
def id(self) -> str:
"""
The provider-assigned unique ID for this managed resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> Optional[str]:
return pulumi.get(self, "ip_address")
@property
@pulumi.getter(name="primaryGw")
def primary_gw(self) -> str:
"""
(String)
"""
return pulumi.get(self, "primary_gw")
@property
@pulumi.getter(name="secondaryGw")
def secondary_gw(self) -> str:
"""
(String)
"""
return pulumi.get(self, "secondary_gw")
@property
@pulumi.getter(name="tunId")
def tun_id(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "tun_id")
class AwaitableGetTrafficForwardingGRETunnelInfoResult(GetTrafficForwardingGRETunnelInfoResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrafficForwardingGRETunnelInfoResult(
gre_enabled=self.gre_enabled,
gre_range_primary=self.gre_range_primary,
gre_range_secondary=self.gre_range_secondary,
gre_tunnel_ip=self.gre_tunnel_ip,
id=self.id,
ip_address=self.ip_address,
primary_gw=self.primary_gw,
secondary_gw=self.secondary_gw,
tun_id=self.tun_id)
def get_traffic_forwarding_gre_tunnel_info(gre_enabled: Optional[bool] = None,
ip_address: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrafficForwardingGRETunnelInfoResult:
"""
The **zia_traffic_forwarding_gre_tunnel_info** data source to get information about provisioned GRE tunnel information created in the Zscaler Internet Access portal.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_gre_tunnel_info(ip_address="1.1.1.1")
```
:param bool gre_enabled: Displays only ip addresses with GRE tunnel enabled
:param str ip_address: Filter based on an IP address range.
"""
__args__ = dict()
__args__['greEnabled'] = gre_enabled
__args__['ipAddress'] = ip_address
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:TrafficForwarding/getTrafficForwardingGRETunnelInfo:getTrafficForwardingGRETunnelInfo', __args__, opts=opts, typ=GetTrafficForwardingGRETunnelInfoResult).value
return AwaitableGetTrafficForwardingGRETunnelInfoResult(
gre_enabled=__ret__.gre_enabled,
gre_range_primary=__ret__.gre_range_primary,
gre_range_secondary=__ret__.gre_range_secondary,
gre_tunnel_ip=__ret__.gre_tunnel_ip,
id=__ret__.id,
ip_address=__ret__.ip_address,
primary_gw=__ret__.primary_gw,
secondary_gw=__ret__.secondary_gw,
tun_id=__ret__.tun_id)
@_utilities.lift_output_func(get_traffic_forwarding_gre_tunnel_info)
def get_traffic_forwarding_gre_tunnel_info_output(gre_enabled: Optional[pulumi.Input[Optional[bool]]] = None,
ip_address: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrafficForwardingGRETunnelInfoResult]:
"""
The **zia_traffic_forwarding_gre_tunnel_info** data source to get information about provisioned GRE tunnel information created in the Zscaler Internet Access portal.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.TrafficForwarding.get_traffic_forwarding_gre_tunnel_info(ip_address="1.1.1.1")
```
:param bool gre_enabled: Displays only ip addresses with GRE tunnel enabled
:param str ip_address: Filter based on an IP address range.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/trafficforwarding/get_traffic_forwarding_gre_tunnel_info.py | get_traffic_forwarding_gre_tunnel_info.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetAdminRolesResult',
'AwaitableGetAdminRolesResult',
'get_admin_roles',
'get_admin_roles_output',
]
@pulumi.output_type
class GetAdminRolesResult:
"""
A collection of values returned by getAdminRoles.
"""
def __init__(__self__, admin_acct_access=None, analysis_access=None, dashboard_access=None, id=None, is_auditor=None, is_non_editable=None, logs_limit=None, name=None, permissions=None, policy_access=None, rank=None, report_access=None, role_type=None, username_access=None):
if admin_acct_access and not isinstance(admin_acct_access, str):
raise TypeError("Expected argument 'admin_acct_access' to be a str")
pulumi.set(__self__, "admin_acct_access", admin_acct_access)
if analysis_access and not isinstance(analysis_access, str):
raise TypeError("Expected argument 'analysis_access' to be a str")
pulumi.set(__self__, "analysis_access", analysis_access)
if dashboard_access and not isinstance(dashboard_access, str):
raise TypeError("Expected argument 'dashboard_access' to be a str")
pulumi.set(__self__, "dashboard_access", dashboard_access)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if is_auditor and not isinstance(is_auditor, bool):
raise TypeError("Expected argument 'is_auditor' to be a bool")
pulumi.set(__self__, "is_auditor", is_auditor)
if is_non_editable and not isinstance(is_non_editable, bool):
raise TypeError("Expected argument 'is_non_editable' to be a bool")
pulumi.set(__self__, "is_non_editable", is_non_editable)
if logs_limit and not isinstance(logs_limit, str):
raise TypeError("Expected argument 'logs_limit' to be a str")
pulumi.set(__self__, "logs_limit", logs_limit)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if permissions and not isinstance(permissions, list):
raise TypeError("Expected argument 'permissions' to be a list")
pulumi.set(__self__, "permissions", permissions)
if policy_access and not isinstance(policy_access, str):
raise TypeError("Expected argument 'policy_access' to be a str")
pulumi.set(__self__, "policy_access", policy_access)
if rank and not isinstance(rank, int):
raise TypeError("Expected argument 'rank' to be a int")
pulumi.set(__self__, "rank", rank)
if report_access and not isinstance(report_access, str):
raise TypeError("Expected argument 'report_access' to be a str")
pulumi.set(__self__, "report_access", report_access)
if role_type and not isinstance(role_type, str):
raise TypeError("Expected argument 'role_type' to be a str")
pulumi.set(__self__, "role_type", role_type)
if username_access and not isinstance(username_access, str):
raise TypeError("Expected argument 'username_access' to be a str")
pulumi.set(__self__, "username_access", username_access)
@property
@pulumi.getter(name="adminAcctAccess")
def admin_acct_access(self) -> str:
"""
(String)
"""
return pulumi.get(self, "admin_acct_access")
@property
@pulumi.getter(name="analysisAccess")
def analysis_access(self) -> str:
"""
(String)
"""
return pulumi.get(self, "analysis_access")
@property
@pulumi.getter(name="dashboardAccess")
def dashboard_access(self) -> str:
"""
(String) Dashboard access permission. Supported values are: `NONE`, `READ_ONLY`
"""
return pulumi.get(self, "dashboard_access")
@property
@pulumi.getter
def id(self) -> int:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="isAuditor")
def is_auditor(self) -> bool:
"""
(Boolean) Indicates whether this is an auditor role.
"""
return pulumi.get(self, "is_auditor")
@property
@pulumi.getter(name="isNonEditable")
def is_non_editable(self) -> bool:
"""
(Boolean) Indicates whether or not this admin user is editable/deletable.
"""
return pulumi.get(self, "is_non_editable")
@property
@pulumi.getter(name="logsLimit")
def logs_limit(self) -> str:
"""
(String) Log range limit. Returned values are: `UNRESTRICTED`, `MONTH_1`, `MONTH_2`, `MONTH_3`, `MONTH_4`, `MONTH_5`, `MONTH_6`
"""
return pulumi.get(self, "logs_limit")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter
def permissions(self) -> Sequence[str]:
"""
(List of String) List of functional areas to which this role has access. This attribute is subject to change.
"""
return pulumi.get(self, "permissions")
@property
@pulumi.getter(name="policyAccess")
def policy_access(self) -> str:
"""
(String) Policy access permission. Returned values are: `NONE`, `READ_ONLY`,`READ_WRITE`
"""
return pulumi.get(self, "policy_access")
@property
@pulumi.getter
def rank(self) -> int:
"""
(Number) Admin rank of this admin role. This is applicable only when admin rank is enabled in the advanced settings. Default value is 7 (the lowest rank). The assigned admin rank determines the roles or admin users this user can manage, and which rule orders this admin can access.
"""
return pulumi.get(self, "rank")
@property
@pulumi.getter(name="reportAccess")
def report_access(self) -> str:
"""
(String) Report access permission. Returned values are: `NONE`, `READ_ONLY`,`READ_WRITE`
"""
return pulumi.get(self, "report_access")
@property
@pulumi.getter(name="roleType")
def role_type(self) -> str:
"""
(String) The admin role type. ()This attribute is subject to change.) Supported values are: `ORG_ADMIN`, `EXEC_INSIGHT`, `EXEC_INSIGHT_AND_ORG_ADMIN`, `SDWAN`
"""
return pulumi.get(self, "role_type")
@property
@pulumi.getter(name="usernameAccess")
def username_access(self) -> str:
"""
(String) Username access permission. When set to NONE, the username will be obfuscated. Supported values are: `NONE|READ_ONLY`
"""
return pulumi.get(self, "username_access")
class AwaitableGetAdminRolesResult(GetAdminRolesResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetAdminRolesResult(
admin_acct_access=self.admin_acct_access,
analysis_access=self.analysis_access,
dashboard_access=self.dashboard_access,
id=self.id,
is_auditor=self.is_auditor,
is_non_editable=self.is_non_editable,
logs_limit=self.logs_limit,
name=self.name,
permissions=self.permissions,
policy_access=self.policy_access,
rank=self.rank,
report_access=self.report_access,
role_type=self.role_type,
username_access=self.username_access)
def get_admin_roles(name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAdminRolesResult:
"""
Use the **zia_admin_roles** data source to get information about an admin role created in the Zscaler Internet Access cloud or via the API. This data source can then be associated with a ZIA administrator account.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.AdminRoles.get_admin_roles(name="Super Admin")
```
:param str name: The name of the Admin role to be exported.
"""
__args__ = dict()
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:AdminRoles/getAdminRoles:getAdminRoles', __args__, opts=opts, typ=GetAdminRolesResult).value
return AwaitableGetAdminRolesResult(
admin_acct_access=__ret__.admin_acct_access,
analysis_access=__ret__.analysis_access,
dashboard_access=__ret__.dashboard_access,
id=__ret__.id,
is_auditor=__ret__.is_auditor,
is_non_editable=__ret__.is_non_editable,
logs_limit=__ret__.logs_limit,
name=__ret__.name,
permissions=__ret__.permissions,
policy_access=__ret__.policy_access,
rank=__ret__.rank,
report_access=__ret__.report_access,
role_type=__ret__.role_type,
username_access=__ret__.username_access)
@_utilities.lift_output_func(get_admin_roles)
def get_admin_roles_output(name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetAdminRolesResult]:
"""
Use the **zia_admin_roles** data source to get information about an admin role created in the Zscaler Internet Access cloud or via the API. This data source can then be associated with a ZIA administrator account.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.AdminRoles.get_admin_roles(name="Super Admin")
```
:param str name: The name of the Admin role to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/adminroles/get_admin_roles.py | get_admin_roles.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetLocationGroupsDynamicLocationGroupCriteriaArgs',
'GetLocationGroupsDynamicLocationGroupCriteriaCityArgs',
'GetLocationGroupsDynamicLocationGroupCriteriaManagedByArgs',
'GetLocationGroupsDynamicLocationGroupCriteriaNameArgs',
]
@pulumi.input_type
class GetLocationGroupsDynamicLocationGroupCriteriaArgs:
def __init__(__self__, *,
enable_bandwidth_control: bool,
enable_caution: bool,
enable_xff_forwarding: bool,
enforce_aup: bool,
enforce_authentication: bool,
enforce_firewall_control: bool,
managed_bies: Sequence['GetLocationGroupsDynamicLocationGroupCriteriaManagedByArgs'],
cities: Optional[Sequence['GetLocationGroupsDynamicLocationGroupCriteriaCityArgs']] = None,
countries: Optional[Sequence[str]] = None,
names: Optional[Sequence['GetLocationGroupsDynamicLocationGroupCriteriaNameArgs']] = None,
profiles: Optional[Sequence[str]] = None):
"""
:param bool enable_bandwidth_control: (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
:param bool enable_caution: (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
:param bool enable_xff_forwarding: (Boolean) Enable `XFF` Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
:param bool enforce_aup: (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
:param bool enforce_authentication: (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
:param bool enforce_firewall_control: (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
:param Sequence['GetLocationGroupsDynamicLocationGroupCriteriaManagedByArgs'] managed_bies: (Block List)
:param Sequence['GetLocationGroupsDynamicLocationGroupCriteriaCityArgs'] cities: (Block List)
:param Sequence[str] countries: (List of String) One or more countries from a predefined set
:param Sequence['GetLocationGroupsDynamicLocationGroupCriteriaNameArgs'] names: Location group name
:param Sequence[str] profiles: (List of String) One or more location profiles from a predefined set
"""
pulumi.set(__self__, "enable_bandwidth_control", enable_bandwidth_control)
pulumi.set(__self__, "enable_caution", enable_caution)
pulumi.set(__self__, "enable_xff_forwarding", enable_xff_forwarding)
pulumi.set(__self__, "enforce_aup", enforce_aup)
pulumi.set(__self__, "enforce_authentication", enforce_authentication)
pulumi.set(__self__, "enforce_firewall_control", enforce_firewall_control)
pulumi.set(__self__, "managed_bies", managed_bies)
if cities is not None:
pulumi.set(__self__, "cities", cities)
if countries is not None:
pulumi.set(__self__, "countries", countries)
if names is not None:
pulumi.set(__self__, "names", names)
if profiles is not None:
pulumi.set(__self__, "profiles", profiles)
@property
@pulumi.getter(name="enableBandwidthControl")
def enable_bandwidth_control(self) -> bool:
"""
(Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
"""
return pulumi.get(self, "enable_bandwidth_control")
@enable_bandwidth_control.setter
def enable_bandwidth_control(self, value: bool):
pulumi.set(self, "enable_bandwidth_control", value)
@property
@pulumi.getter(name="enableCaution")
def enable_caution(self) -> bool:
"""
(Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
"""
return pulumi.get(self, "enable_caution")
@enable_caution.setter
def enable_caution(self, value: bool):
pulumi.set(self, "enable_caution", value)
@property
@pulumi.getter(name="enableXffForwarding")
def enable_xff_forwarding(self) -> bool:
"""
(Boolean) Enable `XFF` Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
"""
return pulumi.get(self, "enable_xff_forwarding")
@enable_xff_forwarding.setter
def enable_xff_forwarding(self, value: bool):
pulumi.set(self, "enable_xff_forwarding", value)
@property
@pulumi.getter(name="enforceAup")
def enforce_aup(self) -> bool:
"""
(Boolean) Enable AUP. When set to true, AUP is enabled for the location.
"""
return pulumi.get(self, "enforce_aup")
@enforce_aup.setter
def enforce_aup(self, value: bool):
pulumi.set(self, "enforce_aup", value)
@property
@pulumi.getter(name="enforceAuthentication")
def enforce_authentication(self) -> bool:
"""
(Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
"""
return pulumi.get(self, "enforce_authentication")
@enforce_authentication.setter
def enforce_authentication(self, value: bool):
pulumi.set(self, "enforce_authentication", value)
@property
@pulumi.getter(name="enforceFirewallControl")
def enforce_firewall_control(self) -> bool:
"""
(Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
"""
return pulumi.get(self, "enforce_firewall_control")
@enforce_firewall_control.setter
def enforce_firewall_control(self, value: bool):
pulumi.set(self, "enforce_firewall_control", value)
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Sequence['GetLocationGroupsDynamicLocationGroupCriteriaManagedByArgs']:
"""
(Block List)
"""
return pulumi.get(self, "managed_bies")
@managed_bies.setter
def managed_bies(self, value: Sequence['GetLocationGroupsDynamicLocationGroupCriteriaManagedByArgs']):
pulumi.set(self, "managed_bies", value)
@property
@pulumi.getter
def cities(self) -> Optional[Sequence['GetLocationGroupsDynamicLocationGroupCriteriaCityArgs']]:
"""
(Block List)
"""
return pulumi.get(self, "cities")
@cities.setter
def cities(self, value: Optional[Sequence['GetLocationGroupsDynamicLocationGroupCriteriaCityArgs']]):
pulumi.set(self, "cities", value)
@property
@pulumi.getter
def countries(self) -> Optional[Sequence[str]]:
"""
(List of String) One or more countries from a predefined set
"""
return pulumi.get(self, "countries")
@countries.setter
def countries(self, value: Optional[Sequence[str]]):
pulumi.set(self, "countries", value)
@property
@pulumi.getter
def names(self) -> Optional[Sequence['GetLocationGroupsDynamicLocationGroupCriteriaNameArgs']]:
"""
Location group name
"""
return pulumi.get(self, "names")
@names.setter
def names(self, value: Optional[Sequence['GetLocationGroupsDynamicLocationGroupCriteriaNameArgs']]):
pulumi.set(self, "names", value)
@property
@pulumi.getter
def profiles(self) -> Optional[Sequence[str]]:
"""
(List of String) One or more location profiles from a predefined set
"""
return pulumi.get(self, "profiles")
@profiles.setter
def profiles(self, value: Optional[Sequence[str]]):
pulumi.set(self, "profiles", value)
@pulumi.input_type
class GetLocationGroupsDynamicLocationGroupCriteriaCityArgs:
def __init__(__self__, *,
match_string: Optional[str] = None,
match_type: Optional[str] = None):
"""
:param str match_string: (String) String value to be matched or partially matched
:param str match_type: (String) Operator that performs match action
"""
if match_string is not None:
pulumi.set(__self__, "match_string", match_string)
if match_type is not None:
pulumi.set(__self__, "match_type", match_type)
@property
@pulumi.getter(name="matchString")
def match_string(self) -> Optional[str]:
"""
(String) String value to be matched or partially matched
"""
return pulumi.get(self, "match_string")
@match_string.setter
def match_string(self, value: Optional[str]):
pulumi.set(self, "match_string", value)
@property
@pulumi.getter(name="matchType")
def match_type(self) -> Optional[str]:
"""
(String) Operator that performs match action
"""
return pulumi.get(self, "match_type")
@match_type.setter
def match_type(self, value: Optional[str]):
pulumi.set(self, "match_type", value)
@pulumi.input_type
class GetLocationGroupsDynamicLocationGroupCriteriaManagedByArgs:
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the location group
:param str name: Location group name
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Mapping[str, str]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the location group
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: int):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def name(self) -> str:
"""
Location group name
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: str):
pulumi.set(self, "name", value)
@pulumi.input_type
class GetLocationGroupsDynamicLocationGroupCriteriaNameArgs:
def __init__(__self__, *,
match_string: Optional[str] = None,
match_type: Optional[str] = None):
"""
:param str match_string: (String) String value to be matched or partially matched
:param str match_type: (String) Operator that performs match action
"""
if match_string is not None:
pulumi.set(__self__, "match_string", match_string)
if match_type is not None:
pulumi.set(__self__, "match_type", match_type)
@property
@pulumi.getter(name="matchString")
def match_string(self) -> Optional[str]:
"""
(String) String value to be matched or partially matched
"""
return pulumi.get(self, "match_string")
@match_string.setter
def match_string(self, value: Optional[str]):
pulumi.set(self, "match_string", value)
@property
@pulumi.getter(name="matchType")
def match_type(self) -> Optional[str]:
"""
(String) Operator that performs match action
"""
return pulumi.get(self, "match_type")
@match_type.setter
def match_type(self, value: Optional[str]):
pulumi.set(self, "match_type", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/locationgroups/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetLocationGroupsDynamicLocationGroupCriteriaResult',
'GetLocationGroupsDynamicLocationGroupCriteriaCityResult',
'GetLocationGroupsDynamicLocationGroupCriteriaManagedByResult',
'GetLocationGroupsDynamicLocationGroupCriteriaNameResult',
'GetLocationGroupsLastModUserResult',
'GetLocationGroupsLocationResult',
]
@pulumi.output_type
class GetLocationGroupsDynamicLocationGroupCriteriaResult(dict):
def __init__(__self__, *,
enable_bandwidth_control: bool,
enable_caution: bool,
enable_xff_forwarding: bool,
enforce_aup: bool,
enforce_authentication: bool,
enforce_firewall_control: bool,
managed_bies: Sequence['outputs.GetLocationGroupsDynamicLocationGroupCriteriaManagedByResult'],
cities: Optional[Sequence['outputs.GetLocationGroupsDynamicLocationGroupCriteriaCityResult']] = None,
countries: Optional[Sequence[str]] = None,
names: Optional[Sequence['outputs.GetLocationGroupsDynamicLocationGroupCriteriaNameResult']] = None,
profiles: Optional[Sequence[str]] = None):
"""
:param bool enable_bandwidth_control: (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
:param bool enable_caution: (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
:param bool enable_xff_forwarding: (Boolean) Enable `XFF` Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
:param bool enforce_aup: (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
:param bool enforce_authentication: (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
:param bool enforce_firewall_control: (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
:param Sequence['GetLocationGroupsDynamicLocationGroupCriteriaManagedByArgs'] managed_bies: (Block List)
:param Sequence['GetLocationGroupsDynamicLocationGroupCriteriaCityArgs'] cities: (Block List)
:param Sequence[str] countries: (List of String) One or more countries from a predefined set
:param Sequence['GetLocationGroupsDynamicLocationGroupCriteriaNameArgs'] names: Location group name
:param Sequence[str] profiles: (List of String) One or more location profiles from a predefined set
"""
pulumi.set(__self__, "enable_bandwidth_control", enable_bandwidth_control)
pulumi.set(__self__, "enable_caution", enable_caution)
pulumi.set(__self__, "enable_xff_forwarding", enable_xff_forwarding)
pulumi.set(__self__, "enforce_aup", enforce_aup)
pulumi.set(__self__, "enforce_authentication", enforce_authentication)
pulumi.set(__self__, "enforce_firewall_control", enforce_firewall_control)
pulumi.set(__self__, "managed_bies", managed_bies)
if cities is not None:
pulumi.set(__self__, "cities", cities)
if countries is not None:
pulumi.set(__self__, "countries", countries)
if names is not None:
pulumi.set(__self__, "names", names)
if profiles is not None:
pulumi.set(__self__, "profiles", profiles)
@property
@pulumi.getter(name="enableBandwidthControl")
def enable_bandwidth_control(self) -> bool:
"""
(Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
"""
return pulumi.get(self, "enable_bandwidth_control")
@property
@pulumi.getter(name="enableCaution")
def enable_caution(self) -> bool:
"""
(Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
"""
return pulumi.get(self, "enable_caution")
@property
@pulumi.getter(name="enableXffForwarding")
def enable_xff_forwarding(self) -> bool:
"""
(Boolean) Enable `XFF` Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
"""
return pulumi.get(self, "enable_xff_forwarding")
@property
@pulumi.getter(name="enforceAup")
def enforce_aup(self) -> bool:
"""
(Boolean) Enable AUP. When set to true, AUP is enabled for the location.
"""
return pulumi.get(self, "enforce_aup")
@property
@pulumi.getter(name="enforceAuthentication")
def enforce_authentication(self) -> bool:
"""
(Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
"""
return pulumi.get(self, "enforce_authentication")
@property
@pulumi.getter(name="enforceFirewallControl")
def enforce_firewall_control(self) -> bool:
"""
(Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
"""
return pulumi.get(self, "enforce_firewall_control")
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Sequence['outputs.GetLocationGroupsDynamicLocationGroupCriteriaManagedByResult']:
"""
(Block List)
"""
return pulumi.get(self, "managed_bies")
@property
@pulumi.getter
def cities(self) -> Optional[Sequence['outputs.GetLocationGroupsDynamicLocationGroupCriteriaCityResult']]:
"""
(Block List)
"""
return pulumi.get(self, "cities")
@property
@pulumi.getter
def countries(self) -> Optional[Sequence[str]]:
"""
(List of String) One or more countries from a predefined set
"""
return pulumi.get(self, "countries")
@property
@pulumi.getter
def names(self) -> Optional[Sequence['outputs.GetLocationGroupsDynamicLocationGroupCriteriaNameResult']]:
"""
Location group name
"""
return pulumi.get(self, "names")
@property
@pulumi.getter
def profiles(self) -> Optional[Sequence[str]]:
"""
(List of String) One or more location profiles from a predefined set
"""
return pulumi.get(self, "profiles")
@pulumi.output_type
class GetLocationGroupsDynamicLocationGroupCriteriaCityResult(dict):
def __init__(__self__, *,
match_string: Optional[str] = None,
match_type: Optional[str] = None):
"""
:param str match_string: (String) String value to be matched or partially matched
:param str match_type: (String) Operator that performs match action
"""
if match_string is not None:
pulumi.set(__self__, "match_string", match_string)
if match_type is not None:
pulumi.set(__self__, "match_type", match_type)
@property
@pulumi.getter(name="matchString")
def match_string(self) -> Optional[str]:
"""
(String) String value to be matched or partially matched
"""
return pulumi.get(self, "match_string")
@property
@pulumi.getter(name="matchType")
def match_type(self) -> Optional[str]:
"""
(String) Operator that performs match action
"""
return pulumi.get(self, "match_type")
@pulumi.output_type
class GetLocationGroupsDynamicLocationGroupCriteriaManagedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the location group
:param str name: Location group name
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the location group
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Location group name
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetLocationGroupsDynamicLocationGroupCriteriaNameResult(dict):
def __init__(__self__, *,
match_string: Optional[str] = None,
match_type: Optional[str] = None):
"""
:param str match_string: (String) String value to be matched or partially matched
:param str match_type: (String) Operator that performs match action
"""
if match_string is not None:
pulumi.set(__self__, "match_string", match_string)
if match_type is not None:
pulumi.set(__self__, "match_type", match_type)
@property
@pulumi.getter(name="matchString")
def match_string(self) -> Optional[str]:
"""
(String) String value to be matched or partially matched
"""
return pulumi.get(self, "match_string")
@property
@pulumi.getter(name="matchType")
def match_type(self) -> Optional[str]:
"""
(String) Operator that performs match action
"""
return pulumi.get(self, "match_type")
@pulumi.output_type
class GetLocationGroupsLastModUserResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the location group
:param str name: Location group name
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the location group
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Location group name
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetLocationGroupsLocationResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: Unique identifier for the location group
:param str name: Location group name
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
Unique identifier for the location group
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Location group name
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/locationgroups/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = [
'GetLocationGroupsResult',
'AwaitableGetLocationGroupsResult',
'get_location_groups',
'get_location_groups_output',
]
@pulumi.output_type
class GetLocationGroupsResult:
"""
A collection of values returned by getLocationGroups.
"""
def __init__(__self__, comments=None, deleted=None, dynamic_location_group_criterias=None, group_type=None, id=None, last_mod_time=None, last_mod_users=None, locations=None, name=None, predefined=None):
if comments and not isinstance(comments, str):
raise TypeError("Expected argument 'comments' to be a str")
pulumi.set(__self__, "comments", comments)
if deleted and not isinstance(deleted, bool):
raise TypeError("Expected argument 'deleted' to be a bool")
pulumi.set(__self__, "deleted", deleted)
if dynamic_location_group_criterias and not isinstance(dynamic_location_group_criterias, list):
raise TypeError("Expected argument 'dynamic_location_group_criterias' to be a list")
pulumi.set(__self__, "dynamic_location_group_criterias", dynamic_location_group_criterias)
if group_type and not isinstance(group_type, str):
raise TypeError("Expected argument 'group_type' to be a str")
pulumi.set(__self__, "group_type", group_type)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if last_mod_time and not isinstance(last_mod_time, int):
raise TypeError("Expected argument 'last_mod_time' to be a int")
pulumi.set(__self__, "last_mod_time", last_mod_time)
if last_mod_users and not isinstance(last_mod_users, list):
raise TypeError("Expected argument 'last_mod_users' to be a list")
pulumi.set(__self__, "last_mod_users", last_mod_users)
if locations and not isinstance(locations, list):
raise TypeError("Expected argument 'locations' to be a list")
pulumi.set(__self__, "locations", locations)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if predefined and not isinstance(predefined, bool):
raise TypeError("Expected argument 'predefined' to be a bool")
pulumi.set(__self__, "predefined", predefined)
@property
@pulumi.getter
def comments(self) -> str:
"""
(List of Object)
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def deleted(self) -> bool:
"""
(Boolean) Indicates the location group was deleted
"""
return pulumi.get(self, "deleted")
@property
@pulumi.getter(name="dynamicLocationGroupCriterias")
def dynamic_location_group_criterias(self) -> Optional[Sequence['outputs.GetLocationGroupsDynamicLocationGroupCriteriaResult']]:
"""
(Block Set) Dynamic location group information.
"""
return pulumi.get(self, "dynamic_location_group_criterias")
@property
@pulumi.getter(name="groupType")
def group_type(self) -> str:
"""
(String) The location group's type (i.e., Static or Dynamic)
"""
return pulumi.get(self, "group_type")
@property
@pulumi.getter
def id(self) -> int:
"""
(Number) Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="lastModTime")
def last_mod_time(self) -> int:
"""
(List of Object) Automatically populated with the current time, after a successful POST or PUT request.
"""
return pulumi.get(self, "last_mod_time")
@property
@pulumi.getter(name="lastModUsers")
def last_mod_users(self) -> Sequence['outputs.GetLocationGroupsLastModUserResult']:
"""
(List of Object)
"""
return pulumi.get(self, "last_mod_users")
@property
@pulumi.getter
def locations(self) -> Sequence['outputs.GetLocationGroupsLocationResult']:
"""
(List of Object) The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
"""
return pulumi.get(self, "locations")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def predefined(self) -> bool:
"""
(Boolean)
"""
return pulumi.get(self, "predefined")
class AwaitableGetLocationGroupsResult(GetLocationGroupsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetLocationGroupsResult(
comments=self.comments,
deleted=self.deleted,
dynamic_location_group_criterias=self.dynamic_location_group_criterias,
group_type=self.group_type,
id=self.id,
last_mod_time=self.last_mod_time,
last_mod_users=self.last_mod_users,
locations=self.locations,
name=self.name,
predefined=self.predefined)
def get_location_groups(dynamic_location_group_criterias: Optional[Sequence[pulumi.InputType['GetLocationGroupsDynamicLocationGroupCriteriaArgs']]] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetLocationGroupsResult:
"""
Use the **zia_location_groups** data source to get information about a location group option available in the Zscaler Internet Access.
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Corporate User Traffic Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Guest Wifi Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="IoT Traffic Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Server Traffic Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Server Traffic Group")
```
:param Sequence[pulumi.InputType['GetLocationGroupsDynamicLocationGroupCriteriaArgs']] dynamic_location_group_criterias: (Block Set) Dynamic location group information.
:param str name: Location group name
"""
__args__ = dict()
__args__['dynamicLocationGroupCriterias'] = dynamic_location_group_criterias
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:LocationGroups/getLocationGroups:getLocationGroups', __args__, opts=opts, typ=GetLocationGroupsResult).value
return AwaitableGetLocationGroupsResult(
comments=__ret__.comments,
deleted=__ret__.deleted,
dynamic_location_group_criterias=__ret__.dynamic_location_group_criterias,
group_type=__ret__.group_type,
id=__ret__.id,
last_mod_time=__ret__.last_mod_time,
last_mod_users=__ret__.last_mod_users,
locations=__ret__.locations,
name=__ret__.name,
predefined=__ret__.predefined)
@_utilities.lift_output_func(get_location_groups)
def get_location_groups_output(dynamic_location_group_criterias: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetLocationGroupsDynamicLocationGroupCriteriaArgs']]]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetLocationGroupsResult]:
"""
Use the **zia_location_groups** data source to get information about a location group option available in the Zscaler Internet Access.
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Corporate User Traffic Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Guest Wifi Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="IoT Traffic Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Server Traffic Group")
```
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationGroups.get_location_groups(name="Server Traffic Group")
```
:param Sequence[pulumi.InputType['GetLocationGroupsDynamicLocationGroupCriteriaArgs']] dynamic_location_group_criterias: (Block Set) Dynamic location group information.
:param str name: Location group name
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/locationgroups/get_location_groups.py | get_location_groups.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'URLCategoriesScopeArgs',
'URLCategoriesScopeScopeEntitiesArgs',
'URLCategoriesScopeScopeGroupMemberEntitiesArgs',
'URLCategoriesUrlKeywordCountsArgs',
]
@pulumi.input_type
class URLCategoriesScopeArgs:
def __init__(__self__, *,
scope_entities: Optional[pulumi.Input['URLCategoriesScopeScopeEntitiesArgs']] = None,
scope_group_member_entities: Optional[pulumi.Input['URLCategoriesScopeScopeGroupMemberEntitiesArgs']] = None,
type: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input['URLCategoriesScopeScopeGroupMemberEntitiesArgs'] scope_group_member_entities: Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
:param pulumi.Input[str] type: Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
"""
if scope_entities is not None:
pulumi.set(__self__, "scope_entities", scope_entities)
if scope_group_member_entities is not None:
pulumi.set(__self__, "scope_group_member_entities", scope_group_member_entities)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter(name="scopeEntities")
def scope_entities(self) -> Optional[pulumi.Input['URLCategoriesScopeScopeEntitiesArgs']]:
return pulumi.get(self, "scope_entities")
@scope_entities.setter
def scope_entities(self, value: Optional[pulumi.Input['URLCategoriesScopeScopeEntitiesArgs']]):
pulumi.set(self, "scope_entities", value)
@property
@pulumi.getter(name="scopeGroupMemberEntities")
def scope_group_member_entities(self) -> Optional[pulumi.Input['URLCategoriesScopeScopeGroupMemberEntitiesArgs']]:
"""
Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
"""
return pulumi.get(self, "scope_group_member_entities")
@scope_group_member_entities.setter
def scope_group_member_entities(self, value: Optional[pulumi.Input['URLCategoriesScopeScopeGroupMemberEntitiesArgs']]):
pulumi.set(self, "scope_group_member_entities", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
@pulumi.input_type
class URLCategoriesScopeScopeEntitiesArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLCategoriesScopeScopeGroupMemberEntitiesArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLCategoriesUrlKeywordCountsArgs:
def __init__(__self__, *,
retain_parent_keyword_count: Optional[pulumi.Input[int]] = None,
retain_parent_url_count: Optional[pulumi.Input[int]] = None,
total_keyword_count: Optional[pulumi.Input[int]] = None,
total_url_count: Optional[pulumi.Input[int]] = None):
"""
:param pulumi.Input[int] retain_parent_keyword_count: Count of total keywords with retain parent category.
:param pulumi.Input[int] retain_parent_url_count: Count of URLs with retain parent category.
:param pulumi.Input[int] total_keyword_count: Total keyword count for the category.
:param pulumi.Input[int] total_url_count: Custom URL count for the category.
"""
if retain_parent_keyword_count is not None:
pulumi.set(__self__, "retain_parent_keyword_count", retain_parent_keyword_count)
if retain_parent_url_count is not None:
pulumi.set(__self__, "retain_parent_url_count", retain_parent_url_count)
if total_keyword_count is not None:
pulumi.set(__self__, "total_keyword_count", total_keyword_count)
if total_url_count is not None:
pulumi.set(__self__, "total_url_count", total_url_count)
@property
@pulumi.getter(name="retainParentKeywordCount")
def retain_parent_keyword_count(self) -> Optional[pulumi.Input[int]]:
"""
Count of total keywords with retain parent category.
"""
return pulumi.get(self, "retain_parent_keyword_count")
@retain_parent_keyword_count.setter
def retain_parent_keyword_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "retain_parent_keyword_count", value)
@property
@pulumi.getter(name="retainParentUrlCount")
def retain_parent_url_count(self) -> Optional[pulumi.Input[int]]:
"""
Count of URLs with retain parent category.
"""
return pulumi.get(self, "retain_parent_url_count")
@retain_parent_url_count.setter
def retain_parent_url_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "retain_parent_url_count", value)
@property
@pulumi.getter(name="totalKeywordCount")
def total_keyword_count(self) -> Optional[pulumi.Input[int]]:
"""
Total keyword count for the category.
"""
return pulumi.get(self, "total_keyword_count")
@total_keyword_count.setter
def total_keyword_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "total_keyword_count", value)
@property
@pulumi.getter(name="totalUrlCount")
def total_url_count(self) -> Optional[pulumi.Input[int]]:
"""
Custom URL count for the category.
"""
return pulumi.get(self, "total_url_count")
@total_url_count.setter
def total_url_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "total_url_count", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlcategory/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'URLCategoriesScope',
'URLCategoriesScopeScopeEntities',
'URLCategoriesScopeScopeGroupMemberEntities',
'URLCategoriesUrlKeywordCounts',
'GetURLCategoriesScopeResult',
'GetURLCategoriesScopeScopeEntityResult',
'GetURLCategoriesScopeScopeGroupMemberEntityResult',
'GetURLCategoriesUrlKeywordCountResult',
]
@pulumi.output_type
class URLCategoriesScope(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "scopeEntities":
suggest = "scope_entities"
elif key == "scopeGroupMemberEntities":
suggest = "scope_group_member_entities"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in URLCategoriesScope. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
URLCategoriesScope.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
URLCategoriesScope.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
scope_entities: Optional['outputs.URLCategoriesScopeScopeEntities'] = None,
scope_group_member_entities: Optional['outputs.URLCategoriesScopeScopeGroupMemberEntities'] = None,
type: Optional[str] = None):
"""
:param 'URLCategoriesScopeScopeGroupMemberEntitiesArgs' scope_group_member_entities: Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
:param str type: Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
"""
if scope_entities is not None:
pulumi.set(__self__, "scope_entities", scope_entities)
if scope_group_member_entities is not None:
pulumi.set(__self__, "scope_group_member_entities", scope_group_member_entities)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter(name="scopeEntities")
def scope_entities(self) -> Optional['outputs.URLCategoriesScopeScopeEntities']:
return pulumi.get(self, "scope_entities")
@property
@pulumi.getter(name="scopeGroupMemberEntities")
def scope_group_member_entities(self) -> Optional['outputs.URLCategoriesScopeScopeGroupMemberEntities']:
"""
Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
"""
return pulumi.get(self, "scope_group_member_entities")
@property
@pulumi.getter
def type(self) -> Optional[str]:
"""
Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
"""
return pulumi.get(self, "type")
@pulumi.output_type
class URLCategoriesScopeScopeEntities(dict):
def __init__(__self__, *,
ids: Sequence[int]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
return pulumi.get(self, "ids")
@pulumi.output_type
class URLCategoriesScopeScopeGroupMemberEntities(dict):
def __init__(__self__, *,
ids: Sequence[int]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
return pulumi.get(self, "ids")
@pulumi.output_type
class URLCategoriesUrlKeywordCounts(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "retainParentKeywordCount":
suggest = "retain_parent_keyword_count"
elif key == "retainParentUrlCount":
suggest = "retain_parent_url_count"
elif key == "totalKeywordCount":
suggest = "total_keyword_count"
elif key == "totalUrlCount":
suggest = "total_url_count"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in URLCategoriesUrlKeywordCounts. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
URLCategoriesUrlKeywordCounts.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
URLCategoriesUrlKeywordCounts.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
retain_parent_keyword_count: Optional[int] = None,
retain_parent_url_count: Optional[int] = None,
total_keyword_count: Optional[int] = None,
total_url_count: Optional[int] = None):
"""
:param int retain_parent_keyword_count: Count of total keywords with retain parent category.
:param int retain_parent_url_count: Count of URLs with retain parent category.
:param int total_keyword_count: Total keyword count for the category.
:param int total_url_count: Custom URL count for the category.
"""
if retain_parent_keyword_count is not None:
pulumi.set(__self__, "retain_parent_keyword_count", retain_parent_keyword_count)
if retain_parent_url_count is not None:
pulumi.set(__self__, "retain_parent_url_count", retain_parent_url_count)
if total_keyword_count is not None:
pulumi.set(__self__, "total_keyword_count", total_keyword_count)
if total_url_count is not None:
pulumi.set(__self__, "total_url_count", total_url_count)
@property
@pulumi.getter(name="retainParentKeywordCount")
def retain_parent_keyword_count(self) -> Optional[int]:
"""
Count of total keywords with retain parent category.
"""
return pulumi.get(self, "retain_parent_keyword_count")
@property
@pulumi.getter(name="retainParentUrlCount")
def retain_parent_url_count(self) -> Optional[int]:
"""
Count of URLs with retain parent category.
"""
return pulumi.get(self, "retain_parent_url_count")
@property
@pulumi.getter(name="totalKeywordCount")
def total_keyword_count(self) -> Optional[int]:
"""
Total keyword count for the category.
"""
return pulumi.get(self, "total_keyword_count")
@property
@pulumi.getter(name="totalUrlCount")
def total_url_count(self) -> Optional[int]:
"""
Custom URL count for the category.
"""
return pulumi.get(self, "total_url_count")
@pulumi.output_type
class GetURLCategoriesScopeResult(dict):
def __init__(__self__, *,
scope_entities: Sequence['outputs.GetURLCategoriesScopeScopeEntityResult'],
scope_group_member_entities: Sequence['outputs.GetURLCategoriesScopeScopeGroupMemberEntityResult'],
type: str):
"""
:param Sequence['GetURLCategoriesScopeScopeEntityArgs'] scope_entities: (List of Object)
:param Sequence['GetURLCategoriesScopeScopeGroupMemberEntityArgs'] scope_group_member_entities: (List of Object) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
:param str type: (String) The admin scope type. The attribute name is subject to change. `ORGANIZATION`, `DEPARTMENT`, `LOCATION`, `LOCATION_GROUP`
"""
pulumi.set(__self__, "scope_entities", scope_entities)
pulumi.set(__self__, "scope_group_member_entities", scope_group_member_entities)
pulumi.set(__self__, "type", type)
@property
@pulumi.getter(name="scopeEntities")
def scope_entities(self) -> Sequence['outputs.GetURLCategoriesScopeScopeEntityResult']:
"""
(List of Object)
"""
return pulumi.get(self, "scope_entities")
@property
@pulumi.getter(name="scopeGroupMemberEntities")
def scope_group_member_entities(self) -> Sequence['outputs.GetURLCategoriesScopeScopeGroupMemberEntityResult']:
"""
(List of Object) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group. The attribute name is subject to change.
"""
return pulumi.get(self, "scope_group_member_entities")
@property
@pulumi.getter
def type(self) -> str:
"""
(String) The admin scope type. The attribute name is subject to change. `ORGANIZATION`, `DEPARTMENT`, `LOCATION`, `LOCATION_GROUP`
"""
return pulumi.get(self, "type")
@pulumi.output_type
class GetURLCategoriesScopeScopeEntityResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL category
:param str name: (String) The configured name of the entity
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL category
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLCategoriesScopeScopeGroupMemberEntityResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL category
:param str name: (String) The configured name of the entity
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL category
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLCategoriesUrlKeywordCountResult(dict):
def __init__(__self__, *,
retain_parent_keyword_count: int,
retain_parent_url_count: int,
total_keyword_count: int,
total_url_count: int):
"""
:param int retain_parent_keyword_count: (Number) Count of total keywords with retain parent category.
:param int retain_parent_url_count: (Number) Count of URLs with retain parent category.
:param int total_keyword_count: (Number) Total keyword count for the category.
:param int total_url_count: (Number) Custom URL count for the category.
"""
pulumi.set(__self__, "retain_parent_keyword_count", retain_parent_keyword_count)
pulumi.set(__self__, "retain_parent_url_count", retain_parent_url_count)
pulumi.set(__self__, "total_keyword_count", total_keyword_count)
pulumi.set(__self__, "total_url_count", total_url_count)
@property
@pulumi.getter(name="retainParentKeywordCount")
def retain_parent_keyword_count(self) -> int:
"""
(Number) Count of total keywords with retain parent category.
"""
return pulumi.get(self, "retain_parent_keyword_count")
@property
@pulumi.getter(name="retainParentUrlCount")
def retain_parent_url_count(self) -> int:
"""
(Number) Count of URLs with retain parent category.
"""
return pulumi.get(self, "retain_parent_url_count")
@property
@pulumi.getter(name="totalKeywordCount")
def total_keyword_count(self) -> int:
"""
(Number) Total keyword count for the category.
"""
return pulumi.get(self, "total_keyword_count")
@property
@pulumi.getter(name="totalUrlCount")
def total_url_count(self) -> int:
"""
(Number) Custom URL count for the category.
"""
return pulumi.get(self, "total_url_count") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlcategory/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['URLCategoriesArgs', 'URLCategories']
@pulumi.input_type
class URLCategoriesArgs:
def __init__(__self__, *,
configured_name: Optional[pulumi.Input[str]] = None,
custom_category: Optional[pulumi.Input[bool]] = None,
custom_ip_ranges_count: Optional[pulumi.Input[int]] = None,
custom_urls_count: Optional[pulumi.Input[int]] = None,
db_categorized_urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
editable: Optional[pulumi.Input[bool]] = None,
ip_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_category_count: Optional[pulumi.Input[int]] = None,
keywords: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
keywords_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
scopes: Optional[pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]]] = None,
super_category: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
url_keyword_counts: Optional[pulumi.Input['URLCategoriesUrlKeywordCountsArgs']] = None,
urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
urls_retaining_parent_category_count: Optional[pulumi.Input[int]] = None):
"""
The set of arguments for constructing a URLCategories resource.
:param pulumi.Input[str] configured_name: Name of the URL category. This is only required for custom URL categories.
:param pulumi.Input[bool] custom_category: Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
:param pulumi.Input[int] custom_ip_ranges_count: The number of custom IP address ranges associated to the URL category.
:param pulumi.Input[int] custom_urls_count: The number of custom URLs associated to the URL category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] db_categorized_urls: URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
:param pulumi.Input[str] description: Description of the category.
:param pulumi.Input[bool] editable: Value is set to false for custom URL category when due to scope user does not have edit permission
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges: Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges_retaining_parent_categories: The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[int] ip_ranges_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] keywords: Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]] scopes: Scope of the custom categories.
:param pulumi.Input[str] super_category: Super Category of the URL category. This field is required when creating custom URL categories.
:param pulumi.Input[str] type: Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
:param pulumi.Input['URLCategoriesUrlKeywordCountsArgs'] url_keyword_counts: URL and keyword counts for the category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] urls: Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[int] urls_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
if configured_name is not None:
pulumi.set(__self__, "configured_name", configured_name)
if custom_category is not None:
pulumi.set(__self__, "custom_category", custom_category)
if custom_ip_ranges_count is not None:
pulumi.set(__self__, "custom_ip_ranges_count", custom_ip_ranges_count)
if custom_urls_count is not None:
pulumi.set(__self__, "custom_urls_count", custom_urls_count)
if db_categorized_urls is not None:
pulumi.set(__self__, "db_categorized_urls", db_categorized_urls)
if description is not None:
pulumi.set(__self__, "description", description)
if editable is not None:
pulumi.set(__self__, "editable", editable)
if ip_ranges is not None:
pulumi.set(__self__, "ip_ranges", ip_ranges)
if ip_ranges_retaining_parent_categories is not None:
pulumi.set(__self__, "ip_ranges_retaining_parent_categories", ip_ranges_retaining_parent_categories)
if ip_ranges_retaining_parent_category_count is not None:
pulumi.set(__self__, "ip_ranges_retaining_parent_category_count", ip_ranges_retaining_parent_category_count)
if keywords is not None:
pulumi.set(__self__, "keywords", keywords)
if keywords_retaining_parent_categories is not None:
pulumi.set(__self__, "keywords_retaining_parent_categories", keywords_retaining_parent_categories)
if scopes is not None:
pulumi.set(__self__, "scopes", scopes)
if super_category is not None:
pulumi.set(__self__, "super_category", super_category)
if type is not None:
pulumi.set(__self__, "type", type)
if url_keyword_counts is not None:
pulumi.set(__self__, "url_keyword_counts", url_keyword_counts)
if urls is not None:
pulumi.set(__self__, "urls", urls)
if urls_retaining_parent_category_count is not None:
pulumi.set(__self__, "urls_retaining_parent_category_count", urls_retaining_parent_category_count)
@property
@pulumi.getter(name="configuredName")
def configured_name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the URL category. This is only required for custom URL categories.
"""
return pulumi.get(self, "configured_name")
@configured_name.setter
def configured_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "configured_name", value)
@property
@pulumi.getter(name="customCategory")
def custom_category(self) -> Optional[pulumi.Input[bool]]:
"""
Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
"""
return pulumi.get(self, "custom_category")
@custom_category.setter
def custom_category(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "custom_category", value)
@property
@pulumi.getter(name="customIpRangesCount")
def custom_ip_ranges_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom IP address ranges associated to the URL category.
"""
return pulumi.get(self, "custom_ip_ranges_count")
@custom_ip_ranges_count.setter
def custom_ip_ranges_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "custom_ip_ranges_count", value)
@property
@pulumi.getter(name="customUrlsCount")
def custom_urls_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom URLs associated to the URL category.
"""
return pulumi.get(self, "custom_urls_count")
@custom_urls_count.setter
def custom_urls_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "custom_urls_count", value)
@property
@pulumi.getter(name="dbCategorizedUrls")
def db_categorized_urls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
"""
return pulumi.get(self, "db_categorized_urls")
@db_categorized_urls.setter
def db_categorized_urls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "db_categorized_urls", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the category.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def editable(self) -> Optional[pulumi.Input[bool]]:
"""
Value is set to false for custom URL category when due to scope user does not have edit permission
"""
return pulumi.get(self, "editable")
@editable.setter
def editable(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "editable", value)
@property
@pulumi.getter(name="ipRanges")
def ip_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
"""
return pulumi.get(self, "ip_ranges")
@ip_ranges.setter
def ip_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_ranges", value)
@property
@pulumi.getter(name="ipRangesRetainingParentCategories")
def ip_ranges_retaining_parent_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
"""
return pulumi.get(self, "ip_ranges_retaining_parent_categories")
@ip_ranges_retaining_parent_categories.setter
def ip_ranges_retaining_parent_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_ranges_retaining_parent_categories", value)
@property
@pulumi.getter(name="ipRangesRetainingParentCategoryCount")
def ip_ranges_retaining_parent_category_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "ip_ranges_retaining_parent_category_count")
@ip_ranges_retaining_parent_category_count.setter
def ip_ranges_retaining_parent_category_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "ip_ranges_retaining_parent_category_count", value)
@property
@pulumi.getter
def keywords(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "keywords")
@keywords.setter
def keywords(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "keywords", value)
@property
@pulumi.getter(name="keywordsRetainingParentCategories")
def keywords_retaining_parent_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "keywords_retaining_parent_categories")
@keywords_retaining_parent_categories.setter
def keywords_retaining_parent_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "keywords_retaining_parent_categories", value)
@property
@pulumi.getter
def scopes(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]]]:
"""
Scope of the custom categories.
"""
return pulumi.get(self, "scopes")
@scopes.setter
def scopes(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]]]):
pulumi.set(self, "scopes", value)
@property
@pulumi.getter(name="superCategory")
def super_category(self) -> Optional[pulumi.Input[str]]:
"""
Super Category of the URL category. This field is required when creating custom URL categories.
"""
return pulumi.get(self, "super_category")
@super_category.setter
def super_category(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "super_category", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
@property
@pulumi.getter(name="urlKeywordCounts")
def url_keyword_counts(self) -> Optional[pulumi.Input['URLCategoriesUrlKeywordCountsArgs']]:
"""
URL and keyword counts for the category.
"""
return pulumi.get(self, "url_keyword_counts")
@url_keyword_counts.setter
def url_keyword_counts(self, value: Optional[pulumi.Input['URLCategoriesUrlKeywordCountsArgs']]):
pulumi.set(self, "url_keyword_counts", value)
@property
@pulumi.getter
def urls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "urls")
@urls.setter
def urls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "urls", value)
@property
@pulumi.getter(name="urlsRetainingParentCategoryCount")
def urls_retaining_parent_category_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "urls_retaining_parent_category_count")
@urls_retaining_parent_category_count.setter
def urls_retaining_parent_category_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "urls_retaining_parent_category_count", value)
@pulumi.input_type
class _URLCategoriesState:
def __init__(__self__, *,
configured_name: Optional[pulumi.Input[str]] = None,
custom_category: Optional[pulumi.Input[bool]] = None,
custom_ip_ranges_count: Optional[pulumi.Input[int]] = None,
custom_urls_count: Optional[pulumi.Input[int]] = None,
db_categorized_urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
editable: Optional[pulumi.Input[bool]] = None,
ip_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_category_count: Optional[pulumi.Input[int]] = None,
keywords: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
keywords_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
scopes: Optional[pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]]] = None,
super_category: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
url_category_id: Optional[pulumi.Input[str]] = None,
url_keyword_counts: Optional[pulumi.Input['URLCategoriesUrlKeywordCountsArgs']] = None,
urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
urls_retaining_parent_category_count: Optional[pulumi.Input[int]] = None):
"""
Input properties used for looking up and filtering URLCategories resources.
:param pulumi.Input[str] configured_name: Name of the URL category. This is only required for custom URL categories.
:param pulumi.Input[bool] custom_category: Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
:param pulumi.Input[int] custom_ip_ranges_count: The number of custom IP address ranges associated to the URL category.
:param pulumi.Input[int] custom_urls_count: The number of custom URLs associated to the URL category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] db_categorized_urls: URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
:param pulumi.Input[str] description: Description of the category.
:param pulumi.Input[bool] editable: Value is set to false for custom URL category when due to scope user does not have edit permission
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges: Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges_retaining_parent_categories: The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[int] ip_ranges_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] keywords: Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]] scopes: Scope of the custom categories.
:param pulumi.Input[str] super_category: Super Category of the URL category. This field is required when creating custom URL categories.
:param pulumi.Input[str] type: Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
:param pulumi.Input['URLCategoriesUrlKeywordCountsArgs'] url_keyword_counts: URL and keyword counts for the category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] urls: Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[int] urls_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
if configured_name is not None:
pulumi.set(__self__, "configured_name", configured_name)
if custom_category is not None:
pulumi.set(__self__, "custom_category", custom_category)
if custom_ip_ranges_count is not None:
pulumi.set(__self__, "custom_ip_ranges_count", custom_ip_ranges_count)
if custom_urls_count is not None:
pulumi.set(__self__, "custom_urls_count", custom_urls_count)
if db_categorized_urls is not None:
pulumi.set(__self__, "db_categorized_urls", db_categorized_urls)
if description is not None:
pulumi.set(__self__, "description", description)
if editable is not None:
pulumi.set(__self__, "editable", editable)
if ip_ranges is not None:
pulumi.set(__self__, "ip_ranges", ip_ranges)
if ip_ranges_retaining_parent_categories is not None:
pulumi.set(__self__, "ip_ranges_retaining_parent_categories", ip_ranges_retaining_parent_categories)
if ip_ranges_retaining_parent_category_count is not None:
pulumi.set(__self__, "ip_ranges_retaining_parent_category_count", ip_ranges_retaining_parent_category_count)
if keywords is not None:
pulumi.set(__self__, "keywords", keywords)
if keywords_retaining_parent_categories is not None:
pulumi.set(__self__, "keywords_retaining_parent_categories", keywords_retaining_parent_categories)
if scopes is not None:
pulumi.set(__self__, "scopes", scopes)
if super_category is not None:
pulumi.set(__self__, "super_category", super_category)
if type is not None:
pulumi.set(__self__, "type", type)
if url_category_id is not None:
pulumi.set(__self__, "url_category_id", url_category_id)
if url_keyword_counts is not None:
pulumi.set(__self__, "url_keyword_counts", url_keyword_counts)
if urls is not None:
pulumi.set(__self__, "urls", urls)
if urls_retaining_parent_category_count is not None:
pulumi.set(__self__, "urls_retaining_parent_category_count", urls_retaining_parent_category_count)
@property
@pulumi.getter(name="configuredName")
def configured_name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the URL category. This is only required for custom URL categories.
"""
return pulumi.get(self, "configured_name")
@configured_name.setter
def configured_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "configured_name", value)
@property
@pulumi.getter(name="customCategory")
def custom_category(self) -> Optional[pulumi.Input[bool]]:
"""
Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
"""
return pulumi.get(self, "custom_category")
@custom_category.setter
def custom_category(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "custom_category", value)
@property
@pulumi.getter(name="customIpRangesCount")
def custom_ip_ranges_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom IP address ranges associated to the URL category.
"""
return pulumi.get(self, "custom_ip_ranges_count")
@custom_ip_ranges_count.setter
def custom_ip_ranges_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "custom_ip_ranges_count", value)
@property
@pulumi.getter(name="customUrlsCount")
def custom_urls_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom URLs associated to the URL category.
"""
return pulumi.get(self, "custom_urls_count")
@custom_urls_count.setter
def custom_urls_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "custom_urls_count", value)
@property
@pulumi.getter(name="dbCategorizedUrls")
def db_categorized_urls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
"""
return pulumi.get(self, "db_categorized_urls")
@db_categorized_urls.setter
def db_categorized_urls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "db_categorized_urls", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the category.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def editable(self) -> Optional[pulumi.Input[bool]]:
"""
Value is set to false for custom URL category when due to scope user does not have edit permission
"""
return pulumi.get(self, "editable")
@editable.setter
def editable(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "editable", value)
@property
@pulumi.getter(name="ipRanges")
def ip_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
"""
return pulumi.get(self, "ip_ranges")
@ip_ranges.setter
def ip_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_ranges", value)
@property
@pulumi.getter(name="ipRangesRetainingParentCategories")
def ip_ranges_retaining_parent_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
"""
return pulumi.get(self, "ip_ranges_retaining_parent_categories")
@ip_ranges_retaining_parent_categories.setter
def ip_ranges_retaining_parent_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_ranges_retaining_parent_categories", value)
@property
@pulumi.getter(name="ipRangesRetainingParentCategoryCount")
def ip_ranges_retaining_parent_category_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "ip_ranges_retaining_parent_category_count")
@ip_ranges_retaining_parent_category_count.setter
def ip_ranges_retaining_parent_category_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "ip_ranges_retaining_parent_category_count", value)
@property
@pulumi.getter
def keywords(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "keywords")
@keywords.setter
def keywords(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "keywords", value)
@property
@pulumi.getter(name="keywordsRetainingParentCategories")
def keywords_retaining_parent_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "keywords_retaining_parent_categories")
@keywords_retaining_parent_categories.setter
def keywords_retaining_parent_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "keywords_retaining_parent_categories", value)
@property
@pulumi.getter
def scopes(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]]]:
"""
Scope of the custom categories.
"""
return pulumi.get(self, "scopes")
@scopes.setter
def scopes(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['URLCategoriesScopeArgs']]]]):
pulumi.set(self, "scopes", value)
@property
@pulumi.getter(name="superCategory")
def super_category(self) -> Optional[pulumi.Input[str]]:
"""
Super Category of the URL category. This field is required when creating custom URL categories.
"""
return pulumi.get(self, "super_category")
@super_category.setter
def super_category(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "super_category", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
"""
Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
"""
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value)
@property
@pulumi.getter(name="urlCategoryId")
def url_category_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "url_category_id")
@url_category_id.setter
def url_category_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "url_category_id", value)
@property
@pulumi.getter(name="urlKeywordCounts")
def url_keyword_counts(self) -> Optional[pulumi.Input['URLCategoriesUrlKeywordCountsArgs']]:
"""
URL and keyword counts for the category.
"""
return pulumi.get(self, "url_keyword_counts")
@url_keyword_counts.setter
def url_keyword_counts(self, value: Optional[pulumi.Input['URLCategoriesUrlKeywordCountsArgs']]):
pulumi.set(self, "url_keyword_counts", value)
@property
@pulumi.getter
def urls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "urls")
@urls.setter
def urls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "urls", value)
@property
@pulumi.getter(name="urlsRetainingParentCategoryCount")
def urls_retaining_parent_category_count(self) -> Optional[pulumi.Input[int]]:
"""
The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "urls_retaining_parent_category_count")
@urls_retaining_parent_category_count.setter
def urls_retaining_parent_category_count(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "urls_retaining_parent_category_count", value)
class URLCategories(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
configured_name: Optional[pulumi.Input[str]] = None,
custom_category: Optional[pulumi.Input[bool]] = None,
custom_ip_ranges_count: Optional[pulumi.Input[int]] = None,
custom_urls_count: Optional[pulumi.Input[int]] = None,
db_categorized_urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
editable: Optional[pulumi.Input[bool]] = None,
ip_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_category_count: Optional[pulumi.Input[int]] = None,
keywords: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
keywords_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
scopes: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLCategoriesScopeArgs']]]]] = None,
super_category: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
url_keyword_counts: Optional[pulumi.Input[pulumi.InputType['URLCategoriesUrlKeywordCountsArgs']]] = None,
urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
urls_retaining_parent_category_count: Optional[pulumi.Input[int]] = None,
__props__=None):
"""
The **zia_url_categories** resource creates and manages a new custom URL category. If keywords are included within the request, they will be added to the new category.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
example = zia.url_category.URLCategories("example",
super_category="USER_DEFINED",
configured_name="MCAS Unsanctioned Apps",
description="MCAS Unsanctioned Apps",
keywords=["microsoft"],
custom_category=True,
type="URL_CATEGORY",
scopes=[zia.url_category.URLCategoriesScopeArgs(
type="LOCATION",
scope_entities=zia.url_category.URLCategoriesScopeScopeEntitiesArgs(
ids=[data["zpa_location_management"]["nyc_site"]["id"]],
),
scope_group_member_entities=zia.url_category.URLCategoriesScopeScopeGroupMemberEntitiesArgs(
ids=[data["zia_group_management"]["engineering"]["id"]],
),
)],
urls=[
".coupons.com",
".resource.alaskaair.net",
".techrepublic.com",
".dailymotion.com",
".osiriscomm.com",
".uefa.com",
".Logz.io",
".alexa.com",
".baidu.com",
".cnn.com",
".level3.com",
])
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] configured_name: Name of the URL category. This is only required for custom URL categories.
:param pulumi.Input[bool] custom_category: Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
:param pulumi.Input[int] custom_ip_ranges_count: The number of custom IP address ranges associated to the URL category.
:param pulumi.Input[int] custom_urls_count: The number of custom URLs associated to the URL category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] db_categorized_urls: URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
:param pulumi.Input[str] description: Description of the category.
:param pulumi.Input[bool] editable: Value is set to false for custom URL category when due to scope user does not have edit permission
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges: Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges_retaining_parent_categories: The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[int] ip_ranges_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] keywords: Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLCategoriesScopeArgs']]]] scopes: Scope of the custom categories.
:param pulumi.Input[str] super_category: Super Category of the URL category. This field is required when creating custom URL categories.
:param pulumi.Input[str] type: Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
:param pulumi.Input[pulumi.InputType['URLCategoriesUrlKeywordCountsArgs']] url_keyword_counts: URL and keyword counts for the category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] urls: Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[int] urls_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[URLCategoriesArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_url_categories** resource creates and manages a new custom URL category. If keywords are included within the request, they will be added to the new category.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
example = zia.url_category.URLCategories("example",
super_category="USER_DEFINED",
configured_name="MCAS Unsanctioned Apps",
description="MCAS Unsanctioned Apps",
keywords=["microsoft"],
custom_category=True,
type="URL_CATEGORY",
scopes=[zia.url_category.URLCategoriesScopeArgs(
type="LOCATION",
scope_entities=zia.url_category.URLCategoriesScopeScopeEntitiesArgs(
ids=[data["zpa_location_management"]["nyc_site"]["id"]],
),
scope_group_member_entities=zia.url_category.URLCategoriesScopeScopeGroupMemberEntitiesArgs(
ids=[data["zia_group_management"]["engineering"]["id"]],
),
)],
urls=[
".coupons.com",
".resource.alaskaair.net",
".techrepublic.com",
".dailymotion.com",
".osiriscomm.com",
".uefa.com",
".Logz.io",
".alexa.com",
".baidu.com",
".cnn.com",
".level3.com",
])
```
:param str resource_name: The name of the resource.
:param URLCategoriesArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(URLCategoriesArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
configured_name: Optional[pulumi.Input[str]] = None,
custom_category: Optional[pulumi.Input[bool]] = None,
custom_ip_ranges_count: Optional[pulumi.Input[int]] = None,
custom_urls_count: Optional[pulumi.Input[int]] = None,
db_categorized_urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
editable: Optional[pulumi.Input[bool]] = None,
ip_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_category_count: Optional[pulumi.Input[int]] = None,
keywords: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
keywords_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
scopes: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLCategoriesScopeArgs']]]]] = None,
super_category: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
url_keyword_counts: Optional[pulumi.Input[pulumi.InputType['URLCategoriesUrlKeywordCountsArgs']]] = None,
urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
urls_retaining_parent_category_count: Optional[pulumi.Input[int]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = URLCategoriesArgs.__new__(URLCategoriesArgs)
__props__.__dict__["configured_name"] = configured_name
__props__.__dict__["custom_category"] = custom_category
__props__.__dict__["custom_ip_ranges_count"] = custom_ip_ranges_count
__props__.__dict__["custom_urls_count"] = custom_urls_count
__props__.__dict__["db_categorized_urls"] = db_categorized_urls
__props__.__dict__["description"] = description
__props__.__dict__["editable"] = editable
__props__.__dict__["ip_ranges"] = ip_ranges
__props__.__dict__["ip_ranges_retaining_parent_categories"] = ip_ranges_retaining_parent_categories
__props__.__dict__["ip_ranges_retaining_parent_category_count"] = ip_ranges_retaining_parent_category_count
__props__.__dict__["keywords"] = keywords
__props__.__dict__["keywords_retaining_parent_categories"] = keywords_retaining_parent_categories
__props__.__dict__["scopes"] = scopes
__props__.__dict__["super_category"] = super_category
__props__.__dict__["type"] = type
__props__.__dict__["url_keyword_counts"] = url_keyword_counts
__props__.__dict__["urls"] = urls
__props__.__dict__["urls_retaining_parent_category_count"] = urls_retaining_parent_category_count
__props__.__dict__["url_category_id"] = None
super(URLCategories, __self__).__init__(
'zia:URLCategory/uRLCategories:URLCategories',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
configured_name: Optional[pulumi.Input[str]] = None,
custom_category: Optional[pulumi.Input[bool]] = None,
custom_ip_ranges_count: Optional[pulumi.Input[int]] = None,
custom_urls_count: Optional[pulumi.Input[int]] = None,
db_categorized_urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
description: Optional[pulumi.Input[str]] = None,
editable: Optional[pulumi.Input[bool]] = None,
ip_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ip_ranges_retaining_parent_category_count: Optional[pulumi.Input[int]] = None,
keywords: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
keywords_retaining_parent_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
scopes: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLCategoriesScopeArgs']]]]] = None,
super_category: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
url_category_id: Optional[pulumi.Input[str]] = None,
url_keyword_counts: Optional[pulumi.Input[pulumi.InputType['URLCategoriesUrlKeywordCountsArgs']]] = None,
urls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
urls_retaining_parent_category_count: Optional[pulumi.Input[int]] = None) -> 'URLCategories':
"""
Get an existing URLCategories resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] configured_name: Name of the URL category. This is only required for custom URL categories.
:param pulumi.Input[bool] custom_category: Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
:param pulumi.Input[int] custom_ip_ranges_count: The number of custom IP address ranges associated to the URL category.
:param pulumi.Input[int] custom_urls_count: The number of custom URLs associated to the URL category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] db_categorized_urls: URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
:param pulumi.Input[str] description: Description of the category.
:param pulumi.Input[bool] editable: Value is set to false for custom URL category when due to scope user does not have edit permission
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges: Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_ranges_retaining_parent_categories: The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
:param pulumi.Input[int] ip_ranges_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] keywords: Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLCategoriesScopeArgs']]]] scopes: Scope of the custom categories.
:param pulumi.Input[str] super_category: Super Category of the URL category. This field is required when creating custom URL categories.
:param pulumi.Input[str] type: Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
:param pulumi.Input[pulumi.InputType['URLCategoriesUrlKeywordCountsArgs']] url_keyword_counts: URL and keyword counts for the category.
:param pulumi.Input[Sequence[pulumi.Input[str]]] urls: Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
:param pulumi.Input[int] urls_retaining_parent_category_count: The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _URLCategoriesState.__new__(_URLCategoriesState)
__props__.__dict__["configured_name"] = configured_name
__props__.__dict__["custom_category"] = custom_category
__props__.__dict__["custom_ip_ranges_count"] = custom_ip_ranges_count
__props__.__dict__["custom_urls_count"] = custom_urls_count
__props__.__dict__["db_categorized_urls"] = db_categorized_urls
__props__.__dict__["description"] = description
__props__.__dict__["editable"] = editable
__props__.__dict__["ip_ranges"] = ip_ranges
__props__.__dict__["ip_ranges_retaining_parent_categories"] = ip_ranges_retaining_parent_categories
__props__.__dict__["ip_ranges_retaining_parent_category_count"] = ip_ranges_retaining_parent_category_count
__props__.__dict__["keywords"] = keywords
__props__.__dict__["keywords_retaining_parent_categories"] = keywords_retaining_parent_categories
__props__.__dict__["scopes"] = scopes
__props__.__dict__["super_category"] = super_category
__props__.__dict__["type"] = type
__props__.__dict__["url_category_id"] = url_category_id
__props__.__dict__["url_keyword_counts"] = url_keyword_counts
__props__.__dict__["urls"] = urls
__props__.__dict__["urls_retaining_parent_category_count"] = urls_retaining_parent_category_count
return URLCategories(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="configuredName")
def configured_name(self) -> pulumi.Output[Optional[str]]:
"""
Name of the URL category. This is only required for custom URL categories.
"""
return pulumi.get(self, "configured_name")
@property
@pulumi.getter(name="customCategory")
def custom_category(self) -> pulumi.Output[Optional[bool]]:
"""
Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
"""
return pulumi.get(self, "custom_category")
@property
@pulumi.getter(name="customIpRangesCount")
def custom_ip_ranges_count(self) -> pulumi.Output[int]:
"""
The number of custom IP address ranges associated to the URL category.
"""
return pulumi.get(self, "custom_ip_ranges_count")
@property
@pulumi.getter(name="customUrlsCount")
def custom_urls_count(self) -> pulumi.Output[int]:
"""
The number of custom URLs associated to the URL category.
"""
return pulumi.get(self, "custom_urls_count")
@property
@pulumi.getter(name="dbCategorizedUrls")
def db_categorized_urls(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
"""
return pulumi.get(self, "db_categorized_urls")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Description of the category.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def editable(self) -> pulumi.Output[Optional[bool]]:
"""
Value is set to false for custom URL category when due to scope user does not have edit permission
"""
return pulumi.get(self, "editable")
@property
@pulumi.getter(name="ipRanges")
def ip_ranges(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
Custom IP address ranges associated to a URL category. Up to 2000 custom IP address ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
"""
return pulumi.get(self, "ip_ranges")
@property
@pulumi.getter(name="ipRangesRetainingParentCategories")
def ip_ranges_retaining_parent_categories(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
The retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.
"""
return pulumi.get(self, "ip_ranges_retaining_parent_categories")
@property
@pulumi.getter(name="ipRangesRetainingParentCategoryCount")
def ip_ranges_retaining_parent_category_count(self) -> pulumi.Output[int]:
"""
The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "ip_ranges_retaining_parent_category_count")
@property
@pulumi.getter
def keywords(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "keywords")
@property
@pulumi.getter(name="keywordsRetainingParentCategories")
def keywords_retaining_parent_categories(self) -> pulumi.Output[Optional[Sequence[str]]]:
return pulumi.get(self, "keywords_retaining_parent_categories")
@property
@pulumi.getter
def scopes(self) -> pulumi.Output[Optional[Sequence['outputs.URLCategoriesScope']]]:
"""
Scope of the custom categories.
"""
return pulumi.get(self, "scopes")
@property
@pulumi.getter(name="superCategory")
def super_category(self) -> pulumi.Output[Optional[str]]:
"""
Super Category of the URL category. This field is required when creating custom URL categories.
"""
return pulumi.get(self, "super_category")
@property
@pulumi.getter
def type(self) -> pulumi.Output[Optional[str]]:
"""
Type of the custom categories. `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`
"""
return pulumi.get(self, "type")
@property
@pulumi.getter(name="urlCategoryId")
def url_category_id(self) -> pulumi.Output[str]:
return pulumi.get(self, "url_category_id")
@property
@pulumi.getter(name="urlKeywordCounts")
def url_keyword_counts(self) -> pulumi.Output['outputs.URLCategoriesUrlKeywordCounts']:
"""
URL and keyword counts for the category.
"""
return pulumi.get(self, "url_keyword_counts")
@property
@pulumi.getter
def urls(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "urls")
@property
@pulumi.getter(name="urlsRetainingParentCategoryCount")
def urls_retaining_parent_category_count(self) -> pulumi.Output[int]:
"""
The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "urls_retaining_parent_category_count") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlcategory/url_categories.py | url_categories.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetURLCategoriesResult',
'AwaitableGetURLCategoriesResult',
'get_url_categories',
'get_url_categories_output',
]
@pulumi.output_type
class GetURLCategoriesResult:
"""
A collection of values returned by getURLCategories.
"""
def __init__(__self__, configured_name=None, custom_category=None, custom_ip_ranges_count=None, custom_urls_count=None, db_categorized_urls=None, description=None, editable=None, id=None, ip_ranges=None, ip_ranges_retaining_parent_categories=None, ip_ranges_retaining_parent_category_count=None, keywords=None, keywords_retaining_parent_categories=None, scopes=None, super_category=None, type=None, url_keyword_counts=None, urls=None, urls_retaining_parent_category_count=None, val=None):
if configured_name and not isinstance(configured_name, str):
raise TypeError("Expected argument 'configured_name' to be a str")
pulumi.set(__self__, "configured_name", configured_name)
if custom_category and not isinstance(custom_category, bool):
raise TypeError("Expected argument 'custom_category' to be a bool")
pulumi.set(__self__, "custom_category", custom_category)
if custom_ip_ranges_count and not isinstance(custom_ip_ranges_count, int):
raise TypeError("Expected argument 'custom_ip_ranges_count' to be a int")
pulumi.set(__self__, "custom_ip_ranges_count", custom_ip_ranges_count)
if custom_urls_count and not isinstance(custom_urls_count, int):
raise TypeError("Expected argument 'custom_urls_count' to be a int")
pulumi.set(__self__, "custom_urls_count", custom_urls_count)
if db_categorized_urls and not isinstance(db_categorized_urls, list):
raise TypeError("Expected argument 'db_categorized_urls' to be a list")
pulumi.set(__self__, "db_categorized_urls", db_categorized_urls)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if editable and not isinstance(editable, bool):
raise TypeError("Expected argument 'editable' to be a bool")
pulumi.set(__self__, "editable", editable)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if ip_ranges and not isinstance(ip_ranges, list):
raise TypeError("Expected argument 'ip_ranges' to be a list")
pulumi.set(__self__, "ip_ranges", ip_ranges)
if ip_ranges_retaining_parent_categories and not isinstance(ip_ranges_retaining_parent_categories, list):
raise TypeError("Expected argument 'ip_ranges_retaining_parent_categories' to be a list")
pulumi.set(__self__, "ip_ranges_retaining_parent_categories", ip_ranges_retaining_parent_categories)
if ip_ranges_retaining_parent_category_count and not isinstance(ip_ranges_retaining_parent_category_count, int):
raise TypeError("Expected argument 'ip_ranges_retaining_parent_category_count' to be a int")
pulumi.set(__self__, "ip_ranges_retaining_parent_category_count", ip_ranges_retaining_parent_category_count)
if keywords and not isinstance(keywords, list):
raise TypeError("Expected argument 'keywords' to be a list")
pulumi.set(__self__, "keywords", keywords)
if keywords_retaining_parent_categories and not isinstance(keywords_retaining_parent_categories, list):
raise TypeError("Expected argument 'keywords_retaining_parent_categories' to be a list")
pulumi.set(__self__, "keywords_retaining_parent_categories", keywords_retaining_parent_categories)
if scopes and not isinstance(scopes, list):
raise TypeError("Expected argument 'scopes' to be a list")
pulumi.set(__self__, "scopes", scopes)
if super_category and not isinstance(super_category, str):
raise TypeError("Expected argument 'super_category' to be a str")
pulumi.set(__self__, "super_category", super_category)
if type and not isinstance(type, str):
raise TypeError("Expected argument 'type' to be a str")
pulumi.set(__self__, "type", type)
if url_keyword_counts and not isinstance(url_keyword_counts, list):
raise TypeError("Expected argument 'url_keyword_counts' to be a list")
pulumi.set(__self__, "url_keyword_counts", url_keyword_counts)
if urls and not isinstance(urls, list):
raise TypeError("Expected argument 'urls' to be a list")
pulumi.set(__self__, "urls", urls)
if urls_retaining_parent_category_count and not isinstance(urls_retaining_parent_category_count, int):
raise TypeError("Expected argument 'urls_retaining_parent_category_count' to be a int")
pulumi.set(__self__, "urls_retaining_parent_category_count", urls_retaining_parent_category_count)
if val and not isinstance(val, int):
raise TypeError("Expected argument 'val' to be a int")
pulumi.set(__self__, "val", val)
@property
@pulumi.getter(name="configuredName")
def configured_name(self) -> str:
"""
(String) Name of the URL category. This is only required for custom URL categories.
"""
return pulumi.get(self, "configured_name")
@property
@pulumi.getter(name="customCategory")
def custom_category(self) -> bool:
"""
(Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
"""
return pulumi.get(self, "custom_category")
@property
@pulumi.getter(name="customIpRangesCount")
def custom_ip_ranges_count(self) -> Optional[int]:
"""
(Number) The number of custom IP address ranges associated to the URL category.
"""
return pulumi.get(self, "custom_ip_ranges_count")
@property
@pulumi.getter(name="customUrlsCount")
def custom_urls_count(self) -> int:
"""
(Number) The number of custom URLs associated to the URL category.
"""
return pulumi.get(self, "custom_urls_count")
@property
@pulumi.getter(name="dbCategorizedUrls")
def db_categorized_urls(self) -> Sequence[str]:
"""
(List of String) URLs added to a custom URL category are also retained under the original parent URL category (i.e., the predefined category the URL previously belonged to).
"""
return pulumi.get(self, "db_categorized_urls")
@property
@pulumi.getter
def description(self) -> str:
"""
(String) Description of the category.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def editable(self) -> bool:
"""
(Boolean) Value is set to false for custom URL category when due to scope user does not have edit permission
"""
return pulumi.get(self, "editable")
@property
@pulumi.getter
def id(self) -> str:
"""
(String) Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipRanges")
def ip_ranges(self) -> Sequence[str]:
return pulumi.get(self, "ip_ranges")
@property
@pulumi.getter(name="ipRangesRetainingParentCategories")
def ip_ranges_retaining_parent_categories(self) -> Sequence[str]:
return pulumi.get(self, "ip_ranges_retaining_parent_categories")
@property
@pulumi.getter(name="ipRangesRetainingParentCategoryCount")
def ip_ranges_retaining_parent_category_count(self) -> int:
"""
(Number) The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "ip_ranges_retaining_parent_category_count")
@property
@pulumi.getter
def keywords(self) -> Sequence[str]:
"""
(List of String) Custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "keywords")
@property
@pulumi.getter(name="keywordsRetainingParentCategories")
def keywords_retaining_parent_categories(self) -> Sequence[str]:
return pulumi.get(self, "keywords_retaining_parent_categories")
@property
@pulumi.getter
def scopes(self) -> Sequence['outputs.GetURLCategoriesScopeResult']:
"""
(List of Object) Scope of the custom categories.
"""
return pulumi.get(self, "scopes")
@property
@pulumi.getter(name="superCategory")
def super_category(self) -> Optional[str]:
"""
(String)
"""
return pulumi.get(self, "super_category")
@property
@pulumi.getter
def type(self) -> str:
"""
(String) The admin scope type. The attribute name is subject to change. `ORGANIZATION`, `DEPARTMENT`, `LOCATION`, `LOCATION_GROUP`
"""
return pulumi.get(self, "type")
@property
@pulumi.getter(name="urlKeywordCounts")
def url_keyword_counts(self) -> Sequence['outputs.GetURLCategoriesUrlKeywordCountResult']:
"""
(List of Object) URL and keyword counts for the category.
"""
return pulumi.get(self, "url_keyword_counts")
@property
@pulumi.getter
def urls(self) -> Sequence[str]:
"""
(List of String) Custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories (including bandwidth classes).
"""
return pulumi.get(self, "urls")
@property
@pulumi.getter(name="urlsRetainingParentCategoryCount")
def urls_retaining_parent_category_count(self) -> int:
"""
(Number) The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.
"""
return pulumi.get(self, "urls_retaining_parent_category_count")
@property
@pulumi.getter
def val(self) -> int:
"""
(Number)
"""
return pulumi.get(self, "val")
class AwaitableGetURLCategoriesResult(GetURLCategoriesResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetURLCategoriesResult(
configured_name=self.configured_name,
custom_category=self.custom_category,
custom_ip_ranges_count=self.custom_ip_ranges_count,
custom_urls_count=self.custom_urls_count,
db_categorized_urls=self.db_categorized_urls,
description=self.description,
editable=self.editable,
id=self.id,
ip_ranges=self.ip_ranges,
ip_ranges_retaining_parent_categories=self.ip_ranges_retaining_parent_categories,
ip_ranges_retaining_parent_category_count=self.ip_ranges_retaining_parent_category_count,
keywords=self.keywords,
keywords_retaining_parent_categories=self.keywords_retaining_parent_categories,
scopes=self.scopes,
super_category=self.super_category,
type=self.type,
url_keyword_counts=self.url_keyword_counts,
urls=self.urls,
urls_retaining_parent_category_count=self.urls_retaining_parent_category_count,
val=self.val)
def get_url_categories(configured_name: Optional[str] = None,
custom_category: Optional[bool] = None,
custom_ip_ranges_count: Optional[int] = None,
id: Optional[str] = None,
super_category: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetURLCategoriesResult:
"""
Use the **zia_url_categories** data source to get information about all or custom URL categories. By default, the response includes keywords.
```python
import pulumi
import pulumi_zia as zia
example = zia.URLCategory.get_url_categories(id="CUSTOM_08")
```
:param str configured_name: (String) Name of the URL category. This is only required for custom URL categories.
:param bool custom_category: (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
:param int custom_ip_ranges_count: (Number) The number of custom IP address ranges associated to the URL category.
:param str id: URL category
:param str super_category: (String)
"""
__args__ = dict()
__args__['configuredName'] = configured_name
__args__['customCategory'] = custom_category
__args__['customIpRangesCount'] = custom_ip_ranges_count
__args__['id'] = id
__args__['superCategory'] = super_category
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:URLCategory/getURLCategories:getURLCategories', __args__, opts=opts, typ=GetURLCategoriesResult).value
return AwaitableGetURLCategoriesResult(
configured_name=__ret__.configured_name,
custom_category=__ret__.custom_category,
custom_ip_ranges_count=__ret__.custom_ip_ranges_count,
custom_urls_count=__ret__.custom_urls_count,
db_categorized_urls=__ret__.db_categorized_urls,
description=__ret__.description,
editable=__ret__.editable,
id=__ret__.id,
ip_ranges=__ret__.ip_ranges,
ip_ranges_retaining_parent_categories=__ret__.ip_ranges_retaining_parent_categories,
ip_ranges_retaining_parent_category_count=__ret__.ip_ranges_retaining_parent_category_count,
keywords=__ret__.keywords,
keywords_retaining_parent_categories=__ret__.keywords_retaining_parent_categories,
scopes=__ret__.scopes,
super_category=__ret__.super_category,
type=__ret__.type,
url_keyword_counts=__ret__.url_keyword_counts,
urls=__ret__.urls,
urls_retaining_parent_category_count=__ret__.urls_retaining_parent_category_count,
val=__ret__.val)
@_utilities.lift_output_func(get_url_categories)
def get_url_categories_output(configured_name: Optional[pulumi.Input[Optional[str]]] = None,
custom_category: Optional[pulumi.Input[Optional[bool]]] = None,
custom_ip_ranges_count: Optional[pulumi.Input[Optional[int]]] = None,
id: Optional[pulumi.Input[Optional[str]]] = None,
super_category: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetURLCategoriesResult]:
"""
Use the **zia_url_categories** data source to get information about all or custom URL categories. By default, the response includes keywords.
```python
import pulumi
import pulumi_zia as zia
example = zia.URLCategory.get_url_categories(id="CUSTOM_08")
```
:param str configured_name: (String) Name of the URL category. This is only required for custom URL categories.
:param bool custom_category: (Boolean) Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.
:param int custom_ip_ranges_count: (Number) The number of custom IP address ranges associated to the URL category.
:param str id: URL category
:param str super_category: (String)
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlcategory/get_url_categories.py | get_url_categories.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'LocationManagementVpnCredentialArgs',
]
@pulumi.input_type
class LocationManagementVpnCredentialArgs:
def __init__(__self__, *,
comments: Optional[pulumi.Input[str]] = None,
fqdn: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[int]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
pre_shared_key: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[int] id: VPN credential resource id. The value is required if `ip_addresses` are not defined.
"""
if comments is not None:
pulumi.set(__self__, "comments", comments)
if fqdn is not None:
pulumi.set(__self__, "fqdn", fqdn)
if id is not None:
pulumi.set(__self__, "id", id)
if ip_address is not None:
pulumi.set(__self__, "ip_address", ip_address)
if pre_shared_key is not None:
pulumi.set(__self__, "pre_shared_key", pre_shared_key)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def comments(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "comments")
@comments.setter
def comments(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "comments", value)
@property
@pulumi.getter
def fqdn(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "fqdn")
@fqdn.setter
def fqdn(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "fqdn", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
"""
VPN credential resource id. The value is required if `ip_addresses` are not defined.
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "ip_address")
@ip_address.setter
def ip_address(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ip_address", value)
@property
@pulumi.getter(name="preSharedKey")
def pre_shared_key(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "pre_shared_key")
@pre_shared_key.setter
def pre_shared_key(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "pre_shared_key", value)
@property
@pulumi.getter
def type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "type")
@type.setter
def type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "type", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/locationmanagement/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'LocationManagementVpnCredential',
'GetLocationManagementVpnCredentialResult',
'GetLocationManagementVpnCredentialLocationResult',
'GetLocationManagementVpnCredentialManagedByResult',
]
@pulumi.output_type
class LocationManagementVpnCredential(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "ipAddress":
suggest = "ip_address"
elif key == "preSharedKey":
suggest = "pre_shared_key"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in LocationManagementVpnCredential. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
LocationManagementVpnCredential.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
LocationManagementVpnCredential.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
comments: Optional[str] = None,
fqdn: Optional[str] = None,
id: Optional[int] = None,
ip_address: Optional[str] = None,
pre_shared_key: Optional[str] = None,
type: Optional[str] = None):
"""
:param int id: VPN credential resource id. The value is required if `ip_addresses` are not defined.
"""
if comments is not None:
pulumi.set(__self__, "comments", comments)
if fqdn is not None:
pulumi.set(__self__, "fqdn", fqdn)
if id is not None:
pulumi.set(__self__, "id", id)
if ip_address is not None:
pulumi.set(__self__, "ip_address", ip_address)
if pre_shared_key is not None:
pulumi.set(__self__, "pre_shared_key", pre_shared_key)
if type is not None:
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def comments(self) -> Optional[str]:
return pulumi.get(self, "comments")
@property
@pulumi.getter
def fqdn(self) -> Optional[str]:
return pulumi.get(self, "fqdn")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
VPN credential resource id. The value is required if `ip_addresses` are not defined.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAddress")
def ip_address(self) -> Optional[str]:
return pulumi.get(self, "ip_address")
@property
@pulumi.getter(name="preSharedKey")
def pre_shared_key(self) -> Optional[str]:
return pulumi.get(self, "pre_shared_key")
@property
@pulumi.getter
def type(self) -> Optional[str]:
return pulumi.get(self, "type")
@pulumi.output_type
class GetLocationManagementVpnCredentialResult(dict):
def __init__(__self__, *,
comments: str,
fqdn: str,
id: int,
locations: Sequence['outputs.GetLocationManagementVpnCredentialLocationResult'],
managed_bies: Sequence['outputs.GetLocationManagementVpnCredentialManagedByResult'],
pre_shared_key: str,
type: str):
"""
:param str comments: (String) Additional information about this VPN credential.
Additional information about this VPN credential.
:param str fqdn: (String) Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
:param int id: The ID of the location to be exported.
:param Sequence['GetLocationManagementVpnCredentialLocationArgs'] locations: (List of Object)
:param Sequence['GetLocationManagementVpnCredentialManagedByArgs'] managed_bies: (List of Object)
:param str pre_shared_key: (String) Pre-shared key. This is a required field for `UFQDN` and IP auth type.
:param str type: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
"""
pulumi.set(__self__, "comments", comments)
pulumi.set(__self__, "fqdn", fqdn)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "locations", locations)
pulumi.set(__self__, "managed_bies", managed_bies)
pulumi.set(__self__, "pre_shared_key", pre_shared_key)
pulumi.set(__self__, "type", type)
@property
@pulumi.getter
def comments(self) -> str:
"""
(String) Additional information about this VPN credential.
Additional information about this VPN credential.
"""
return pulumi.get(self, "comments")
@property
@pulumi.getter
def fqdn(self) -> str:
"""
(String) Fully Qualified Domain Name. Applicable only to `UFQDN` or `XAUTH` (or `HOSTED_MOBILE_USERS`) auth type.
"""
return pulumi.get(self, "fqdn")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of the location to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def locations(self) -> Sequence['outputs.GetLocationManagementVpnCredentialLocationResult']:
"""
(List of Object)
"""
return pulumi.get(self, "locations")
@property
@pulumi.getter(name="managedBies")
def managed_bies(self) -> Sequence['outputs.GetLocationManagementVpnCredentialManagedByResult']:
"""
(List of Object)
"""
return pulumi.get(self, "managed_bies")
@property
@pulumi.getter(name="preSharedKey")
def pre_shared_key(self) -> str:
"""
(String) Pre-shared key. This is a required field for `UFQDN` and IP auth type.
"""
return pulumi.get(self, "pre_shared_key")
@property
@pulumi.getter
def type(self) -> str:
"""
(String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
"""
return pulumi.get(self, "type")
@pulumi.output_type
class GetLocationManagementVpnCredentialLocationResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: The ID of the location to be exported.
:param str name: The name of the location to be exported.
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of the location to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the location to be exported.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetLocationManagementVpnCredentialManagedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: The ID of the location to be exported.
:param str name: The name of the location to be exported.
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
The ID of the location to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the location to be exported.
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/locationmanagement/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetLocationManagementResult',
'AwaitableGetLocationManagementResult',
'get_location_management',
'get_location_management_output',
]
@pulumi.output_type
class GetLocationManagementResult:
"""
A collection of values returned by getLocationManagement.
"""
def __init__(__self__, aup_block_internet_until_accepted=None, aup_enabled=None, aup_force_ssl_inspection=None, aup_timeout_in_days=None, auth_required=None, caution_enabled=None, country=None, description=None, display_time_unit=None, dn_bandwidth=None, id=None, idle_time_in_minutes=None, ip_addresses=None, ips_control=None, name=None, ofw_enabled=None, parent_id=None, ports=None, profile=None, ssl_scan_enabled=None, surrogate_ip=None, surrogate_ip_enforced_for_known_browsers=None, surrogate_refresh_time_in_minutes=None, surrogate_refresh_time_unit=None, tz=None, up_bandwidth=None, vpn_credentials=None, xff_forward_enabled=None, zapp_ssl_scan_enabled=None):
if aup_block_internet_until_accepted and not isinstance(aup_block_internet_until_accepted, bool):
raise TypeError("Expected argument 'aup_block_internet_until_accepted' to be a bool")
pulumi.set(__self__, "aup_block_internet_until_accepted", aup_block_internet_until_accepted)
if aup_enabled and not isinstance(aup_enabled, bool):
raise TypeError("Expected argument 'aup_enabled' to be a bool")
pulumi.set(__self__, "aup_enabled", aup_enabled)
if aup_force_ssl_inspection and not isinstance(aup_force_ssl_inspection, bool):
raise TypeError("Expected argument 'aup_force_ssl_inspection' to be a bool")
pulumi.set(__self__, "aup_force_ssl_inspection", aup_force_ssl_inspection)
if aup_timeout_in_days and not isinstance(aup_timeout_in_days, int):
raise TypeError("Expected argument 'aup_timeout_in_days' to be a int")
pulumi.set(__self__, "aup_timeout_in_days", aup_timeout_in_days)
if auth_required and not isinstance(auth_required, bool):
raise TypeError("Expected argument 'auth_required' to be a bool")
pulumi.set(__self__, "auth_required", auth_required)
if caution_enabled and not isinstance(caution_enabled, bool):
raise TypeError("Expected argument 'caution_enabled' to be a bool")
pulumi.set(__self__, "caution_enabled", caution_enabled)
if country and not isinstance(country, str):
raise TypeError("Expected argument 'country' to be a str")
pulumi.set(__self__, "country", country)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if display_time_unit and not isinstance(display_time_unit, str):
raise TypeError("Expected argument 'display_time_unit' to be a str")
pulumi.set(__self__, "display_time_unit", display_time_unit)
if dn_bandwidth and not isinstance(dn_bandwidth, int):
raise TypeError("Expected argument 'dn_bandwidth' to be a int")
pulumi.set(__self__, "dn_bandwidth", dn_bandwidth)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if idle_time_in_minutes and not isinstance(idle_time_in_minutes, int):
raise TypeError("Expected argument 'idle_time_in_minutes' to be a int")
pulumi.set(__self__, "idle_time_in_minutes", idle_time_in_minutes)
if ip_addresses and not isinstance(ip_addresses, list):
raise TypeError("Expected argument 'ip_addresses' to be a list")
pulumi.set(__self__, "ip_addresses", ip_addresses)
if ips_control and not isinstance(ips_control, bool):
raise TypeError("Expected argument 'ips_control' to be a bool")
pulumi.set(__self__, "ips_control", ips_control)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if ofw_enabled and not isinstance(ofw_enabled, bool):
raise TypeError("Expected argument 'ofw_enabled' to be a bool")
pulumi.set(__self__, "ofw_enabled", ofw_enabled)
if parent_id and not isinstance(parent_id, int):
raise TypeError("Expected argument 'parent_id' to be a int")
pulumi.set(__self__, "parent_id", parent_id)
if ports and not isinstance(ports, str):
raise TypeError("Expected argument 'ports' to be a str")
pulumi.set(__self__, "ports", ports)
if profile and not isinstance(profile, str):
raise TypeError("Expected argument 'profile' to be a str")
pulumi.set(__self__, "profile", profile)
if ssl_scan_enabled and not isinstance(ssl_scan_enabled, bool):
raise TypeError("Expected argument 'ssl_scan_enabled' to be a bool")
pulumi.set(__self__, "ssl_scan_enabled", ssl_scan_enabled)
if surrogate_ip and not isinstance(surrogate_ip, bool):
raise TypeError("Expected argument 'surrogate_ip' to be a bool")
pulumi.set(__self__, "surrogate_ip", surrogate_ip)
if surrogate_ip_enforced_for_known_browsers and not isinstance(surrogate_ip_enforced_for_known_browsers, bool):
raise TypeError("Expected argument 'surrogate_ip_enforced_for_known_browsers' to be a bool")
pulumi.set(__self__, "surrogate_ip_enforced_for_known_browsers", surrogate_ip_enforced_for_known_browsers)
if surrogate_refresh_time_in_minutes and not isinstance(surrogate_refresh_time_in_minutes, int):
raise TypeError("Expected argument 'surrogate_refresh_time_in_minutes' to be a int")
pulumi.set(__self__, "surrogate_refresh_time_in_minutes", surrogate_refresh_time_in_minutes)
if surrogate_refresh_time_unit and not isinstance(surrogate_refresh_time_unit, str):
raise TypeError("Expected argument 'surrogate_refresh_time_unit' to be a str")
pulumi.set(__self__, "surrogate_refresh_time_unit", surrogate_refresh_time_unit)
if tz and not isinstance(tz, str):
raise TypeError("Expected argument 'tz' to be a str")
pulumi.set(__self__, "tz", tz)
if up_bandwidth and not isinstance(up_bandwidth, int):
raise TypeError("Expected argument 'up_bandwidth' to be a int")
pulumi.set(__self__, "up_bandwidth", up_bandwidth)
if vpn_credentials and not isinstance(vpn_credentials, list):
raise TypeError("Expected argument 'vpn_credentials' to be a list")
pulumi.set(__self__, "vpn_credentials", vpn_credentials)
if xff_forward_enabled and not isinstance(xff_forward_enabled, bool):
raise TypeError("Expected argument 'xff_forward_enabled' to be a bool")
pulumi.set(__self__, "xff_forward_enabled", xff_forward_enabled)
if zapp_ssl_scan_enabled and not isinstance(zapp_ssl_scan_enabled, bool):
raise TypeError("Expected argument 'zapp_ssl_scan_enabled' to be a bool")
pulumi.set(__self__, "zapp_ssl_scan_enabled", zapp_ssl_scan_enabled)
@property
@pulumi.getter(name="aupBlockInternetUntilAccepted")
def aup_block_internet_until_accepted(self) -> bool:
"""
(Boolean) For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
"""
return pulumi.get(self, "aup_block_internet_until_accepted")
@property
@pulumi.getter(name="aupEnabled")
def aup_enabled(self) -> bool:
"""
(Boolean) Enable AUP. When set to true, AUP is enabled for the location.
"""
return pulumi.get(self, "aup_enabled")
@property
@pulumi.getter(name="aupForceSslInspection")
def aup_force_ssl_inspection(self) -> bool:
"""
(Boolean) For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
"""
return pulumi.get(self, "aup_force_ssl_inspection")
@property
@pulumi.getter(name="aupTimeoutInDays")
def aup_timeout_in_days(self) -> int:
"""
(Number) Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
"""
return pulumi.get(self, "aup_timeout_in_days")
@property
@pulumi.getter(name="authRequired")
def auth_required(self) -> bool:
"""
(Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
"""
return pulumi.get(self, "auth_required")
@property
@pulumi.getter(name="cautionEnabled")
def caution_enabled(self) -> bool:
"""
(Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
"""
return pulumi.get(self, "caution_enabled")
@property
@pulumi.getter
def country(self) -> str:
"""
(String) Country
"""
return pulumi.get(self, "country")
@property
@pulumi.getter
def description(self) -> str:
"""
(String) Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="displayTimeUnit")
def display_time_unit(self) -> str:
"""
(String) Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
"""
return pulumi.get(self, "display_time_unit")
@property
@pulumi.getter(name="dnBandwidth")
def dn_bandwidth(self) -> int:
"""
(Number) Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "dn_bandwidth")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
(Number) Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idleTimeInMinutes")
def idle_time_in_minutes(self) -> int:
"""
(Number) Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
"""
return pulumi.get(self, "idle_time_in_minutes")
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> Sequence[str]:
"""
(List of String) For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)).
"""
return pulumi.get(self, "ip_addresses")
@property
@pulumi.getter(name="ipsControl")
def ips_control(self) -> bool:
"""
(Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
"""
return pulumi.get(self, "ips_control")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="ofwEnabled")
def ofw_enabled(self) -> bool:
"""
(Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
"""
return pulumi.get(self, "ofw_enabled")
@property
@pulumi.getter(name="parentId")
def parent_id(self) -> int:
"""
(Number) - Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
"""
return pulumi.get(self, "parent_id")
@property
@pulumi.getter
def ports(self) -> str:
"""
(String) IP ports that are associated with the location.
"""
return pulumi.get(self, "ports")
@property
@pulumi.getter
def profile(self) -> str:
"""
(String) Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`.
"""
return pulumi.get(self, "profile")
@property
@pulumi.getter(name="sslScanEnabled")
def ssl_scan_enabled(self) -> bool:
"""
(Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "ssl_scan_enabled")
@property
@pulumi.getter(name="surrogateIp")
def surrogate_ip(self) -> bool:
"""
(Boolean) Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
"""
return pulumi.get(self, "surrogate_ip")
@property
@pulumi.getter(name="surrogateIpEnforcedForKnownBrowsers")
def surrogate_ip_enforced_for_known_browsers(self) -> bool:
"""
(Boolean) Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
"""
return pulumi.get(self, "surrogate_ip_enforced_for_known_browsers")
@property
@pulumi.getter(name="surrogateRefreshTimeInMinutes")
def surrogate_refresh_time_in_minutes(self) -> int:
"""
(Number) Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
"""
return pulumi.get(self, "surrogate_refresh_time_in_minutes")
@property
@pulumi.getter(name="surrogateRefreshTimeUnit")
def surrogate_refresh_time_unit(self) -> str:
"""
(String) Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
"""
return pulumi.get(self, "surrogate_refresh_time_unit")
@property
@pulumi.getter
def tz(self) -> str:
"""
(String) Timezone of the location. If not specified, it defaults to GMT.
"""
return pulumi.get(self, "tz")
@property
@pulumi.getter(name="upBandwidth")
def up_bandwidth(self) -> int:
"""
(Number) Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "up_bandwidth")
@property
@pulumi.getter(name="vpnCredentials")
def vpn_credentials(self) -> Sequence['outputs.GetLocationManagementVpnCredentialResult']:
return pulumi.get(self, "vpn_credentials")
@property
@pulumi.getter(name="xffForwardEnabled")
def xff_forward_enabled(self) -> bool:
"""
(Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
"""
return pulumi.get(self, "xff_forward_enabled")
@property
@pulumi.getter(name="zappSslScanEnabled")
def zapp_ssl_scan_enabled(self) -> bool:
"""
(Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "zapp_ssl_scan_enabled")
class AwaitableGetLocationManagementResult(GetLocationManagementResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetLocationManagementResult(
aup_block_internet_until_accepted=self.aup_block_internet_until_accepted,
aup_enabled=self.aup_enabled,
aup_force_ssl_inspection=self.aup_force_ssl_inspection,
aup_timeout_in_days=self.aup_timeout_in_days,
auth_required=self.auth_required,
caution_enabled=self.caution_enabled,
country=self.country,
description=self.description,
display_time_unit=self.display_time_unit,
dn_bandwidth=self.dn_bandwidth,
id=self.id,
idle_time_in_minutes=self.idle_time_in_minutes,
ip_addresses=self.ip_addresses,
ips_control=self.ips_control,
name=self.name,
ofw_enabled=self.ofw_enabled,
parent_id=self.parent_id,
ports=self.ports,
profile=self.profile,
ssl_scan_enabled=self.ssl_scan_enabled,
surrogate_ip=self.surrogate_ip,
surrogate_ip_enforced_for_known_browsers=self.surrogate_ip_enforced_for_known_browsers,
surrogate_refresh_time_in_minutes=self.surrogate_refresh_time_in_minutes,
surrogate_refresh_time_unit=self.surrogate_refresh_time_unit,
tz=self.tz,
up_bandwidth=self.up_bandwidth,
vpn_credentials=self.vpn_credentials,
xff_forward_enabled=self.xff_forward_enabled,
zapp_ssl_scan_enabled=self.zapp_ssl_scan_enabled)
def get_location_management(id: Optional[int] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetLocationManagementResult:
"""
Use the **zia_location_management** data source to get information about a location resource available in the Zscaler Internet Access Location Management. This resource can then be referenced in multiple other resources, such as URL Filtering Rules, Firewall rules etc.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationManagement.get_location_management(name="San Jose")
```
:param int id: The ID of the location to be exported.
:param str name: The name of the location to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:LocationManagement/getLocationManagement:getLocationManagement', __args__, opts=opts, typ=GetLocationManagementResult).value
return AwaitableGetLocationManagementResult(
aup_block_internet_until_accepted=__ret__.aup_block_internet_until_accepted,
aup_enabled=__ret__.aup_enabled,
aup_force_ssl_inspection=__ret__.aup_force_ssl_inspection,
aup_timeout_in_days=__ret__.aup_timeout_in_days,
auth_required=__ret__.auth_required,
caution_enabled=__ret__.caution_enabled,
country=__ret__.country,
description=__ret__.description,
display_time_unit=__ret__.display_time_unit,
dn_bandwidth=__ret__.dn_bandwidth,
id=__ret__.id,
idle_time_in_minutes=__ret__.idle_time_in_minutes,
ip_addresses=__ret__.ip_addresses,
ips_control=__ret__.ips_control,
name=__ret__.name,
ofw_enabled=__ret__.ofw_enabled,
parent_id=__ret__.parent_id,
ports=__ret__.ports,
profile=__ret__.profile,
ssl_scan_enabled=__ret__.ssl_scan_enabled,
surrogate_ip=__ret__.surrogate_ip,
surrogate_ip_enforced_for_known_browsers=__ret__.surrogate_ip_enforced_for_known_browsers,
surrogate_refresh_time_in_minutes=__ret__.surrogate_refresh_time_in_minutes,
surrogate_refresh_time_unit=__ret__.surrogate_refresh_time_unit,
tz=__ret__.tz,
up_bandwidth=__ret__.up_bandwidth,
vpn_credentials=__ret__.vpn_credentials,
xff_forward_enabled=__ret__.xff_forward_enabled,
zapp_ssl_scan_enabled=__ret__.zapp_ssl_scan_enabled)
@_utilities.lift_output_func(get_location_management)
def get_location_management_output(id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetLocationManagementResult]:
"""
Use the **zia_location_management** data source to get information about a location resource available in the Zscaler Internet Access Location Management. This resource can then be referenced in multiple other resources, such as URL Filtering Rules, Firewall rules etc.
## Example Usage
```python
import pulumi
import pulumi_zia as zia
example = zia.LocationManagement.get_location_management(name="San Jose")
```
:param int id: The ID of the location to be exported.
:param str name: The name of the location to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/locationmanagement/get_location_management.py | get_location_management.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['LocationManagementArgs', 'LocationManagement']
@pulumi.input_type
class LocationManagementArgs:
def __init__(__self__, *,
aup_block_internet_until_accepted: Optional[pulumi.Input[bool]] = None,
aup_enabled: Optional[pulumi.Input[bool]] = None,
aup_force_ssl_inspection: Optional[pulumi.Input[bool]] = None,
aup_timeout_in_days: Optional[pulumi.Input[int]] = None,
auth_required: Optional[pulumi.Input[bool]] = None,
caution_enabled: Optional[pulumi.Input[bool]] = None,
country: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
display_time_unit: Optional[pulumi.Input[str]] = None,
dn_bandwidth: Optional[pulumi.Input[int]] = None,
idle_time_in_minutes: Optional[pulumi.Input[int]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ips_control: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
ofw_enabled: Optional[pulumi.Input[bool]] = None,
parent_id: Optional[pulumi.Input[int]] = None,
ports: Optional[pulumi.Input[str]] = None,
profile: Optional[pulumi.Input[str]] = None,
ssl_scan_enabled: Optional[pulumi.Input[bool]] = None,
surrogate_ip: Optional[pulumi.Input[bool]] = None,
surrogate_ip_enforced_for_known_browsers: Optional[pulumi.Input[bool]] = None,
surrogate_refresh_time_in_minutes: Optional[pulumi.Input[int]] = None,
surrogate_refresh_time_unit: Optional[pulumi.Input[str]] = None,
tz: Optional[pulumi.Input[str]] = None,
up_bandwidth: Optional[pulumi.Input[int]] = None,
vpn_credentials: Optional[pulumi.Input[Sequence[pulumi.Input['LocationManagementVpnCredentialArgs']]]] = None,
xff_forward_enabled: Optional[pulumi.Input[bool]] = None,
zapp_ssl_scan_enabled: Optional[pulumi.Input[bool]] = None):
"""
The set of arguments for constructing a LocationManagement resource.
:param pulumi.Input[bool] aup_block_internet_until_accepted: For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
:param pulumi.Input[bool] aup_enabled: Enable AUP. When set to true, AUP is enabled for the location.
:param pulumi.Input[bool] aup_force_ssl_inspection: For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
:param pulumi.Input[int] aup_timeout_in_days: Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
:param pulumi.Input[bool] auth_required: Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
:param pulumi.Input[bool] caution_enabled: Enable Caution. When set to true, a caution notifcation is enabled for the location.
:param pulumi.Input[str] country: Country
:param pulumi.Input[str] description: Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
:param pulumi.Input[str] display_time_unit: Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
:param pulumi.Input[int] dn_bandwidth: Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[int] idle_time_in_minutes: Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)). The value is required if `vpn_credentials` are not defined.
:param pulumi.Input[bool] ips_control: Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
:param pulumi.Input[str] name: Location Name.
:param pulumi.Input[bool] ofw_enabled: Enable Firewall. When set to true, Firewall is enabled for the location.
:param pulumi.Input[int] parent_id: Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
:param pulumi.Input[str] ports: IP ports that are associated with the location.
:param pulumi.Input[str] profile: Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`. The supported options are: `NONE`, `CORPORATE`, `SERVER`, `GUESTWIFI`, `IOT`.
:param pulumi.Input[bool] ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
:param pulumi.Input[bool] surrogate_ip: Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
:param pulumi.Input[bool] surrogate_ip_enforced_for_known_browsers: Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
:param pulumi.Input[int] surrogate_refresh_time_in_minutes: Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
:param pulumi.Input[str] surrogate_refresh_time_unit: Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
:param pulumi.Input[str] tz: Timezone of the location. If not specified, it defaults to GMT.
:param pulumi.Input[int] up_bandwidth: Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[bool] xff_forward_enabled: Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
:param pulumi.Input[bool] zapp_ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
if aup_block_internet_until_accepted is not None:
pulumi.set(__self__, "aup_block_internet_until_accepted", aup_block_internet_until_accepted)
if aup_enabled is not None:
pulumi.set(__self__, "aup_enabled", aup_enabled)
if aup_force_ssl_inspection is not None:
pulumi.set(__self__, "aup_force_ssl_inspection", aup_force_ssl_inspection)
if aup_timeout_in_days is not None:
pulumi.set(__self__, "aup_timeout_in_days", aup_timeout_in_days)
if auth_required is not None:
pulumi.set(__self__, "auth_required", auth_required)
if caution_enabled is not None:
pulumi.set(__self__, "caution_enabled", caution_enabled)
if country is not None:
pulumi.set(__self__, "country", country)
if description is not None:
pulumi.set(__self__, "description", description)
if display_time_unit is not None:
pulumi.set(__self__, "display_time_unit", display_time_unit)
if dn_bandwidth is not None:
pulumi.set(__self__, "dn_bandwidth", dn_bandwidth)
if idle_time_in_minutes is not None:
pulumi.set(__self__, "idle_time_in_minutes", idle_time_in_minutes)
if ip_addresses is not None:
pulumi.set(__self__, "ip_addresses", ip_addresses)
if ips_control is not None:
pulumi.set(__self__, "ips_control", ips_control)
if name is not None:
pulumi.set(__self__, "name", name)
if ofw_enabled is not None:
pulumi.set(__self__, "ofw_enabled", ofw_enabled)
if parent_id is not None:
pulumi.set(__self__, "parent_id", parent_id)
if ports is not None:
pulumi.set(__self__, "ports", ports)
if profile is not None:
pulumi.set(__self__, "profile", profile)
if ssl_scan_enabled is not None:
pulumi.set(__self__, "ssl_scan_enabled", ssl_scan_enabled)
if surrogate_ip is not None:
pulumi.set(__self__, "surrogate_ip", surrogate_ip)
if surrogate_ip_enforced_for_known_browsers is not None:
pulumi.set(__self__, "surrogate_ip_enforced_for_known_browsers", surrogate_ip_enforced_for_known_browsers)
if surrogate_refresh_time_in_minutes is not None:
pulumi.set(__self__, "surrogate_refresh_time_in_minutes", surrogate_refresh_time_in_minutes)
if surrogate_refresh_time_unit is not None:
pulumi.set(__self__, "surrogate_refresh_time_unit", surrogate_refresh_time_unit)
if tz is not None:
pulumi.set(__self__, "tz", tz)
if up_bandwidth is not None:
pulumi.set(__self__, "up_bandwidth", up_bandwidth)
if vpn_credentials is not None:
pulumi.set(__self__, "vpn_credentials", vpn_credentials)
if xff_forward_enabled is not None:
pulumi.set(__self__, "xff_forward_enabled", xff_forward_enabled)
if zapp_ssl_scan_enabled is not None:
pulumi.set(__self__, "zapp_ssl_scan_enabled", zapp_ssl_scan_enabled)
@property
@pulumi.getter(name="aupBlockInternetUntilAccepted")
def aup_block_internet_until_accepted(self) -> Optional[pulumi.Input[bool]]:
"""
For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
"""
return pulumi.get(self, "aup_block_internet_until_accepted")
@aup_block_internet_until_accepted.setter
def aup_block_internet_until_accepted(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "aup_block_internet_until_accepted", value)
@property
@pulumi.getter(name="aupEnabled")
def aup_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable AUP. When set to true, AUP is enabled for the location.
"""
return pulumi.get(self, "aup_enabled")
@aup_enabled.setter
def aup_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "aup_enabled", value)
@property
@pulumi.getter(name="aupForceSslInspection")
def aup_force_ssl_inspection(self) -> Optional[pulumi.Input[bool]]:
"""
For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
"""
return pulumi.get(self, "aup_force_ssl_inspection")
@aup_force_ssl_inspection.setter
def aup_force_ssl_inspection(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "aup_force_ssl_inspection", value)
@property
@pulumi.getter(name="aupTimeoutInDays")
def aup_timeout_in_days(self) -> Optional[pulumi.Input[int]]:
"""
Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
"""
return pulumi.get(self, "aup_timeout_in_days")
@aup_timeout_in_days.setter
def aup_timeout_in_days(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "aup_timeout_in_days", value)
@property
@pulumi.getter(name="authRequired")
def auth_required(self) -> Optional[pulumi.Input[bool]]:
"""
Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
"""
return pulumi.get(self, "auth_required")
@auth_required.setter
def auth_required(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "auth_required", value)
@property
@pulumi.getter(name="cautionEnabled")
def caution_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable Caution. When set to true, a caution notifcation is enabled for the location.
"""
return pulumi.get(self, "caution_enabled")
@caution_enabled.setter
def caution_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "caution_enabled", value)
@property
@pulumi.getter
def country(self) -> Optional[pulumi.Input[str]]:
"""
Country
"""
return pulumi.get(self, "country")
@country.setter
def country(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "country", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="displayTimeUnit")
def display_time_unit(self) -> Optional[pulumi.Input[str]]:
"""
Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
"""
return pulumi.get(self, "display_time_unit")
@display_time_unit.setter
def display_time_unit(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "display_time_unit", value)
@property
@pulumi.getter(name="dnBandwidth")
def dn_bandwidth(self) -> Optional[pulumi.Input[int]]:
"""
Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "dn_bandwidth")
@dn_bandwidth.setter
def dn_bandwidth(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "dn_bandwidth", value)
@property
@pulumi.getter(name="idleTimeInMinutes")
def idle_time_in_minutes(self) -> Optional[pulumi.Input[int]]:
"""
Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
"""
return pulumi.get(self, "idle_time_in_minutes")
@idle_time_in_minutes.setter
def idle_time_in_minutes(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "idle_time_in_minutes", value)
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)). The value is required if `vpn_credentials` are not defined.
"""
return pulumi.get(self, "ip_addresses")
@ip_addresses.setter
def ip_addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_addresses", value)
@property
@pulumi.getter(name="ipsControl")
def ips_control(self) -> Optional[pulumi.Input[bool]]:
"""
Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
"""
return pulumi.get(self, "ips_control")
@ips_control.setter
def ips_control(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ips_control", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Location Name.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="ofwEnabled")
def ofw_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable Firewall. When set to true, Firewall is enabled for the location.
"""
return pulumi.get(self, "ofw_enabled")
@ofw_enabled.setter
def ofw_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ofw_enabled", value)
@property
@pulumi.getter(name="parentId")
def parent_id(self) -> Optional[pulumi.Input[int]]:
"""
Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
"""
return pulumi.get(self, "parent_id")
@parent_id.setter
def parent_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "parent_id", value)
@property
@pulumi.getter
def ports(self) -> Optional[pulumi.Input[str]]:
"""
IP ports that are associated with the location.
"""
return pulumi.get(self, "ports")
@ports.setter
def ports(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ports", value)
@property
@pulumi.getter
def profile(self) -> Optional[pulumi.Input[str]]:
"""
Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`. The supported options are: `NONE`, `CORPORATE`, `SERVER`, `GUESTWIFI`, `IOT`.
"""
return pulumi.get(self, "profile")
@profile.setter
def profile(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "profile", value)
@property
@pulumi.getter(name="sslScanEnabled")
def ssl_scan_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "ssl_scan_enabled")
@ssl_scan_enabled.setter
def ssl_scan_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ssl_scan_enabled", value)
@property
@pulumi.getter(name="surrogateIp")
def surrogate_ip(self) -> Optional[pulumi.Input[bool]]:
"""
Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
"""
return pulumi.get(self, "surrogate_ip")
@surrogate_ip.setter
def surrogate_ip(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "surrogate_ip", value)
@property
@pulumi.getter(name="surrogateIpEnforcedForKnownBrowsers")
def surrogate_ip_enforced_for_known_browsers(self) -> Optional[pulumi.Input[bool]]:
"""
Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
"""
return pulumi.get(self, "surrogate_ip_enforced_for_known_browsers")
@surrogate_ip_enforced_for_known_browsers.setter
def surrogate_ip_enforced_for_known_browsers(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "surrogate_ip_enforced_for_known_browsers", value)
@property
@pulumi.getter(name="surrogateRefreshTimeInMinutes")
def surrogate_refresh_time_in_minutes(self) -> Optional[pulumi.Input[int]]:
"""
Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
"""
return pulumi.get(self, "surrogate_refresh_time_in_minutes")
@surrogate_refresh_time_in_minutes.setter
def surrogate_refresh_time_in_minutes(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "surrogate_refresh_time_in_minutes", value)
@property
@pulumi.getter(name="surrogateRefreshTimeUnit")
def surrogate_refresh_time_unit(self) -> Optional[pulumi.Input[str]]:
"""
Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
"""
return pulumi.get(self, "surrogate_refresh_time_unit")
@surrogate_refresh_time_unit.setter
def surrogate_refresh_time_unit(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "surrogate_refresh_time_unit", value)
@property
@pulumi.getter
def tz(self) -> Optional[pulumi.Input[str]]:
"""
Timezone of the location. If not specified, it defaults to GMT.
"""
return pulumi.get(self, "tz")
@tz.setter
def tz(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "tz", value)
@property
@pulumi.getter(name="upBandwidth")
def up_bandwidth(self) -> Optional[pulumi.Input[int]]:
"""
Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "up_bandwidth")
@up_bandwidth.setter
def up_bandwidth(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "up_bandwidth", value)
@property
@pulumi.getter(name="vpnCredentials")
def vpn_credentials(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LocationManagementVpnCredentialArgs']]]]:
return pulumi.get(self, "vpn_credentials")
@vpn_credentials.setter
def vpn_credentials(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LocationManagementVpnCredentialArgs']]]]):
pulumi.set(self, "vpn_credentials", value)
@property
@pulumi.getter(name="xffForwardEnabled")
def xff_forward_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
"""
return pulumi.get(self, "xff_forward_enabled")
@xff_forward_enabled.setter
def xff_forward_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "xff_forward_enabled", value)
@property
@pulumi.getter(name="zappSslScanEnabled")
def zapp_ssl_scan_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "zapp_ssl_scan_enabled")
@zapp_ssl_scan_enabled.setter
def zapp_ssl_scan_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "zapp_ssl_scan_enabled", value)
@pulumi.input_type
class _LocationManagementState:
def __init__(__self__, *,
aup_block_internet_until_accepted: Optional[pulumi.Input[bool]] = None,
aup_enabled: Optional[pulumi.Input[bool]] = None,
aup_force_ssl_inspection: Optional[pulumi.Input[bool]] = None,
aup_timeout_in_days: Optional[pulumi.Input[int]] = None,
auth_required: Optional[pulumi.Input[bool]] = None,
caution_enabled: Optional[pulumi.Input[bool]] = None,
country: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
display_time_unit: Optional[pulumi.Input[str]] = None,
dn_bandwidth: Optional[pulumi.Input[int]] = None,
idle_time_in_minutes: Optional[pulumi.Input[int]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ips_control: Optional[pulumi.Input[bool]] = None,
location_id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
ofw_enabled: Optional[pulumi.Input[bool]] = None,
parent_id: Optional[pulumi.Input[int]] = None,
ports: Optional[pulumi.Input[str]] = None,
profile: Optional[pulumi.Input[str]] = None,
ssl_scan_enabled: Optional[pulumi.Input[bool]] = None,
surrogate_ip: Optional[pulumi.Input[bool]] = None,
surrogate_ip_enforced_for_known_browsers: Optional[pulumi.Input[bool]] = None,
surrogate_refresh_time_in_minutes: Optional[pulumi.Input[int]] = None,
surrogate_refresh_time_unit: Optional[pulumi.Input[str]] = None,
tz: Optional[pulumi.Input[str]] = None,
up_bandwidth: Optional[pulumi.Input[int]] = None,
vpn_credentials: Optional[pulumi.Input[Sequence[pulumi.Input['LocationManagementVpnCredentialArgs']]]] = None,
xff_forward_enabled: Optional[pulumi.Input[bool]] = None,
zapp_ssl_scan_enabled: Optional[pulumi.Input[bool]] = None):
"""
Input properties used for looking up and filtering LocationManagement resources.
:param pulumi.Input[bool] aup_block_internet_until_accepted: For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
:param pulumi.Input[bool] aup_enabled: Enable AUP. When set to true, AUP is enabled for the location.
:param pulumi.Input[bool] aup_force_ssl_inspection: For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
:param pulumi.Input[int] aup_timeout_in_days: Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
:param pulumi.Input[bool] auth_required: Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
:param pulumi.Input[bool] caution_enabled: Enable Caution. When set to true, a caution notifcation is enabled for the location.
:param pulumi.Input[str] country: Country
:param pulumi.Input[str] description: Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
:param pulumi.Input[str] display_time_unit: Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
:param pulumi.Input[int] dn_bandwidth: Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[int] idle_time_in_minutes: Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)). The value is required if `vpn_credentials` are not defined.
:param pulumi.Input[bool] ips_control: Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
:param pulumi.Input[str] name: Location Name.
:param pulumi.Input[bool] ofw_enabled: Enable Firewall. When set to true, Firewall is enabled for the location.
:param pulumi.Input[int] parent_id: Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
:param pulumi.Input[str] ports: IP ports that are associated with the location.
:param pulumi.Input[str] profile: Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`. The supported options are: `NONE`, `CORPORATE`, `SERVER`, `GUESTWIFI`, `IOT`.
:param pulumi.Input[bool] ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
:param pulumi.Input[bool] surrogate_ip: Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
:param pulumi.Input[bool] surrogate_ip_enforced_for_known_browsers: Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
:param pulumi.Input[int] surrogate_refresh_time_in_minutes: Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
:param pulumi.Input[str] surrogate_refresh_time_unit: Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
:param pulumi.Input[str] tz: Timezone of the location. If not specified, it defaults to GMT.
:param pulumi.Input[int] up_bandwidth: Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[bool] xff_forward_enabled: Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
:param pulumi.Input[bool] zapp_ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
if aup_block_internet_until_accepted is not None:
pulumi.set(__self__, "aup_block_internet_until_accepted", aup_block_internet_until_accepted)
if aup_enabled is not None:
pulumi.set(__self__, "aup_enabled", aup_enabled)
if aup_force_ssl_inspection is not None:
pulumi.set(__self__, "aup_force_ssl_inspection", aup_force_ssl_inspection)
if aup_timeout_in_days is not None:
pulumi.set(__self__, "aup_timeout_in_days", aup_timeout_in_days)
if auth_required is not None:
pulumi.set(__self__, "auth_required", auth_required)
if caution_enabled is not None:
pulumi.set(__self__, "caution_enabled", caution_enabled)
if country is not None:
pulumi.set(__self__, "country", country)
if description is not None:
pulumi.set(__self__, "description", description)
if display_time_unit is not None:
pulumi.set(__self__, "display_time_unit", display_time_unit)
if dn_bandwidth is not None:
pulumi.set(__self__, "dn_bandwidth", dn_bandwidth)
if idle_time_in_minutes is not None:
pulumi.set(__self__, "idle_time_in_minutes", idle_time_in_minutes)
if ip_addresses is not None:
pulumi.set(__self__, "ip_addresses", ip_addresses)
if ips_control is not None:
pulumi.set(__self__, "ips_control", ips_control)
if location_id is not None:
pulumi.set(__self__, "location_id", location_id)
if name is not None:
pulumi.set(__self__, "name", name)
if ofw_enabled is not None:
pulumi.set(__self__, "ofw_enabled", ofw_enabled)
if parent_id is not None:
pulumi.set(__self__, "parent_id", parent_id)
if ports is not None:
pulumi.set(__self__, "ports", ports)
if profile is not None:
pulumi.set(__self__, "profile", profile)
if ssl_scan_enabled is not None:
pulumi.set(__self__, "ssl_scan_enabled", ssl_scan_enabled)
if surrogate_ip is not None:
pulumi.set(__self__, "surrogate_ip", surrogate_ip)
if surrogate_ip_enforced_for_known_browsers is not None:
pulumi.set(__self__, "surrogate_ip_enforced_for_known_browsers", surrogate_ip_enforced_for_known_browsers)
if surrogate_refresh_time_in_minutes is not None:
pulumi.set(__self__, "surrogate_refresh_time_in_minutes", surrogate_refresh_time_in_minutes)
if surrogate_refresh_time_unit is not None:
pulumi.set(__self__, "surrogate_refresh_time_unit", surrogate_refresh_time_unit)
if tz is not None:
pulumi.set(__self__, "tz", tz)
if up_bandwidth is not None:
pulumi.set(__self__, "up_bandwidth", up_bandwidth)
if vpn_credentials is not None:
pulumi.set(__self__, "vpn_credentials", vpn_credentials)
if xff_forward_enabled is not None:
pulumi.set(__self__, "xff_forward_enabled", xff_forward_enabled)
if zapp_ssl_scan_enabled is not None:
pulumi.set(__self__, "zapp_ssl_scan_enabled", zapp_ssl_scan_enabled)
@property
@pulumi.getter(name="aupBlockInternetUntilAccepted")
def aup_block_internet_until_accepted(self) -> Optional[pulumi.Input[bool]]:
"""
For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
"""
return pulumi.get(self, "aup_block_internet_until_accepted")
@aup_block_internet_until_accepted.setter
def aup_block_internet_until_accepted(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "aup_block_internet_until_accepted", value)
@property
@pulumi.getter(name="aupEnabled")
def aup_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable AUP. When set to true, AUP is enabled for the location.
"""
return pulumi.get(self, "aup_enabled")
@aup_enabled.setter
def aup_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "aup_enabled", value)
@property
@pulumi.getter(name="aupForceSslInspection")
def aup_force_ssl_inspection(self) -> Optional[pulumi.Input[bool]]:
"""
For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
"""
return pulumi.get(self, "aup_force_ssl_inspection")
@aup_force_ssl_inspection.setter
def aup_force_ssl_inspection(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "aup_force_ssl_inspection", value)
@property
@pulumi.getter(name="aupTimeoutInDays")
def aup_timeout_in_days(self) -> Optional[pulumi.Input[int]]:
"""
Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
"""
return pulumi.get(self, "aup_timeout_in_days")
@aup_timeout_in_days.setter
def aup_timeout_in_days(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "aup_timeout_in_days", value)
@property
@pulumi.getter(name="authRequired")
def auth_required(self) -> Optional[pulumi.Input[bool]]:
"""
Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
"""
return pulumi.get(self, "auth_required")
@auth_required.setter
def auth_required(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "auth_required", value)
@property
@pulumi.getter(name="cautionEnabled")
def caution_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable Caution. When set to true, a caution notifcation is enabled for the location.
"""
return pulumi.get(self, "caution_enabled")
@caution_enabled.setter
def caution_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "caution_enabled", value)
@property
@pulumi.getter
def country(self) -> Optional[pulumi.Input[str]]:
"""
Country
"""
return pulumi.get(self, "country")
@country.setter
def country(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "country", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="displayTimeUnit")
def display_time_unit(self) -> Optional[pulumi.Input[str]]:
"""
Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
"""
return pulumi.get(self, "display_time_unit")
@display_time_unit.setter
def display_time_unit(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "display_time_unit", value)
@property
@pulumi.getter(name="dnBandwidth")
def dn_bandwidth(self) -> Optional[pulumi.Input[int]]:
"""
Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "dn_bandwidth")
@dn_bandwidth.setter
def dn_bandwidth(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "dn_bandwidth", value)
@property
@pulumi.getter(name="idleTimeInMinutes")
def idle_time_in_minutes(self) -> Optional[pulumi.Input[int]]:
"""
Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
"""
return pulumi.get(self, "idle_time_in_minutes")
@idle_time_in_minutes.setter
def idle_time_in_minutes(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "idle_time_in_minutes", value)
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)). The value is required if `vpn_credentials` are not defined.
"""
return pulumi.get(self, "ip_addresses")
@ip_addresses.setter
def ip_addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_addresses", value)
@property
@pulumi.getter(name="ipsControl")
def ips_control(self) -> Optional[pulumi.Input[bool]]:
"""
Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
"""
return pulumi.get(self, "ips_control")
@ips_control.setter
def ips_control(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ips_control", value)
@property
@pulumi.getter(name="locationId")
def location_id(self) -> Optional[pulumi.Input[int]]:
return pulumi.get(self, "location_id")
@location_id.setter
def location_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "location_id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Location Name.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="ofwEnabled")
def ofw_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable Firewall. When set to true, Firewall is enabled for the location.
"""
return pulumi.get(self, "ofw_enabled")
@ofw_enabled.setter
def ofw_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ofw_enabled", value)
@property
@pulumi.getter(name="parentId")
def parent_id(self) -> Optional[pulumi.Input[int]]:
"""
Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
"""
return pulumi.get(self, "parent_id")
@parent_id.setter
def parent_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "parent_id", value)
@property
@pulumi.getter
def ports(self) -> Optional[pulumi.Input[str]]:
"""
IP ports that are associated with the location.
"""
return pulumi.get(self, "ports")
@ports.setter
def ports(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ports", value)
@property
@pulumi.getter
def profile(self) -> Optional[pulumi.Input[str]]:
"""
Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`. The supported options are: `NONE`, `CORPORATE`, `SERVER`, `GUESTWIFI`, `IOT`.
"""
return pulumi.get(self, "profile")
@profile.setter
def profile(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "profile", value)
@property
@pulumi.getter(name="sslScanEnabled")
def ssl_scan_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "ssl_scan_enabled")
@ssl_scan_enabled.setter
def ssl_scan_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ssl_scan_enabled", value)
@property
@pulumi.getter(name="surrogateIp")
def surrogate_ip(self) -> Optional[pulumi.Input[bool]]:
"""
Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
"""
return pulumi.get(self, "surrogate_ip")
@surrogate_ip.setter
def surrogate_ip(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "surrogate_ip", value)
@property
@pulumi.getter(name="surrogateIpEnforcedForKnownBrowsers")
def surrogate_ip_enforced_for_known_browsers(self) -> Optional[pulumi.Input[bool]]:
"""
Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
"""
return pulumi.get(self, "surrogate_ip_enforced_for_known_browsers")
@surrogate_ip_enforced_for_known_browsers.setter
def surrogate_ip_enforced_for_known_browsers(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "surrogate_ip_enforced_for_known_browsers", value)
@property
@pulumi.getter(name="surrogateRefreshTimeInMinutes")
def surrogate_refresh_time_in_minutes(self) -> Optional[pulumi.Input[int]]:
"""
Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
"""
return pulumi.get(self, "surrogate_refresh_time_in_minutes")
@surrogate_refresh_time_in_minutes.setter
def surrogate_refresh_time_in_minutes(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "surrogate_refresh_time_in_minutes", value)
@property
@pulumi.getter(name="surrogateRefreshTimeUnit")
def surrogate_refresh_time_unit(self) -> Optional[pulumi.Input[str]]:
"""
Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
"""
return pulumi.get(self, "surrogate_refresh_time_unit")
@surrogate_refresh_time_unit.setter
def surrogate_refresh_time_unit(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "surrogate_refresh_time_unit", value)
@property
@pulumi.getter
def tz(self) -> Optional[pulumi.Input[str]]:
"""
Timezone of the location. If not specified, it defaults to GMT.
"""
return pulumi.get(self, "tz")
@tz.setter
def tz(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "tz", value)
@property
@pulumi.getter(name="upBandwidth")
def up_bandwidth(self) -> Optional[pulumi.Input[int]]:
"""
Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "up_bandwidth")
@up_bandwidth.setter
def up_bandwidth(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "up_bandwidth", value)
@property
@pulumi.getter(name="vpnCredentials")
def vpn_credentials(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LocationManagementVpnCredentialArgs']]]]:
return pulumi.get(self, "vpn_credentials")
@vpn_credentials.setter
def vpn_credentials(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LocationManagementVpnCredentialArgs']]]]):
pulumi.set(self, "vpn_credentials", value)
@property
@pulumi.getter(name="xffForwardEnabled")
def xff_forward_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
"""
return pulumi.get(self, "xff_forward_enabled")
@xff_forward_enabled.setter
def xff_forward_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "xff_forward_enabled", value)
@property
@pulumi.getter(name="zappSslScanEnabled")
def zapp_ssl_scan_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "zapp_ssl_scan_enabled")
@zapp_ssl_scan_enabled.setter
def zapp_ssl_scan_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "zapp_ssl_scan_enabled", value)
class LocationManagement(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
aup_block_internet_until_accepted: Optional[pulumi.Input[bool]] = None,
aup_enabled: Optional[pulumi.Input[bool]] = None,
aup_force_ssl_inspection: Optional[pulumi.Input[bool]] = None,
aup_timeout_in_days: Optional[pulumi.Input[int]] = None,
auth_required: Optional[pulumi.Input[bool]] = None,
caution_enabled: Optional[pulumi.Input[bool]] = None,
country: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
display_time_unit: Optional[pulumi.Input[str]] = None,
dn_bandwidth: Optional[pulumi.Input[int]] = None,
idle_time_in_minutes: Optional[pulumi.Input[int]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ips_control: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
ofw_enabled: Optional[pulumi.Input[bool]] = None,
parent_id: Optional[pulumi.Input[int]] = None,
ports: Optional[pulumi.Input[str]] = None,
profile: Optional[pulumi.Input[str]] = None,
ssl_scan_enabled: Optional[pulumi.Input[bool]] = None,
surrogate_ip: Optional[pulumi.Input[bool]] = None,
surrogate_ip_enforced_for_known_browsers: Optional[pulumi.Input[bool]] = None,
surrogate_refresh_time_in_minutes: Optional[pulumi.Input[int]] = None,
surrogate_refresh_time_unit: Optional[pulumi.Input[str]] = None,
tz: Optional[pulumi.Input[str]] = None,
up_bandwidth: Optional[pulumi.Input[int]] = None,
vpn_credentials: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LocationManagementVpnCredentialArgs']]]]] = None,
xff_forward_enabled: Optional[pulumi.Input[bool]] = None,
zapp_ssl_scan_enabled: Optional[pulumi.Input[bool]] = None,
__props__=None):
"""
The **zia_location_management** resource allows the creation and management of ZIA locations in the Zscaler Internet Access. This resource can then be associated with a:
* Static IP resource
* GRE Tunnel resource
* VPN credentials resource
* URL filtering and firewall filtering rules
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
usa_sjc37_traffic_forwarding_vpn_credentials = zia.traffic_forwarding.TrafficForwardingVPNCredentials("usaSjc37TrafficForwardingVPNCredentials",
type="UFQDN",
fqdn="[email protected]",
comments="USA - San Jose IPSec Tunnel",
pre_shared_key="P@ass0rd123!")
usa_sjc37_traffic_forwarding_static_ip = zia.traffic_forwarding.TrafficForwardingStaticIP("usaSjc37TrafficForwardingStaticIP",
ip_address="1.1.1.1",
routable_ip=True,
comment="SJC37 - Static IP",
geo_override=False)
# ZIA Location Management
usa_sjc37_location_management = zia.location_management.LocationManagement("usaSjc37LocationManagement",
description="Created with Terraform",
country="UNITED_STATES",
tz="UNITED_STATES_AMERICA_LOS_ANGELES",
auth_required=True,
idle_time_in_minutes=720,
display_time_unit="HOUR",
surrogate_ip=True,
xff_forward_enabled=True,
ofw_enabled=True,
ips_control=True,
ip_addresses=[usa_sjc37_traffic_forwarding_static_ip.ip_address],
vpn_credentials=[zia.location_management.LocationManagementVpnCredentialArgs(
id=usa_sjc37_traffic_forwarding_vpn_credentials.vpn_credental_id,
type=usa_sjc37_traffic_forwarding_vpn_credentials.type,
)],
opts=pulumi.ResourceOptions(depends_on=[
usa_sjc37_traffic_forwarding_vpn_credentials,
usa_sjc37_traffic_forwarding_static_ip,
]))
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[bool] aup_block_internet_until_accepted: For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
:param pulumi.Input[bool] aup_enabled: Enable AUP. When set to true, AUP is enabled for the location.
:param pulumi.Input[bool] aup_force_ssl_inspection: For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
:param pulumi.Input[int] aup_timeout_in_days: Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
:param pulumi.Input[bool] auth_required: Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
:param pulumi.Input[bool] caution_enabled: Enable Caution. When set to true, a caution notifcation is enabled for the location.
:param pulumi.Input[str] country: Country
:param pulumi.Input[str] description: Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
:param pulumi.Input[str] display_time_unit: Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
:param pulumi.Input[int] dn_bandwidth: Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[int] idle_time_in_minutes: Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)). The value is required if `vpn_credentials` are not defined.
:param pulumi.Input[bool] ips_control: Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
:param pulumi.Input[str] name: Location Name.
:param pulumi.Input[bool] ofw_enabled: Enable Firewall. When set to true, Firewall is enabled for the location.
:param pulumi.Input[int] parent_id: Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
:param pulumi.Input[str] ports: IP ports that are associated with the location.
:param pulumi.Input[str] profile: Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`. The supported options are: `NONE`, `CORPORATE`, `SERVER`, `GUESTWIFI`, `IOT`.
:param pulumi.Input[bool] ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
:param pulumi.Input[bool] surrogate_ip: Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
:param pulumi.Input[bool] surrogate_ip_enforced_for_known_browsers: Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
:param pulumi.Input[int] surrogate_refresh_time_in_minutes: Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
:param pulumi.Input[str] surrogate_refresh_time_unit: Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
:param pulumi.Input[str] tz: Timezone of the location. If not specified, it defaults to GMT.
:param pulumi.Input[int] up_bandwidth: Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[bool] xff_forward_enabled: Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
:param pulumi.Input[bool] zapp_ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[LocationManagementArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_location_management** resource allows the creation and management of ZIA locations in the Zscaler Internet Access. This resource can then be associated with a:
* Static IP resource
* GRE Tunnel resource
* VPN credentials resource
* URL filtering and firewall filtering rules
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
usa_sjc37_traffic_forwarding_vpn_credentials = zia.traffic_forwarding.TrafficForwardingVPNCredentials("usaSjc37TrafficForwardingVPNCredentials",
type="UFQDN",
fqdn="[email protected]",
comments="USA - San Jose IPSec Tunnel",
pre_shared_key="P@ass0rd123!")
usa_sjc37_traffic_forwarding_static_ip = zia.traffic_forwarding.TrafficForwardingStaticIP("usaSjc37TrafficForwardingStaticIP",
ip_address="1.1.1.1",
routable_ip=True,
comment="SJC37 - Static IP",
geo_override=False)
# ZIA Location Management
usa_sjc37_location_management = zia.location_management.LocationManagement("usaSjc37LocationManagement",
description="Created with Terraform",
country="UNITED_STATES",
tz="UNITED_STATES_AMERICA_LOS_ANGELES",
auth_required=True,
idle_time_in_minutes=720,
display_time_unit="HOUR",
surrogate_ip=True,
xff_forward_enabled=True,
ofw_enabled=True,
ips_control=True,
ip_addresses=[usa_sjc37_traffic_forwarding_static_ip.ip_address],
vpn_credentials=[zia.location_management.LocationManagementVpnCredentialArgs(
id=usa_sjc37_traffic_forwarding_vpn_credentials.vpn_credental_id,
type=usa_sjc37_traffic_forwarding_vpn_credentials.type,
)],
opts=pulumi.ResourceOptions(depends_on=[
usa_sjc37_traffic_forwarding_vpn_credentials,
usa_sjc37_traffic_forwarding_static_ip,
]))
```
:param str resource_name: The name of the resource.
:param LocationManagementArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(LocationManagementArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
aup_block_internet_until_accepted: Optional[pulumi.Input[bool]] = None,
aup_enabled: Optional[pulumi.Input[bool]] = None,
aup_force_ssl_inspection: Optional[pulumi.Input[bool]] = None,
aup_timeout_in_days: Optional[pulumi.Input[int]] = None,
auth_required: Optional[pulumi.Input[bool]] = None,
caution_enabled: Optional[pulumi.Input[bool]] = None,
country: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
display_time_unit: Optional[pulumi.Input[str]] = None,
dn_bandwidth: Optional[pulumi.Input[int]] = None,
idle_time_in_minutes: Optional[pulumi.Input[int]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ips_control: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
ofw_enabled: Optional[pulumi.Input[bool]] = None,
parent_id: Optional[pulumi.Input[int]] = None,
ports: Optional[pulumi.Input[str]] = None,
profile: Optional[pulumi.Input[str]] = None,
ssl_scan_enabled: Optional[pulumi.Input[bool]] = None,
surrogate_ip: Optional[pulumi.Input[bool]] = None,
surrogate_ip_enforced_for_known_browsers: Optional[pulumi.Input[bool]] = None,
surrogate_refresh_time_in_minutes: Optional[pulumi.Input[int]] = None,
surrogate_refresh_time_unit: Optional[pulumi.Input[str]] = None,
tz: Optional[pulumi.Input[str]] = None,
up_bandwidth: Optional[pulumi.Input[int]] = None,
vpn_credentials: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LocationManagementVpnCredentialArgs']]]]] = None,
xff_forward_enabled: Optional[pulumi.Input[bool]] = None,
zapp_ssl_scan_enabled: Optional[pulumi.Input[bool]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = LocationManagementArgs.__new__(LocationManagementArgs)
__props__.__dict__["aup_block_internet_until_accepted"] = aup_block_internet_until_accepted
__props__.__dict__["aup_enabled"] = aup_enabled
__props__.__dict__["aup_force_ssl_inspection"] = aup_force_ssl_inspection
__props__.__dict__["aup_timeout_in_days"] = aup_timeout_in_days
__props__.__dict__["auth_required"] = auth_required
__props__.__dict__["caution_enabled"] = caution_enabled
__props__.__dict__["country"] = country
__props__.__dict__["description"] = description
__props__.__dict__["display_time_unit"] = display_time_unit
__props__.__dict__["dn_bandwidth"] = dn_bandwidth
__props__.__dict__["idle_time_in_minutes"] = idle_time_in_minutes
__props__.__dict__["ip_addresses"] = ip_addresses
__props__.__dict__["ips_control"] = ips_control
__props__.__dict__["name"] = name
__props__.__dict__["ofw_enabled"] = ofw_enabled
__props__.__dict__["parent_id"] = parent_id
__props__.__dict__["ports"] = ports
__props__.__dict__["profile"] = profile
__props__.__dict__["ssl_scan_enabled"] = ssl_scan_enabled
__props__.__dict__["surrogate_ip"] = surrogate_ip
__props__.__dict__["surrogate_ip_enforced_for_known_browsers"] = surrogate_ip_enforced_for_known_browsers
__props__.__dict__["surrogate_refresh_time_in_minutes"] = surrogate_refresh_time_in_minutes
__props__.__dict__["surrogate_refresh_time_unit"] = surrogate_refresh_time_unit
__props__.__dict__["tz"] = tz
__props__.__dict__["up_bandwidth"] = up_bandwidth
__props__.__dict__["vpn_credentials"] = vpn_credentials
__props__.__dict__["xff_forward_enabled"] = xff_forward_enabled
__props__.__dict__["zapp_ssl_scan_enabled"] = zapp_ssl_scan_enabled
__props__.__dict__["location_id"] = None
super(LocationManagement, __self__).__init__(
'zia:LocationManagement/locationManagement:LocationManagement',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
aup_block_internet_until_accepted: Optional[pulumi.Input[bool]] = None,
aup_enabled: Optional[pulumi.Input[bool]] = None,
aup_force_ssl_inspection: Optional[pulumi.Input[bool]] = None,
aup_timeout_in_days: Optional[pulumi.Input[int]] = None,
auth_required: Optional[pulumi.Input[bool]] = None,
caution_enabled: Optional[pulumi.Input[bool]] = None,
country: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
display_time_unit: Optional[pulumi.Input[str]] = None,
dn_bandwidth: Optional[pulumi.Input[int]] = None,
idle_time_in_minutes: Optional[pulumi.Input[int]] = None,
ip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
ips_control: Optional[pulumi.Input[bool]] = None,
location_id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
ofw_enabled: Optional[pulumi.Input[bool]] = None,
parent_id: Optional[pulumi.Input[int]] = None,
ports: Optional[pulumi.Input[str]] = None,
profile: Optional[pulumi.Input[str]] = None,
ssl_scan_enabled: Optional[pulumi.Input[bool]] = None,
surrogate_ip: Optional[pulumi.Input[bool]] = None,
surrogate_ip_enforced_for_known_browsers: Optional[pulumi.Input[bool]] = None,
surrogate_refresh_time_in_minutes: Optional[pulumi.Input[int]] = None,
surrogate_refresh_time_unit: Optional[pulumi.Input[str]] = None,
tz: Optional[pulumi.Input[str]] = None,
up_bandwidth: Optional[pulumi.Input[int]] = None,
vpn_credentials: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LocationManagementVpnCredentialArgs']]]]] = None,
xff_forward_enabled: Optional[pulumi.Input[bool]] = None,
zapp_ssl_scan_enabled: Optional[pulumi.Input[bool]] = None) -> 'LocationManagement':
"""
Get an existing LocationManagement resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[bool] aup_block_internet_until_accepted: For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
:param pulumi.Input[bool] aup_enabled: Enable AUP. When set to true, AUP is enabled for the location.
:param pulumi.Input[bool] aup_force_ssl_inspection: For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
:param pulumi.Input[int] aup_timeout_in_days: Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
:param pulumi.Input[bool] auth_required: Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
:param pulumi.Input[bool] caution_enabled: Enable Caution. When set to true, a caution notifcation is enabled for the location.
:param pulumi.Input[str] country: Country
:param pulumi.Input[str] description: Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
:param pulumi.Input[str] display_time_unit: Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
:param pulumi.Input[int] dn_bandwidth: Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[int] idle_time_in_minutes: Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
:param pulumi.Input[Sequence[pulumi.Input[str]]] ip_addresses: For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)). The value is required if `vpn_credentials` are not defined.
:param pulumi.Input[bool] ips_control: Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
:param pulumi.Input[str] name: Location Name.
:param pulumi.Input[bool] ofw_enabled: Enable Firewall. When set to true, Firewall is enabled for the location.
:param pulumi.Input[int] parent_id: Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
:param pulumi.Input[str] ports: IP ports that are associated with the location.
:param pulumi.Input[str] profile: Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`. The supported options are: `NONE`, `CORPORATE`, `SERVER`, `GUESTWIFI`, `IOT`.
:param pulumi.Input[bool] ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
:param pulumi.Input[bool] surrogate_ip: Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
:param pulumi.Input[bool] surrogate_ip_enforced_for_known_browsers: Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
:param pulumi.Input[int] surrogate_refresh_time_in_minutes: Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
:param pulumi.Input[str] surrogate_refresh_time_unit: Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
:param pulumi.Input[str] tz: Timezone of the location. If not specified, it defaults to GMT.
:param pulumi.Input[int] up_bandwidth: Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
:param pulumi.Input[bool] xff_forward_enabled: Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
:param pulumi.Input[bool] zapp_ssl_scan_enabled: This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _LocationManagementState.__new__(_LocationManagementState)
__props__.__dict__["aup_block_internet_until_accepted"] = aup_block_internet_until_accepted
__props__.__dict__["aup_enabled"] = aup_enabled
__props__.__dict__["aup_force_ssl_inspection"] = aup_force_ssl_inspection
__props__.__dict__["aup_timeout_in_days"] = aup_timeout_in_days
__props__.__dict__["auth_required"] = auth_required
__props__.__dict__["caution_enabled"] = caution_enabled
__props__.__dict__["country"] = country
__props__.__dict__["description"] = description
__props__.__dict__["display_time_unit"] = display_time_unit
__props__.__dict__["dn_bandwidth"] = dn_bandwidth
__props__.__dict__["idle_time_in_minutes"] = idle_time_in_minutes
__props__.__dict__["ip_addresses"] = ip_addresses
__props__.__dict__["ips_control"] = ips_control
__props__.__dict__["location_id"] = location_id
__props__.__dict__["name"] = name
__props__.__dict__["ofw_enabled"] = ofw_enabled
__props__.__dict__["parent_id"] = parent_id
__props__.__dict__["ports"] = ports
__props__.__dict__["profile"] = profile
__props__.__dict__["ssl_scan_enabled"] = ssl_scan_enabled
__props__.__dict__["surrogate_ip"] = surrogate_ip
__props__.__dict__["surrogate_ip_enforced_for_known_browsers"] = surrogate_ip_enforced_for_known_browsers
__props__.__dict__["surrogate_refresh_time_in_minutes"] = surrogate_refresh_time_in_minutes
__props__.__dict__["surrogate_refresh_time_unit"] = surrogate_refresh_time_unit
__props__.__dict__["tz"] = tz
__props__.__dict__["up_bandwidth"] = up_bandwidth
__props__.__dict__["vpn_credentials"] = vpn_credentials
__props__.__dict__["xff_forward_enabled"] = xff_forward_enabled
__props__.__dict__["zapp_ssl_scan_enabled"] = zapp_ssl_scan_enabled
return LocationManagement(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="aupBlockInternetUntilAccepted")
def aup_block_internet_until_accepted(self) -> pulumi.Output[bool]:
"""
For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
"""
return pulumi.get(self, "aup_block_internet_until_accepted")
@property
@pulumi.getter(name="aupEnabled")
def aup_enabled(self) -> pulumi.Output[bool]:
"""
Enable AUP. When set to true, AUP is enabled for the location.
"""
return pulumi.get(self, "aup_enabled")
@property
@pulumi.getter(name="aupForceSslInspection")
def aup_force_ssl_inspection(self) -> pulumi.Output[bool]:
"""
For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
"""
return pulumi.get(self, "aup_force_ssl_inspection")
@property
@pulumi.getter(name="aupTimeoutInDays")
def aup_timeout_in_days(self) -> pulumi.Output[Optional[int]]:
"""
Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
"""
return pulumi.get(self, "aup_timeout_in_days")
@property
@pulumi.getter(name="authRequired")
def auth_required(self) -> pulumi.Output[bool]:
"""
Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
"""
return pulumi.get(self, "auth_required")
@property
@pulumi.getter(name="cautionEnabled")
def caution_enabled(self) -> pulumi.Output[bool]:
"""
Enable Caution. When set to true, a caution notifcation is enabled for the location.
"""
return pulumi.get(self, "caution_enabled")
@property
@pulumi.getter
def country(self) -> pulumi.Output[str]:
"""
Country
"""
return pulumi.get(self, "country")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="displayTimeUnit")
def display_time_unit(self) -> pulumi.Output[Optional[str]]:
"""
Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
"""
return pulumi.get(self, "display_time_unit")
@property
@pulumi.getter(name="dnBandwidth")
def dn_bandwidth(self) -> pulumi.Output[Optional[int]]:
"""
Download bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "dn_bandwidth")
@property
@pulumi.getter(name="idleTimeInMinutes")
def idle_time_in_minutes(self) -> pulumi.Output[Optional[int]]:
"""
Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
"""
return pulumi.get(self, "idle_time_in_minutes")
@property
@pulumi.getter(name="ipAddresses")
def ip_addresses(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., `238.10.33.9`). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., `10.10.33.0/24`), or range (e.g., `10.10.33.1-10.10.33.10`)). The value is required if `vpn_credentials` are not defined.
"""
return pulumi.get(self, "ip_addresses")
@property
@pulumi.getter(name="ipsControl")
def ips_control(self) -> pulumi.Output[bool]:
"""
Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
"""
return pulumi.get(self, "ips_control")
@property
@pulumi.getter(name="locationId")
def location_id(self) -> pulumi.Output[int]:
return pulumi.get(self, "location_id")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Location Name.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="ofwEnabled")
def ofw_enabled(self) -> pulumi.Output[bool]:
"""
Enable Firewall. When set to true, Firewall is enabled for the location.
"""
return pulumi.get(self, "ofw_enabled")
@property
@pulumi.getter(name="parentId")
def parent_id(self) -> pulumi.Output[Optional[int]]:
"""
Parent Location ID. If this ID does not exist or is `0`, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: `SUB`
"""
return pulumi.get(self, "parent_id")
@property
@pulumi.getter
def ports(self) -> pulumi.Output[Optional[str]]:
"""
IP ports that are associated with the location.
"""
return pulumi.get(self, "ports")
@property
@pulumi.getter
def profile(self) -> pulumi.Output[str]:
"""
Profile tag that specifies the location traffic type. If not specified, this tag defaults to `Unassigned`. The supported options are: `NONE`, `CORPORATE`, `SERVER`, `GUESTWIFI`, `IOT`.
"""
return pulumi.get(self, "profile")
@property
@pulumi.getter(name="sslScanEnabled")
def ssl_scan_enabled(self) -> pulumi.Output[bool]:
"""
This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "ssl_scan_enabled")
@property
@pulumi.getter(name="surrogateIp")
def surrogate_ip(self) -> pulumi.Output[bool]:
"""
Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
"""
return pulumi.get(self, "surrogate_ip")
@property
@pulumi.getter(name="surrogateIpEnforcedForKnownBrowsers")
def surrogate_ip_enforced_for_known_browsers(self) -> pulumi.Output[bool]:
"""
Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
"""
return pulumi.get(self, "surrogate_ip_enforced_for_known_browsers")
@property
@pulumi.getter(name="surrogateRefreshTimeInMinutes")
def surrogate_refresh_time_in_minutes(self) -> pulumi.Output[Optional[int]]:
"""
Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
"""
return pulumi.get(self, "surrogate_refresh_time_in_minutes")
@property
@pulumi.getter(name="surrogateRefreshTimeUnit")
def surrogate_refresh_time_unit(self) -> pulumi.Output[Optional[str]]:
"""
Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
"""
return pulumi.get(self, "surrogate_refresh_time_unit")
@property
@pulumi.getter
def tz(self) -> pulumi.Output[str]:
"""
Timezone of the location. If not specified, it defaults to GMT.
"""
return pulumi.get(self, "tz")
@property
@pulumi.getter(name="upBandwidth")
def up_bandwidth(self) -> pulumi.Output[Optional[int]]:
"""
Upload bandwidth in bytes. The value `0` implies no Bandwidth Control enforcement.
"""
return pulumi.get(self, "up_bandwidth")
@property
@pulumi.getter(name="vpnCredentials")
def vpn_credentials(self) -> pulumi.Output[Optional[Sequence['outputs.LocationManagementVpnCredential']]]:
return pulumi.get(self, "vpn_credentials")
@property
@pulumi.getter(name="xffForwardEnabled")
def xff_forward_enabled(self) -> pulumi.Output[bool]:
"""
Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
"""
return pulumi.get(self, "xff_forward_enabled")
@property
@pulumi.getter(name="zappSslScanEnabled")
def zapp_ssl_scan_enabled(self) -> pulumi.Output[bool]:
"""
This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
"""
return pulumi.get(self, "zapp_ssl_scan_enabled") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/locationmanagement/location_management.py | location_management.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'URLFilteringRulesDepartmentsArgs',
'URLFilteringRulesDeviceGroupsArgs',
'URLFilteringRulesDevicesArgs',
'URLFilteringRulesGroupsArgs',
'URLFilteringRulesLabelsArgs',
'URLFilteringRulesLastModifiedByArgs',
'URLFilteringRulesLocationGroupsArgs',
'URLFilteringRulesLocationsArgs',
'URLFilteringRulesOverrideGroupsArgs',
'URLFilteringRulesOverrideUsersArgs',
'URLFilteringRulesTimeWindowsArgs',
'URLFilteringRulesUsersArgs',
]
@pulumi.input_type
class URLFilteringRulesDepartmentsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesDeviceGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesDevicesArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesLabelsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesLastModifiedByArgs:
def __init__(__self__, *,
extensions: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[int] id: Identifier that uniquely identifies an entity
:param pulumi.Input[str] name: Name of the Firewall Filtering policy rule
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
return pulumi.get(self, "extensions")
@extensions.setter
def extensions(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
pulumi.set(self, "extensions", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[int]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class URLFilteringRulesLocationGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesLocationsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesOverrideGroupsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesOverrideUsersArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesTimeWindowsArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class URLFilteringRulesUsersArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[int]]]):
"""
:param pulumi.Input[Sequence[pulumi.Input[int]]] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[int]]]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[int]]]):
pulumi.set(self, "ids", value) | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlfiltering/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['URLFilteringRulesArgs', 'URLFilteringRules']
@pulumi.input_type
class URLFilteringRulesArgs:
def __init__(__self__, *,
order: pulumi.Input[int],
protocols: pulumi.Input[Sequence[pulumi.Input[str]]],
action: Optional[pulumi.Input[str]] = None,
block_override: Optional[pulumi.Input[bool]] = None,
ciparule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input['URLFilteringRulesDepartmentsArgs']] = None,
description: Optional[pulumi.Input[str]] = None,
device_groups: Optional[pulumi.Input['URLFilteringRulesDeviceGroupsArgs']] = None,
device_trust_levels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
devices: Optional[pulumi.Input['URLFilteringRulesDevicesArgs']] = None,
end_user_notification_url: Optional[pulumi.Input[str]] = None,
enforce_time_validity: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input['URLFilteringRulesGroupsArgs']] = None,
labels: Optional[pulumi.Input['URLFilteringRulesLabelsArgs']] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input['URLFilteringRulesLocationGroupsArgs']] = None,
locations: Optional[pulumi.Input['URLFilteringRulesLocationsArgs']] = None,
name: Optional[pulumi.Input[str]] = None,
override_groups: Optional[pulumi.Input['URLFilteringRulesOverrideGroupsArgs']] = None,
override_users: Optional[pulumi.Input['URLFilteringRulesOverrideUsersArgs']] = None,
rank: Optional[pulumi.Input[int]] = None,
request_methods: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
size_quota: Optional[pulumi.Input[int]] = None,
state: Optional[pulumi.Input[str]] = None,
time_quota: Optional[pulumi.Input[int]] = None,
time_windows: Optional[pulumi.Input['URLFilteringRulesTimeWindowsArgs']] = None,
url_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
user_agent_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
users: Optional[pulumi.Input['URLFilteringRulesUsersArgs']] = None,
validity_end_time: Optional[pulumi.Input[int]] = None,
validity_start_time: Optional[pulumi.Input[int]] = None,
validity_time_zone_id: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a URLFilteringRules resource.
:param pulumi.Input[int] order: Order of execution of rule with respect to other URL Filtering rules
:param pulumi.Input[Sequence[pulumi.Input[str]]] protocols: 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`.
:param pulumi.Input[str] action: Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
:param pulumi.Input[bool] block_override: When set to true, a `BLOCK` action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
:param pulumi.Input[bool] ciparule: If set to true, the CIPA Compliance rule is enabled
:param pulumi.Input['URLFilteringRulesDepartmentsArgs'] departments: The departments to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] description: Additional information about the rule
:param pulumi.Input['URLFilteringRulesDeviceGroupsArgs'] device_groups: list of device groups
:param pulumi.Input[Sequence[pulumi.Input[str]]] device_trust_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`
:param pulumi.Input['URLFilteringRulesDevicesArgs'] devices: list of devices
:param pulumi.Input[str] end_user_notification_url: URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
:param pulumi.Input[bool] enforce_time_validity: Enforce a set a validity time period for the URL Filtering rule.
:param pulumi.Input['URLFilteringRulesGroupsArgs'] groups: The groups to which the Firewall Filtering policy rule applies
:param pulumi.Input['URLFilteringRulesLabelsArgs'] labels: list of labels
:param pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]] last_modified_bies: Who modified the rule last
:param pulumi.Input[int] last_modified_time: When the rule was last modified
:param pulumi.Input['URLFilteringRulesLocationGroupsArgs'] location_groups: The location groups to which the Firewall Filtering policy rule applies
:param pulumi.Input['URLFilteringRulesLocationsArgs'] locations: The locations to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] name: Name of the Firewall Filtering policy rule
:param pulumi.Input['URLFilteringRulesOverrideGroupsArgs'] override_groups: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
:param pulumi.Input['URLFilteringRulesOverrideUsersArgs'] override_users: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
:param pulumi.Input[int] rank: Admin rank of the admin who creates this rule
:param pulumi.Input[Sequence[pulumi.Input[str]]] request_methods: Request method for which the rule must be applied. If not set, rule will be applied to all methods
:param pulumi.Input[int] size_quota: 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.
:param pulumi.Input[str] state: Rule State
:param pulumi.Input[int] time_quota: 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.
:param pulumi.Input['URLFilteringRulesTimeWindowsArgs'] time_windows: The time interval in which the Firewall Filtering policy rule applies
:param pulumi.Input[Sequence[pulumi.Input[str]]] url_categories: List of URL categories for which rule must be applied
:param pulumi.Input['URLFilteringRulesUsersArgs'] users: The users to which the Firewall Filtering policy rule applies
:param pulumi.Input[int] validity_end_time: If `enforceTimeValidity` is set to true, the URL Filtering rule will cease to be valid on this end date and time.
:param pulumi.Input[int] validity_start_time: If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
:param pulumi.Input[str] validity_time_zone_id: If `enforceTimeValidity` is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
pulumi.set(__self__, "order", order)
pulumi.set(__self__, "protocols", protocols)
if action is not None:
pulumi.set(__self__, "action", action)
if block_override is not None:
pulumi.set(__self__, "block_override", block_override)
if ciparule is not None:
pulumi.set(__self__, "ciparule", ciparule)
if departments is not None:
pulumi.set(__self__, "departments", departments)
if description is not None:
pulumi.set(__self__, "description", description)
if device_groups is not None:
pulumi.set(__self__, "device_groups", device_groups)
if device_trust_levels is not None:
pulumi.set(__self__, "device_trust_levels", device_trust_levels)
if devices is not None:
pulumi.set(__self__, "devices", devices)
if end_user_notification_url is not None:
pulumi.set(__self__, "end_user_notification_url", end_user_notification_url)
if enforce_time_validity is not None:
pulumi.set(__self__, "enforce_time_validity", enforce_time_validity)
if groups is not None:
pulumi.set(__self__, "groups", groups)
if labels is not None:
pulumi.set(__self__, "labels", labels)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time is not None:
pulumi.set(__self__, "last_modified_time", last_modified_time)
if location_groups is not None:
pulumi.set(__self__, "location_groups", location_groups)
if locations is not None:
pulumi.set(__self__, "locations", locations)
if name is not None:
pulumi.set(__self__, "name", name)
if override_groups is not None:
pulumi.set(__self__, "override_groups", override_groups)
if override_users is not None:
pulumi.set(__self__, "override_users", override_users)
if rank is not None:
pulumi.set(__self__, "rank", rank)
if request_methods is not None:
pulumi.set(__self__, "request_methods", request_methods)
if size_quota is not None:
pulumi.set(__self__, "size_quota", size_quota)
if state is not None:
pulumi.set(__self__, "state", state)
if time_quota is not None:
pulumi.set(__self__, "time_quota", time_quota)
if time_windows is not None:
pulumi.set(__self__, "time_windows", time_windows)
if url_categories is not None:
pulumi.set(__self__, "url_categories", url_categories)
if user_agent_types is not None:
pulumi.set(__self__, "user_agent_types", user_agent_types)
if users is not None:
pulumi.set(__self__, "users", users)
if validity_end_time is not None:
pulumi.set(__self__, "validity_end_time", validity_end_time)
if validity_start_time is not None:
pulumi.set(__self__, "validity_start_time", validity_start_time)
if validity_time_zone_id is not None:
pulumi.set(__self__, "validity_time_zone_id", validity_time_zone_id)
@property
@pulumi.getter
def order(self) -> pulumi.Input[int]:
"""
Order of execution of rule with respect to other URL Filtering rules
"""
return pulumi.get(self, "order")
@order.setter
def order(self, value: pulumi.Input[int]):
pulumi.set(self, "order", value)
@property
@pulumi.getter
def protocols(self) -> pulumi.Input[Sequence[pulumi.Input[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`.
"""
return pulumi.get(self, "protocols")
@protocols.setter
def protocols(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "protocols", value)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="blockOverride")
def block_override(self) -> Optional[pulumi.Input[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, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
"""
return pulumi.get(self, "block_override")
@block_override.setter
def block_override(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "block_override", value)
@property
@pulumi.getter
def ciparule(self) -> Optional[pulumi.Input[bool]]:
"""
If set to true, the CIPA Compliance rule is enabled
"""
return pulumi.get(self, "ciparule")
@ciparule.setter
def ciparule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ciparule", value)
@property
@pulumi.getter
def departments(self) -> Optional[pulumi.Input['URLFilteringRulesDepartmentsArgs']]:
"""
The departments to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "departments")
@departments.setter
def departments(self, value: Optional[pulumi.Input['URLFilteringRulesDepartmentsArgs']]):
pulumi.set(self, "departments", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about the rule
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="deviceGroups")
def device_groups(self) -> Optional[pulumi.Input['URLFilteringRulesDeviceGroupsArgs']]:
"""
list of device groups
"""
return pulumi.get(self, "device_groups")
@device_groups.setter
def device_groups(self, value: Optional[pulumi.Input['URLFilteringRulesDeviceGroupsArgs']]):
pulumi.set(self, "device_groups", value)
@property
@pulumi.getter(name="deviceTrustLevels")
def device_trust_levels(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation. Supported values: `ANY`, `UNKNOWN_DEVICETRUSTLEVEL`, `LOW_TRUST`, `MEDIUM_TRUST`, `HIGH_TRUST`
"""
return pulumi.get(self, "device_trust_levels")
@device_trust_levels.setter
def device_trust_levels(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "device_trust_levels", value)
@property
@pulumi.getter
def devices(self) -> Optional[pulumi.Input['URLFilteringRulesDevicesArgs']]:
"""
list of devices
"""
return pulumi.get(self, "devices")
@devices.setter
def devices(self, value: Optional[pulumi.Input['URLFilteringRulesDevicesArgs']]):
pulumi.set(self, "devices", value)
@property
@pulumi.getter(name="endUserNotificationUrl")
def end_user_notification_url(self) -> Optional[pulumi.Input[str]]:
"""
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
"""
return pulumi.get(self, "end_user_notification_url")
@end_user_notification_url.setter
def end_user_notification_url(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "end_user_notification_url", value)
@property
@pulumi.getter(name="enforceTimeValidity")
def enforce_time_validity(self) -> Optional[pulumi.Input[bool]]:
"""
Enforce a set a validity time period for the URL Filtering rule.
"""
return pulumi.get(self, "enforce_time_validity")
@enforce_time_validity.setter
def enforce_time_validity(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enforce_time_validity", value)
@property
@pulumi.getter
def groups(self) -> Optional[pulumi.Input['URLFilteringRulesGroupsArgs']]:
"""
The groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "groups")
@groups.setter
def groups(self, value: Optional[pulumi.Input['URLFilteringRulesGroupsArgs']]):
pulumi.set(self, "groups", value)
@property
@pulumi.getter
def labels(self) -> Optional[pulumi.Input['URLFilteringRulesLabelsArgs']]:
"""
list of labels
"""
return pulumi.get(self, "labels")
@labels.setter
def labels(self, value: Optional[pulumi.Input['URLFilteringRulesLabelsArgs']]):
pulumi.set(self, "labels", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]]]:
"""
Who modified the rule last
"""
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> Optional[pulumi.Input[int]]:
"""
When the rule was last modified
"""
return pulumi.get(self, "last_modified_time")
@last_modified_time.setter
def last_modified_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "last_modified_time", value)
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> Optional[pulumi.Input['URLFilteringRulesLocationGroupsArgs']]:
"""
The location groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "location_groups")
@location_groups.setter
def location_groups(self, value: Optional[pulumi.Input['URLFilteringRulesLocationGroupsArgs']]):
pulumi.set(self, "location_groups", value)
@property
@pulumi.getter
def locations(self) -> Optional[pulumi.Input['URLFilteringRulesLocationsArgs']]:
"""
The locations to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "locations")
@locations.setter
def locations(self, value: Optional[pulumi.Input['URLFilteringRulesLocationsArgs']]):
pulumi.set(self, "locations", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="overrideGroups")
def override_groups(self) -> Optional[pulumi.Input['URLFilteringRulesOverrideGroupsArgs']]:
"""
Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
"""
return pulumi.get(self, "override_groups")
@override_groups.setter
def override_groups(self, value: Optional[pulumi.Input['URLFilteringRulesOverrideGroupsArgs']]):
pulumi.set(self, "override_groups", value)
@property
@pulumi.getter(name="overrideUsers")
def override_users(self) -> Optional[pulumi.Input['URLFilteringRulesOverrideUsersArgs']]:
"""
Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
"""
return pulumi.get(self, "override_users")
@override_users.setter
def override_users(self, value: Optional[pulumi.Input['URLFilteringRulesOverrideUsersArgs']]):
pulumi.set(self, "override_users", value)
@property
@pulumi.getter
def rank(self) -> Optional[pulumi.Input[int]]:
"""
Admin rank of the admin who creates this rule
"""
return pulumi.get(self, "rank")
@rank.setter
def rank(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "rank", value)
@property
@pulumi.getter(name="requestMethods")
def request_methods(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Request method for which the rule must be applied. If not set, rule will be applied to all methods
"""
return pulumi.get(self, "request_methods")
@request_methods.setter
def request_methods(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "request_methods", value)
@property
@pulumi.getter(name="sizeQuota")
def size_quota(self) -> Optional[pulumi.Input[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.
"""
return pulumi.get(self, "size_quota")
@size_quota.setter
def size_quota(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "size_quota", value)
@property
@pulumi.getter
def state(self) -> Optional[pulumi.Input[str]]:
"""
Rule State
"""
return pulumi.get(self, "state")
@state.setter
def state(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "state", value)
@property
@pulumi.getter(name="timeQuota")
def time_quota(self) -> Optional[pulumi.Input[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.
"""
return pulumi.get(self, "time_quota")
@time_quota.setter
def time_quota(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "time_quota", value)
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> Optional[pulumi.Input['URLFilteringRulesTimeWindowsArgs']]:
"""
The time interval in which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "time_windows")
@time_windows.setter
def time_windows(self, value: Optional[pulumi.Input['URLFilteringRulesTimeWindowsArgs']]):
pulumi.set(self, "time_windows", value)
@property
@pulumi.getter(name="urlCategories")
def url_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of URL categories for which rule must be applied
"""
return pulumi.get(self, "url_categories")
@url_categories.setter
def url_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "url_categories", value)
@property
@pulumi.getter(name="userAgentTypes")
def user_agent_types(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "user_agent_types")
@user_agent_types.setter
def user_agent_types(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "user_agent_types", value)
@property
@pulumi.getter
def users(self) -> Optional[pulumi.Input['URLFilteringRulesUsersArgs']]:
"""
The users to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "users")
@users.setter
def users(self, value: Optional[pulumi.Input['URLFilteringRulesUsersArgs']]):
pulumi.set(self, "users", value)
@property
@pulumi.getter(name="validityEndTime")
def validity_end_time(self) -> Optional[pulumi.Input[int]]:
"""
If `enforceTimeValidity` is set to true, the URL Filtering rule will cease to be valid on this end date and time.
"""
return pulumi.get(self, "validity_end_time")
@validity_end_time.setter
def validity_end_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "validity_end_time", value)
@property
@pulumi.getter(name="validityStartTime")
def validity_start_time(self) -> Optional[pulumi.Input[int]]:
"""
If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
"""
return pulumi.get(self, "validity_start_time")
@validity_start_time.setter
def validity_start_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "validity_start_time", value)
@property
@pulumi.getter(name="validityTimeZoneId")
def validity_time_zone_id(self) -> Optional[pulumi.Input[str]]:
"""
If `enforceTimeValidity` is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
return pulumi.get(self, "validity_time_zone_id")
@validity_time_zone_id.setter
def validity_time_zone_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "validity_time_zone_id", value)
@pulumi.input_type
class _URLFilteringRulesState:
def __init__(__self__, *,
action: Optional[pulumi.Input[str]] = None,
block_override: Optional[pulumi.Input[bool]] = None,
ciparule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input['URLFilteringRulesDepartmentsArgs']] = None,
description: Optional[pulumi.Input[str]] = None,
device_groups: Optional[pulumi.Input['URLFilteringRulesDeviceGroupsArgs']] = None,
device_trust_levels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
devices: Optional[pulumi.Input['URLFilteringRulesDevicesArgs']] = None,
end_user_notification_url: Optional[pulumi.Input[str]] = None,
enforce_time_validity: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input['URLFilteringRulesGroupsArgs']] = None,
labels: Optional[pulumi.Input['URLFilteringRulesLabelsArgs']] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input['URLFilteringRulesLocationGroupsArgs']] = None,
locations: Optional[pulumi.Input['URLFilteringRulesLocationsArgs']] = None,
name: Optional[pulumi.Input[str]] = None,
order: Optional[pulumi.Input[int]] = None,
override_groups: Optional[pulumi.Input['URLFilteringRulesOverrideGroupsArgs']] = None,
override_users: Optional[pulumi.Input['URLFilteringRulesOverrideUsersArgs']] = None,
protocols: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
rank: Optional[pulumi.Input[int]] = None,
request_methods: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
rule_id: Optional[pulumi.Input[int]] = None,
size_quota: Optional[pulumi.Input[int]] = None,
state: Optional[pulumi.Input[str]] = None,
time_quota: Optional[pulumi.Input[int]] = None,
time_windows: Optional[pulumi.Input['URLFilteringRulesTimeWindowsArgs']] = None,
url_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
user_agent_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
users: Optional[pulumi.Input['URLFilteringRulesUsersArgs']] = None,
validity_end_time: Optional[pulumi.Input[int]] = None,
validity_start_time: Optional[pulumi.Input[int]] = None,
validity_time_zone_id: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering URLFilteringRules resources.
:param pulumi.Input[str] action: Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
:param pulumi.Input[bool] block_override: When set to true, a `BLOCK` action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
:param pulumi.Input[bool] ciparule: If set to true, the CIPA Compliance rule is enabled
:param pulumi.Input['URLFilteringRulesDepartmentsArgs'] departments: The departments to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] description: Additional information about the rule
:param pulumi.Input['URLFilteringRulesDeviceGroupsArgs'] device_groups: list of device groups
:param pulumi.Input[Sequence[pulumi.Input[str]]] device_trust_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`
:param pulumi.Input['URLFilteringRulesDevicesArgs'] devices: list of devices
:param pulumi.Input[str] end_user_notification_url: URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
:param pulumi.Input[bool] enforce_time_validity: Enforce a set a validity time period for the URL Filtering rule.
:param pulumi.Input['URLFilteringRulesGroupsArgs'] groups: The groups to which the Firewall Filtering policy rule applies
:param pulumi.Input['URLFilteringRulesLabelsArgs'] labels: list of labels
:param pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]] last_modified_bies: Who modified the rule last
:param pulumi.Input[int] last_modified_time: When the rule was last modified
:param pulumi.Input['URLFilteringRulesLocationGroupsArgs'] location_groups: The location groups to which the Firewall Filtering policy rule applies
:param pulumi.Input['URLFilteringRulesLocationsArgs'] locations: The locations to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] name: Name of the Firewall Filtering policy rule
:param pulumi.Input[int] order: Order of execution of rule with respect to other URL Filtering rules
:param pulumi.Input['URLFilteringRulesOverrideGroupsArgs'] override_groups: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
:param pulumi.Input['URLFilteringRulesOverrideUsersArgs'] override_users: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
:param pulumi.Input[Sequence[pulumi.Input[str]]] protocols: 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`.
:param pulumi.Input[int] rank: Admin rank of the admin who creates this rule
:param pulumi.Input[Sequence[pulumi.Input[str]]] request_methods: Request method for which the rule must be applied. If not set, rule will be applied to all methods
:param pulumi.Input[int] rule_id: URL Filtering Rule ID
:param pulumi.Input[int] size_quota: 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.
:param pulumi.Input[str] state: Rule State
:param pulumi.Input[int] time_quota: 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.
:param pulumi.Input['URLFilteringRulesTimeWindowsArgs'] time_windows: The time interval in which the Firewall Filtering policy rule applies
:param pulumi.Input[Sequence[pulumi.Input[str]]] url_categories: List of URL categories for which rule must be applied
:param pulumi.Input['URLFilteringRulesUsersArgs'] users: The users to which the Firewall Filtering policy rule applies
:param pulumi.Input[int] validity_end_time: If `enforceTimeValidity` is set to true, the URL Filtering rule will cease to be valid on this end date and time.
:param pulumi.Input[int] validity_start_time: If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
:param pulumi.Input[str] validity_time_zone_id: If `enforceTimeValidity` is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
if action is not None:
pulumi.set(__self__, "action", action)
if block_override is not None:
pulumi.set(__self__, "block_override", block_override)
if ciparule is not None:
pulumi.set(__self__, "ciparule", ciparule)
if departments is not None:
pulumi.set(__self__, "departments", departments)
if description is not None:
pulumi.set(__self__, "description", description)
if device_groups is not None:
pulumi.set(__self__, "device_groups", device_groups)
if device_trust_levels is not None:
pulumi.set(__self__, "device_trust_levels", device_trust_levels)
if devices is not None:
pulumi.set(__self__, "devices", devices)
if end_user_notification_url is not None:
pulumi.set(__self__, "end_user_notification_url", end_user_notification_url)
if enforce_time_validity is not None:
pulumi.set(__self__, "enforce_time_validity", enforce_time_validity)
if groups is not None:
pulumi.set(__self__, "groups", groups)
if labels is not None:
pulumi.set(__self__, "labels", labels)
if last_modified_bies is not None:
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time is not None:
pulumi.set(__self__, "last_modified_time", last_modified_time)
if location_groups is not None:
pulumi.set(__self__, "location_groups", location_groups)
if locations is not None:
pulumi.set(__self__, "locations", locations)
if name is not None:
pulumi.set(__self__, "name", name)
if order is not None:
pulumi.set(__self__, "order", order)
if override_groups is not None:
pulumi.set(__self__, "override_groups", override_groups)
if override_users is not None:
pulumi.set(__self__, "override_users", override_users)
if protocols is not None:
pulumi.set(__self__, "protocols", protocols)
if rank is not None:
pulumi.set(__self__, "rank", rank)
if request_methods is not None:
pulumi.set(__self__, "request_methods", request_methods)
if rule_id is not None:
pulumi.set(__self__, "rule_id", rule_id)
if size_quota is not None:
pulumi.set(__self__, "size_quota", size_quota)
if state is not None:
pulumi.set(__self__, "state", state)
if time_quota is not None:
pulumi.set(__self__, "time_quota", time_quota)
if time_windows is not None:
pulumi.set(__self__, "time_windows", time_windows)
if url_categories is not None:
pulumi.set(__self__, "url_categories", url_categories)
if user_agent_types is not None:
pulumi.set(__self__, "user_agent_types", user_agent_types)
if users is not None:
pulumi.set(__self__, "users", users)
if validity_end_time is not None:
pulumi.set(__self__, "validity_end_time", validity_end_time)
if validity_start_time is not None:
pulumi.set(__self__, "validity_start_time", validity_start_time)
if validity_time_zone_id is not None:
pulumi.set(__self__, "validity_time_zone_id", validity_time_zone_id)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="blockOverride")
def block_override(self) -> Optional[pulumi.Input[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, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
"""
return pulumi.get(self, "block_override")
@block_override.setter
def block_override(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "block_override", value)
@property
@pulumi.getter
def ciparule(self) -> Optional[pulumi.Input[bool]]:
"""
If set to true, the CIPA Compliance rule is enabled
"""
return pulumi.get(self, "ciparule")
@ciparule.setter
def ciparule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ciparule", value)
@property
@pulumi.getter
def departments(self) -> Optional[pulumi.Input['URLFilteringRulesDepartmentsArgs']]:
"""
The departments to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "departments")
@departments.setter
def departments(self, value: Optional[pulumi.Input['URLFilteringRulesDepartmentsArgs']]):
pulumi.set(self, "departments", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Additional information about the rule
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="deviceGroups")
def device_groups(self) -> Optional[pulumi.Input['URLFilteringRulesDeviceGroupsArgs']]:
"""
list of device groups
"""
return pulumi.get(self, "device_groups")
@device_groups.setter
def device_groups(self, value: Optional[pulumi.Input['URLFilteringRulesDeviceGroupsArgs']]):
pulumi.set(self, "device_groups", value)
@property
@pulumi.getter(name="deviceTrustLevels")
def device_trust_levels(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation. Supported values: `ANY`, `UNKNOWN_DEVICETRUSTLEVEL`, `LOW_TRUST`, `MEDIUM_TRUST`, `HIGH_TRUST`
"""
return pulumi.get(self, "device_trust_levels")
@device_trust_levels.setter
def device_trust_levels(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "device_trust_levels", value)
@property
@pulumi.getter
def devices(self) -> Optional[pulumi.Input['URLFilteringRulesDevicesArgs']]:
"""
list of devices
"""
return pulumi.get(self, "devices")
@devices.setter
def devices(self, value: Optional[pulumi.Input['URLFilteringRulesDevicesArgs']]):
pulumi.set(self, "devices", value)
@property
@pulumi.getter(name="endUserNotificationUrl")
def end_user_notification_url(self) -> Optional[pulumi.Input[str]]:
"""
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
"""
return pulumi.get(self, "end_user_notification_url")
@end_user_notification_url.setter
def end_user_notification_url(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "end_user_notification_url", value)
@property
@pulumi.getter(name="enforceTimeValidity")
def enforce_time_validity(self) -> Optional[pulumi.Input[bool]]:
"""
Enforce a set a validity time period for the URL Filtering rule.
"""
return pulumi.get(self, "enforce_time_validity")
@enforce_time_validity.setter
def enforce_time_validity(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enforce_time_validity", value)
@property
@pulumi.getter
def groups(self) -> Optional[pulumi.Input['URLFilteringRulesGroupsArgs']]:
"""
The groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "groups")
@groups.setter
def groups(self, value: Optional[pulumi.Input['URLFilteringRulesGroupsArgs']]):
pulumi.set(self, "groups", value)
@property
@pulumi.getter
def labels(self) -> Optional[pulumi.Input['URLFilteringRulesLabelsArgs']]:
"""
list of labels
"""
return pulumi.get(self, "labels")
@labels.setter
def labels(self, value: Optional[pulumi.Input['URLFilteringRulesLabelsArgs']]):
pulumi.set(self, "labels", value)
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]]]:
"""
Who modified the rule last
"""
return pulumi.get(self, "last_modified_bies")
@last_modified_bies.setter
def last_modified_bies(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['URLFilteringRulesLastModifiedByArgs']]]]):
pulumi.set(self, "last_modified_bies", value)
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> Optional[pulumi.Input[int]]:
"""
When the rule was last modified
"""
return pulumi.get(self, "last_modified_time")
@last_modified_time.setter
def last_modified_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "last_modified_time", value)
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> Optional[pulumi.Input['URLFilteringRulesLocationGroupsArgs']]:
"""
The location groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "location_groups")
@location_groups.setter
def location_groups(self, value: Optional[pulumi.Input['URLFilteringRulesLocationGroupsArgs']]):
pulumi.set(self, "location_groups", value)
@property
@pulumi.getter
def locations(self) -> Optional[pulumi.Input['URLFilteringRulesLocationsArgs']]:
"""
The locations to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "locations")
@locations.setter
def locations(self, value: Optional[pulumi.Input['URLFilteringRulesLocationsArgs']]):
pulumi.set(self, "locations", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def order(self) -> Optional[pulumi.Input[int]]:
"""
Order of execution of rule with respect to other URL Filtering rules
"""
return pulumi.get(self, "order")
@order.setter
def order(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "order", value)
@property
@pulumi.getter(name="overrideGroups")
def override_groups(self) -> Optional[pulumi.Input['URLFilteringRulesOverrideGroupsArgs']]:
"""
Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
"""
return pulumi.get(self, "override_groups")
@override_groups.setter
def override_groups(self, value: Optional[pulumi.Input['URLFilteringRulesOverrideGroupsArgs']]):
pulumi.set(self, "override_groups", value)
@property
@pulumi.getter(name="overrideUsers")
def override_users(self) -> Optional[pulumi.Input['URLFilteringRulesOverrideUsersArgs']]:
"""
Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
"""
return pulumi.get(self, "override_users")
@override_users.setter
def override_users(self, value: Optional[pulumi.Input['URLFilteringRulesOverrideUsersArgs']]):
pulumi.set(self, "override_users", value)
@property
@pulumi.getter
def protocols(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[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`.
"""
return pulumi.get(self, "protocols")
@protocols.setter
def protocols(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "protocols", value)
@property
@pulumi.getter
def rank(self) -> Optional[pulumi.Input[int]]:
"""
Admin rank of the admin who creates this rule
"""
return pulumi.get(self, "rank")
@rank.setter
def rank(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "rank", value)
@property
@pulumi.getter(name="requestMethods")
def request_methods(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Request method for which the rule must be applied. If not set, rule will be applied to all methods
"""
return pulumi.get(self, "request_methods")
@request_methods.setter
def request_methods(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "request_methods", value)
@property
@pulumi.getter(name="ruleId")
def rule_id(self) -> Optional[pulumi.Input[int]]:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "rule_id")
@rule_id.setter
def rule_id(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "rule_id", value)
@property
@pulumi.getter(name="sizeQuota")
def size_quota(self) -> Optional[pulumi.Input[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.
"""
return pulumi.get(self, "size_quota")
@size_quota.setter
def size_quota(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "size_quota", value)
@property
@pulumi.getter
def state(self) -> Optional[pulumi.Input[str]]:
"""
Rule State
"""
return pulumi.get(self, "state")
@state.setter
def state(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "state", value)
@property
@pulumi.getter(name="timeQuota")
def time_quota(self) -> Optional[pulumi.Input[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.
"""
return pulumi.get(self, "time_quota")
@time_quota.setter
def time_quota(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "time_quota", value)
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> Optional[pulumi.Input['URLFilteringRulesTimeWindowsArgs']]:
"""
The time interval in which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "time_windows")
@time_windows.setter
def time_windows(self, value: Optional[pulumi.Input['URLFilteringRulesTimeWindowsArgs']]):
pulumi.set(self, "time_windows", value)
@property
@pulumi.getter(name="urlCategories")
def url_categories(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of URL categories for which rule must be applied
"""
return pulumi.get(self, "url_categories")
@url_categories.setter
def url_categories(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "url_categories", value)
@property
@pulumi.getter(name="userAgentTypes")
def user_agent_types(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "user_agent_types")
@user_agent_types.setter
def user_agent_types(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "user_agent_types", value)
@property
@pulumi.getter
def users(self) -> Optional[pulumi.Input['URLFilteringRulesUsersArgs']]:
"""
The users to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "users")
@users.setter
def users(self, value: Optional[pulumi.Input['URLFilteringRulesUsersArgs']]):
pulumi.set(self, "users", value)
@property
@pulumi.getter(name="validityEndTime")
def validity_end_time(self) -> Optional[pulumi.Input[int]]:
"""
If `enforceTimeValidity` is set to true, the URL Filtering rule will cease to be valid on this end date and time.
"""
return pulumi.get(self, "validity_end_time")
@validity_end_time.setter
def validity_end_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "validity_end_time", value)
@property
@pulumi.getter(name="validityStartTime")
def validity_start_time(self) -> Optional[pulumi.Input[int]]:
"""
If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
"""
return pulumi.get(self, "validity_start_time")
@validity_start_time.setter
def validity_start_time(self, value: Optional[pulumi.Input[int]]):
pulumi.set(self, "validity_start_time", value)
@property
@pulumi.getter(name="validityTimeZoneId")
def validity_time_zone_id(self) -> Optional[pulumi.Input[str]]:
"""
If `enforceTimeValidity` is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
return pulumi.get(self, "validity_time_zone_id")
@validity_time_zone_id.setter
def validity_time_zone_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "validity_time_zone_id", value)
class URLFilteringRules(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
block_override: Optional[pulumi.Input[bool]] = None,
ciparule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDepartmentsArgs']]] = None,
description: Optional[pulumi.Input[str]] = None,
device_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDeviceGroupsArgs']]] = None,
device_trust_levels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
devices: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDevicesArgs']]] = None,
end_user_notification_url: Optional[pulumi.Input[str]] = None,
enforce_time_validity: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesGroupsArgs']]] = None,
labels: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLabelsArgs']]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLFilteringRulesLastModifiedByArgs']]]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLocationGroupsArgs']]] = None,
locations: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLocationsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
order: Optional[pulumi.Input[int]] = None,
override_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideGroupsArgs']]] = None,
override_users: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideUsersArgs']]] = None,
protocols: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
rank: Optional[pulumi.Input[int]] = None,
request_methods: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
size_quota: Optional[pulumi.Input[int]] = None,
state: Optional[pulumi.Input[str]] = None,
time_quota: Optional[pulumi.Input[int]] = None,
time_windows: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesTimeWindowsArgs']]] = None,
url_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
user_agent_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
users: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesUsersArgs']]] = None,
validity_end_time: Optional[pulumi.Input[int]] = None,
validity_start_time: Optional[pulumi.Input[int]] = None,
validity_time_zone_id: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The **zia_url_filtering_rules** resource creates and manages a URL filtering rules within the Zscaler Internet Access cloud.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# URL filtering rules
block_streaming = zia.url_filtering.URLFilteringRules("blockStreaming",
action="BLOCK",
description="Block Video Streaming.",
device_trust_levels=[
"UNKNOWN_DEVICETRUSTLEVEL",
"LOW_TRUST",
"MEDIUM_TRUST",
"HIGH_TRUST",
],
order=2,
protocols=["ANY_RULE"],
request_methods=[
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"OTHER",
"POST",
"PUT",
"TRACE",
],
state="ENABLED",
url_categories=["ANY"])
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
:param pulumi.Input[bool] block_override: When set to true, a `BLOCK` action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
:param pulumi.Input[bool] ciparule: If set to true, the CIPA Compliance rule is enabled
:param pulumi.Input[pulumi.InputType['URLFilteringRulesDepartmentsArgs']] departments: The departments to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] description: Additional information about the rule
:param pulumi.Input[pulumi.InputType['URLFilteringRulesDeviceGroupsArgs']] device_groups: list of device groups
:param pulumi.Input[Sequence[pulumi.Input[str]]] device_trust_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`
:param pulumi.Input[pulumi.InputType['URLFilteringRulesDevicesArgs']] devices: list of devices
:param pulumi.Input[str] end_user_notification_url: URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
:param pulumi.Input[bool] enforce_time_validity: Enforce a set a validity time period for the URL Filtering rule.
:param pulumi.Input[pulumi.InputType['URLFilteringRulesGroupsArgs']] groups: The groups to which the Firewall Filtering policy rule applies
:param pulumi.Input[pulumi.InputType['URLFilteringRulesLabelsArgs']] labels: list of labels
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLFilteringRulesLastModifiedByArgs']]]] last_modified_bies: Who modified the rule last
:param pulumi.Input[int] last_modified_time: When the rule was last modified
:param pulumi.Input[pulumi.InputType['URLFilteringRulesLocationGroupsArgs']] location_groups: The location groups to which the Firewall Filtering policy rule applies
:param pulumi.Input[pulumi.InputType['URLFilteringRulesLocationsArgs']] locations: The locations to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] name: Name of the Firewall Filtering policy rule
:param pulumi.Input[int] order: Order of execution of rule with respect to other URL Filtering rules
:param pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideGroupsArgs']] override_groups: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
:param pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideUsersArgs']] override_users: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
:param pulumi.Input[Sequence[pulumi.Input[str]]] protocols: 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`.
:param pulumi.Input[int] rank: Admin rank of the admin who creates this rule
:param pulumi.Input[Sequence[pulumi.Input[str]]] request_methods: Request method for which the rule must be applied. If not set, rule will be applied to all methods
:param pulumi.Input[int] size_quota: 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.
:param pulumi.Input[str] state: Rule State
:param pulumi.Input[int] time_quota: 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.
:param pulumi.Input[pulumi.InputType['URLFilteringRulesTimeWindowsArgs']] time_windows: The time interval in which the Firewall Filtering policy rule applies
:param pulumi.Input[Sequence[pulumi.Input[str]]] url_categories: List of URL categories for which rule must be applied
:param pulumi.Input[pulumi.InputType['URLFilteringRulesUsersArgs']] users: The users to which the Firewall Filtering policy rule applies
:param pulumi.Input[int] validity_end_time: If `enforceTimeValidity` is set to true, the URL Filtering rule will cease to be valid on this end date and time.
:param pulumi.Input[int] validity_start_time: If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
:param pulumi.Input[str] validity_time_zone_id: If `enforceTimeValidity` is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: URLFilteringRulesArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zia_url_filtering_rules** resource creates and manages a URL filtering rules within the Zscaler Internet Access cloud.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zia as zia
# URL filtering rules
block_streaming = zia.url_filtering.URLFilteringRules("blockStreaming",
action="BLOCK",
description="Block Video Streaming.",
device_trust_levels=[
"UNKNOWN_DEVICETRUSTLEVEL",
"LOW_TRUST",
"MEDIUM_TRUST",
"HIGH_TRUST",
],
order=2,
protocols=["ANY_RULE"],
request_methods=[
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"OTHER",
"POST",
"PUT",
"TRACE",
],
state="ENABLED",
url_categories=["ANY"])
```
:param str resource_name: The name of the resource.
:param URLFilteringRulesArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(URLFilteringRulesArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
block_override: Optional[pulumi.Input[bool]] = None,
ciparule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDepartmentsArgs']]] = None,
description: Optional[pulumi.Input[str]] = None,
device_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDeviceGroupsArgs']]] = None,
device_trust_levels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
devices: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDevicesArgs']]] = None,
end_user_notification_url: Optional[pulumi.Input[str]] = None,
enforce_time_validity: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesGroupsArgs']]] = None,
labels: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLabelsArgs']]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLFilteringRulesLastModifiedByArgs']]]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLocationGroupsArgs']]] = None,
locations: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLocationsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
order: Optional[pulumi.Input[int]] = None,
override_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideGroupsArgs']]] = None,
override_users: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideUsersArgs']]] = None,
protocols: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
rank: Optional[pulumi.Input[int]] = None,
request_methods: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
size_quota: Optional[pulumi.Input[int]] = None,
state: Optional[pulumi.Input[str]] = None,
time_quota: Optional[pulumi.Input[int]] = None,
time_windows: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesTimeWindowsArgs']]] = None,
url_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
user_agent_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
users: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesUsersArgs']]] = None,
validity_end_time: Optional[pulumi.Input[int]] = None,
validity_start_time: Optional[pulumi.Input[int]] = None,
validity_time_zone_id: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = URLFilteringRulesArgs.__new__(URLFilteringRulesArgs)
__props__.__dict__["action"] = action
__props__.__dict__["block_override"] = block_override
__props__.__dict__["ciparule"] = ciparule
__props__.__dict__["departments"] = departments
__props__.__dict__["description"] = description
__props__.__dict__["device_groups"] = device_groups
__props__.__dict__["device_trust_levels"] = device_trust_levels
__props__.__dict__["devices"] = devices
__props__.__dict__["end_user_notification_url"] = end_user_notification_url
__props__.__dict__["enforce_time_validity"] = enforce_time_validity
__props__.__dict__["groups"] = groups
__props__.__dict__["labels"] = labels
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["last_modified_time"] = last_modified_time
__props__.__dict__["location_groups"] = location_groups
__props__.__dict__["locations"] = locations
__props__.__dict__["name"] = name
if order is None and not opts.urn:
raise TypeError("Missing required property 'order'")
__props__.__dict__["order"] = order
__props__.__dict__["override_groups"] = override_groups
__props__.__dict__["override_users"] = override_users
if protocols is None and not opts.urn:
raise TypeError("Missing required property 'protocols'")
__props__.__dict__["protocols"] = protocols
__props__.__dict__["rank"] = rank
__props__.__dict__["request_methods"] = request_methods
__props__.__dict__["size_quota"] = size_quota
__props__.__dict__["state"] = state
__props__.__dict__["time_quota"] = time_quota
__props__.__dict__["time_windows"] = time_windows
__props__.__dict__["url_categories"] = url_categories
__props__.__dict__["user_agent_types"] = user_agent_types
__props__.__dict__["users"] = users
__props__.__dict__["validity_end_time"] = validity_end_time
__props__.__dict__["validity_start_time"] = validity_start_time
__props__.__dict__["validity_time_zone_id"] = validity_time_zone_id
__props__.__dict__["rule_id"] = None
super(URLFilteringRules, __self__).__init__(
'zia:URLFiltering/uRLFilteringRules:URLFilteringRules',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
block_override: Optional[pulumi.Input[bool]] = None,
ciparule: Optional[pulumi.Input[bool]] = None,
departments: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDepartmentsArgs']]] = None,
description: Optional[pulumi.Input[str]] = None,
device_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDeviceGroupsArgs']]] = None,
device_trust_levels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
devices: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesDevicesArgs']]] = None,
end_user_notification_url: Optional[pulumi.Input[str]] = None,
enforce_time_validity: Optional[pulumi.Input[bool]] = None,
groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesGroupsArgs']]] = None,
labels: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLabelsArgs']]] = None,
last_modified_bies: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLFilteringRulesLastModifiedByArgs']]]]] = None,
last_modified_time: Optional[pulumi.Input[int]] = None,
location_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLocationGroupsArgs']]] = None,
locations: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesLocationsArgs']]] = None,
name: Optional[pulumi.Input[str]] = None,
order: Optional[pulumi.Input[int]] = None,
override_groups: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideGroupsArgs']]] = None,
override_users: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideUsersArgs']]] = None,
protocols: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
rank: Optional[pulumi.Input[int]] = None,
request_methods: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
rule_id: Optional[pulumi.Input[int]] = None,
size_quota: Optional[pulumi.Input[int]] = None,
state: Optional[pulumi.Input[str]] = None,
time_quota: Optional[pulumi.Input[int]] = None,
time_windows: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesTimeWindowsArgs']]] = None,
url_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
user_agent_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
users: Optional[pulumi.Input[pulumi.InputType['URLFilteringRulesUsersArgs']]] = None,
validity_end_time: Optional[pulumi.Input[int]] = None,
validity_start_time: Optional[pulumi.Input[int]] = None,
validity_time_zone_id: Optional[pulumi.Input[str]] = None) -> 'URLFilteringRules':
"""
Get an existing URLFilteringRules resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
:param pulumi.Input[bool] block_override: When set to true, a `BLOCK` action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
:param pulumi.Input[bool] ciparule: If set to true, the CIPA Compliance rule is enabled
:param pulumi.Input[pulumi.InputType['URLFilteringRulesDepartmentsArgs']] departments: The departments to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] description: Additional information about the rule
:param pulumi.Input[pulumi.InputType['URLFilteringRulesDeviceGroupsArgs']] device_groups: list of device groups
:param pulumi.Input[Sequence[pulumi.Input[str]]] device_trust_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`
:param pulumi.Input[pulumi.InputType['URLFilteringRulesDevicesArgs']] devices: list of devices
:param pulumi.Input[str] end_user_notification_url: URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
:param pulumi.Input[bool] enforce_time_validity: Enforce a set a validity time period for the URL Filtering rule.
:param pulumi.Input[pulumi.InputType['URLFilteringRulesGroupsArgs']] groups: The groups to which the Firewall Filtering policy rule applies
:param pulumi.Input[pulumi.InputType['URLFilteringRulesLabelsArgs']] labels: list of labels
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['URLFilteringRulesLastModifiedByArgs']]]] last_modified_bies: Who modified the rule last
:param pulumi.Input[int] last_modified_time: When the rule was last modified
:param pulumi.Input[pulumi.InputType['URLFilteringRulesLocationGroupsArgs']] location_groups: The location groups to which the Firewall Filtering policy rule applies
:param pulumi.Input[pulumi.InputType['URLFilteringRulesLocationsArgs']] locations: The locations to which the Firewall Filtering policy rule applies
:param pulumi.Input[str] name: Name of the Firewall Filtering policy rule
:param pulumi.Input[int] order: Order of execution of rule with respect to other URL Filtering rules
:param pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideGroupsArgs']] override_groups: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
:param pulumi.Input[pulumi.InputType['URLFilteringRulesOverrideUsersArgs']] override_users: Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
:param pulumi.Input[Sequence[pulumi.Input[str]]] protocols: 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`.
:param pulumi.Input[int] rank: Admin rank of the admin who creates this rule
:param pulumi.Input[Sequence[pulumi.Input[str]]] request_methods: Request method for which the rule must be applied. If not set, rule will be applied to all methods
:param pulumi.Input[int] rule_id: URL Filtering Rule ID
:param pulumi.Input[int] size_quota: 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.
:param pulumi.Input[str] state: Rule State
:param pulumi.Input[int] time_quota: 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.
:param pulumi.Input[pulumi.InputType['URLFilteringRulesTimeWindowsArgs']] time_windows: The time interval in which the Firewall Filtering policy rule applies
:param pulumi.Input[Sequence[pulumi.Input[str]]] url_categories: List of URL categories for which rule must be applied
:param pulumi.Input[pulumi.InputType['URLFilteringRulesUsersArgs']] users: The users to which the Firewall Filtering policy rule applies
:param pulumi.Input[int] validity_end_time: If `enforceTimeValidity` is set to true, the URL Filtering rule will cease to be valid on this end date and time.
:param pulumi.Input[int] validity_start_time: If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
:param pulumi.Input[str] validity_time_zone_id: If `enforceTimeValidity` is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _URLFilteringRulesState.__new__(_URLFilteringRulesState)
__props__.__dict__["action"] = action
__props__.__dict__["block_override"] = block_override
__props__.__dict__["ciparule"] = ciparule
__props__.__dict__["departments"] = departments
__props__.__dict__["description"] = description
__props__.__dict__["device_groups"] = device_groups
__props__.__dict__["device_trust_levels"] = device_trust_levels
__props__.__dict__["devices"] = devices
__props__.__dict__["end_user_notification_url"] = end_user_notification_url
__props__.__dict__["enforce_time_validity"] = enforce_time_validity
__props__.__dict__["groups"] = groups
__props__.__dict__["labels"] = labels
__props__.__dict__["last_modified_bies"] = last_modified_bies
__props__.__dict__["last_modified_time"] = last_modified_time
__props__.__dict__["location_groups"] = location_groups
__props__.__dict__["locations"] = locations
__props__.__dict__["name"] = name
__props__.__dict__["order"] = order
__props__.__dict__["override_groups"] = override_groups
__props__.__dict__["override_users"] = override_users
__props__.__dict__["protocols"] = protocols
__props__.__dict__["rank"] = rank
__props__.__dict__["request_methods"] = request_methods
__props__.__dict__["rule_id"] = rule_id
__props__.__dict__["size_quota"] = size_quota
__props__.__dict__["state"] = state
__props__.__dict__["time_quota"] = time_quota
__props__.__dict__["time_windows"] = time_windows
__props__.__dict__["url_categories"] = url_categories
__props__.__dict__["user_agent_types"] = user_agent_types
__props__.__dict__["users"] = users
__props__.__dict__["validity_end_time"] = validity_end_time
__props__.__dict__["validity_start_time"] = validity_start_time
__props__.__dict__["validity_time_zone_id"] = validity_time_zone_id
return URLFilteringRules(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def action(self) -> pulumi.Output[Optional[str]]:
"""
Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
"""
return pulumi.get(self, "action")
@property
@pulumi.getter(name="blockOverride")
def block_override(self) -> pulumi.Output[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, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
"""
return pulumi.get(self, "block_override")
@property
@pulumi.getter
def ciparule(self) -> pulumi.Output[bool]:
"""
If set to true, the CIPA Compliance rule is enabled
"""
return pulumi.get(self, "ciparule")
@property
@pulumi.getter
def departments(self) -> pulumi.Output['outputs.URLFilteringRulesDepartments']:
"""
The departments to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "departments")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Additional information about the rule
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="deviceGroups")
def device_groups(self) -> pulumi.Output['outputs.URLFilteringRulesDeviceGroups']:
"""
list of device groups
"""
return pulumi.get(self, "device_groups")
@property
@pulumi.getter(name="deviceTrustLevels")
def device_trust_levels(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
List of device trust levels for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. The trust levels are assigned to the devices based on your posture configurations in the Zscaler Client Connector Portal. If no value is set, this field is ignored during the policy evaluation. Supported values: `ANY`, `UNKNOWN_DEVICETRUSTLEVEL`, `LOW_TRUST`, `MEDIUM_TRUST`, `HIGH_TRUST`
"""
return pulumi.get(self, "device_trust_levels")
@property
@pulumi.getter
def devices(self) -> pulumi.Output['outputs.URLFilteringRulesDevices']:
"""
list of devices
"""
return pulumi.get(self, "devices")
@property
@pulumi.getter(name="endUserNotificationUrl")
def end_user_notification_url(self) -> pulumi.Output[Optional[str]]:
"""
URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
"""
return pulumi.get(self, "end_user_notification_url")
@property
@pulumi.getter(name="enforceTimeValidity")
def enforce_time_validity(self) -> pulumi.Output[bool]:
"""
Enforce a set a validity time period for the URL Filtering rule.
"""
return pulumi.get(self, "enforce_time_validity")
@property
@pulumi.getter
def groups(self) -> pulumi.Output['outputs.URLFilteringRulesGroups']:
"""
The groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "groups")
@property
@pulumi.getter
def labels(self) -> pulumi.Output['outputs.URLFilteringRulesLabels']:
"""
list of labels
"""
return pulumi.get(self, "labels")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> pulumi.Output[Sequence['outputs.URLFilteringRulesLastModifiedBy']]:
"""
Who modified the rule last
"""
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> pulumi.Output[Optional[int]]:
"""
When the rule was last modified
"""
return pulumi.get(self, "last_modified_time")
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> pulumi.Output['outputs.URLFilteringRulesLocationGroups']:
"""
The location groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "location_groups")
@property
@pulumi.getter
def locations(self) -> pulumi.Output['outputs.URLFilteringRulesLocations']:
"""
The locations to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "locations")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def order(self) -> pulumi.Output[int]:
"""
Order of execution of rule with respect to other URL Filtering rules
"""
return pulumi.get(self, "order")
@property
@pulumi.getter(name="overrideGroups")
def override_groups(self) -> pulumi.Output['outputs.URLFilteringRulesOverrideGroups']:
"""
Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
"""
return pulumi.get(self, "override_groups")
@property
@pulumi.getter(name="overrideUsers")
def override_users(self) -> pulumi.Output['outputs.URLFilteringRulesOverrideUsers']:
"""
Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
"""
return pulumi.get(self, "override_users")
@property
@pulumi.getter
def protocols(self) -> pulumi.Output[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`.
"""
return pulumi.get(self, "protocols")
@property
@pulumi.getter
def rank(self) -> pulumi.Output[Optional[int]]:
"""
Admin rank of the admin who creates this rule
"""
return pulumi.get(self, "rank")
@property
@pulumi.getter(name="requestMethods")
def request_methods(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
Request method for which the rule must be applied. If not set, rule will be applied to all methods
"""
return pulumi.get(self, "request_methods")
@property
@pulumi.getter(name="ruleId")
def rule_id(self) -> pulumi.Output[int]:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "rule_id")
@property
@pulumi.getter(name="sizeQuota")
def size_quota(self) -> pulumi.Output[Optional[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.
"""
return pulumi.get(self, "size_quota")
@property
@pulumi.getter
def state(self) -> pulumi.Output[Optional[str]]:
"""
Rule State
"""
return pulumi.get(self, "state")
@property
@pulumi.getter(name="timeQuota")
def time_quota(self) -> pulumi.Output[Optional[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.
"""
return pulumi.get(self, "time_quota")
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> pulumi.Output['outputs.URLFilteringRulesTimeWindows']:
"""
The time interval in which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "time_windows")
@property
@pulumi.getter(name="urlCategories")
def url_categories(self) -> pulumi.Output[Optional[Sequence[str]]]:
"""
List of URL categories for which rule must be applied
"""
return pulumi.get(self, "url_categories")
@property
@pulumi.getter(name="userAgentTypes")
def user_agent_types(self) -> pulumi.Output[Optional[Sequence[str]]]:
return pulumi.get(self, "user_agent_types")
@property
@pulumi.getter
def users(self) -> pulumi.Output['outputs.URLFilteringRulesUsers']:
"""
The users to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "users")
@property
@pulumi.getter(name="validityEndTime")
def validity_end_time(self) -> pulumi.Output[Optional[int]]:
"""
If `enforceTimeValidity` is set to true, the URL Filtering rule will cease to be valid on this end date and time.
"""
return pulumi.get(self, "validity_end_time")
@property
@pulumi.getter(name="validityStartTime")
def validity_start_time(self) -> pulumi.Output[Optional[int]]:
"""
If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
"""
return pulumi.get(self, "validity_start_time")
@property
@pulumi.getter(name="validityTimeZoneId")
def validity_time_zone_id(self) -> pulumi.Output[Optional[str]]:
"""
If `enforceTimeValidity` is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
return pulumi.get(self, "validity_time_zone_id") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlfiltering/url_filtering_rules.py | url_filtering_rules.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'URLFilteringRulesDepartments',
'URLFilteringRulesDeviceGroups',
'URLFilteringRulesDevices',
'URLFilteringRulesGroups',
'URLFilteringRulesLabels',
'URLFilteringRulesLastModifiedBy',
'URLFilteringRulesLocationGroups',
'URLFilteringRulesLocations',
'URLFilteringRulesOverrideGroups',
'URLFilteringRulesOverrideUsers',
'URLFilteringRulesTimeWindows',
'URLFilteringRulesUsers',
'GetURLFilteringRulesDepartmentResult',
'GetURLFilteringRulesDeviceResult',
'GetURLFilteringRulesDeviceGroupResult',
'GetURLFilteringRulesGroupResult',
'GetURLFilteringRulesLabelResult',
'GetURLFilteringRulesLastModifiedByResult',
'GetURLFilteringRulesLocationResult',
'GetURLFilteringRulesLocationGroupResult',
'GetURLFilteringRulesOverrideGroupResult',
'GetURLFilteringRulesOverrideUserResult',
'GetURLFilteringRulesTimeWindowResult',
'GetURLFilteringRulesUserResult',
]
@pulumi.output_type
class URLFilteringRulesDepartments(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesDeviceGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesDevices(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesLabels(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesLastModifiedBy(dict):
def __init__(__self__, *,
extensions: Optional[Mapping[str, str]] = None,
id: Optional[int] = None,
name: Optional[str] = None):
"""
:param int id: Identifier that uniquely identifies an entity
:param str name: Name of the Firewall Filtering policy rule
"""
if extensions is not None:
pulumi.set(__self__, "extensions", extensions)
if id is not None:
pulumi.set(__self__, "id", id)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Optional[Mapping[str, str]]:
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> Optional[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
Name of the Firewall Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class URLFilteringRulesLocationGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesLocations(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesOverrideGroups(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesOverrideUsers(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesTimeWindows(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class URLFilteringRulesUsers(dict):
def __init__(__self__, *,
ids: Sequence[int]):
"""
:param Sequence[int] ids: Identifier that uniquely identifies an entity
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[int]:
"""
Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class GetURLFilteringRulesDepartmentResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesDeviceResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesDeviceGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesLabelResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesLastModifiedByResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesLocationResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesLocationGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesOverrideGroupResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesOverrideUserResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesTimeWindowResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetURLFilteringRulesUserResult(dict):
def __init__(__self__, *,
extensions: Mapping[str, str],
id: int,
name: str):
"""
:param Mapping[str, str] extensions: (Map of String)
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
"""
pulumi.set(__self__, "extensions", extensions)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def extensions(self) -> Mapping[str, str]:
"""
(Map of String)
"""
return pulumi.get(self, "extensions")
@property
@pulumi.getter
def id(self) -> int:
"""
URL Filtering Rule ID
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the URL Filtering policy rule
"""
return pulumi.get(self, "name") | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlfiltering/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetURLFilteringRulesResult',
'AwaitableGetURLFilteringRulesResult',
'get_url_filtering_rules',
'get_url_filtering_rules_output',
]
@pulumi.output_type
class GetURLFilteringRulesResult:
"""
A collection of values returned by getURLFilteringRules.
"""
def __init__(__self__, action=None, block_override=None, cbi_profile_id=None, ciparule=None, departments=None, description=None, device_groups=None, device_trust_levels=None, devices=None, end_user_notification_url=None, enforce_time_validity=None, groups=None, id=None, labels=None, last_modified_bies=None, last_modified_time=None, location_groups=None, locations=None, name=None, order=None, override_groups=None, override_users=None, protocols=None, rank=None, request_methods=None, size_quota=None, state=None, time_quota=None, time_windows=None, url_categories=None, user_agent_types=None, users=None, validity_end_time=None, validity_start_time=None, validity_time_zone_id=None):
if action and not isinstance(action, str):
raise TypeError("Expected argument 'action' to be a str")
pulumi.set(__self__, "action", action)
if block_override and not isinstance(block_override, bool):
raise TypeError("Expected argument 'block_override' to be a bool")
pulumi.set(__self__, "block_override", block_override)
if cbi_profile_id and not isinstance(cbi_profile_id, int):
raise TypeError("Expected argument 'cbi_profile_id' to be a int")
pulumi.set(__self__, "cbi_profile_id", cbi_profile_id)
if ciparule and not isinstance(ciparule, bool):
raise TypeError("Expected argument 'ciparule' to be a bool")
pulumi.set(__self__, "ciparule", ciparule)
if departments and not isinstance(departments, list):
raise TypeError("Expected argument 'departments' to be a list")
pulumi.set(__self__, "departments", departments)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if device_groups and not isinstance(device_groups, list):
raise TypeError("Expected argument 'device_groups' to be a list")
pulumi.set(__self__, "device_groups", device_groups)
if device_trust_levels and not isinstance(device_trust_levels, list):
raise TypeError("Expected argument 'device_trust_levels' to be a list")
pulumi.set(__self__, "device_trust_levels", device_trust_levels)
if devices and not isinstance(devices, list):
raise TypeError("Expected argument 'devices' to be a list")
pulumi.set(__self__, "devices", devices)
if end_user_notification_url and not isinstance(end_user_notification_url, str):
raise TypeError("Expected argument 'end_user_notification_url' to be a str")
pulumi.set(__self__, "end_user_notification_url", end_user_notification_url)
if enforce_time_validity and not isinstance(enforce_time_validity, bool):
raise TypeError("Expected argument 'enforce_time_validity' to be a bool")
pulumi.set(__self__, "enforce_time_validity", enforce_time_validity)
if groups and not isinstance(groups, list):
raise TypeError("Expected argument 'groups' to be a list")
pulumi.set(__self__, "groups", groups)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if labels and not isinstance(labels, list):
raise TypeError("Expected argument 'labels' to be a list")
pulumi.set(__self__, "labels", labels)
if last_modified_bies and not isinstance(last_modified_bies, list):
raise TypeError("Expected argument 'last_modified_bies' to be a list")
pulumi.set(__self__, "last_modified_bies", last_modified_bies)
if last_modified_time and not isinstance(last_modified_time, int):
raise TypeError("Expected argument 'last_modified_time' to be a int")
pulumi.set(__self__, "last_modified_time", last_modified_time)
if location_groups and not isinstance(location_groups, list):
raise TypeError("Expected argument 'location_groups' to be a list")
pulumi.set(__self__, "location_groups", location_groups)
if locations and not isinstance(locations, list):
raise TypeError("Expected argument 'locations' to be a list")
pulumi.set(__self__, "locations", locations)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if order and not isinstance(order, int):
raise TypeError("Expected argument 'order' to be a int")
pulumi.set(__self__, "order", order)
if override_groups and not isinstance(override_groups, list):
raise TypeError("Expected argument 'override_groups' to be a list")
pulumi.set(__self__, "override_groups", override_groups)
if override_users and not isinstance(override_users, list):
raise TypeError("Expected argument 'override_users' to be a list")
pulumi.set(__self__, "override_users", override_users)
if protocols and not isinstance(protocols, list):
raise TypeError("Expected argument 'protocols' to be a list")
pulumi.set(__self__, "protocols", protocols)
if rank and not isinstance(rank, int):
raise TypeError("Expected argument 'rank' to be a int")
pulumi.set(__self__, "rank", rank)
if request_methods and not isinstance(request_methods, list):
raise TypeError("Expected argument 'request_methods' to be a list")
pulumi.set(__self__, "request_methods", request_methods)
if size_quota and not isinstance(size_quota, int):
raise TypeError("Expected argument 'size_quota' to be a int")
pulumi.set(__self__, "size_quota", size_quota)
if state and not isinstance(state, str):
raise TypeError("Expected argument 'state' to be a str")
pulumi.set(__self__, "state", state)
if time_quota and not isinstance(time_quota, int):
raise TypeError("Expected argument 'time_quota' to be a int")
pulumi.set(__self__, "time_quota", time_quota)
if time_windows and not isinstance(time_windows, list):
raise TypeError("Expected argument 'time_windows' to be a list")
pulumi.set(__self__, "time_windows", time_windows)
if url_categories and not isinstance(url_categories, list):
raise TypeError("Expected argument 'url_categories' to be a list")
pulumi.set(__self__, "url_categories", url_categories)
if user_agent_types and not isinstance(user_agent_types, list):
raise TypeError("Expected argument 'user_agent_types' to be a list")
pulumi.set(__self__, "user_agent_types", user_agent_types)
if users and not isinstance(users, list):
raise TypeError("Expected argument 'users' to be a list")
pulumi.set(__self__, "users", users)
if validity_end_time and not isinstance(validity_end_time, int):
raise TypeError("Expected argument 'validity_end_time' to be a int")
pulumi.set(__self__, "validity_end_time", validity_end_time)
if validity_start_time and not isinstance(validity_start_time, int):
raise TypeError("Expected argument 'validity_start_time' to be a int")
pulumi.set(__self__, "validity_start_time", validity_start_time)
if validity_time_zone_id and not isinstance(validity_time_zone_id, str):
raise TypeError("Expected argument 'validity_time_zone_id' to be a str")
pulumi.set(__self__, "validity_time_zone_id", validity_time_zone_id)
@property
@pulumi.getter
def action(self) -> str:
"""
(String) Action taken when traffic matches rule criteria. Supported values: `ANY`, `NONE`, `BLOCK`, `CAUTION`, `ALLOW`, `ICAP_RESPONSE`
"""
return pulumi.get(self, "action")
@property
@pulumi.getter(name="blockOverride")
def block_override(self) -> bool:
"""
(String) When set to true, a `BLOCK` action triggered by the rule could be overridden. If true and both overrideGroup and overrideUsers are not set, the `BLOCK` triggered by this rule could be overridden for any users. If block)Override is not set, `BLOCK` action cannot be overridden.
"""
return pulumi.get(self, "block_override")
@property
@pulumi.getter(name="cbiProfileId")
def cbi_profile_id(self) -> int:
return pulumi.get(self, "cbi_profile_id")
@property
@pulumi.getter
def ciparule(self) -> bool:
return pulumi.get(self, "ciparule")
@property
@pulumi.getter
def departments(self) -> Sequence['outputs.GetURLFilteringRulesDepartmentResult']:
"""
(List of Object) The departments to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "departments")
@property
@pulumi.getter
def description(self) -> str:
"""
(String) Additional information about the rule
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="deviceGroups")
def device_groups(self) -> Sequence['outputs.GetURLFilteringRulesDeviceGroupResult']:
return pulumi.get(self, "device_groups")
@property
@pulumi.getter(name="deviceTrustLevels")
def device_trust_levels(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "device_trust_levels")
@property
@pulumi.getter
def devices(self) -> Sequence['outputs.GetURLFilteringRulesDeviceResult']:
return pulumi.get(self, "devices")
@property
@pulumi.getter(name="endUserNotificationUrl")
def end_user_notification_url(self) -> str:
"""
(String) URL of end user notification page to be displayed when the rule is matched. Not applicable if either 'overrideUsers' or 'overrideGroups' is specified.
"""
return pulumi.get(self, "end_user_notification_url")
@property
@pulumi.getter(name="enforceTimeValidity")
def enforce_time_validity(self) -> bool:
"""
(String) Enforce a set a validity time period for the URL Filtering rule.
"""
return pulumi.get(self, "enforce_time_validity")
@property
@pulumi.getter
def groups(self) -> Sequence['outputs.GetURLFilteringRulesGroupResult']:
"""
(List of Object) The groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "groups")
@property
@pulumi.getter
def id(self) -> int:
"""
(Number) Identifier that uniquely identifies an entity
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def labels(self) -> Sequence['outputs.GetURLFilteringRulesLabelResult']:
return pulumi.get(self, "labels")
@property
@pulumi.getter(name="lastModifiedBies")
def last_modified_bies(self) -> Sequence['outputs.GetURLFilteringRulesLastModifiedByResult']:
return pulumi.get(self, "last_modified_bies")
@property
@pulumi.getter(name="lastModifiedTime")
def last_modified_time(self) -> int:
"""
(Number) When the rule was last modified
"""
return pulumi.get(self, "last_modified_time")
@property
@pulumi.getter(name="locationGroups")
def location_groups(self) -> Sequence['outputs.GetURLFilteringRulesLocationGroupResult']:
"""
(List of Object) The location groups to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "location_groups")
@property
@pulumi.getter
def locations(self) -> Sequence['outputs.GetURLFilteringRulesLocationResult']:
"""
(List of Object) The locations to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "locations")
@property
@pulumi.getter
def name(self) -> str:
"""
(String) The configured name of the entity
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def order(self) -> int:
"""
(Number) Order of execution of rule with respect to other URL Filtering rules
"""
return pulumi.get(self, "order")
@property
@pulumi.getter(name="overrideGroups")
def override_groups(self) -> Sequence['outputs.GetURLFilteringRulesOverrideGroupResult']:
"""
(List of Object) Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any group.
"""
return pulumi.get(self, "override_groups")
@property
@pulumi.getter(name="overrideUsers")
def override_users(self) -> Sequence['outputs.GetURLFilteringRulesOverrideUserResult']:
"""
(List of Object) Name-ID pairs of users for which this rule can be overridden. Applicable only if blockOverride is set to `true`, action is `BLOCK` and overrideGroups is not set.If this overrideUsers is not set, `BLOCK` action can be overridden for any user.
"""
return pulumi.get(self, "override_users")
@property
@pulumi.getter
def protocols(self) -> Sequence[str]:
"""
(List of Object) 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`.
"""
return pulumi.get(self, "protocols")
@property
@pulumi.getter
def rank(self) -> int:
"""
(String) Admin rank of the admin who creates this rule
"""
return pulumi.get(self, "rank")
@property
@pulumi.getter(name="requestMethods")
def request_methods(self) -> Sequence[str]:
"""
(String) Request method for which the rule must be applied. If not set, rule will be applied to all methods
"""
return pulumi.get(self, "request_methods")
@property
@pulumi.getter(name="sizeQuota")
def size_quota(self) -> int:
"""
(String) 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.
"""
return pulumi.get(self, "size_quota")
@property
@pulumi.getter
def state(self) -> str:
"""
(String) Rule State
"""
return pulumi.get(self, "state")
@property
@pulumi.getter(name="timeQuota")
def time_quota(self) -> int:
"""
(String) 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.
"""
return pulumi.get(self, "time_quota")
@property
@pulumi.getter(name="timeWindows")
def time_windows(self) -> Sequence['outputs.GetURLFilteringRulesTimeWindowResult']:
"""
(List of Object) The time interval in which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "time_windows")
@property
@pulumi.getter(name="urlCategories")
def url_categories(self) -> Sequence[str]:
"""
(String) List of URL categories for which rule must be applied
"""
return pulumi.get(self, "url_categories")
@property
@pulumi.getter(name="userAgentTypes")
def user_agent_types(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "user_agent_types")
@property
@pulumi.getter
def users(self) -> Sequence['outputs.GetURLFilteringRulesUserResult']:
"""
(List of Object) The users to which the Firewall Filtering policy rule applies
"""
return pulumi.get(self, "users")
@property
@pulumi.getter(name="validityEndTime")
def validity_end_time(self) -> int:
"""
(Number) If enforceTimeValidity is set to true, the URL Filtering rule will cease to be valid on this end date and time.
"""
return pulumi.get(self, "validity_end_time")
@property
@pulumi.getter(name="validityStartTime")
def validity_start_time(self) -> int:
"""
(Number) If enforceTimeValidity is set to true, the URL Filtering rule will be valid starting on this date and time.
"""
return pulumi.get(self, "validity_start_time")
@property
@pulumi.getter(name="validityTimeZoneId")
def validity_time_zone_id(self) -> str:
"""
(Number) If enforceTimeValidity is set to true, the URL Filtering rule date and time will be valid based on this time zone ID.
"""
return pulumi.get(self, "validity_time_zone_id")
class AwaitableGetURLFilteringRulesResult(GetURLFilteringRulesResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetURLFilteringRulesResult(
action=self.action,
block_override=self.block_override,
cbi_profile_id=self.cbi_profile_id,
ciparule=self.ciparule,
departments=self.departments,
description=self.description,
device_groups=self.device_groups,
device_trust_levels=self.device_trust_levels,
devices=self.devices,
end_user_notification_url=self.end_user_notification_url,
enforce_time_validity=self.enforce_time_validity,
groups=self.groups,
id=self.id,
labels=self.labels,
last_modified_bies=self.last_modified_bies,
last_modified_time=self.last_modified_time,
location_groups=self.location_groups,
locations=self.locations,
name=self.name,
order=self.order,
override_groups=self.override_groups,
override_users=self.override_users,
protocols=self.protocols,
rank=self.rank,
request_methods=self.request_methods,
size_quota=self.size_quota,
state=self.state,
time_quota=self.time_quota,
time_windows=self.time_windows,
url_categories=self.url_categories,
user_agent_types=self.user_agent_types,
users=self.users,
validity_end_time=self.validity_end_time,
validity_start_time=self.validity_start_time,
validity_time_zone_id=self.validity_time_zone_id)
def get_url_filtering_rules(device_trust_levels: Optional[Sequence[str]] = None,
id: Optional[int] = None,
name: Optional[str] = None,
order: Optional[int] = None,
user_agent_types: Optional[Sequence[str]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetURLFilteringRulesResult:
"""
Use the **zia_url_filtering_rules** data source to get information about a URL filtering rule information for the specified `Name`.
```python
import pulumi
import pulumi_zia as zia
example = zia.URLFiltering.get_url_filtering_rules(name="Example")
```
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
:param int order: (Number) Order of execution of rule with respect to other URL Filtering rules
"""
__args__ = dict()
__args__['deviceTrustLevels'] = device_trust_levels
__args__['id'] = id
__args__['name'] = name
__args__['order'] = order
__args__['userAgentTypes'] = user_agent_types
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:URLFiltering/getURLFilteringRules:getURLFilteringRules', __args__, opts=opts, typ=GetURLFilteringRulesResult).value
return AwaitableGetURLFilteringRulesResult(
action=__ret__.action,
block_override=__ret__.block_override,
cbi_profile_id=__ret__.cbi_profile_id,
ciparule=__ret__.ciparule,
departments=__ret__.departments,
description=__ret__.description,
device_groups=__ret__.device_groups,
device_trust_levels=__ret__.device_trust_levels,
devices=__ret__.devices,
end_user_notification_url=__ret__.end_user_notification_url,
enforce_time_validity=__ret__.enforce_time_validity,
groups=__ret__.groups,
id=__ret__.id,
labels=__ret__.labels,
last_modified_bies=__ret__.last_modified_bies,
last_modified_time=__ret__.last_modified_time,
location_groups=__ret__.location_groups,
locations=__ret__.locations,
name=__ret__.name,
order=__ret__.order,
override_groups=__ret__.override_groups,
override_users=__ret__.override_users,
protocols=__ret__.protocols,
rank=__ret__.rank,
request_methods=__ret__.request_methods,
size_quota=__ret__.size_quota,
state=__ret__.state,
time_quota=__ret__.time_quota,
time_windows=__ret__.time_windows,
url_categories=__ret__.url_categories,
user_agent_types=__ret__.user_agent_types,
users=__ret__.users,
validity_end_time=__ret__.validity_end_time,
validity_start_time=__ret__.validity_start_time,
validity_time_zone_id=__ret__.validity_time_zone_id)
@_utilities.lift_output_func(get_url_filtering_rules)
def get_url_filtering_rules_output(device_trust_levels: Optional[pulumi.Input[Optional[Sequence[str]]]] = None,
id: Optional[pulumi.Input[Optional[int]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
order: Optional[pulumi.Input[Optional[int]]] = None,
user_agent_types: Optional[pulumi.Input[Optional[Sequence[str]]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetURLFilteringRulesResult]:
"""
Use the **zia_url_filtering_rules** data source to get information about a URL filtering rule information for the specified `Name`.
```python
import pulumi
import pulumi_zia as zia
example = zia.URLFiltering.get_url_filtering_rules(name="Example")
```
:param int id: URL Filtering Rule ID
:param str name: Name of the URL Filtering policy rule
:param int order: (Number) Order of execution of rule with respect to other URL Filtering rules
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/urlfiltering/get_url_filtering_rules.py | get_url_filtering_rules.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetDeviceGroupsResult',
'AwaitableGetDeviceGroupsResult',
'get_device_groups',
'get_device_groups_output',
]
@pulumi.output_type
class GetDeviceGroupsResult:
"""
A collection of values returned by getDeviceGroups.
"""
def __init__(__self__, description=None, device_count=None, device_names=None, group_type=None, id=None, name=None, os_type=None, predefined=None):
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if device_count and not isinstance(device_count, int):
raise TypeError("Expected argument 'device_count' to be a int")
pulumi.set(__self__, "device_count", device_count)
if device_names and not isinstance(device_names, str):
raise TypeError("Expected argument 'device_names' to be a str")
pulumi.set(__self__, "device_names", device_names)
if group_type and not isinstance(group_type, str):
raise TypeError("Expected argument 'group_type' to be a str")
pulumi.set(__self__, "group_type", group_type)
if id and not isinstance(id, int):
raise TypeError("Expected argument 'id' to be a int")
pulumi.set(__self__, "id", id)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if os_type and not isinstance(os_type, str):
raise TypeError("Expected argument 'os_type' to be a str")
pulumi.set(__self__, "os_type", os_type)
if predefined and not isinstance(predefined, bool):
raise TypeError("Expected argument 'predefined' to be a bool")
pulumi.set(__self__, "predefined", predefined)
@property
@pulumi.getter
def description(self) -> str:
"""
(String) The device group's description.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="deviceCount")
def device_count(self) -> int:
"""
(int) The number of devices within the group.
"""
return pulumi.get(self, "device_count")
@property
@pulumi.getter(name="deviceNames")
def device_names(self) -> str:
"""
(String) The names of devices that belong to the device group. The device names are comma-separated.
"""
return pulumi.get(self, "device_names")
@property
@pulumi.getter(name="groupType")
def group_type(self) -> str:
"""
(String) The device group type. i.e ``ZCC_OS``, ``NON_ZCC``, ``CBI``
"""
return pulumi.get(self, "group_type")
@property
@pulumi.getter
def id(self) -> int:
"""
(String) The unique identifer for the device group.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
(String) The device group name.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="osType")
def os_type(self) -> str:
"""
(String) The operating system (OS).
"""
return pulumi.get(self, "os_type")
@property
@pulumi.getter
def predefined(self) -> bool:
"""
(Boolean) Indicates whether this is a predefined device group. If this value is set to true, the group is predefined.
"""
return pulumi.get(self, "predefined")
class AwaitableGetDeviceGroupsResult(GetDeviceGroupsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetDeviceGroupsResult(
description=self.description,
device_count=self.device_count,
device_names=self.device_names,
group_type=self.group_type,
id=self.id,
name=self.name,
os_type=self.os_type,
predefined=self.predefined)
def get_device_groups(name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDeviceGroupsResult:
"""
Use the **zia_device_groups** data source to get information about a device group in the Zscaler Internet Access cloud or via the API. This data source can then be associated with resources such as: URL Filtering Rules
## Example Usage
```python
import pulumi
import pulumi_zia as zia
ios = zia.DeviceGroups.get_device_groups(name="IOS")
```
```python
import pulumi
import pulumi_zia as zia
android = zia.DeviceGroups.get_device_groups(name="Android")
```
:param str name: The name of the device group to be exported.
"""
__args__ = dict()
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zia:DeviceGroups/getDeviceGroups:getDeviceGroups', __args__, opts=opts, typ=GetDeviceGroupsResult).value
return AwaitableGetDeviceGroupsResult(
description=__ret__.description,
device_count=__ret__.device_count,
device_names=__ret__.device_names,
group_type=__ret__.group_type,
id=__ret__.id,
name=__ret__.name,
os_type=__ret__.os_type,
predefined=__ret__.predefined)
@_utilities.lift_output_func(get_device_groups)
def get_device_groups_output(name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetDeviceGroupsResult]:
"""
Use the **zia_device_groups** data source to get information about a device group in the Zscaler Internet Access cloud or via the API. This data source can then be associated with resources such as: URL Filtering Rules
## Example Usage
```python
import pulumi
import pulumi_zia as zia
ios = zia.DeviceGroups.get_device_groups(name="IOS")
```
```python
import pulumi
import pulumi_zia as zia
android = zia.DeviceGroups.get_device_groups(name="Android")
```
:param str name: The name of the device group to be exported.
"""
... | zscaler-pulumi-zia | /zscaler_pulumi_zia-0.0.3a1675095059.tar.gz/zscaler_pulumi_zia-0.0.3a1675095059/zscaler_pulumi_zia/devicegroups/get_device_groups.py | get_device_groups.py |
# ZPA Resource Provider
The ZPA Resource Provider for Pulumi lets you manage [ZPA](http://github.com/zscaler/pulumi-zpa) resources. To use
this package, please [install the Pulumi CLI first](https://pulumi.com/).
## Installing
This package is available for several languages/platforms:
### Node.js (JavaScript/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
```bash
npm install @zscaler/pulumi-zpa
```
or `yarn`:
```bash
yarn add @zscaler/pulumi-zpa
```
### Python
To use from Python, install using `pip`:
```bash
pip install zscaler-pulumi-zpa
```
### Go
To use from Go, use `go get` to grab the latest version of the library:
```bash
go get github.com/zscaler/pulumi-zpa/sdk/go/...
```
### .NET
To use from .NET, install using `dotnet add package`:
```bash
dotnet add package zscaler.PulumiPackage.Zpa
```
## Configuration
The following configuration points are available for the `zpa` provider:
- `zpa:client_id` (client id: `ZPA_CLIENT_ID`) - the client id for `zpa`
- `zpa:client_secret` (client secret: `ZPA_CLIENT_SECRET`) - the client secret for `zpa`
- `zpa:customer_id` (customer id: `ZPA_CUSTOMER_ID`) - the customer id that identifies the ZPA tenant
- `zpa:cloud` (cloud environment: `ZPA_CLOUD`) - the cloud environment in which to deploy resources
## Reference
For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/zpa/api-docs/).
## Support
This template/solution are released under an as-is, best effort, support
policy. These scripts should be seen as community supported and Zscaler
Business Development Team will contribute our expertise as and when possible.
We do not provide technical support or help in using or troubleshooting the components
of the project through our normal support options such as Zscaler support teams,
or ASC (Authorized Support Centers) partners and backline
support options. The underlying product used (Zscaler Internet Access API) by the
scripts or templates are still supported, but the support is only for the
product functionality and not for help in deploying or using the template or
script itself. Unless explicitly tagged, all projects or work posted in our
GitHub repository at (<https://github.com/zscaler>) or sites other
than our official Downloads page on <https://support.zscaler.com>
are provided under the best effort policy.
| zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/README.md | README.md |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from . import _utilities
__all__ = ['ProviderArgs', 'Provider']
@pulumi.input_type
class ProviderArgs:
def __init__(__self__, *,
zpa_client_id: Optional[pulumi.Input[str]] = None,
zpa_client_secret: Optional[pulumi.Input[str]] = None,
zpa_cloud: Optional[pulumi.Input[str]] = None,
zpa_customer_id: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a Provider resource.
:param pulumi.Input[str] zpa_client_id: zpa client id
:param pulumi.Input[str] zpa_client_secret: zpa client secret
:param pulumi.Input[str] zpa_cloud: Cloud to use PRODUCTION, BETA, GOV or PREVIEW
:param pulumi.Input[str] zpa_customer_id: zpa customer id
"""
if zpa_client_id is None:
zpa_client_id = _utilities.get_env('ZPA_CLIENT_ID')
if zpa_client_id is not None:
pulumi.set(__self__, "zpa_client_id", zpa_client_id)
if zpa_client_secret is None:
zpa_client_secret = _utilities.get_env('ZPA_CLIENT_SECRET')
if zpa_client_secret is not None:
pulumi.set(__self__, "zpa_client_secret", zpa_client_secret)
if zpa_cloud is None:
zpa_cloud = _utilities.get_env('ZPA_CLOUD')
if zpa_cloud is not None:
pulumi.set(__self__, "zpa_cloud", zpa_cloud)
if zpa_customer_id is None:
zpa_customer_id = _utilities.get_env('ZPA_CUSTOMER_ID')
if zpa_customer_id is not None:
pulumi.set(__self__, "zpa_customer_id", zpa_customer_id)
@property
@pulumi.getter(name="zpaClientId")
def zpa_client_id(self) -> Optional[pulumi.Input[str]]:
"""
zpa client id
"""
return pulumi.get(self, "zpa_client_id")
@zpa_client_id.setter
def zpa_client_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpa_client_id", value)
@property
@pulumi.getter(name="zpaClientSecret")
def zpa_client_secret(self) -> Optional[pulumi.Input[str]]:
"""
zpa client secret
"""
return pulumi.get(self, "zpa_client_secret")
@zpa_client_secret.setter
def zpa_client_secret(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpa_client_secret", value)
@property
@pulumi.getter(name="zpaCloud")
def zpa_cloud(self) -> Optional[pulumi.Input[str]]:
"""
Cloud to use PRODUCTION, BETA, GOV or PREVIEW
"""
return pulumi.get(self, "zpa_cloud")
@zpa_cloud.setter
def zpa_cloud(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpa_cloud", value)
@property
@pulumi.getter(name="zpaCustomerId")
def zpa_customer_id(self) -> Optional[pulumi.Input[str]]:
"""
zpa customer id
"""
return pulumi.get(self, "zpa_customer_id")
@zpa_customer_id.setter
def zpa_customer_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpa_customer_id", value)
class Provider(pulumi.ProviderResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
zpa_client_id: Optional[pulumi.Input[str]] = None,
zpa_client_secret: Optional[pulumi.Input[str]] = None,
zpa_cloud: Optional[pulumi.Input[str]] = None,
zpa_customer_id: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The provider type for the zpa package. By default, resources use package-wide configuration
settings, however an explicit `Provider` instance may be created and passed during resource
construction to achieve fine-grained programmatic control over provider settings. See the
[documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] zpa_client_id: zpa client id
:param pulumi.Input[str] zpa_client_secret: zpa client secret
:param pulumi.Input[str] zpa_cloud: Cloud to use PRODUCTION, BETA, GOV or PREVIEW
:param pulumi.Input[str] zpa_customer_id: zpa customer id
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[ProviderArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The provider type for the zpa package. By default, resources use package-wide configuration
settings, however an explicit `Provider` instance may be created and passed during resource
construction to achieve fine-grained programmatic control over provider settings. See the
[documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
:param str resource_name: The name of the resource.
:param ProviderArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ProviderArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
zpa_client_id: Optional[pulumi.Input[str]] = None,
zpa_client_secret: Optional[pulumi.Input[str]] = None,
zpa_cloud: Optional[pulumi.Input[str]] = None,
zpa_customer_id: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ProviderArgs.__new__(ProviderArgs)
if zpa_client_id is None:
zpa_client_id = _utilities.get_env('ZPA_CLIENT_ID')
__props__.__dict__["zpa_client_id"] = zpa_client_id
if zpa_client_secret is None:
zpa_client_secret = _utilities.get_env('ZPA_CLIENT_SECRET')
__props__.__dict__["zpa_client_secret"] = None if zpa_client_secret is None else pulumi.Output.secret(zpa_client_secret)
if zpa_cloud is None:
zpa_cloud = _utilities.get_env('ZPA_CLOUD')
__props__.__dict__["zpa_cloud"] = zpa_cloud
if zpa_customer_id is None:
zpa_customer_id = _utilities.get_env('ZPA_CUSTOMER_ID')
__props__.__dict__["zpa_customer_id"] = None if zpa_customer_id is None else pulumi.Output.secret(zpa_customer_id)
secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["zpaClientSecret", "zpaCustomerId"])
opts = pulumi.ResourceOptions.merge(opts, secret_opts)
super(Provider, __self__).__init__(
'zpa',
resource_name,
__props__,
opts)
@property
@pulumi.getter(name="zpaClientId")
def zpa_client_id(self) -> pulumi.Output[Optional[str]]:
"""
zpa client id
"""
return pulumi.get(self, "zpa_client_id")
@property
@pulumi.getter(name="zpaClientSecret")
def zpa_client_secret(self) -> pulumi.Output[Optional[str]]:
"""
zpa client secret
"""
return pulumi.get(self, "zpa_client_secret")
@property
@pulumi.getter(name="zpaCloud")
def zpa_cloud(self) -> pulumi.Output[Optional[str]]:
"""
Cloud to use PRODUCTION, BETA, GOV or PREVIEW
"""
return pulumi.get(self, "zpa_cloud")
@property
@pulumi.getter(name="zpaCustomerId")
def zpa_customer_id(self) -> pulumi.Output[Optional[str]]:
"""
zpa customer id
"""
return pulumi.get(self, "zpa_customer_id") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/provider.py | provider.py |
import importlib.util
import inspect
import json
import os
import pkg_resources
import sys
import typing
import pulumi
import pulumi.runtime
from semver import VersionInfo as SemverVersion
from parver import Version as PEP440Version
def get_env(*args):
for v in args:
value = os.getenv(v)
if value is not None:
return value
return None
def get_env_bool(*args):
str = get_env(*args)
if str is not None:
# NOTE: these values are taken from https://golang.org/src/strconv/atob.go?s=351:391#L1, which is what
# Terraform uses internally when parsing boolean values.
if str in ["1", "t", "T", "true", "TRUE", "True"]:
return True
if str in ["0", "f", "F", "false", "FALSE", "False"]:
return False
return None
def get_env_int(*args):
str = get_env(*args)
if str is not None:
try:
return int(str)
except:
return None
return None
def get_env_float(*args):
str = get_env(*args)
if str is not None:
try:
return float(str)
except:
return None
return None
def _get_semver_version():
# __name__ is set to the fully-qualified name of the current module, In our case, it will be
# <some module>._utilities. <some module> is the module we want to query the version for.
root_package, *rest = __name__.split('.')
# pkg_resources uses setuptools to inspect the set of installed packages. We use it here to ask
# for the currently installed version of the root package (i.e. us) and get its version.
# Unfortunately, PEP440 and semver differ slightly in incompatible ways. The Pulumi engine expects
# to receive a valid semver string when receiving requests from the language host, so it's our
# responsibility as the library to convert our own PEP440 version into a valid semver string.
pep440_version_string = pkg_resources.require(root_package)[0].version
pep440_version = PEP440Version.parse(pep440_version_string)
(major, minor, patch) = pep440_version.release
prerelease = None
if pep440_version.pre_tag == 'a':
prerelease = f"alpha.{pep440_version.pre}"
elif pep440_version.pre_tag == 'b':
prerelease = f"beta.{pep440_version.pre}"
elif pep440_version.pre_tag == 'rc':
prerelease = f"rc.{pep440_version.pre}"
elif pep440_version.dev is not None:
prerelease = f"dev.{pep440_version.dev}"
# The only significant difference between PEP440 and semver as it pertains to us is that PEP440 has explicit support
# for dev builds, while semver encodes them as "prerelease" versions. In order to bridge between the two, we convert
# our dev build version into a prerelease tag. This matches what all of our other packages do when constructing
# their own semver string.
return SemverVersion(major=major, minor=minor, patch=patch, prerelease=prerelease)
# Determine the version once and cache the value, which measurably improves program performance.
_version = _get_semver_version()
_version_str = str(_version)
def get_version():
return _version_str
def get_resource_opts_defaults() -> pulumi.ResourceOptions:
return pulumi.ResourceOptions(
version=get_version(),
plugin_download_url=get_plugin_download_url(),
)
def get_invoke_opts_defaults() -> pulumi.InvokeOptions:
return pulumi.InvokeOptions(
version=get_version(),
plugin_download_url=get_plugin_download_url(),
)
def get_resource_args_opts(resource_args_type, resource_options_type, *args, **kwargs):
"""
Return the resource args and options given the *args and **kwargs of a resource's
__init__ method.
"""
resource_args, opts = None, None
# If the first item is the resource args type, save it and remove it from the args list.
if args and isinstance(args[0], resource_args_type):
resource_args, args = args[0], args[1:]
# Now look at the first item in the args list again.
# If the first item is the resource options class, save it.
if args and isinstance(args[0], resource_options_type):
opts = args[0]
# If resource_args is None, see if "args" is in kwargs, and, if so, if it's typed as the
# the resource args type.
if resource_args is None:
a = kwargs.get("args")
if isinstance(a, resource_args_type):
resource_args = a
# If opts is None, look it up in kwargs.
if opts is None:
opts = kwargs.get("opts")
return resource_args, opts
# Temporary: just use pulumi._utils.lazy_import once everyone upgrades.
def lazy_import(fullname):
import pulumi._utils as u
f = getattr(u, 'lazy_import', None)
if f is None:
f = _lazy_import_temp
return f(fullname)
# Copied from pulumi._utils.lazy_import, see comments there.
def _lazy_import_temp(fullname):
m = sys.modules.get(fullname, None)
if m is not None:
return m
spec = importlib.util.find_spec(fullname)
m = sys.modules.get(fullname, None)
if m is not None:
return m
loader = importlib.util.LazyLoader(spec.loader)
spec.loader = loader
module = importlib.util.module_from_spec(spec)
m = sys.modules.get(fullname, None)
if m is not None:
return m
sys.modules[fullname] = module
loader.exec_module(module)
return module
class Package(pulumi.runtime.ResourcePackage):
def __init__(self, pkg_info):
super().__init__()
self.pkg_info = pkg_info
def version(self):
return _version
def construct_provider(self, name: str, typ: str, urn: str) -> pulumi.ProviderResource:
if typ != self.pkg_info['token']:
raise Exception(f"unknown provider type {typ}")
Provider = getattr(lazy_import(self.pkg_info['fqn']), self.pkg_info['class'])
return Provider(name, pulumi.ResourceOptions(urn=urn))
class Module(pulumi.runtime.ResourceModule):
def __init__(self, mod_info):
super().__init__()
self.mod_info = mod_info
def version(self):
return _version
def construct(self, name: str, typ: str, urn: str) -> pulumi.Resource:
class_name = self.mod_info['classes'].get(typ, None)
if class_name is None:
raise Exception(f"unknown resource type {typ}")
TheClass = getattr(lazy_import(self.mod_info['fqn']), class_name)
return TheClass(name, pulumi.ResourceOptions(urn=urn))
def register(resource_modules, resource_packages):
resource_modules = json.loads(resource_modules)
resource_packages = json.loads(resource_packages)
for pkg_info in resource_packages:
pulumi.runtime.register_resource_package(pkg_info['pkg'], Package(pkg_info))
for mod_info in resource_modules:
pulumi.runtime.register_resource_module(
mod_info['pkg'],
mod_info['mod'],
Module(mod_info))
_F = typing.TypeVar('_F', bound=typing.Callable[..., typing.Any])
def lift_output_func(func: typing.Any) -> typing.Callable[[_F], _F]:
"""Decorator internally used on {fn}_output lifted function versions
to implement them automatically from the un-lifted function."""
func_sig = inspect.signature(func)
def lifted_func(*args, opts=None, **kwargs):
bound_args = func_sig.bind(*args, **kwargs)
# Convert tuple to list, see pulumi/pulumi#8172
args_list = list(bound_args.args)
return pulumi.Output.from_input({
'args': args_list,
'kwargs': bound_args.kwargs
}).apply(lambda resolved_args: func(*resolved_args['args'],
opts=opts,
**resolved_args['kwargs']))
return (lambda _: lifted_func)
def get_plugin_download_url():
return "github://api.github.com/zscaler" | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/_utilities.py | _utilities.py |
from . import _utilities
import typing
# Export this package's modules as members:
from .provider import *
# Make subpackages available:
if typing.TYPE_CHECKING:
import zscaler_pulumi_zpa.accesspolicy as __accesspolicy
accesspolicy = __accesspolicy
import zscaler_pulumi_zpa.appconnectorgroup as __appconnectorgroup
appconnectorgroup = __appconnectorgroup
import zscaler_pulumi_zpa.applicationsegment as __applicationsegment
applicationsegment = __applicationsegment
import zscaler_pulumi_zpa.applicationserver as __applicationserver
applicationserver = __applicationserver
import zscaler_pulumi_zpa.browsercertificate as __browsercertificate
browsercertificate = __browsercertificate
import zscaler_pulumi_zpa.cloudconnectorgroup as __cloudconnectorgroup
cloudconnectorgroup = __cloudconnectorgroup
import zscaler_pulumi_zpa.config as __config
config = __config
import zscaler_pulumi_zpa.enrollmentcertificate as __enrollmentcertificate
enrollmentcertificate = __enrollmentcertificate
import zscaler_pulumi_zpa.forwardpolicy as __forwardpolicy
forwardpolicy = __forwardpolicy
import zscaler_pulumi_zpa.idpcontroller as __idpcontroller
idpcontroller = __idpcontroller
import zscaler_pulumi_zpa.inspection as __inspection
inspection = __inspection
import zscaler_pulumi_zpa.inspectionpolicy as __inspectionpolicy
inspectionpolicy = __inspectionpolicy
import zscaler_pulumi_zpa.lssconfig as __lssconfig
lssconfig = __lssconfig
import zscaler_pulumi_zpa.machinegroup as __machinegroup
machinegroup = __machinegroup
import zscaler_pulumi_zpa.policytype as __policytype
policytype = __policytype
import zscaler_pulumi_zpa.postureprofile as __postureprofile
postureprofile = __postureprofile
import zscaler_pulumi_zpa.provisioningkey as __provisioningkey
provisioningkey = __provisioningkey
import zscaler_pulumi_zpa.samlattribute as __samlattribute
samlattribute = __samlattribute
import zscaler_pulumi_zpa.scimattribute as __scimattribute
scimattribute = __scimattribute
import zscaler_pulumi_zpa.scimgroup as __scimgroup
scimgroup = __scimgroup
import zscaler_pulumi_zpa.segmentgroup as __segmentgroup
segmentgroup = __segmentgroup
import zscaler_pulumi_zpa.servergroup as __servergroup
servergroup = __servergroup
import zscaler_pulumi_zpa.serviceedge as __serviceedge
serviceedge = __serviceedge
import zscaler_pulumi_zpa.timeoutpolicy as __timeoutpolicy
timeoutpolicy = __timeoutpolicy
import zscaler_pulumi_zpa.trustednetwork as __trustednetwork
trustednetwork = __trustednetwork
else:
accesspolicy = _utilities.lazy_import('zscaler_pulumi_zpa.accesspolicy')
appconnectorgroup = _utilities.lazy_import('zscaler_pulumi_zpa.appconnectorgroup')
applicationsegment = _utilities.lazy_import('zscaler_pulumi_zpa.applicationsegment')
applicationserver = _utilities.lazy_import('zscaler_pulumi_zpa.applicationserver')
browsercertificate = _utilities.lazy_import('zscaler_pulumi_zpa.browsercertificate')
cloudconnectorgroup = _utilities.lazy_import('zscaler_pulumi_zpa.cloudconnectorgroup')
config = _utilities.lazy_import('zscaler_pulumi_zpa.config')
enrollmentcertificate = _utilities.lazy_import('zscaler_pulumi_zpa.enrollmentcertificate')
forwardpolicy = _utilities.lazy_import('zscaler_pulumi_zpa.forwardpolicy')
idpcontroller = _utilities.lazy_import('zscaler_pulumi_zpa.idpcontroller')
inspection = _utilities.lazy_import('zscaler_pulumi_zpa.inspection')
inspectionpolicy = _utilities.lazy_import('zscaler_pulumi_zpa.inspectionpolicy')
lssconfig = _utilities.lazy_import('zscaler_pulumi_zpa.lssconfig')
machinegroup = _utilities.lazy_import('zscaler_pulumi_zpa.machinegroup')
policytype = _utilities.lazy_import('zscaler_pulumi_zpa.policytype')
postureprofile = _utilities.lazy_import('zscaler_pulumi_zpa.postureprofile')
provisioningkey = _utilities.lazy_import('zscaler_pulumi_zpa.provisioningkey')
samlattribute = _utilities.lazy_import('zscaler_pulumi_zpa.samlattribute')
scimattribute = _utilities.lazy_import('zscaler_pulumi_zpa.scimattribute')
scimgroup = _utilities.lazy_import('zscaler_pulumi_zpa.scimgroup')
segmentgroup = _utilities.lazy_import('zscaler_pulumi_zpa.segmentgroup')
servergroup = _utilities.lazy_import('zscaler_pulumi_zpa.servergroup')
serviceedge = _utilities.lazy_import('zscaler_pulumi_zpa.serviceedge')
timeoutpolicy = _utilities.lazy_import('zscaler_pulumi_zpa.timeoutpolicy')
trustednetwork = _utilities.lazy_import('zscaler_pulumi_zpa.trustednetwork')
_utilities.register(
resource_modules="""
[
{
"pkg": "zpa",
"mod": "AccessPolicy/policyAccessRule",
"fqn": "zscaler_pulumi_zpa.accesspolicy",
"classes": {
"zpa:AccessPolicy/policyAccessRule:PolicyAccessRule": "PolicyAccessRule"
}
},
{
"pkg": "zpa",
"mod": "AppConnectorGroup/connectorGroup",
"fqn": "zscaler_pulumi_zpa.appconnectorgroup",
"classes": {
"zpa:AppConnectorGroup/connectorGroup:ConnectorGroup": "ConnectorGroup"
}
},
{
"pkg": "zpa",
"mod": "ApplicationSegment/applicationSegment",
"fqn": "zscaler_pulumi_zpa.applicationsegment",
"classes": {
"zpa:ApplicationSegment/applicationSegment:ApplicationSegment": "ApplicationSegment"
}
},
{
"pkg": "zpa",
"mod": "ApplicationSegment/applicationSegmentBrowserAccess",
"fqn": "zscaler_pulumi_zpa.applicationsegment",
"classes": {
"zpa:ApplicationSegment/applicationSegmentBrowserAccess:ApplicationSegmentBrowserAccess": "ApplicationSegmentBrowserAccess"
}
},
{
"pkg": "zpa",
"mod": "ApplicationSegment/applicationSegmentInspection",
"fqn": "zscaler_pulumi_zpa.applicationsegment",
"classes": {
"zpa:ApplicationSegment/applicationSegmentInspection:ApplicationSegmentInspection": "ApplicationSegmentInspection"
}
},
{
"pkg": "zpa",
"mod": "ApplicationSegment/applicationSegmentPRA",
"fqn": "zscaler_pulumi_zpa.applicationsegment",
"classes": {
"zpa:ApplicationSegment/applicationSegmentPRA:ApplicationSegmentPRA": "ApplicationSegmentPRA"
}
},
{
"pkg": "zpa",
"mod": "ApplicationSegment/browserAccess",
"fqn": "zscaler_pulumi_zpa.applicationsegment",
"classes": {
"zpa:ApplicationSegment/browserAccess:BrowserAccess": "BrowserAccess"
}
},
{
"pkg": "zpa",
"mod": "ApplicationServer/applicationServer",
"fqn": "zscaler_pulumi_zpa.applicationserver",
"classes": {
"zpa:ApplicationServer/applicationServer:ApplicationServer": "ApplicationServer"
}
},
{
"pkg": "zpa",
"mod": "ForwardPolicy/policyAccessForwardingRule",
"fqn": "zscaler_pulumi_zpa.forwardpolicy",
"classes": {
"zpa:ForwardPolicy/policyAccessForwardingRule:PolicyAccessForwardingRule": "PolicyAccessForwardingRule"
}
},
{
"pkg": "zpa",
"mod": "Inspection/inspectionCustomControls",
"fqn": "zscaler_pulumi_zpa.inspection",
"classes": {
"zpa:Inspection/inspectionCustomControls:InspectionCustomControls": "InspectionCustomControls"
}
},
{
"pkg": "zpa",
"mod": "Inspection/inspectionProfile",
"fqn": "zscaler_pulumi_zpa.inspection",
"classes": {
"zpa:Inspection/inspectionProfile:InspectionProfile": "InspectionProfile"
}
},
{
"pkg": "zpa",
"mod": "InspectionPolicy/policyAccessInspectionRule",
"fqn": "zscaler_pulumi_zpa.inspectionpolicy",
"classes": {
"zpa:InspectionPolicy/policyAccessInspectionRule:PolicyAccessInspectionRule": "PolicyAccessInspectionRule"
}
},
{
"pkg": "zpa",
"mod": "LSSConfig/lSSConfigController",
"fqn": "zscaler_pulumi_zpa.lssconfig",
"classes": {
"zpa:LSSConfig/lSSConfigController:LSSConfigController": "LSSConfigController"
}
},
{
"pkg": "zpa",
"mod": "ProvisioningKey/provisioningKey",
"fqn": "zscaler_pulumi_zpa.provisioningkey",
"classes": {
"zpa:ProvisioningKey/provisioningKey:ProvisioningKey": "ProvisioningKey"
}
},
{
"pkg": "zpa",
"mod": "SegmentGroup/segmentGroup",
"fqn": "zscaler_pulumi_zpa.segmentgroup",
"classes": {
"zpa:SegmentGroup/segmentGroup:SegmentGroup": "SegmentGroup"
}
},
{
"pkg": "zpa",
"mod": "ServerGroup/serverGroup",
"fqn": "zscaler_pulumi_zpa.servergroup",
"classes": {
"zpa:ServerGroup/serverGroup:ServerGroup": "ServerGroup"
}
},
{
"pkg": "zpa",
"mod": "ServiceEdge/serviceEdgeGroup",
"fqn": "zscaler_pulumi_zpa.serviceedge",
"classes": {
"zpa:ServiceEdge/serviceEdgeGroup:ServiceEdgeGroup": "ServiceEdgeGroup"
}
},
{
"pkg": "zpa",
"mod": "TimeoutPolicy/policyAccessTimeOutRule",
"fqn": "zscaler_pulumi_zpa.timeoutpolicy",
"classes": {
"zpa:TimeoutPolicy/policyAccessTimeOutRule:PolicyAccessTimeOutRule": "PolicyAccessTimeOutRule"
}
}
]
""",
resource_packages="""
[
{
"pkg": "zpa",
"token": "pulumi:providers:zpa",
"fqn": "zscaler_pulumi_zpa",
"class": "Provider"
}
]
"""
) | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/__init__.py | __init__.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = ['ProvisioningKeyArgs', 'ProvisioningKey']
@pulumi.input_type
class ProvisioningKeyArgs:
def __init__(__self__, *,
association_type: pulumi.Input[str],
enrollment_cert_id: pulumi.Input[str],
max_usage: pulumi.Input[str],
zcomponent_id: pulumi.Input[str],
app_connector_group_id: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
ip_acls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
ui_config: Optional[pulumi.Input[str]] = None,
usage_count: Optional[pulumi.Input[str]] = None,
zcomponent_name: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a ProvisioningKey resource.
:param pulumi.Input[str] association_type: Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
:param pulumi.Input[str] enrollment_cert_id: ID of the enrollment certificate that can be used for this provisioning key. `ID` of the existing enrollment certificate that has the private key
:param pulumi.Input[str] max_usage: The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
:param pulumi.Input[str] zcomponent_id: ID of the existing App Connector or Service Edge Group.
:param pulumi.Input[bool] enabled: Whether the provisioning key is enabled or not. Supported values: true, false
:param pulumi.Input[str] name: Name of the provisioning key.
:param pulumi.Input[str] usage_count: The provisioning key utilization count.
:param pulumi.Input[str] zcomponent_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
pulumi.set(__self__, "association_type", association_type)
pulumi.set(__self__, "enrollment_cert_id", enrollment_cert_id)
pulumi.set(__self__, "max_usage", max_usage)
pulumi.set(__self__, "zcomponent_id", zcomponent_id)
if app_connector_group_id is not None:
pulumi.set(__self__, "app_connector_group_id", app_connector_group_id)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if ip_acls is not None:
pulumi.set(__self__, "ip_acls", ip_acls)
if name is not None:
pulumi.set(__self__, "name", name)
if ui_config is not None:
pulumi.set(__self__, "ui_config", ui_config)
if usage_count is not None:
pulumi.set(__self__, "usage_count", usage_count)
if zcomponent_name is not None:
pulumi.set(__self__, "zcomponent_name", zcomponent_name)
@property
@pulumi.getter(name="associationType")
def association_type(self) -> pulumi.Input[str]:
"""
Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
"""
return pulumi.get(self, "association_type")
@association_type.setter
def association_type(self, value: pulumi.Input[str]):
pulumi.set(self, "association_type", value)
@property
@pulumi.getter(name="enrollmentCertId")
def enrollment_cert_id(self) -> pulumi.Input[str]:
"""
ID of the enrollment certificate that can be used for this provisioning key. `ID` of the existing enrollment certificate that has the private key
"""
return pulumi.get(self, "enrollment_cert_id")
@enrollment_cert_id.setter
def enrollment_cert_id(self, value: pulumi.Input[str]):
pulumi.set(self, "enrollment_cert_id", value)
@property
@pulumi.getter(name="maxUsage")
def max_usage(self) -> pulumi.Input[str]:
"""
The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
"""
return pulumi.get(self, "max_usage")
@max_usage.setter
def max_usage(self, value: pulumi.Input[str]):
pulumi.set(self, "max_usage", value)
@property
@pulumi.getter(name="zcomponentId")
def zcomponent_id(self) -> pulumi.Input[str]:
"""
ID of the existing App Connector or Service Edge Group.
"""
return pulumi.get(self, "zcomponent_id")
@zcomponent_id.setter
def zcomponent_id(self, value: pulumi.Input[str]):
pulumi.set(self, "zcomponent_id", value)
@property
@pulumi.getter(name="appConnectorGroupId")
def app_connector_group_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "app_connector_group_id")
@app_connector_group_id.setter
def app_connector_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "app_connector_group_id", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether the provisioning key is enabled or not. Supported values: true, false
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="ipAcls")
def ip_acls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "ip_acls")
@ip_acls.setter
def ip_acls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_acls", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the provisioning key.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="uiConfig")
def ui_config(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "ui_config")
@ui_config.setter
def ui_config(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ui_config", value)
@property
@pulumi.getter(name="usageCount")
def usage_count(self) -> Optional[pulumi.Input[str]]:
"""
The provisioning key utilization count.
"""
return pulumi.get(self, "usage_count")
@usage_count.setter
def usage_count(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "usage_count", value)
@property
@pulumi.getter(name="zcomponentName")
def zcomponent_name(self) -> Optional[pulumi.Input[str]]:
"""
Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "zcomponent_name")
@zcomponent_name.setter
def zcomponent_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zcomponent_name", value)
@pulumi.input_type
class _ProvisioningKeyState:
def __init__(__self__, *,
app_connector_group_id: Optional[pulumi.Input[str]] = None,
app_connector_group_name: Optional[pulumi.Input[str]] = None,
association_type: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
enrollment_cert_id: Optional[pulumi.Input[str]] = None,
enrollment_cert_name: Optional[pulumi.Input[str]] = None,
ip_acls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
key: Optional[pulumi.Input[str]] = None,
max_usage: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
ui_config: Optional[pulumi.Input[str]] = None,
usage_count: Optional[pulumi.Input[str]] = None,
zcomponent_id: Optional[pulumi.Input[str]] = None,
zcomponent_name: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering ProvisioningKey resources.
:param pulumi.Input[str] app_connector_group_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
:param pulumi.Input[str] association_type: Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
:param pulumi.Input[bool] enabled: Whether the provisioning key is enabled or not. Supported values: true, false
:param pulumi.Input[str] enrollment_cert_id: ID of the enrollment certificate that can be used for this provisioning key. `ID` of the existing enrollment certificate that has the private key
:param pulumi.Input[str] enrollment_cert_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
:param pulumi.Input[str] key: read only field. Ignored in PUT/POST calls.
:param pulumi.Input[str] max_usage: The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
:param pulumi.Input[str] name: Name of the provisioning key.
:param pulumi.Input[str] usage_count: The provisioning key utilization count.
:param pulumi.Input[str] zcomponent_id: ID of the existing App Connector or Service Edge Group.
:param pulumi.Input[str] zcomponent_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
if app_connector_group_id is not None:
pulumi.set(__self__, "app_connector_group_id", app_connector_group_id)
if app_connector_group_name is not None:
pulumi.set(__self__, "app_connector_group_name", app_connector_group_name)
if association_type is not None:
pulumi.set(__self__, "association_type", association_type)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if enrollment_cert_id is not None:
pulumi.set(__self__, "enrollment_cert_id", enrollment_cert_id)
if enrollment_cert_name is not None:
pulumi.set(__self__, "enrollment_cert_name", enrollment_cert_name)
if ip_acls is not None:
pulumi.set(__self__, "ip_acls", ip_acls)
if key is not None:
pulumi.set(__self__, "key", key)
if max_usage is not None:
pulumi.set(__self__, "max_usage", max_usage)
if name is not None:
pulumi.set(__self__, "name", name)
if ui_config is not None:
pulumi.set(__self__, "ui_config", ui_config)
if usage_count is not None:
pulumi.set(__self__, "usage_count", usage_count)
if zcomponent_id is not None:
pulumi.set(__self__, "zcomponent_id", zcomponent_id)
if zcomponent_name is not None:
pulumi.set(__self__, "zcomponent_name", zcomponent_name)
@property
@pulumi.getter(name="appConnectorGroupId")
def app_connector_group_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "app_connector_group_id")
@app_connector_group_id.setter
def app_connector_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "app_connector_group_id", value)
@property
@pulumi.getter(name="appConnectorGroupName")
def app_connector_group_name(self) -> Optional[pulumi.Input[str]]:
"""
Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "app_connector_group_name")
@app_connector_group_name.setter
def app_connector_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "app_connector_group_name", value)
@property
@pulumi.getter(name="associationType")
def association_type(self) -> Optional[pulumi.Input[str]]:
"""
Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
"""
return pulumi.get(self, "association_type")
@association_type.setter
def association_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "association_type", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether the provisioning key is enabled or not. Supported values: true, false
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="enrollmentCertId")
def enrollment_cert_id(self) -> Optional[pulumi.Input[str]]:
"""
ID of the enrollment certificate that can be used for this provisioning key. `ID` of the existing enrollment certificate that has the private key
"""
return pulumi.get(self, "enrollment_cert_id")
@enrollment_cert_id.setter
def enrollment_cert_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "enrollment_cert_id", value)
@property
@pulumi.getter(name="enrollmentCertName")
def enrollment_cert_name(self) -> Optional[pulumi.Input[str]]:
"""
Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "enrollment_cert_name")
@enrollment_cert_name.setter
def enrollment_cert_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "enrollment_cert_name", value)
@property
@pulumi.getter(name="ipAcls")
def ip_acls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "ip_acls")
@ip_acls.setter
def ip_acls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ip_acls", value)
@property
@pulumi.getter
def key(self) -> Optional[pulumi.Input[str]]:
"""
read only field. Ignored in PUT/POST calls.
"""
return pulumi.get(self, "key")
@key.setter
def key(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "key", value)
@property
@pulumi.getter(name="maxUsage")
def max_usage(self) -> Optional[pulumi.Input[str]]:
"""
The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
"""
return pulumi.get(self, "max_usage")
@max_usage.setter
def max_usage(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "max_usage", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the provisioning key.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="uiConfig")
def ui_config(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "ui_config")
@ui_config.setter
def ui_config(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "ui_config", value)
@property
@pulumi.getter(name="usageCount")
def usage_count(self) -> Optional[pulumi.Input[str]]:
"""
The provisioning key utilization count.
"""
return pulumi.get(self, "usage_count")
@usage_count.setter
def usage_count(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "usage_count", value)
@property
@pulumi.getter(name="zcomponentId")
def zcomponent_id(self) -> Optional[pulumi.Input[str]]:
"""
ID of the existing App Connector or Service Edge Group.
"""
return pulumi.get(self, "zcomponent_id")
@zcomponent_id.setter
def zcomponent_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zcomponent_id", value)
@property
@pulumi.getter(name="zcomponentName")
def zcomponent_name(self) -> Optional[pulumi.Input[str]]:
"""
Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "zcomponent_name")
@zcomponent_name.setter
def zcomponent_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zcomponent_name", value)
class ProvisioningKey(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
app_connector_group_id: Optional[pulumi.Input[str]] = None,
association_type: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
enrollment_cert_id: Optional[pulumi.Input[str]] = None,
ip_acls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
max_usage: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
ui_config: Optional[pulumi.Input[str]] = None,
usage_count: Optional[pulumi.Input[str]] = None,
zcomponent_id: Optional[pulumi.Input[str]] = None,
zcomponent_name: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Provisioning key can be imported by using `<PROVISIONING KEY ID>` or `<PROVISIONING KEY NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ProvisioningKey/provisioningKey:ProvisioningKey example <provisioning_key_id>
```
or
```sh
$ pulumi import zpa:ProvisioningKey/provisioningKey:ProvisioningKey example <provisioning_key_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] association_type: Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
:param pulumi.Input[bool] enabled: Whether the provisioning key is enabled or not. Supported values: true, false
:param pulumi.Input[str] enrollment_cert_id: ID of the enrollment certificate that can be used for this provisioning key. `ID` of the existing enrollment certificate that has the private key
:param pulumi.Input[str] max_usage: The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
:param pulumi.Input[str] name: Name of the provisioning key.
:param pulumi.Input[str] usage_count: The provisioning key utilization count.
:param pulumi.Input[str] zcomponent_id: ID of the existing App Connector or Service Edge Group.
:param pulumi.Input[str] zcomponent_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: ProvisioningKeyArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Provisioning key can be imported by using `<PROVISIONING KEY ID>` or `<PROVISIONING KEY NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ProvisioningKey/provisioningKey:ProvisioningKey example <provisioning_key_id>
```
or
```sh
$ pulumi import zpa:ProvisioningKey/provisioningKey:ProvisioningKey example <provisioning_key_name>
```
:param str resource_name: The name of the resource.
:param ProvisioningKeyArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ProvisioningKeyArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
app_connector_group_id: Optional[pulumi.Input[str]] = None,
association_type: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
enrollment_cert_id: Optional[pulumi.Input[str]] = None,
ip_acls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
max_usage: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
ui_config: Optional[pulumi.Input[str]] = None,
usage_count: Optional[pulumi.Input[str]] = None,
zcomponent_id: Optional[pulumi.Input[str]] = None,
zcomponent_name: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ProvisioningKeyArgs.__new__(ProvisioningKeyArgs)
__props__.__dict__["app_connector_group_id"] = app_connector_group_id
if association_type is None and not opts.urn:
raise TypeError("Missing required property 'association_type'")
__props__.__dict__["association_type"] = association_type
__props__.__dict__["enabled"] = enabled
if enrollment_cert_id is None and not opts.urn:
raise TypeError("Missing required property 'enrollment_cert_id'")
__props__.__dict__["enrollment_cert_id"] = enrollment_cert_id
__props__.__dict__["ip_acls"] = ip_acls
if max_usage is None and not opts.urn:
raise TypeError("Missing required property 'max_usage'")
__props__.__dict__["max_usage"] = max_usage
__props__.__dict__["name"] = name
__props__.__dict__["ui_config"] = ui_config
__props__.__dict__["usage_count"] = usage_count
if zcomponent_id is None and not opts.urn:
raise TypeError("Missing required property 'zcomponent_id'")
__props__.__dict__["zcomponent_id"] = zcomponent_id
__props__.__dict__["zcomponent_name"] = zcomponent_name
__props__.__dict__["app_connector_group_name"] = None
__props__.__dict__["enrollment_cert_name"] = None
__props__.__dict__["key"] = None
secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["key"])
opts = pulumi.ResourceOptions.merge(opts, secret_opts)
super(ProvisioningKey, __self__).__init__(
'zpa:ProvisioningKey/provisioningKey:ProvisioningKey',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
app_connector_group_id: Optional[pulumi.Input[str]] = None,
app_connector_group_name: Optional[pulumi.Input[str]] = None,
association_type: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
enrollment_cert_id: Optional[pulumi.Input[str]] = None,
enrollment_cert_name: Optional[pulumi.Input[str]] = None,
ip_acls: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
key: Optional[pulumi.Input[str]] = None,
max_usage: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
ui_config: Optional[pulumi.Input[str]] = None,
usage_count: Optional[pulumi.Input[str]] = None,
zcomponent_id: Optional[pulumi.Input[str]] = None,
zcomponent_name: Optional[pulumi.Input[str]] = None) -> 'ProvisioningKey':
"""
Get an existing ProvisioningKey resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] app_connector_group_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
:param pulumi.Input[str] association_type: Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
:param pulumi.Input[bool] enabled: Whether the provisioning key is enabled or not. Supported values: true, false
:param pulumi.Input[str] enrollment_cert_id: ID of the enrollment certificate that can be used for this provisioning key. `ID` of the existing enrollment certificate that has the private key
:param pulumi.Input[str] enrollment_cert_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
:param pulumi.Input[str] key: read only field. Ignored in PUT/POST calls.
:param pulumi.Input[str] max_usage: The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
:param pulumi.Input[str] name: Name of the provisioning key.
:param pulumi.Input[str] usage_count: The provisioning key utilization count.
:param pulumi.Input[str] zcomponent_id: ID of the existing App Connector or Service Edge Group.
:param pulumi.Input[str] zcomponent_name: Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ProvisioningKeyState.__new__(_ProvisioningKeyState)
__props__.__dict__["app_connector_group_id"] = app_connector_group_id
__props__.__dict__["app_connector_group_name"] = app_connector_group_name
__props__.__dict__["association_type"] = association_type
__props__.__dict__["enabled"] = enabled
__props__.__dict__["enrollment_cert_id"] = enrollment_cert_id
__props__.__dict__["enrollment_cert_name"] = enrollment_cert_name
__props__.__dict__["ip_acls"] = ip_acls
__props__.__dict__["key"] = key
__props__.__dict__["max_usage"] = max_usage
__props__.__dict__["name"] = name
__props__.__dict__["ui_config"] = ui_config
__props__.__dict__["usage_count"] = usage_count
__props__.__dict__["zcomponent_id"] = zcomponent_id
__props__.__dict__["zcomponent_name"] = zcomponent_name
return ProvisioningKey(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="appConnectorGroupId")
def app_connector_group_id(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "app_connector_group_id")
@property
@pulumi.getter(name="appConnectorGroupName")
def app_connector_group_name(self) -> pulumi.Output[str]:
"""
Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "app_connector_group_name")
@property
@pulumi.getter(name="associationType")
def association_type(self) -> pulumi.Output[str]:
"""
Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
"""
return pulumi.get(self, "association_type")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[Optional[bool]]:
"""
Whether the provisioning key is enabled or not. Supported values: true, false
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="enrollmentCertId")
def enrollment_cert_id(self) -> pulumi.Output[str]:
"""
ID of the enrollment certificate that can be used for this provisioning key. `ID` of the existing enrollment certificate that has the private key
"""
return pulumi.get(self, "enrollment_cert_id")
@property
@pulumi.getter(name="enrollmentCertName")
def enrollment_cert_name(self) -> pulumi.Output[str]:
"""
Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "enrollment_cert_name")
@property
@pulumi.getter(name="ipAcls")
def ip_acls(self) -> pulumi.Output[Optional[Sequence[str]]]:
return pulumi.get(self, "ip_acls")
@property
@pulumi.getter
def key(self) -> pulumi.Output[str]:
"""
read only field. Ignored in PUT/POST calls.
"""
return pulumi.get(self, "key")
@property
@pulumi.getter(name="maxUsage")
def max_usage(self) -> pulumi.Output[str]:
"""
The maximum number of instances where this provisioning key can be used for enrolling an App Connector or Service Edge.
"""
return pulumi.get(self, "max_usage")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the provisioning key.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="uiConfig")
def ui_config(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "ui_config")
@property
@pulumi.getter(name="usageCount")
def usage_count(self) -> pulumi.Output[str]:
"""
The provisioning key utilization count.
"""
return pulumi.get(self, "usage_count")
@property
@pulumi.getter(name="zcomponentId")
def zcomponent_id(self) -> pulumi.Output[str]:
"""
ID of the existing App Connector or Service Edge Group.
"""
return pulumi.get(self, "zcomponent_id")
@property
@pulumi.getter(name="zcomponentName")
def zcomponent_name(self) -> pulumi.Output[str]:
"""
Read only property. Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "zcomponent_name") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/provisioningkey/provisioning_key.py | provisioning_key.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetProvisioningKeyResult',
'AwaitableGetProvisioningKeyResult',
'get_provisioning_key',
'get_provisioning_key_output',
]
@pulumi.output_type
class GetProvisioningKeyResult:
"""
A collection of values returned by getProvisioningKey.
"""
def __init__(__self__, app_connector_group_id=None, app_connector_group_name=None, association_type=None, creation_time=None, enabled=None, enrollment_cert_id=None, enrollment_cert_name=None, expiration_in_epoch_sec=None, id=None, ip_acls=None, max_usage=None, modified_time=None, modifiedby=None, name=None, provisioning_key=None, ui_config=None, usage_count=None, zcomponent_id=None, zcomponent_name=None):
if app_connector_group_id and not isinstance(app_connector_group_id, str):
raise TypeError("Expected argument 'app_connector_group_id' to be a str")
pulumi.set(__self__, "app_connector_group_id", app_connector_group_id)
if app_connector_group_name and not isinstance(app_connector_group_name, str):
raise TypeError("Expected argument 'app_connector_group_name' to be a str")
pulumi.set(__self__, "app_connector_group_name", app_connector_group_name)
if association_type and not isinstance(association_type, str):
raise TypeError("Expected argument 'association_type' to be a str")
pulumi.set(__self__, "association_type", association_type)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if enrollment_cert_id and not isinstance(enrollment_cert_id, str):
raise TypeError("Expected argument 'enrollment_cert_id' to be a str")
pulumi.set(__self__, "enrollment_cert_id", enrollment_cert_id)
if enrollment_cert_name and not isinstance(enrollment_cert_name, str):
raise TypeError("Expected argument 'enrollment_cert_name' to be a str")
pulumi.set(__self__, "enrollment_cert_name", enrollment_cert_name)
if expiration_in_epoch_sec and not isinstance(expiration_in_epoch_sec, str):
raise TypeError("Expected argument 'expiration_in_epoch_sec' to be a str")
pulumi.set(__self__, "expiration_in_epoch_sec", expiration_in_epoch_sec)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if ip_acls and not isinstance(ip_acls, list):
raise TypeError("Expected argument 'ip_acls' to be a list")
pulumi.set(__self__, "ip_acls", ip_acls)
if max_usage and not isinstance(max_usage, str):
raise TypeError("Expected argument 'max_usage' to be a str")
pulumi.set(__self__, "max_usage", max_usage)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if provisioning_key and not isinstance(provisioning_key, str):
raise TypeError("Expected argument 'provisioning_key' to be a str")
pulumi.set(__self__, "provisioning_key", provisioning_key)
if ui_config and not isinstance(ui_config, str):
raise TypeError("Expected argument 'ui_config' to be a str")
pulumi.set(__self__, "ui_config", ui_config)
if usage_count and not isinstance(usage_count, str):
raise TypeError("Expected argument 'usage_count' to be a str")
pulumi.set(__self__, "usage_count", usage_count)
if zcomponent_id and not isinstance(zcomponent_id, str):
raise TypeError("Expected argument 'zcomponent_id' to be a str")
pulumi.set(__self__, "zcomponent_id", zcomponent_id)
if zcomponent_name and not isinstance(zcomponent_name, str):
raise TypeError("Expected argument 'zcomponent_name' to be a str")
pulumi.set(__self__, "zcomponent_name", zcomponent_name)
@property
@pulumi.getter(name="appConnectorGroupId")
def app_connector_group_id(self) -> str:
return pulumi.get(self, "app_connector_group_id")
@property
@pulumi.getter(name="appConnectorGroupName")
def app_connector_group_name(self) -> str:
return pulumi.get(self, "app_connector_group_name")
@property
@pulumi.getter(name="associationType")
def association_type(self) -> str:
return pulumi.get(self, "association_type")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="enrollmentCertId")
def enrollment_cert_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "enrollment_cert_id")
@property
@pulumi.getter(name="enrollmentCertName")
def enrollment_cert_name(self) -> str:
"""
(string) Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "enrollment_cert_name")
@property
@pulumi.getter(name="expirationInEpochSec")
def expiration_in_epoch_sec(self) -> str:
"""
(string)
"""
return pulumi.get(self, "expiration_in_epoch_sec")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAcls")
def ip_acls(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "ip_acls")
@property
@pulumi.getter(name="maxUsage")
def max_usage(self) -> str:
"""
(string)
"""
return pulumi.get(self, "max_usage")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="provisioningKey")
def provisioning_key(self) -> str:
"""
(string) Ignored in PUT/POST calls.
"""
return pulumi.get(self, "provisioning_key")
@property
@pulumi.getter(name="uiConfig")
def ui_config(self) -> str:
"""
(string)
"""
return pulumi.get(self, "ui_config")
@property
@pulumi.getter(name="usageCount")
def usage_count(self) -> str:
"""
(string)
"""
return pulumi.get(self, "usage_count")
@property
@pulumi.getter(name="zcomponentId")
def zcomponent_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "zcomponent_id")
@property
@pulumi.getter(name="zcomponentName")
def zcomponent_name(self) -> str:
"""
(string) Applicable only for GET calls, ignored in PUT/POST calls.
"""
return pulumi.get(self, "zcomponent_name")
class AwaitableGetProvisioningKeyResult(GetProvisioningKeyResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetProvisioningKeyResult(
app_connector_group_id=self.app_connector_group_id,
app_connector_group_name=self.app_connector_group_name,
association_type=self.association_type,
creation_time=self.creation_time,
enabled=self.enabled,
enrollment_cert_id=self.enrollment_cert_id,
enrollment_cert_name=self.enrollment_cert_name,
expiration_in_epoch_sec=self.expiration_in_epoch_sec,
id=self.id,
ip_acls=self.ip_acls,
max_usage=self.max_usage,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
provisioning_key=self.provisioning_key,
ui_config=self.ui_config,
usage_count=self.usage_count,
zcomponent_id=self.zcomponent_id,
zcomponent_name=self.zcomponent_name)
def get_provisioning_key(association_type: Optional[str] = None,
id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetProvisioningKeyResult:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ProvisioningKey.get_provisioning_key(association_type="CONNECTOR_GRP",
name="Provisioning_Key")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ProvisioningKey.get_provisioning_key(association_type="SERVICE_EDGE_GRP",
name="Provisioning_Key")
```
:param str association_type: Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
:param str id: The ID of the provisioning key to be exported.
:param str name: Name of the provisioning key.
"""
__args__ = dict()
__args__['associationType'] = association_type
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ProvisioningKey/getProvisioningKey:getProvisioningKey', __args__, opts=opts, typ=GetProvisioningKeyResult).value
return AwaitableGetProvisioningKeyResult(
app_connector_group_id=__ret__.app_connector_group_id,
app_connector_group_name=__ret__.app_connector_group_name,
association_type=__ret__.association_type,
creation_time=__ret__.creation_time,
enabled=__ret__.enabled,
enrollment_cert_id=__ret__.enrollment_cert_id,
enrollment_cert_name=__ret__.enrollment_cert_name,
expiration_in_epoch_sec=__ret__.expiration_in_epoch_sec,
id=__ret__.id,
ip_acls=__ret__.ip_acls,
max_usage=__ret__.max_usage,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
provisioning_key=__ret__.provisioning_key,
ui_config=__ret__.ui_config,
usage_count=__ret__.usage_count,
zcomponent_id=__ret__.zcomponent_id,
zcomponent_name=__ret__.zcomponent_name)
@_utilities.lift_output_func(get_provisioning_key)
def get_provisioning_key_output(association_type: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetProvisioningKeyResult]:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ProvisioningKey.get_provisioning_key(association_type="CONNECTOR_GRP",
name="Provisioning_Key")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ProvisioningKey.get_provisioning_key(association_type="SERVICE_EDGE_GRP",
name="Provisioning_Key")
```
:param str association_type: Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are `CONNECTOR_GRP` and `SERVICE_EDGE_GRP`
:param str id: The ID of the provisioning key to be exported.
:param str name: Name of the provisioning key.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/provisioningkey/get_provisioning_key.py | get_provisioning_key.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetTrustedNetworkResult',
'AwaitableGetTrustedNetworkResult',
'get_trusted_network',
'get_trusted_network_output',
]
@pulumi.output_type
class GetTrustedNetworkResult:
"""
A collection of values returned by getTrustedNetwork.
"""
def __init__(__self__, creation_time=None, domain=None, id=None, modified_time=None, modifiedby=None, name=None, network_id=None, zscaler_cloud=None):
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if domain and not isinstance(domain, str):
raise TypeError("Expected argument 'domain' to be a str")
pulumi.set(__self__, "domain", domain)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if network_id and not isinstance(network_id, str):
raise TypeError("Expected argument 'network_id' to be a str")
pulumi.set(__self__, "network_id", network_id)
if zscaler_cloud and not isinstance(zscaler_cloud, str):
raise TypeError("Expected argument 'zscaler_cloud' to be a str")
pulumi.set(__self__, "zscaler_cloud", zscaler_cloud)
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def domain(self) -> str:
"""
(string)
"""
return pulumi.get(self, "domain")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="networkId")
def network_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "network_id")
@property
@pulumi.getter(name="zscalerCloud")
def zscaler_cloud(self) -> str:
"""
(string)
"""
return pulumi.get(self, "zscaler_cloud")
class AwaitableGetTrustedNetworkResult(GetTrustedNetworkResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetTrustedNetworkResult(
creation_time=self.creation_time,
domain=self.domain,
id=self.id,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
network_id=self.network_id,
zscaler_cloud=self.zscaler_cloud)
def get_trusted_network(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTrustedNetworkResult:
"""
The **zpa_trusted_network** data source to get information about a trusted network created in the Zscaler Private Access Mobile Portal. This data source can then be referenced within the following resources:
1. Access Policy
2. Forwarding Policy
3. Inspection Policy
4. Isolation Policy
5. Service Edge Group.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.trustedNetwork.get_trusted_network(name="trusted_network_name")
```
> **NOTE** To query trusted network that are associated with a specific Zscaler cloud, it is required to append the cloud name to the name of the trusted network as the below example:
```python
import pulumi
import pulumi_zpa as zpa
example1 = zpa.trustedNetwork.get_trusted_network(name="Corporate-Network (zscalertwo.net)")
pulumi.export("zpaTrustedNetwork", example1.network_id)
```
:param str id: The ID of the posture profile to be exported.
:param str name: The name of the posture profile to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:trustedNetwork/getTrustedNetwork:getTrustedNetwork', __args__, opts=opts, typ=GetTrustedNetworkResult).value
return AwaitableGetTrustedNetworkResult(
creation_time=__ret__.creation_time,
domain=__ret__.domain,
id=__ret__.id,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
network_id=__ret__.network_id,
zscaler_cloud=__ret__.zscaler_cloud)
@_utilities.lift_output_func(get_trusted_network)
def get_trusted_network_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetTrustedNetworkResult]:
"""
The **zpa_trusted_network** data source to get information about a trusted network created in the Zscaler Private Access Mobile Portal. This data source can then be referenced within the following resources:
1. Access Policy
2. Forwarding Policy
3. Inspection Policy
4. Isolation Policy
5. Service Edge Group.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.trustedNetwork.get_trusted_network(name="trusted_network_name")
```
> **NOTE** To query trusted network that are associated with a specific Zscaler cloud, it is required to append the cloud name to the name of the trusted network as the below example:
```python
import pulumi
import pulumi_zpa as zpa
example1 = zpa.trustedNetwork.get_trusted_network(name="Corporate-Network (zscalertwo.net)")
pulumi.export("zpaTrustedNetwork", example1.network_id)
```
:param str id: The ID of the posture profile to be exported.
:param str name: The name of the posture profile to be exported.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/trustednetwork/get_trusted_network.py | get_trusted_network.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'PolicyAccessInspectionRuleConditionArgs',
'PolicyAccessInspectionRuleConditionOperandArgs',
]
@pulumi.input_type
class PolicyAccessInspectionRuleConditionArgs:
def __init__(__self__, *,
operator: pulumi.Input[str],
id: Optional[pulumi.Input[str]] = None,
negated: Optional[pulumi.Input[bool]] = None,
operands: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionOperandArgs']]]] = None):
pulumi.set(__self__, "operator", operator)
if id is not None:
pulumi.set(__self__, "id", id)
if negated is not None:
pulumi.set(__self__, "negated", negated)
if operands is not None:
pulumi.set(__self__, "operands", operands)
@property
@pulumi.getter
def operator(self) -> pulumi.Input[str]:
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: pulumi.Input[str]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def negated(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "negated")
@negated.setter
def negated(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "negated", value)
@property
@pulumi.getter
def operands(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionOperandArgs']]]]:
return pulumi.get(self, "operands")
@operands.setter
def operands(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionOperandArgs']]]]):
pulumi.set(self, "operands", value)
@pulumi.input_type
class PolicyAccessInspectionRuleConditionOperandArgs:
def __init__(__self__, *,
lhs: pulumi.Input[str],
object_type: pulumi.Input[str],
id: Optional[pulumi.Input[str]] = None,
idp_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
rhs: Optional[pulumi.Input[str]] = None,
rhs_lists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
pulumi.set(__self__, "lhs", lhs)
pulumi.set(__self__, "object_type", object_type)
if id is not None:
pulumi.set(__self__, "id", id)
if idp_id is not None:
pulumi.set(__self__, "idp_id", idp_id)
if name is not None:
pulumi.set(__self__, "name", name)
if rhs is not None:
pulumi.set(__self__, "rhs", rhs)
if rhs_lists is not None:
pulumi.set(__self__, "rhs_lists", rhs_lists)
@property
@pulumi.getter
def lhs(self) -> pulumi.Input[str]:
return pulumi.get(self, "lhs")
@lhs.setter
def lhs(self, value: pulumi.Input[str]):
pulumi.set(self, "lhs", value)
@property
@pulumi.getter(name="objectType")
def object_type(self) -> pulumi.Input[str]:
return pulumi.get(self, "object_type")
@object_type.setter
def object_type(self, value: pulumi.Input[str]):
pulumi.set(self, "object_type", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "idp_id")
@idp_id.setter
def idp_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "idp_id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def rhs(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "rhs")
@rhs.setter
def rhs(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "rhs", value)
@property
@pulumi.getter(name="rhsLists")
def rhs_lists(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "rhs_lists")
@rhs_lists.setter
def rhs_lists(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "rhs_lists", value) | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/inspectionpolicy/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['PolicyAccessInspectionRuleArgs', 'PolicyAccessInspectionRule']
@pulumi.input_type
class PolicyAccessInspectionRuleArgs:
def __init__(__self__, *,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a PolicyAccessInspectionRule resource.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
if action is not None:
pulumi.set(__self__, "action", action)
if action_id is not None:
pulumi.set(__self__, "action_id", action_id)
if bypass_default_rule is not None:
pulumi.set(__self__, "bypass_default_rule", bypass_default_rule)
if conditions is not None:
pulumi.set(__self__, "conditions", conditions)
if custom_msg is not None:
pulumi.set(__self__, "custom_msg", custom_msg)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if description is not None:
pulumi.set(__self__, "description", description)
if lss_default_rule is not None:
pulumi.set(__self__, "lss_default_rule", lss_default_rule)
if name is not None:
pulumi.set(__self__, "name", name)
if operator is not None:
pulumi.set(__self__, "operator", operator)
if policy_set_id is not None:
pulumi.set(__self__, "policy_set_id", policy_set_id)
if policy_type is not None:
pulumi.set(__self__, "policy_type", policy_type)
if priority is not None:
pulumi.set(__self__, "priority", priority)
if reauth_default_rule is not None:
pulumi.set(__self__, "reauth_default_rule", reauth_default_rule)
if reauth_idle_timeout is not None:
pulumi.set(__self__, "reauth_idle_timeout", reauth_idle_timeout)
if reauth_timeout is not None:
pulumi.set(__self__, "reauth_timeout", reauth_timeout)
if rule_order is not None:
pulumi.set(__self__, "rule_order", rule_order)
if zpn_inspection_profile_id is not None:
pulumi.set(__self__, "zpn_inspection_profile_id", zpn_inspection_profile_id)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing the rule action.
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="actionId")
def action_id(self) -> Optional[pulumi.Input[str]]:
"""
This field defines the description of the server.
"""
return pulumi.get(self, "action_id")
@action_id.setter
def action_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action_id", value)
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "bypass_default_rule")
@bypass_default_rule.setter
def bypass_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "bypass_default_rule", value)
@property
@pulumi.getter
def conditions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]]]:
"""
This is for proviidng the set of conditions for the policy.
"""
return pulumi.get(self, "conditions")
@conditions.setter
def conditions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]]]):
pulumi.set(self, "conditions", value)
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "custom_msg")
@custom_msg.setter
def custom_msg(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "custom_msg", value)
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[pulumi.Input[bool]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "default_rule")
@default_rule.setter
def default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "default_rule", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
This is the description of the access policy.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "lss_default_rule")
@lss_default_rule.setter
def lss_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "lss_default_rule", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
This is the name of the policy.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def operator(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_set_id")
@policy_set_id.setter
def policy_set_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_set_id", value)
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_type")
@policy_type.setter
def policy_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_type", value)
@property
@pulumi.getter
def priority(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "priority")
@priority.setter
def priority(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "priority", value)
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "reauth_default_rule")
@reauth_default_rule.setter
def reauth_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "reauth_default_rule", value)
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_idle_timeout")
@reauth_idle_timeout.setter
def reauth_idle_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_idle_timeout", value)
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_timeout")
@reauth_timeout.setter
def reauth_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_timeout", value)
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "rule_order")
@rule_order.setter
def rule_order(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "rule_order", value)
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "zpn_inspection_profile_id")
@zpn_inspection_profile_id.setter
def zpn_inspection_profile_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpn_inspection_profile_id", value)
@pulumi.input_type
class _PolicyAccessInspectionRuleState:
def __init__(__self__, *,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering PolicyAccessInspectionRule resources.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
if action is not None:
pulumi.set(__self__, "action", action)
if action_id is not None:
pulumi.set(__self__, "action_id", action_id)
if bypass_default_rule is not None:
pulumi.set(__self__, "bypass_default_rule", bypass_default_rule)
if conditions is not None:
pulumi.set(__self__, "conditions", conditions)
if custom_msg is not None:
pulumi.set(__self__, "custom_msg", custom_msg)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if description is not None:
pulumi.set(__self__, "description", description)
if lss_default_rule is not None:
pulumi.set(__self__, "lss_default_rule", lss_default_rule)
if name is not None:
pulumi.set(__self__, "name", name)
if operator is not None:
pulumi.set(__self__, "operator", operator)
if policy_set_id is not None:
pulumi.set(__self__, "policy_set_id", policy_set_id)
if policy_type is not None:
pulumi.set(__self__, "policy_type", policy_type)
if priority is not None:
pulumi.set(__self__, "priority", priority)
if reauth_default_rule is not None:
pulumi.set(__self__, "reauth_default_rule", reauth_default_rule)
if reauth_idle_timeout is not None:
pulumi.set(__self__, "reauth_idle_timeout", reauth_idle_timeout)
if reauth_timeout is not None:
pulumi.set(__self__, "reauth_timeout", reauth_timeout)
if rule_order is not None:
pulumi.set(__self__, "rule_order", rule_order)
if zpn_inspection_profile_id is not None:
pulumi.set(__self__, "zpn_inspection_profile_id", zpn_inspection_profile_id)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing the rule action.
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="actionId")
def action_id(self) -> Optional[pulumi.Input[str]]:
"""
This field defines the description of the server.
"""
return pulumi.get(self, "action_id")
@action_id.setter
def action_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action_id", value)
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "bypass_default_rule")
@bypass_default_rule.setter
def bypass_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "bypass_default_rule", value)
@property
@pulumi.getter
def conditions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]]]:
"""
This is for proviidng the set of conditions for the policy.
"""
return pulumi.get(self, "conditions")
@conditions.setter
def conditions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessInspectionRuleConditionArgs']]]]):
pulumi.set(self, "conditions", value)
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "custom_msg")
@custom_msg.setter
def custom_msg(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "custom_msg", value)
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[pulumi.Input[bool]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "default_rule")
@default_rule.setter
def default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "default_rule", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
This is the description of the access policy.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "lss_default_rule")
@lss_default_rule.setter
def lss_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "lss_default_rule", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
This is the name of the policy.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def operator(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_set_id")
@policy_set_id.setter
def policy_set_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_set_id", value)
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_type")
@policy_type.setter
def policy_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_type", value)
@property
@pulumi.getter
def priority(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "priority")
@priority.setter
def priority(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "priority", value)
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "reauth_default_rule")
@reauth_default_rule.setter
def reauth_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "reauth_default_rule", value)
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_idle_timeout")
@reauth_idle_timeout.setter
def reauth_idle_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_idle_timeout", value)
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_timeout")
@reauth_timeout.setter
def reauth_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_timeout", value)
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "rule_order")
@rule_order.setter
def rule_order(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "rule_order", value)
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "zpn_inspection_profile_id")
@zpn_inspection_profile_id.setter
def zpn_inspection_profile_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpn_inspection_profile_id", value)
class PolicyAccessInspectionRule(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessInspectionRuleConditionArgs']]]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
Create a PolicyAccessInspectionRule resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessInspectionRuleConditionArgs']]]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[PolicyAccessInspectionRuleArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
Create a PolicyAccessInspectionRule resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param PolicyAccessInspectionRuleArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(PolicyAccessInspectionRuleArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessInspectionRuleConditionArgs']]]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = PolicyAccessInspectionRuleArgs.__new__(PolicyAccessInspectionRuleArgs)
__props__.__dict__["action"] = action
__props__.__dict__["action_id"] = action_id
__props__.__dict__["bypass_default_rule"] = bypass_default_rule
__props__.__dict__["conditions"] = conditions
__props__.__dict__["custom_msg"] = custom_msg
__props__.__dict__["default_rule"] = default_rule
__props__.__dict__["description"] = description
__props__.__dict__["lss_default_rule"] = lss_default_rule
__props__.__dict__["name"] = name
__props__.__dict__["operator"] = operator
__props__.__dict__["policy_set_id"] = policy_set_id
__props__.__dict__["policy_type"] = policy_type
__props__.__dict__["priority"] = priority
__props__.__dict__["reauth_default_rule"] = reauth_default_rule
__props__.__dict__["reauth_idle_timeout"] = reauth_idle_timeout
__props__.__dict__["reauth_timeout"] = reauth_timeout
__props__.__dict__["rule_order"] = rule_order
__props__.__dict__["zpn_inspection_profile_id"] = zpn_inspection_profile_id
super(PolicyAccessInspectionRule, __self__).__init__(
'zpa:InspectionPolicy/policyAccessInspectionRule:PolicyAccessInspectionRule',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessInspectionRuleConditionArgs']]]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None) -> 'PolicyAccessInspectionRule':
"""
Get an existing PolicyAccessInspectionRule resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessInspectionRuleConditionArgs']]]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _PolicyAccessInspectionRuleState.__new__(_PolicyAccessInspectionRuleState)
__props__.__dict__["action"] = action
__props__.__dict__["action_id"] = action_id
__props__.__dict__["bypass_default_rule"] = bypass_default_rule
__props__.__dict__["conditions"] = conditions
__props__.__dict__["custom_msg"] = custom_msg
__props__.__dict__["default_rule"] = default_rule
__props__.__dict__["description"] = description
__props__.__dict__["lss_default_rule"] = lss_default_rule
__props__.__dict__["name"] = name
__props__.__dict__["operator"] = operator
__props__.__dict__["policy_set_id"] = policy_set_id
__props__.__dict__["policy_type"] = policy_type
__props__.__dict__["priority"] = priority
__props__.__dict__["reauth_default_rule"] = reauth_default_rule
__props__.__dict__["reauth_idle_timeout"] = reauth_idle_timeout
__props__.__dict__["reauth_timeout"] = reauth_timeout
__props__.__dict__["rule_order"] = rule_order
__props__.__dict__["zpn_inspection_profile_id"] = zpn_inspection_profile_id
return PolicyAccessInspectionRule(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def action(self) -> pulumi.Output[Optional[str]]:
"""
This is for providing the rule action.
"""
return pulumi.get(self, "action")
@property
@pulumi.getter(name="actionId")
def action_id(self) -> pulumi.Output[Optional[str]]:
"""
This field defines the description of the server.
"""
return pulumi.get(self, "action_id")
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "bypass_default_rule")
@property
@pulumi.getter
def conditions(self) -> pulumi.Output[Sequence['outputs.PolicyAccessInspectionRuleCondition']]:
"""
This is for proviidng the set of conditions for the policy.
"""
return pulumi.get(self, "conditions")
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> pulumi.Output[Optional[str]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "custom_msg")
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> pulumi.Output[Optional[bool]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "default_rule")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
This is the description of the access policy.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "lss_default_rule")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
This is the name of the policy.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def operator(self) -> pulumi.Output[str]:
return pulumi.get(self, "operator")
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> pulumi.Output[str]:
return pulumi.get(self, "policy_set_id")
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> pulumi.Output[str]:
return pulumi.get(self, "policy_type")
@property
@pulumi.getter
def priority(self) -> pulumi.Output[str]:
return pulumi.get(self, "priority")
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "reauth_default_rule")
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "reauth_idle_timeout")
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "reauth_timeout")
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> pulumi.Output[str]:
return pulumi.get(self, "rule_order")
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "zpn_inspection_profile_id") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/inspectionpolicy/policy_access_inspection_rule.py | policy_access_inspection_rule.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'PolicyAccessInspectionRuleCondition',
'PolicyAccessInspectionRuleConditionOperand',
]
@pulumi.output_type
class PolicyAccessInspectionRuleCondition(dict):
def __init__(__self__, *,
operator: str,
id: Optional[str] = None,
negated: Optional[bool] = None,
operands: Optional[Sequence['outputs.PolicyAccessInspectionRuleConditionOperand']] = None):
pulumi.set(__self__, "operator", operator)
if id is not None:
pulumi.set(__self__, "id", id)
if negated is not None:
pulumi.set(__self__, "negated", negated)
if operands is not None:
pulumi.set(__self__, "operands", operands)
@property
@pulumi.getter
def operator(self) -> str:
return pulumi.get(self, "operator")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter
def negated(self) -> Optional[bool]:
return pulumi.get(self, "negated")
@property
@pulumi.getter
def operands(self) -> Optional[Sequence['outputs.PolicyAccessInspectionRuleConditionOperand']]:
return pulumi.get(self, "operands")
@pulumi.output_type
class PolicyAccessInspectionRuleConditionOperand(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "objectType":
suggest = "object_type"
elif key == "idpId":
suggest = "idp_id"
elif key == "rhsLists":
suggest = "rhs_lists"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in PolicyAccessInspectionRuleConditionOperand. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
PolicyAccessInspectionRuleConditionOperand.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
PolicyAccessInspectionRuleConditionOperand.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
lhs: str,
object_type: str,
id: Optional[str] = None,
idp_id: Optional[str] = None,
name: Optional[str] = None,
rhs: Optional[str] = None,
rhs_lists: Optional[Sequence[str]] = None):
pulumi.set(__self__, "lhs", lhs)
pulumi.set(__self__, "object_type", object_type)
if id is not None:
pulumi.set(__self__, "id", id)
if idp_id is not None:
pulumi.set(__self__, "idp_id", idp_id)
if name is not None:
pulumi.set(__self__, "name", name)
if rhs is not None:
pulumi.set(__self__, "rhs", rhs)
if rhs_lists is not None:
pulumi.set(__self__, "rhs_lists", rhs_lists)
@property
@pulumi.getter
def lhs(self) -> str:
return pulumi.get(self, "lhs")
@property
@pulumi.getter(name="objectType")
def object_type(self) -> str:
return pulumi.get(self, "object_type")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> Optional[str]:
return pulumi.get(self, "idp_id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter
def rhs(self) -> Optional[str]:
return pulumi.get(self, "rhs")
@property
@pulumi.getter(name="rhsLists")
def rhs_lists(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "rhs_lists") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/inspectionpolicy/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetBaCertificateResult',
'AwaitableGetBaCertificateResult',
'get_ba_certificate',
'get_ba_certificate_output',
]
@pulumi.output_type
class GetBaCertificateResult:
"""
A collection of values returned by getBaCertificate.
"""
def __init__(__self__, cert_chain=None, cname=None, creation_time=None, description=None, id=None, issued_by=None, issued_to=None, modified_time=None, modifiedby=None, name=None, sans=None, serial_no=None, status=None, valid_from_in_epochsec=None, valid_to_in_epochsec=None):
if cert_chain and not isinstance(cert_chain, str):
raise TypeError("Expected argument 'cert_chain' to be a str")
pulumi.set(__self__, "cert_chain", cert_chain)
if cname and not isinstance(cname, str):
raise TypeError("Expected argument 'cname' to be a str")
pulumi.set(__self__, "cname", cname)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if issued_by and not isinstance(issued_by, str):
raise TypeError("Expected argument 'issued_by' to be a str")
pulumi.set(__self__, "issued_by", issued_by)
if issued_to and not isinstance(issued_to, str):
raise TypeError("Expected argument 'issued_to' to be a str")
pulumi.set(__self__, "issued_to", issued_to)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if sans and not isinstance(sans, list):
raise TypeError("Expected argument 'sans' to be a list")
pulumi.set(__self__, "sans", sans)
if serial_no and not isinstance(serial_no, str):
raise TypeError("Expected argument 'serial_no' to be a str")
pulumi.set(__self__, "serial_no", serial_no)
if status and not isinstance(status, str):
raise TypeError("Expected argument 'status' to be a str")
pulumi.set(__self__, "status", status)
if valid_from_in_epochsec and not isinstance(valid_from_in_epochsec, str):
raise TypeError("Expected argument 'valid_from_in_epochsec' to be a str")
pulumi.set(__self__, "valid_from_in_epochsec", valid_from_in_epochsec)
if valid_to_in_epochsec and not isinstance(valid_to_in_epochsec, str):
raise TypeError("Expected argument 'valid_to_in_epochsec' to be a str")
pulumi.set(__self__, "valid_to_in_epochsec", valid_to_in_epochsec)
@property
@pulumi.getter(name="certChain")
def cert_chain(self) -> str:
"""
(string)
"""
return pulumi.get(self, "cert_chain")
@property
@pulumi.getter
def cname(self) -> str:
"""
(string)
"""
return pulumi.get(self, "cname")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="issuedBy")
def issued_by(self) -> str:
"""
(string)
"""
return pulumi.get(self, "issued_by")
@property
@pulumi.getter(name="issuedTo")
def issued_to(self) -> str:
"""
(string)
"""
return pulumi.get(self, "issued_to")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter
def sans(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "sans")
@property
@pulumi.getter(name="serialNo")
def serial_no(self) -> str:
"""
(string)
"""
return pulumi.get(self, "serial_no")
@property
@pulumi.getter
def status(self) -> str:
"""
(string)
"""
return pulumi.get(self, "status")
@property
@pulumi.getter(name="validFromInEpochsec")
def valid_from_in_epochsec(self) -> str:
"""
(string)
"""
return pulumi.get(self, "valid_from_in_epochsec")
@property
@pulumi.getter(name="validToInEpochsec")
def valid_to_in_epochsec(self) -> str:
"""
(string)
"""
return pulumi.get(self, "valid_to_in_epochsec")
class AwaitableGetBaCertificateResult(GetBaCertificateResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetBaCertificateResult(
cert_chain=self.cert_chain,
cname=self.cname,
creation_time=self.creation_time,
description=self.description,
id=self.id,
issued_by=self.issued_by,
issued_to=self.issued_to,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
sans=self.sans,
serial_no=self.serial_no,
status=self.status,
valid_from_in_epochsec=self.valid_from_in_epochsec,
valid_to_in_epochsec=self.valid_to_in_epochsec)
def get_ba_certificate(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetBaCertificateResult:
"""
Use the **zpa_ba_certificate** data source to get information about a browser access certificate created in the Zscaler Private Access cloud. This data source is required when creating a browser access application segment resource.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.BrowserCertificate.get_ba_certificate(name="example.acme.com")
```
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.BrowserCertificate.get_ba_certificate(id="1234567890")
```
:param str id: The id of the browser access certificate to be exported.
:param str name: The name of the browser access certificate to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:BrowserCertificate/getBaCertificate:getBaCertificate', __args__, opts=opts, typ=GetBaCertificateResult).value
return AwaitableGetBaCertificateResult(
cert_chain=__ret__.cert_chain,
cname=__ret__.cname,
creation_time=__ret__.creation_time,
description=__ret__.description,
id=__ret__.id,
issued_by=__ret__.issued_by,
issued_to=__ret__.issued_to,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
sans=__ret__.sans,
serial_no=__ret__.serial_no,
status=__ret__.status,
valid_from_in_epochsec=__ret__.valid_from_in_epochsec,
valid_to_in_epochsec=__ret__.valid_to_in_epochsec)
@_utilities.lift_output_func(get_ba_certificate)
def get_ba_certificate_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetBaCertificateResult]:
"""
Use the **zpa_ba_certificate** data source to get information about a browser access certificate created in the Zscaler Private Access cloud. This data source is required when creating a browser access application segment resource.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.BrowserCertificate.get_ba_certificate(name="example.acme.com")
```
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.BrowserCertificate.get_ba_certificate(id="1234567890")
```
:param str id: The id of the browser access certificate to be exported.
:param str name: The name of the browser access certificate to be exported.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/browsercertificate/get_ba_certificate.py | get_ba_certificate.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'SegmentGroupApplication',
'GetSegmentGroupApplicationResult',
'GetSegmentGroupApplicationServerGroupResult',
]
@pulumi.output_type
class SegmentGroupApplication(dict):
def __init__(__self__, *,
id: Optional[str] = None):
if id is not None:
pulumi.set(__self__, "id", id)
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@pulumi.output_type
class GetSegmentGroupApplicationResult(dict):
def __init__(__self__, *,
bypass_type: str,
config_space: str,
creation_time: str,
default_idle_timeout: str,
default_max_age: str,
description: str,
domain_name: str,
domain_names: Sequence[str],
double_encrypt: bool,
enabled: bool,
health_check_type: str,
id: str,
ip_anchored: bool,
log_features: Sequence[str],
modified_by: str,
modified_time: str,
name: str,
passive_health_enabled: bool,
server_groups: Sequence['outputs.GetSegmentGroupApplicationServerGroupResult'],
tcp_port_ranges: Sequence[str],
tcp_ports_ins: Sequence[str],
tcp_ports_outs: Sequence[str],
udp_port_ranges: Sequence[str]):
"""
:param str bypass_type: (string)
:param str config_space: (string)
:param str creation_time: (string)
:param str default_idle_timeout: (string)
:param str default_max_age: (string)
:param str description: (string)
:param str domain_name: (string)
:param Sequence[str] domain_names: (string)
:param bool double_encrypt: (string)
:param bool enabled: (bool)
:param str health_check_type: (string)
:param str id: The ID of the segment group to be exported.
:param bool ip_anchored: (bool)
:param str modified_by: (string)
:param str modified_time: (string)
:param str name: The name of the segment group to be exported.
:param bool passive_health_enabled: (bool)
:param Sequence['GetSegmentGroupApplicationServerGroupArgs'] server_groups: (Computed)
:param Sequence[str] tcp_port_ranges: (string)
:param Sequence[str] tcp_ports_ins: (string)
:param Sequence[str] udp_port_ranges: (string)
"""
pulumi.set(__self__, "bypass_type", bypass_type)
pulumi.set(__self__, "config_space", config_space)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "default_idle_timeout", default_idle_timeout)
pulumi.set(__self__, "default_max_age", default_max_age)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "domain_name", domain_name)
pulumi.set(__self__, "domain_names", domain_names)
pulumi.set(__self__, "double_encrypt", double_encrypt)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "health_check_type", health_check_type)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "ip_anchored", ip_anchored)
pulumi.set(__self__, "log_features", log_features)
pulumi.set(__self__, "modified_by", modified_by)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
pulumi.set(__self__, "server_groups", server_groups)
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
pulumi.set(__self__, "tcp_ports_ins", tcp_ports_ins)
pulumi.set(__self__, "tcp_ports_outs", tcp_ports_outs)
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> str:
"""
(string)
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter(name="defaultIdleTimeout")
def default_idle_timeout(self) -> str:
"""
(string)
"""
return pulumi.get(self, "default_idle_timeout")
@property
@pulumi.getter(name="defaultMaxAge")
def default_max_age(self) -> str:
"""
(string)
"""
return pulumi.get(self, "default_max_age")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainName")
def domain_name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "domain_name")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> bool:
"""
(string)
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> str:
"""
(string)
"""
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the segment group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="logFeatures")
def log_features(self) -> Sequence[str]:
return pulumi.get(self, "log_features")
@property
@pulumi.getter(name="modifiedBy")
def modified_by(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_by")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the segment group to be exported.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Sequence['outputs.GetSegmentGroupApplicationServerGroupResult']:
"""
(Computed)
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="tcpPortsIns")
def tcp_ports_ins(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "tcp_ports_ins")
@property
@pulumi.getter(name="tcpPortsOuts")
def tcp_ports_outs(self) -> Sequence[str]:
return pulumi.get(self, "tcp_ports_outs")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "udp_port_ranges")
@pulumi.output_type
class GetSegmentGroupApplicationServerGroupResult(dict):
def __init__(__self__, *,
config_space: str,
creation_time: str,
description: str,
dynamic_discovery: bool,
enabled: bool,
id: str,
modified_by: str,
modified_time: str,
name: str):
"""
:param str config_space: (string)
:param str creation_time: (string)
:param str description: (string)
:param bool dynamic_discovery: (bool)
:param bool enabled: (bool)
:param str id: The ID of the segment group to be exported.
:param str modified_by: (string)
:param str modified_time: (string)
:param str name: The name of the segment group to be exported.
"""
pulumi.set(__self__, "config_space", config_space)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "dynamic_discovery", dynamic_discovery)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "modified_by", modified_by)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="dynamicDiscovery")
def dynamic_discovery(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "dynamic_discovery")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the segment group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedBy")
def modified_by(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_by")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the segment group to be exported.
"""
return pulumi.get(self, "name") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/segmentgroup/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['SegmentGroupArgs', 'SegmentGroup']
@pulumi.input_type
class SegmentGroupArgs:
def __init__(__self__, *,
applications: Optional[pulumi.Input[Sequence[pulumi.Input['SegmentGroupApplicationArgs']]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
policy_migrated: Optional[pulumi.Input[bool]] = None,
tcp_keep_alive_enabled: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a SegmentGroup resource.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the segment group.
:param pulumi.Input[bool] enabled: (Optional) Whether this segment group is enabled or not.
:param pulumi.Input[str] name: (Required) Name of the segment group.
:param pulumi.Input[str] tcp_keep_alive_enabled: (Optional)
"""
if applications is not None:
pulumi.set(__self__, "applications", applications)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if policy_migrated is not None:
pulumi.set(__self__, "policy_migrated", policy_migrated)
if tcp_keep_alive_enabled is not None:
pulumi.set(__self__, "tcp_keep_alive_enabled", tcp_keep_alive_enabled)
@property
@pulumi.getter
def applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SegmentGroupApplicationArgs']]]]:
return pulumi.get(self, "applications")
@applications.setter
def applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SegmentGroupApplicationArgs']]]]):
pulumi.set(self, "applications", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the segment group.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether this segment group is enabled or not.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
(Required) Name of the segment group.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="policyMigrated")
def policy_migrated(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "policy_migrated")
@policy_migrated.setter
def policy_migrated(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "policy_migrated", value)
@property
@pulumi.getter(name="tcpKeepAliveEnabled")
def tcp_keep_alive_enabled(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "tcp_keep_alive_enabled")
@tcp_keep_alive_enabled.setter
def tcp_keep_alive_enabled(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "tcp_keep_alive_enabled", value)
@pulumi.input_type
class _SegmentGroupState:
def __init__(__self__, *,
applications: Optional[pulumi.Input[Sequence[pulumi.Input['SegmentGroupApplicationArgs']]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
policy_migrated: Optional[pulumi.Input[bool]] = None,
tcp_keep_alive_enabled: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering SegmentGroup resources.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the segment group.
:param pulumi.Input[bool] enabled: (Optional) Whether this segment group is enabled or not.
:param pulumi.Input[str] name: (Required) Name of the segment group.
:param pulumi.Input[str] tcp_keep_alive_enabled: (Optional)
"""
if applications is not None:
pulumi.set(__self__, "applications", applications)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if policy_migrated is not None:
pulumi.set(__self__, "policy_migrated", policy_migrated)
if tcp_keep_alive_enabled is not None:
pulumi.set(__self__, "tcp_keep_alive_enabled", tcp_keep_alive_enabled)
@property
@pulumi.getter
def applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SegmentGroupApplicationArgs']]]]:
return pulumi.get(self, "applications")
@applications.setter
def applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SegmentGroupApplicationArgs']]]]):
pulumi.set(self, "applications", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the segment group.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether this segment group is enabled or not.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
(Required) Name of the segment group.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="policyMigrated")
def policy_migrated(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "policy_migrated")
@policy_migrated.setter
def policy_migrated(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "policy_migrated", value)
@property
@pulumi.getter(name="tcpKeepAliveEnabled")
def tcp_keep_alive_enabled(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "tcp_keep_alive_enabled")
@tcp_keep_alive_enabled.setter
def tcp_keep_alive_enabled(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "tcp_keep_alive_enabled", value)
class SegmentGroup(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['SegmentGroupApplicationArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
policy_migrated: Optional[pulumi.Input[bool]] = None,
tcp_keep_alive_enabled: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# ZPA Segment Group resource
test_segment_group = zpa.segment_group.SegmentGroup("testSegmentGroup",
description="test1-segment-group",
enabled=True,
tcp_keep_alive_enabled="1")
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) **segment_group** can be imported by using `<SEGMENT GROUP ID>` or `<SEGMENT GROUP NAME>` as the import ID. For example
```sh
$ pulumi import zpa:SegmentGroup/segmentGroup:SegmentGroup example <segment_group_id>
```
or
```sh
$ pulumi import zpa:SegmentGroup/segmentGroup:SegmentGroup example <segment_group_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the segment group.
:param pulumi.Input[bool] enabled: (Optional) Whether this segment group is enabled or not.
:param pulumi.Input[str] name: (Required) Name of the segment group.
:param pulumi.Input[str] tcp_keep_alive_enabled: (Optional)
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[SegmentGroupArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# ZPA Segment Group resource
test_segment_group = zpa.segment_group.SegmentGroup("testSegmentGroup",
description="test1-segment-group",
enabled=True,
tcp_keep_alive_enabled="1")
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) **segment_group** can be imported by using `<SEGMENT GROUP ID>` or `<SEGMENT GROUP NAME>` as the import ID. For example
```sh
$ pulumi import zpa:SegmentGroup/segmentGroup:SegmentGroup example <segment_group_id>
```
or
```sh
$ pulumi import zpa:SegmentGroup/segmentGroup:SegmentGroup example <segment_group_name>
```
:param str resource_name: The name of the resource.
:param SegmentGroupArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(SegmentGroupArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['SegmentGroupApplicationArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
policy_migrated: Optional[pulumi.Input[bool]] = None,
tcp_keep_alive_enabled: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = SegmentGroupArgs.__new__(SegmentGroupArgs)
__props__.__dict__["applications"] = applications
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["enabled"] = enabled
__props__.__dict__["name"] = name
__props__.__dict__["policy_migrated"] = policy_migrated
__props__.__dict__["tcp_keep_alive_enabled"] = tcp_keep_alive_enabled
super(SegmentGroup, __self__).__init__(
'zpa:SegmentGroup/segmentGroup:SegmentGroup',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['SegmentGroupApplicationArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
policy_migrated: Optional[pulumi.Input[bool]] = None,
tcp_keep_alive_enabled: Optional[pulumi.Input[str]] = None) -> 'SegmentGroup':
"""
Get an existing SegmentGroup resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the segment group.
:param pulumi.Input[bool] enabled: (Optional) Whether this segment group is enabled or not.
:param pulumi.Input[str] name: (Required) Name of the segment group.
:param pulumi.Input[str] tcp_keep_alive_enabled: (Optional)
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _SegmentGroupState.__new__(_SegmentGroupState)
__props__.__dict__["applications"] = applications
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["enabled"] = enabled
__props__.__dict__["name"] = name
__props__.__dict__["policy_migrated"] = policy_migrated
__props__.__dict__["tcp_keep_alive_enabled"] = tcp_keep_alive_enabled
return SegmentGroup(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def applications(self) -> pulumi.Output[Sequence['outputs.SegmentGroupApplication']]:
return pulumi.get(self, "applications")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Description of the segment group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) Whether this segment group is enabled or not.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
(Required) Name of the segment group.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="policyMigrated")
def policy_migrated(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "policy_migrated")
@property
@pulumi.getter(name="tcpKeepAliveEnabled")
def tcp_keep_alive_enabled(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "tcp_keep_alive_enabled") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/segmentgroup/segment_group.py | segment_group.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetSegmentGroupResult',
'AwaitableGetSegmentGroupResult',
'get_segment_group',
'get_segment_group_output',
]
@pulumi.output_type
class GetSegmentGroupResult:
"""
A collection of values returned by getSegmentGroup.
"""
def __init__(__self__, applications=None, config_space=None, creation_time=None, description=None, enabled=None, id=None, modified_by=None, modified_time=None, name=None, policy_migrated=None, tcp_keep_alive_enabled=None):
if applications and not isinstance(applications, list):
raise TypeError("Expected argument 'applications' to be a list")
pulumi.set(__self__, "applications", applications)
if config_space and not isinstance(config_space, str):
raise TypeError("Expected argument 'config_space' to be a str")
pulumi.set(__self__, "config_space", config_space)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if modified_by and not isinstance(modified_by, str):
raise TypeError("Expected argument 'modified_by' to be a str")
pulumi.set(__self__, "modified_by", modified_by)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if policy_migrated and not isinstance(policy_migrated, bool):
raise TypeError("Expected argument 'policy_migrated' to be a bool")
pulumi.set(__self__, "policy_migrated", policy_migrated)
if tcp_keep_alive_enabled and not isinstance(tcp_keep_alive_enabled, str):
raise TypeError("Expected argument 'tcp_keep_alive_enabled' to be a str")
pulumi.set(__self__, "tcp_keep_alive_enabled", tcp_keep_alive_enabled)
@property
@pulumi.getter
def applications(self) -> Sequence['outputs.GetSegmentGroupApplicationResult']:
"""
(Computed)
"""
return pulumi.get(self, "applications")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> Optional[str]:
"""
(string)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedBy")
def modified_by(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_by")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
(string)
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="policyMigrated")
def policy_migrated(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "policy_migrated")
@property
@pulumi.getter(name="tcpKeepAliveEnabled")
def tcp_keep_alive_enabled(self) -> str:
"""
(string)
"""
return pulumi.get(self, "tcp_keep_alive_enabled")
class AwaitableGetSegmentGroupResult(GetSegmentGroupResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetSegmentGroupResult(
applications=self.applications,
config_space=self.config_space,
creation_time=self.creation_time,
description=self.description,
enabled=self.enabled,
id=self.id,
modified_by=self.modified_by,
modified_time=self.modified_time,
name=self.name,
policy_migrated=self.policy_migrated,
tcp_keep_alive_enabled=self.tcp_keep_alive_enabled)
def get_segment_group(id: Optional[str] = None,
name: Optional[str] = None,
policy_migrated: Optional[bool] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSegmentGroupResult:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.SegmentGroup.get_segment_group(name="segment_group_name")
```
:param str id: The ID of the segment group to be exported.
:param str name: The name of the segment group to be exported.
:param bool policy_migrated: (bool)
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
__args__['policyMigrated'] = policy_migrated
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:SegmentGroup/getSegmentGroup:getSegmentGroup', __args__, opts=opts, typ=GetSegmentGroupResult).value
return AwaitableGetSegmentGroupResult(
applications=__ret__.applications,
config_space=__ret__.config_space,
creation_time=__ret__.creation_time,
description=__ret__.description,
enabled=__ret__.enabled,
id=__ret__.id,
modified_by=__ret__.modified_by,
modified_time=__ret__.modified_time,
name=__ret__.name,
policy_migrated=__ret__.policy_migrated,
tcp_keep_alive_enabled=__ret__.tcp_keep_alive_enabled)
@_utilities.lift_output_func(get_segment_group)
def get_segment_group_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
policy_migrated: Optional[pulumi.Input[Optional[bool]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetSegmentGroupResult]:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.SegmentGroup.get_segment_group(name="segment_group_name")
```
:param str id: The ID of the segment group to be exported.
:param str name: The name of the segment group to be exported.
:param bool policy_migrated: (bool)
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/segmentgroup/get_segment_group.py | get_segment_group.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetServiceEdgeGroupResult',
'AwaitableGetServiceEdgeGroupResult',
'get_service_edge_group',
'get_service_edge_group_output',
]
@pulumi.output_type
class GetServiceEdgeGroupResult:
"""
A collection of values returned by getServiceEdgeGroup.
"""
def __init__(__self__, city_country=None, country_code=None, creation_time=None, description=None, enabled=None, geo_location_id=None, id=None, is_public=None, latitude=None, location=None, longitude=None, modified_time=None, modifiedby=None, name=None, override_version_profile=None, service_edges=None, trusted_networks=None, upgrade_day=None, upgrade_time_in_secs=None, version_profile_id=None, version_profile_name=None, version_profile_visibility_scope=None):
if city_country and not isinstance(city_country, str):
raise TypeError("Expected argument 'city_country' to be a str")
pulumi.set(__self__, "city_country", city_country)
if country_code and not isinstance(country_code, str):
raise TypeError("Expected argument 'country_code' to be a str")
pulumi.set(__self__, "country_code", country_code)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if geo_location_id and not isinstance(geo_location_id, str):
raise TypeError("Expected argument 'geo_location_id' to be a str")
pulumi.set(__self__, "geo_location_id", geo_location_id)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if is_public and not isinstance(is_public, str):
raise TypeError("Expected argument 'is_public' to be a str")
pulumi.set(__self__, "is_public", is_public)
if latitude and not isinstance(latitude, str):
raise TypeError("Expected argument 'latitude' to be a str")
pulumi.set(__self__, "latitude", latitude)
if location and not isinstance(location, str):
raise TypeError("Expected argument 'location' to be a str")
pulumi.set(__self__, "location", location)
if longitude and not isinstance(longitude, str):
raise TypeError("Expected argument 'longitude' to be a str")
pulumi.set(__self__, "longitude", longitude)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if override_version_profile and not isinstance(override_version_profile, bool):
raise TypeError("Expected argument 'override_version_profile' to be a bool")
pulumi.set(__self__, "override_version_profile", override_version_profile)
if service_edges and not isinstance(service_edges, list):
raise TypeError("Expected argument 'service_edges' to be a list")
pulumi.set(__self__, "service_edges", service_edges)
if trusted_networks and not isinstance(trusted_networks, list):
raise TypeError("Expected argument 'trusted_networks' to be a list")
pulumi.set(__self__, "trusted_networks", trusted_networks)
if upgrade_day and not isinstance(upgrade_day, str):
raise TypeError("Expected argument 'upgrade_day' to be a str")
pulumi.set(__self__, "upgrade_day", upgrade_day)
if upgrade_time_in_secs and not isinstance(upgrade_time_in_secs, str):
raise TypeError("Expected argument 'upgrade_time_in_secs' to be a str")
pulumi.set(__self__, "upgrade_time_in_secs", upgrade_time_in_secs)
if version_profile_id and not isinstance(version_profile_id, str):
raise TypeError("Expected argument 'version_profile_id' to be a str")
pulumi.set(__self__, "version_profile_id", version_profile_id)
if version_profile_name and not isinstance(version_profile_name, str):
raise TypeError("Expected argument 'version_profile_name' to be a str")
pulumi.set(__self__, "version_profile_name", version_profile_name)
if version_profile_visibility_scope and not isinstance(version_profile_visibility_scope, str):
raise TypeError("Expected argument 'version_profile_visibility_scope' to be a str")
pulumi.set(__self__, "version_profile_visibility_scope", version_profile_visibility_scope)
@property
@pulumi.getter(name="cityCountry")
def city_country(self) -> str:
"""
(string) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "city_country")
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> str:
"""
(string)
"""
return pulumi.get(self, "country_code")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) Description of the Service Edge Group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) Whether this App Connector Group is enabled or not. Default value: `true`. Supported values: `true`, `false`
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="geoLocationId")
def geo_location_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "geo_location_id")
@property
@pulumi.getter
def id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="isPublic")
def is_public(self) -> str:
"""
(string)
"""
return pulumi.get(self, "is_public")
@property
@pulumi.getter
def latitude(self) -> str:
"""
(string)
"""
return pulumi.get(self, "latitude")
@property
@pulumi.getter
def location(self) -> str:
"""
(string)
"""
return pulumi.get(self, "location")
@property
@pulumi.getter
def longitude(self) -> str:
"""
(string)
"""
return pulumi.get(self, "longitude")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="overrideVersionProfile")
def override_version_profile(self) -> bool:
"""
(bool) Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
"""
return pulumi.get(self, "override_version_profile")
@property
@pulumi.getter(name="serviceEdges")
def service_edges(self) -> Sequence['outputs.GetServiceEdgeGroupServiceEdgeResult']:
"""
(string)
"""
return pulumi.get(self, "service_edges")
@property
@pulumi.getter(name="trustedNetworks")
def trusted_networks(self) -> Sequence['outputs.GetServiceEdgeGroupTrustedNetworkResult']:
"""
(string)
"""
return pulumi.get(self, "trusted_networks")
@property
@pulumi.getter(name="upgradeDay")
def upgrade_day(self) -> str:
"""
(string) App Connectors in this group will attempt to update to a newer version of the software during this specified day
"""
return pulumi.get(self, "upgrade_day")
@property
@pulumi.getter(name="upgradeTimeInSecs")
def upgrade_time_in_secs(self) -> str:
"""
(string) App Connectors in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600`. Integer in seconds (i.e., `-66600`). The integer should be greater than or equal to `0` and less than `86400`, in `15` minute intervals
"""
return pulumi.get(self, "upgrade_time_in_secs")
@property
@pulumi.getter(name="versionProfileId")
def version_profile_id(self) -> str:
"""
(String) ID of the version profile.
Exported values are:
"""
return pulumi.get(self, "version_profile_id")
@property
@pulumi.getter(name="versionProfileName")
def version_profile_name(self) -> str:
"""
(String)
Exported values are:
"""
return pulumi.get(self, "version_profile_name")
@property
@pulumi.getter(name="versionProfileVisibilityScope")
def version_profile_visibility_scope(self) -> str:
"""
(string)
Exported values are:
"""
return pulumi.get(self, "version_profile_visibility_scope")
class AwaitableGetServiceEdgeGroupResult(GetServiceEdgeGroupResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetServiceEdgeGroupResult(
city_country=self.city_country,
country_code=self.country_code,
creation_time=self.creation_time,
description=self.description,
enabled=self.enabled,
geo_location_id=self.geo_location_id,
id=self.id,
is_public=self.is_public,
latitude=self.latitude,
location=self.location,
longitude=self.longitude,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
override_version_profile=self.override_version_profile,
service_edges=self.service_edges,
trusted_networks=self.trusted_networks,
upgrade_day=self.upgrade_day,
upgrade_time_in_secs=self.upgrade_time_in_secs,
version_profile_id=self.version_profile_id,
version_profile_name=self.version_profile_name,
version_profile_visibility_scope=self.version_profile_visibility_scope)
def get_service_edge_group(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetServiceEdgeGroupResult:
"""
Use the **zpa_service_edge_group** data source to get information about a service edge group in the Zscaler Private Access cloud. This data source can then be referenced in an App Connector Group. This data source can then be referenced in the following resources:
* Create a server group
* Provisioning Key
* Access policy rule
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.ServiceEdge.get_service_edge_group(name="DataCenter")
```
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.ServiceEdge.get_service_edge_group(id="123456789")
```
:param str id: The ID of the service edge group to be exported.
:param str name: The name of the service edge group to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ServiceEdge/getServiceEdgeGroup:getServiceEdgeGroup', __args__, opts=opts, typ=GetServiceEdgeGroupResult).value
return AwaitableGetServiceEdgeGroupResult(
city_country=__ret__.city_country,
country_code=__ret__.country_code,
creation_time=__ret__.creation_time,
description=__ret__.description,
enabled=__ret__.enabled,
geo_location_id=__ret__.geo_location_id,
id=__ret__.id,
is_public=__ret__.is_public,
latitude=__ret__.latitude,
location=__ret__.location,
longitude=__ret__.longitude,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
override_version_profile=__ret__.override_version_profile,
service_edges=__ret__.service_edges,
trusted_networks=__ret__.trusted_networks,
upgrade_day=__ret__.upgrade_day,
upgrade_time_in_secs=__ret__.upgrade_time_in_secs,
version_profile_id=__ret__.version_profile_id,
version_profile_name=__ret__.version_profile_name,
version_profile_visibility_scope=__ret__.version_profile_visibility_scope)
@_utilities.lift_output_func(get_service_edge_group)
def get_service_edge_group_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetServiceEdgeGroupResult]:
"""
Use the **zpa_service_edge_group** data source to get information about a service edge group in the Zscaler Private Access cloud. This data source can then be referenced in an App Connector Group. This data source can then be referenced in the following resources:
* Create a server group
* Provisioning Key
* Access policy rule
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.ServiceEdge.get_service_edge_group(name="DataCenter")
```
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.ServiceEdge.get_service_edge_group(id="123456789")
```
:param str id: The ID of the service edge group to be exported.
:param str name: The name of the service edge group to be exported.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/serviceedge/get_service_edge_group.py | get_service_edge_group.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'ServiceEdgeGroupServiceEdge',
'ServiceEdgeGroupTrustedNetwork',
'GetServiceEdgeGroupServiceEdgeResult',
'GetServiceEdgeGroupTrustedNetworkResult',
]
@pulumi.output_type
class ServiceEdgeGroupServiceEdge(dict):
def __init__(__self__, *,
ids: Optional[Sequence[str]] = None):
if ids is not None:
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "ids")
@pulumi.output_type
class ServiceEdgeGroupTrustedNetwork(dict):
def __init__(__self__, *,
ids: Optional[Sequence[str]] = None):
if ids is not None:
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "ids")
@pulumi.output_type
class GetServiceEdgeGroupServiceEdgeResult(dict):
def __init__(__self__, *,
application_start_time: str,
control_channel_status: str,
creation_time: str,
ctrl_broker_name: str,
current_version: str,
description: str,
enabled: bool,
enrollment_cert: Mapping[str, Any],
expected_upgrade_time: str,
expected_version: str,
fingerprint: str,
id: str,
ipacl: str,
issued_cert_id: str,
last_broker_connect_time: str,
last_broker_connect_time_duration: str,
last_broker_disconnect_time: str,
last_broker_disconnect_time_duration: str,
last_upgrade_time: str,
latitude: str,
listen_ips: str,
location: str,
longitude: str,
modified_time: str,
modifiedby: str,
name: str,
platform: str,
previous_version: str,
private_ip: str,
provisioning_key_id: str,
provisioning_key_name: str,
public_ip: str,
publish_ips: str,
sarge_version: str,
service_edge_group_id: str,
service_edge_group_name: str,
upgrade_attempt: str,
upgrade_status: str):
"""
:param str application_start_time: (string)
:param str control_channel_status: (string)
:param str creation_time: (string)
:param str ctrl_broker_name: (string)
:param str current_version: (string)
:param str description: (string) Description of the Service Edge Group.
:param bool enabled: (bool) Whether this App Connector Group is enabled or not. Default value: `true`. Supported values: `true`, `false`
:param Mapping[str, Any] enrollment_cert: (string)
:param str expected_upgrade_time: (string)
:param str expected_version: (string)
:param str id: The ID of the service edge group to be exported.
:param str issued_cert_id: (string)
:param str last_broker_connect_time: (string)
:param str last_broker_connect_time_duration: (string)
:param str last_broker_disconnect_time: (string)
:param str last_broker_disconnect_time_duration: (string)
:param str last_upgrade_time: (string)
:param str latitude: (string)
:param str listen_ips: (string)
:param str location: (string)
:param str longitude: (string)
:param str modified_time: (string)
:param str name: The name of the service edge group to be exported.
:param str platform: (string)
:param str previous_version: (string)
:param str private_ip: (string)
:param str provisioning_key_id: (string)
:param str provisioning_key_name: (string)
:param str public_ip: (string)
:param str publish_ips: (string)
:param str sarge_version: (string)
:param str service_edge_group_id: (string)
:param str service_edge_group_name: (string)
:param str upgrade_attempt: (string)
:param str upgrade_status: (string)
"""
pulumi.set(__self__, "application_start_time", application_start_time)
pulumi.set(__self__, "control_channel_status", control_channel_status)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "ctrl_broker_name", ctrl_broker_name)
pulumi.set(__self__, "current_version", current_version)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "enrollment_cert", enrollment_cert)
pulumi.set(__self__, "expected_upgrade_time", expected_upgrade_time)
pulumi.set(__self__, "expected_version", expected_version)
pulumi.set(__self__, "fingerprint", fingerprint)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "ipacl", ipacl)
pulumi.set(__self__, "issued_cert_id", issued_cert_id)
pulumi.set(__self__, "last_broker_connect_time", last_broker_connect_time)
pulumi.set(__self__, "last_broker_connect_time_duration", last_broker_connect_time_duration)
pulumi.set(__self__, "last_broker_disconnect_time", last_broker_disconnect_time)
pulumi.set(__self__, "last_broker_disconnect_time_duration", last_broker_disconnect_time_duration)
pulumi.set(__self__, "last_upgrade_time", last_upgrade_time)
pulumi.set(__self__, "latitude", latitude)
pulumi.set(__self__, "listen_ips", listen_ips)
pulumi.set(__self__, "location", location)
pulumi.set(__self__, "longitude", longitude)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "platform", platform)
pulumi.set(__self__, "previous_version", previous_version)
pulumi.set(__self__, "private_ip", private_ip)
pulumi.set(__self__, "provisioning_key_id", provisioning_key_id)
pulumi.set(__self__, "provisioning_key_name", provisioning_key_name)
pulumi.set(__self__, "public_ip", public_ip)
pulumi.set(__self__, "publish_ips", publish_ips)
pulumi.set(__self__, "sarge_version", sarge_version)
pulumi.set(__self__, "service_edge_group_id", service_edge_group_id)
pulumi.set(__self__, "service_edge_group_name", service_edge_group_name)
pulumi.set(__self__, "upgrade_attempt", upgrade_attempt)
pulumi.set(__self__, "upgrade_status", upgrade_status)
@property
@pulumi.getter(name="applicationStartTime")
def application_start_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "application_start_time")
@property
@pulumi.getter(name="controlChannelStatus")
def control_channel_status(self) -> str:
"""
(string)
"""
return pulumi.get(self, "control_channel_status")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter(name="ctrlBrokerName")
def ctrl_broker_name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "ctrl_broker_name")
@property
@pulumi.getter(name="currentVersion")
def current_version(self) -> str:
"""
(string)
"""
return pulumi.get(self, "current_version")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) Description of the Service Edge Group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) Whether this App Connector Group is enabled or not. Default value: `true`. Supported values: `true`, `false`
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="enrollmentCert")
def enrollment_cert(self) -> Mapping[str, Any]:
"""
(string)
"""
return pulumi.get(self, "enrollment_cert")
@property
@pulumi.getter(name="expectedUpgradeTime")
def expected_upgrade_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "expected_upgrade_time")
@property
@pulumi.getter(name="expectedVersion")
def expected_version(self) -> str:
"""
(string)
"""
return pulumi.get(self, "expected_version")
@property
@pulumi.getter
def fingerprint(self) -> str:
return pulumi.get(self, "fingerprint")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the service edge group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def ipacl(self) -> str:
return pulumi.get(self, "ipacl")
@property
@pulumi.getter(name="issuedCertId")
def issued_cert_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "issued_cert_id")
@property
@pulumi.getter(name="lastBrokerConnectTime")
def last_broker_connect_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "last_broker_connect_time")
@property
@pulumi.getter(name="lastBrokerConnectTimeDuration")
def last_broker_connect_time_duration(self) -> str:
"""
(string)
"""
return pulumi.get(self, "last_broker_connect_time_duration")
@property
@pulumi.getter(name="lastBrokerDisconnectTime")
def last_broker_disconnect_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "last_broker_disconnect_time")
@property
@pulumi.getter(name="lastBrokerDisconnectTimeDuration")
def last_broker_disconnect_time_duration(self) -> str:
"""
(string)
"""
return pulumi.get(self, "last_broker_disconnect_time_duration")
@property
@pulumi.getter(name="lastUpgradeTime")
def last_upgrade_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "last_upgrade_time")
@property
@pulumi.getter
def latitude(self) -> str:
"""
(string)
"""
return pulumi.get(self, "latitude")
@property
@pulumi.getter(name="listenIps")
def listen_ips(self) -> str:
"""
(string)
"""
return pulumi.get(self, "listen_ips")
@property
@pulumi.getter
def location(self) -> str:
"""
(string)
"""
return pulumi.get(self, "location")
@property
@pulumi.getter
def longitude(self) -> str:
"""
(string)
"""
return pulumi.get(self, "longitude")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the service edge group to be exported.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def platform(self) -> str:
"""
(string)
"""
return pulumi.get(self, "platform")
@property
@pulumi.getter(name="previousVersion")
def previous_version(self) -> str:
"""
(string)
"""
return pulumi.get(self, "previous_version")
@property
@pulumi.getter(name="privateIp")
def private_ip(self) -> str:
"""
(string)
"""
return pulumi.get(self, "private_ip")
@property
@pulumi.getter(name="provisioningKeyId")
def provisioning_key_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "provisioning_key_id")
@property
@pulumi.getter(name="provisioningKeyName")
def provisioning_key_name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "provisioning_key_name")
@property
@pulumi.getter(name="publicIp")
def public_ip(self) -> str:
"""
(string)
"""
return pulumi.get(self, "public_ip")
@property
@pulumi.getter(name="publishIps")
def publish_ips(self) -> str:
"""
(string)
"""
return pulumi.get(self, "publish_ips")
@property
@pulumi.getter(name="sargeVersion")
def sarge_version(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sarge_version")
@property
@pulumi.getter(name="serviceEdgeGroupId")
def service_edge_group_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "service_edge_group_id")
@property
@pulumi.getter(name="serviceEdgeGroupName")
def service_edge_group_name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "service_edge_group_name")
@property
@pulumi.getter(name="upgradeAttempt")
def upgrade_attempt(self) -> str:
"""
(string)
"""
return pulumi.get(self, "upgrade_attempt")
@property
@pulumi.getter(name="upgradeStatus")
def upgrade_status(self) -> str:
"""
(string)
"""
return pulumi.get(self, "upgrade_status")
@pulumi.output_type
class GetServiceEdgeGroupTrustedNetworkResult(dict):
def __init__(__self__, *,
creation_time: str,
domain: str,
id: str,
master_customer_id: str,
modified_time: str,
modifiedby: str,
name: str,
network_id: str,
zscaler_cloud: str):
"""
:param str creation_time: (string)
:param str domain: (string)
:param str id: The ID of the service edge group to be exported.
:param str master_customer_id: (string)
:param str modified_time: (string)
:param str name: The name of the service edge group to be exported.
:param str network_id: (string)
:param str zscaler_cloud: (string)
"""
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "domain", domain)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "master_customer_id", master_customer_id)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "network_id", network_id)
pulumi.set(__self__, "zscaler_cloud", zscaler_cloud)
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def domain(self) -> str:
"""
(string)
"""
return pulumi.get(self, "domain")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the service edge group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="masterCustomerId")
def master_customer_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "master_customer_id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the service edge group to be exported.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="networkId")
def network_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "network_id")
@property
@pulumi.getter(name="zscalerCloud")
def zscaler_cloud(self) -> str:
"""
(string)
"""
return pulumi.get(self, "zscaler_cloud") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/serviceedge/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['ServiceEdgeGroupArgs', 'ServiceEdgeGroup']
@pulumi.input_type
class ServiceEdgeGroupArgs:
def __init__(__self__, *,
latitude: pulumi.Input[str],
location: pulumi.Input[str],
longitude: pulumi.Input[str],
city_country: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
is_public: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
override_version_profile: Optional[pulumi.Input[bool]] = None,
service_edges: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupServiceEdgeArgs']]]] = None,
trusted_networks: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]]] = None,
upgrade_day: Optional[pulumi.Input[str]] = None,
upgrade_time_in_secs: Optional[pulumi.Input[str]] = None,
version_profile_id: Optional[pulumi.Input[str]] = None,
version_profile_name: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a ServiceEdgeGroup resource.
:param pulumi.Input[str] latitude: Latitude for the Service Edge Group. Integer or decimal with values in the range of `-90` to `90`
:param pulumi.Input[str] location: Location for the Service Edge Group.
:param pulumi.Input[str] longitude: Longitude for the Service Edge Group. Integer or decimal with values in the range of `-180` to `180`
:param pulumi.Input[str] city_country: This field controls dynamic discovery of the servers.
:param pulumi.Input[str] country_code: This field is an array of app-connector-id only.
:param pulumi.Input[str] description: Description of the Service Edge Group.
:param pulumi.Input[bool] enabled: Whether this Service Edge Group is enabled or not. Default value: `true` Supported values: `true`, `false`
:param pulumi.Input[bool] is_public: Enable or disable public access for the Service Edge Group. Default value: `false` Supported values: `true`, `false`
:param pulumi.Input[str] name: Name of the Service Edge Group.
:param pulumi.Input[bool] override_version_profile: Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
:param pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]] trusted_networks: Trusted networks for this Service Edge Group. List of trusted network objects
:param pulumi.Input[str] upgrade_day: Service Edges in this group will attempt to update to a newer version of the software during this specified day. Default value: `SUNDAY` List of valid days (i.e., Sunday, Monday)
:param pulumi.Input[str] upgrade_time_in_secs: Service Edges in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600` Integer in seconds (i..e, 66600). The integer must be greater than or equal to 0 and less than `86400`, in `15` minute intervals
:param pulumi.Input[str] version_profile_id: ID of the version profile. To learn more, see Version Profile Use Cases. Supported values are:
:param pulumi.Input[str] version_profile_name: ID of the version profile.
"""
pulumi.set(__self__, "latitude", latitude)
pulumi.set(__self__, "location", location)
pulumi.set(__self__, "longitude", longitude)
if city_country is not None:
pulumi.set(__self__, "city_country", city_country)
if country_code is not None:
pulumi.set(__self__, "country_code", country_code)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if is_public is not None:
pulumi.set(__self__, "is_public", is_public)
if name is not None:
pulumi.set(__self__, "name", name)
if override_version_profile is not None:
pulumi.set(__self__, "override_version_profile", override_version_profile)
if service_edges is not None:
pulumi.set(__self__, "service_edges", service_edges)
if trusted_networks is not None:
pulumi.set(__self__, "trusted_networks", trusted_networks)
if upgrade_day is not None:
pulumi.set(__self__, "upgrade_day", upgrade_day)
if upgrade_time_in_secs is not None:
pulumi.set(__self__, "upgrade_time_in_secs", upgrade_time_in_secs)
if version_profile_id is not None:
pulumi.set(__self__, "version_profile_id", version_profile_id)
if version_profile_name is not None:
pulumi.set(__self__, "version_profile_name", version_profile_name)
@property
@pulumi.getter
def latitude(self) -> pulumi.Input[str]:
"""
Latitude for the Service Edge Group. Integer or decimal with values in the range of `-90` to `90`
"""
return pulumi.get(self, "latitude")
@latitude.setter
def latitude(self, value: pulumi.Input[str]):
pulumi.set(self, "latitude", value)
@property
@pulumi.getter
def location(self) -> pulumi.Input[str]:
"""
Location for the Service Edge Group.
"""
return pulumi.get(self, "location")
@location.setter
def location(self, value: pulumi.Input[str]):
pulumi.set(self, "location", value)
@property
@pulumi.getter
def longitude(self) -> pulumi.Input[str]:
"""
Longitude for the Service Edge Group. Integer or decimal with values in the range of `-180` to `180`
"""
return pulumi.get(self, "longitude")
@longitude.setter
def longitude(self, value: pulumi.Input[str]):
pulumi.set(self, "longitude", value)
@property
@pulumi.getter(name="cityCountry")
def city_country(self) -> Optional[pulumi.Input[str]]:
"""
This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "city_country")
@city_country.setter
def city_country(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "city_country", value)
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> Optional[pulumi.Input[str]]:
"""
This field is an array of app-connector-id only.
"""
return pulumi.get(self, "country_code")
@country_code.setter
def country_code(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "country_code", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the Service Edge Group.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this Service Edge Group is enabled or not. Default value: `true` Supported values: `true`, `false`
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="isPublic")
def is_public(self) -> Optional[pulumi.Input[bool]]:
"""
Enable or disable public access for the Service Edge Group. Default value: `false` Supported values: `true`, `false`
"""
return pulumi.get(self, "is_public")
@is_public.setter
def is_public(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_public", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Service Edge Group.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="overrideVersionProfile")
def override_version_profile(self) -> Optional[pulumi.Input[bool]]:
"""
Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
"""
return pulumi.get(self, "override_version_profile")
@override_version_profile.setter
def override_version_profile(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "override_version_profile", value)
@property
@pulumi.getter(name="serviceEdges")
def service_edges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupServiceEdgeArgs']]]]:
return pulumi.get(self, "service_edges")
@service_edges.setter
def service_edges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupServiceEdgeArgs']]]]):
pulumi.set(self, "service_edges", value)
@property
@pulumi.getter(name="trustedNetworks")
def trusted_networks(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]]]:
"""
Trusted networks for this Service Edge Group. List of trusted network objects
"""
return pulumi.get(self, "trusted_networks")
@trusted_networks.setter
def trusted_networks(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]]]):
pulumi.set(self, "trusted_networks", value)
@property
@pulumi.getter(name="upgradeDay")
def upgrade_day(self) -> Optional[pulumi.Input[str]]:
"""
Service Edges in this group will attempt to update to a newer version of the software during this specified day. Default value: `SUNDAY` List of valid days (i.e., Sunday, Monday)
"""
return pulumi.get(self, "upgrade_day")
@upgrade_day.setter
def upgrade_day(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "upgrade_day", value)
@property
@pulumi.getter(name="upgradeTimeInSecs")
def upgrade_time_in_secs(self) -> Optional[pulumi.Input[str]]:
"""
Service Edges in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600` Integer in seconds (i..e, 66600). The integer must be greater than or equal to 0 and less than `86400`, in `15` minute intervals
"""
return pulumi.get(self, "upgrade_time_in_secs")
@upgrade_time_in_secs.setter
def upgrade_time_in_secs(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "upgrade_time_in_secs", value)
@property
@pulumi.getter(name="versionProfileId")
def version_profile_id(self) -> Optional[pulumi.Input[str]]:
"""
ID of the version profile. To learn more, see Version Profile Use Cases. Supported values are:
"""
return pulumi.get(self, "version_profile_id")
@version_profile_id.setter
def version_profile_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "version_profile_id", value)
@property
@pulumi.getter(name="versionProfileName")
def version_profile_name(self) -> Optional[pulumi.Input[str]]:
"""
ID of the version profile.
"""
return pulumi.get(self, "version_profile_name")
@version_profile_name.setter
def version_profile_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "version_profile_name", value)
@pulumi.input_type
class _ServiceEdgeGroupState:
def __init__(__self__, *,
city_country: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
is_public: Optional[pulumi.Input[bool]] = None,
latitude: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
longitude: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
override_version_profile: Optional[pulumi.Input[bool]] = None,
service_edges: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupServiceEdgeArgs']]]] = None,
trusted_networks: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]]] = None,
upgrade_day: Optional[pulumi.Input[str]] = None,
upgrade_time_in_secs: Optional[pulumi.Input[str]] = None,
version_profile_id: Optional[pulumi.Input[str]] = None,
version_profile_name: Optional[pulumi.Input[str]] = None,
version_profile_visibility_scope: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering ServiceEdgeGroup resources.
:param pulumi.Input[str] city_country: This field controls dynamic discovery of the servers.
:param pulumi.Input[str] country_code: This field is an array of app-connector-id only.
:param pulumi.Input[str] description: Description of the Service Edge Group.
:param pulumi.Input[bool] enabled: Whether this Service Edge Group is enabled or not. Default value: `true` Supported values: `true`, `false`
:param pulumi.Input[bool] is_public: Enable or disable public access for the Service Edge Group. Default value: `false` Supported values: `true`, `false`
:param pulumi.Input[str] latitude: Latitude for the Service Edge Group. Integer or decimal with values in the range of `-90` to `90`
:param pulumi.Input[str] location: Location for the Service Edge Group.
:param pulumi.Input[str] longitude: Longitude for the Service Edge Group. Integer or decimal with values in the range of `-180` to `180`
:param pulumi.Input[str] name: Name of the Service Edge Group.
:param pulumi.Input[bool] override_version_profile: Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
:param pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]] trusted_networks: Trusted networks for this Service Edge Group. List of trusted network objects
:param pulumi.Input[str] upgrade_day: Service Edges in this group will attempt to update to a newer version of the software during this specified day. Default value: `SUNDAY` List of valid days (i.e., Sunday, Monday)
:param pulumi.Input[str] upgrade_time_in_secs: Service Edges in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600` Integer in seconds (i..e, 66600). The integer must be greater than or equal to 0 and less than `86400`, in `15` minute intervals
:param pulumi.Input[str] version_profile_id: ID of the version profile. To learn more, see Version Profile Use Cases. Supported values are:
:param pulumi.Input[str] version_profile_name: ID of the version profile.
:param pulumi.Input[str] version_profile_visibility_scope: ID of the version profile.
"""
if city_country is not None:
pulumi.set(__self__, "city_country", city_country)
if country_code is not None:
pulumi.set(__self__, "country_code", country_code)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if is_public is not None:
pulumi.set(__self__, "is_public", is_public)
if latitude is not None:
pulumi.set(__self__, "latitude", latitude)
if location is not None:
pulumi.set(__self__, "location", location)
if longitude is not None:
pulumi.set(__self__, "longitude", longitude)
if name is not None:
pulumi.set(__self__, "name", name)
if override_version_profile is not None:
pulumi.set(__self__, "override_version_profile", override_version_profile)
if service_edges is not None:
pulumi.set(__self__, "service_edges", service_edges)
if trusted_networks is not None:
pulumi.set(__self__, "trusted_networks", trusted_networks)
if upgrade_day is not None:
pulumi.set(__self__, "upgrade_day", upgrade_day)
if upgrade_time_in_secs is not None:
pulumi.set(__self__, "upgrade_time_in_secs", upgrade_time_in_secs)
if version_profile_id is not None:
pulumi.set(__self__, "version_profile_id", version_profile_id)
if version_profile_name is not None:
pulumi.set(__self__, "version_profile_name", version_profile_name)
if version_profile_visibility_scope is not None:
pulumi.set(__self__, "version_profile_visibility_scope", version_profile_visibility_scope)
@property
@pulumi.getter(name="cityCountry")
def city_country(self) -> Optional[pulumi.Input[str]]:
"""
This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "city_country")
@city_country.setter
def city_country(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "city_country", value)
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> Optional[pulumi.Input[str]]:
"""
This field is an array of app-connector-id only.
"""
return pulumi.get(self, "country_code")
@country_code.setter
def country_code(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "country_code", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the Service Edge Group.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this Service Edge Group is enabled or not. Default value: `true` Supported values: `true`, `false`
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="isPublic")
def is_public(self) -> Optional[pulumi.Input[bool]]:
"""
Enable or disable public access for the Service Edge Group. Default value: `false` Supported values: `true`, `false`
"""
return pulumi.get(self, "is_public")
@is_public.setter
def is_public(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_public", value)
@property
@pulumi.getter
def latitude(self) -> Optional[pulumi.Input[str]]:
"""
Latitude for the Service Edge Group. Integer or decimal with values in the range of `-90` to `90`
"""
return pulumi.get(self, "latitude")
@latitude.setter
def latitude(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "latitude", value)
@property
@pulumi.getter
def location(self) -> Optional[pulumi.Input[str]]:
"""
Location for the Service Edge Group.
"""
return pulumi.get(self, "location")
@location.setter
def location(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "location", value)
@property
@pulumi.getter
def longitude(self) -> Optional[pulumi.Input[str]]:
"""
Longitude for the Service Edge Group. Integer or decimal with values in the range of `-180` to `180`
"""
return pulumi.get(self, "longitude")
@longitude.setter
def longitude(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "longitude", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Service Edge Group.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="overrideVersionProfile")
def override_version_profile(self) -> Optional[pulumi.Input[bool]]:
"""
Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
"""
return pulumi.get(self, "override_version_profile")
@override_version_profile.setter
def override_version_profile(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "override_version_profile", value)
@property
@pulumi.getter(name="serviceEdges")
def service_edges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupServiceEdgeArgs']]]]:
return pulumi.get(self, "service_edges")
@service_edges.setter
def service_edges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupServiceEdgeArgs']]]]):
pulumi.set(self, "service_edges", value)
@property
@pulumi.getter(name="trustedNetworks")
def trusted_networks(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]]]:
"""
Trusted networks for this Service Edge Group. List of trusted network objects
"""
return pulumi.get(self, "trusted_networks")
@trusted_networks.setter
def trusted_networks(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServiceEdgeGroupTrustedNetworkArgs']]]]):
pulumi.set(self, "trusted_networks", value)
@property
@pulumi.getter(name="upgradeDay")
def upgrade_day(self) -> Optional[pulumi.Input[str]]:
"""
Service Edges in this group will attempt to update to a newer version of the software during this specified day. Default value: `SUNDAY` List of valid days (i.e., Sunday, Monday)
"""
return pulumi.get(self, "upgrade_day")
@upgrade_day.setter
def upgrade_day(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "upgrade_day", value)
@property
@pulumi.getter(name="upgradeTimeInSecs")
def upgrade_time_in_secs(self) -> Optional[pulumi.Input[str]]:
"""
Service Edges in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600` Integer in seconds (i..e, 66600). The integer must be greater than or equal to 0 and less than `86400`, in `15` minute intervals
"""
return pulumi.get(self, "upgrade_time_in_secs")
@upgrade_time_in_secs.setter
def upgrade_time_in_secs(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "upgrade_time_in_secs", value)
@property
@pulumi.getter(name="versionProfileId")
def version_profile_id(self) -> Optional[pulumi.Input[str]]:
"""
ID of the version profile. To learn more, see Version Profile Use Cases. Supported values are:
"""
return pulumi.get(self, "version_profile_id")
@version_profile_id.setter
def version_profile_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "version_profile_id", value)
@property
@pulumi.getter(name="versionProfileName")
def version_profile_name(self) -> Optional[pulumi.Input[str]]:
"""
ID of the version profile.
"""
return pulumi.get(self, "version_profile_name")
@version_profile_name.setter
def version_profile_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "version_profile_name", value)
@property
@pulumi.getter(name="versionProfileVisibilityScope")
def version_profile_visibility_scope(self) -> Optional[pulumi.Input[str]]:
"""
ID of the version profile.
"""
return pulumi.get(self, "version_profile_visibility_scope")
@version_profile_visibility_scope.setter
def version_profile_visibility_scope(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "version_profile_visibility_scope", value)
class ServiceEdgeGroup(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
city_country: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
is_public: Optional[pulumi.Input[bool]] = None,
latitude: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
longitude: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
override_version_profile: Optional[pulumi.Input[bool]] = None,
service_edges: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupServiceEdgeArgs']]]]] = None,
trusted_networks: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupTrustedNetworkArgs']]]]] = None,
upgrade_day: Optional[pulumi.Input[str]] = None,
upgrade_time_in_secs: Optional[pulumi.Input[str]] = None,
version_profile_id: Optional[pulumi.Input[str]] = None,
version_profile_name: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
The **zpa_service_edge_group** resource creates a service edge group in the Zscaler Private Access cloud. This resource can then be referenced in a service edge connector.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# ZPA Service Edge Group resource - Trusted Network
service_edge_group_sjc = zpa.service_edge.ServiceEdgeGroup("serviceEdgeGroupSjc",
description="Service Edge Group in San Jose",
enabled=True,
is_public=True,
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
latitude="37.3382082",
longitude="-121.8863286",
location="San Jose, CA, USA",
version_profile_name="New Release",
trusted_networks=[zpa.service_edge.ServiceEdgeGroupTrustedNetworkArgs(
ids=[data["zpa_trusted_network"]["example"]["id"]],
)])
```
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# ZPA Service Edge Group resource - No Trusted Network
service_edge_group_nyc = zpa.service_edge.ServiceEdgeGroup("serviceEdgeGroupNyc",
description="Service Edge Group in New York",
enabled=True,
is_public=True,
latitude="40.7128",
location="New York, NY, USA",
longitude="-73.935242",
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
version_profile_name="New Release")
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Service Edge Group can be imported; use `<SERVER EDGE GROUP ID>` or `<SERVER EDGE GROUP NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ServiceEdge/serviceEdgeGroup:ServiceEdgeGroup example <service_edge_group_id>
```
or
```sh
$ pulumi import zpa:ServiceEdge/serviceEdgeGroup:ServiceEdgeGroup example <service_edge_group_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] city_country: This field controls dynamic discovery of the servers.
:param pulumi.Input[str] country_code: This field is an array of app-connector-id only.
:param pulumi.Input[str] description: Description of the Service Edge Group.
:param pulumi.Input[bool] enabled: Whether this Service Edge Group is enabled or not. Default value: `true` Supported values: `true`, `false`
:param pulumi.Input[bool] is_public: Enable or disable public access for the Service Edge Group. Default value: `false` Supported values: `true`, `false`
:param pulumi.Input[str] latitude: Latitude for the Service Edge Group. Integer or decimal with values in the range of `-90` to `90`
:param pulumi.Input[str] location: Location for the Service Edge Group.
:param pulumi.Input[str] longitude: Longitude for the Service Edge Group. Integer or decimal with values in the range of `-180` to `180`
:param pulumi.Input[str] name: Name of the Service Edge Group.
:param pulumi.Input[bool] override_version_profile: Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupTrustedNetworkArgs']]]] trusted_networks: Trusted networks for this Service Edge Group. List of trusted network objects
:param pulumi.Input[str] upgrade_day: Service Edges in this group will attempt to update to a newer version of the software during this specified day. Default value: `SUNDAY` List of valid days (i.e., Sunday, Monday)
:param pulumi.Input[str] upgrade_time_in_secs: Service Edges in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600` Integer in seconds (i..e, 66600). The integer must be greater than or equal to 0 and less than `86400`, in `15` minute intervals
:param pulumi.Input[str] version_profile_id: ID of the version profile. To learn more, see Version Profile Use Cases. Supported values are:
:param pulumi.Input[str] version_profile_name: ID of the version profile.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: ServiceEdgeGroupArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zpa_service_edge_group** resource creates a service edge group in the Zscaler Private Access cloud. This resource can then be referenced in a service edge connector.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# ZPA Service Edge Group resource - Trusted Network
service_edge_group_sjc = zpa.service_edge.ServiceEdgeGroup("serviceEdgeGroupSjc",
description="Service Edge Group in San Jose",
enabled=True,
is_public=True,
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
latitude="37.3382082",
longitude="-121.8863286",
location="San Jose, CA, USA",
version_profile_name="New Release",
trusted_networks=[zpa.service_edge.ServiceEdgeGroupTrustedNetworkArgs(
ids=[data["zpa_trusted_network"]["example"]["id"]],
)])
```
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# ZPA Service Edge Group resource - No Trusted Network
service_edge_group_nyc = zpa.service_edge.ServiceEdgeGroup("serviceEdgeGroupNyc",
description="Service Edge Group in New York",
enabled=True,
is_public=True,
latitude="40.7128",
location="New York, NY, USA",
longitude="-73.935242",
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
version_profile_name="New Release")
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Service Edge Group can be imported; use `<SERVER EDGE GROUP ID>` or `<SERVER EDGE GROUP NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ServiceEdge/serviceEdgeGroup:ServiceEdgeGroup example <service_edge_group_id>
```
or
```sh
$ pulumi import zpa:ServiceEdge/serviceEdgeGroup:ServiceEdgeGroup example <service_edge_group_name>
```
:param str resource_name: The name of the resource.
:param ServiceEdgeGroupArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ServiceEdgeGroupArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
city_country: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
is_public: Optional[pulumi.Input[bool]] = None,
latitude: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
longitude: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
override_version_profile: Optional[pulumi.Input[bool]] = None,
service_edges: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupServiceEdgeArgs']]]]] = None,
trusted_networks: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupTrustedNetworkArgs']]]]] = None,
upgrade_day: Optional[pulumi.Input[str]] = None,
upgrade_time_in_secs: Optional[pulumi.Input[str]] = None,
version_profile_id: Optional[pulumi.Input[str]] = None,
version_profile_name: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ServiceEdgeGroupArgs.__new__(ServiceEdgeGroupArgs)
__props__.__dict__["city_country"] = city_country
__props__.__dict__["country_code"] = country_code
__props__.__dict__["description"] = description
__props__.__dict__["enabled"] = enabled
__props__.__dict__["is_public"] = is_public
if latitude is None and not opts.urn:
raise TypeError("Missing required property 'latitude'")
__props__.__dict__["latitude"] = latitude
if location is None and not opts.urn:
raise TypeError("Missing required property 'location'")
__props__.__dict__["location"] = location
if longitude is None and not opts.urn:
raise TypeError("Missing required property 'longitude'")
__props__.__dict__["longitude"] = longitude
__props__.__dict__["name"] = name
__props__.__dict__["override_version_profile"] = override_version_profile
__props__.__dict__["service_edges"] = service_edges
__props__.__dict__["trusted_networks"] = trusted_networks
__props__.__dict__["upgrade_day"] = upgrade_day
__props__.__dict__["upgrade_time_in_secs"] = upgrade_time_in_secs
__props__.__dict__["version_profile_id"] = version_profile_id
__props__.__dict__["version_profile_name"] = version_profile_name
__props__.__dict__["version_profile_visibility_scope"] = None
super(ServiceEdgeGroup, __self__).__init__(
'zpa:ServiceEdge/serviceEdgeGroup:ServiceEdgeGroup',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
city_country: Optional[pulumi.Input[str]] = None,
country_code: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
is_public: Optional[pulumi.Input[bool]] = None,
latitude: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
longitude: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
override_version_profile: Optional[pulumi.Input[bool]] = None,
service_edges: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupServiceEdgeArgs']]]]] = None,
trusted_networks: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupTrustedNetworkArgs']]]]] = None,
upgrade_day: Optional[pulumi.Input[str]] = None,
upgrade_time_in_secs: Optional[pulumi.Input[str]] = None,
version_profile_id: Optional[pulumi.Input[str]] = None,
version_profile_name: Optional[pulumi.Input[str]] = None,
version_profile_visibility_scope: Optional[pulumi.Input[str]] = None) -> 'ServiceEdgeGroup':
"""
Get an existing ServiceEdgeGroup resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] city_country: This field controls dynamic discovery of the servers.
:param pulumi.Input[str] country_code: This field is an array of app-connector-id only.
:param pulumi.Input[str] description: Description of the Service Edge Group.
:param pulumi.Input[bool] enabled: Whether this Service Edge Group is enabled or not. Default value: `true` Supported values: `true`, `false`
:param pulumi.Input[bool] is_public: Enable or disable public access for the Service Edge Group. Default value: `false` Supported values: `true`, `false`
:param pulumi.Input[str] latitude: Latitude for the Service Edge Group. Integer or decimal with values in the range of `-90` to `90`
:param pulumi.Input[str] location: Location for the Service Edge Group.
:param pulumi.Input[str] longitude: Longitude for the Service Edge Group. Integer or decimal with values in the range of `-180` to `180`
:param pulumi.Input[str] name: Name of the Service Edge Group.
:param pulumi.Input[bool] override_version_profile: Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServiceEdgeGroupTrustedNetworkArgs']]]] trusted_networks: Trusted networks for this Service Edge Group. List of trusted network objects
:param pulumi.Input[str] upgrade_day: Service Edges in this group will attempt to update to a newer version of the software during this specified day. Default value: `SUNDAY` List of valid days (i.e., Sunday, Monday)
:param pulumi.Input[str] upgrade_time_in_secs: Service Edges in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600` Integer in seconds (i..e, 66600). The integer must be greater than or equal to 0 and less than `86400`, in `15` minute intervals
:param pulumi.Input[str] version_profile_id: ID of the version profile. To learn more, see Version Profile Use Cases. Supported values are:
:param pulumi.Input[str] version_profile_name: ID of the version profile.
:param pulumi.Input[str] version_profile_visibility_scope: ID of the version profile.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ServiceEdgeGroupState.__new__(_ServiceEdgeGroupState)
__props__.__dict__["city_country"] = city_country
__props__.__dict__["country_code"] = country_code
__props__.__dict__["description"] = description
__props__.__dict__["enabled"] = enabled
__props__.__dict__["is_public"] = is_public
__props__.__dict__["latitude"] = latitude
__props__.__dict__["location"] = location
__props__.__dict__["longitude"] = longitude
__props__.__dict__["name"] = name
__props__.__dict__["override_version_profile"] = override_version_profile
__props__.__dict__["service_edges"] = service_edges
__props__.__dict__["trusted_networks"] = trusted_networks
__props__.__dict__["upgrade_day"] = upgrade_day
__props__.__dict__["upgrade_time_in_secs"] = upgrade_time_in_secs
__props__.__dict__["version_profile_id"] = version_profile_id
__props__.__dict__["version_profile_name"] = version_profile_name
__props__.__dict__["version_profile_visibility_scope"] = version_profile_visibility_scope
return ServiceEdgeGroup(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="cityCountry")
def city_country(self) -> pulumi.Output[str]:
"""
This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "city_country")
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> pulumi.Output[str]:
"""
This field is an array of app-connector-id only.
"""
return pulumi.get(self, "country_code")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Description of the Service Edge Group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[Optional[bool]]:
"""
Whether this Service Edge Group is enabled or not. Default value: `true` Supported values: `true`, `false`
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="isPublic")
def is_public(self) -> pulumi.Output[Optional[bool]]:
"""
Enable or disable public access for the Service Edge Group. Default value: `false` Supported values: `true`, `false`
"""
return pulumi.get(self, "is_public")
@property
@pulumi.getter
def latitude(self) -> pulumi.Output[str]:
"""
Latitude for the Service Edge Group. Integer or decimal with values in the range of `-90` to `90`
"""
return pulumi.get(self, "latitude")
@property
@pulumi.getter
def location(self) -> pulumi.Output[str]:
"""
Location for the Service Edge Group.
"""
return pulumi.get(self, "location")
@property
@pulumi.getter
def longitude(self) -> pulumi.Output[str]:
"""
Longitude for the Service Edge Group. Integer or decimal with values in the range of `-180` to `180`
"""
return pulumi.get(self, "longitude")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the Service Edge Group.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="overrideVersionProfile")
def override_version_profile(self) -> pulumi.Output[Optional[bool]]:
"""
Whether the default version profile of the App Connector Group is applied or overridden. Default: `false` Supported values: `true`, `false`
"""
return pulumi.get(self, "override_version_profile")
@property
@pulumi.getter(name="serviceEdges")
def service_edges(self) -> pulumi.Output[Optional[Sequence['outputs.ServiceEdgeGroupServiceEdge']]]:
return pulumi.get(self, "service_edges")
@property
@pulumi.getter(name="trustedNetworks")
def trusted_networks(self) -> pulumi.Output[Optional[Sequence['outputs.ServiceEdgeGroupTrustedNetwork']]]:
"""
Trusted networks for this Service Edge Group. List of trusted network objects
"""
return pulumi.get(self, "trusted_networks")
@property
@pulumi.getter(name="upgradeDay")
def upgrade_day(self) -> pulumi.Output[Optional[str]]:
"""
Service Edges in this group will attempt to update to a newer version of the software during this specified day. Default value: `SUNDAY` List of valid days (i.e., Sunday, Monday)
"""
return pulumi.get(self, "upgrade_day")
@property
@pulumi.getter(name="upgradeTimeInSecs")
def upgrade_time_in_secs(self) -> pulumi.Output[Optional[str]]:
"""
Service Edges in this group will attempt to update to a newer version of the software during this specified time. Default value: `66600` Integer in seconds (i..e, 66600). The integer must be greater than or equal to 0 and less than `86400`, in `15` minute intervals
"""
return pulumi.get(self, "upgrade_time_in_secs")
@property
@pulumi.getter(name="versionProfileId")
def version_profile_id(self) -> pulumi.Output[str]:
"""
ID of the version profile. To learn more, see Version Profile Use Cases. Supported values are:
"""
return pulumi.get(self, "version_profile_id")
@property
@pulumi.getter(name="versionProfileName")
def version_profile_name(self) -> pulumi.Output[str]:
"""
ID of the version profile.
"""
return pulumi.get(self, "version_profile_name")
@property
@pulumi.getter(name="versionProfileVisibilityScope")
def version_profile_visibility_scope(self) -> pulumi.Output[str]:
"""
ID of the version profile.
"""
return pulumi.get(self, "version_profile_visibility_scope") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/serviceedge/service_edge_group.py | service_edge_group.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetIdPControllerAdminMetadataResult',
'GetIdPControllerUserMetadataResult',
]
@pulumi.output_type
class GetIdPControllerAdminMetadataResult(dict):
def __init__(__self__, *,
certificate_url: str,
sp_base_url: str,
sp_entity_id: str,
sp_metadata_url: str,
sp_post_url: str):
"""
:param str certificate_url: (string)
:param str sp_entity_id: (string)
:param str sp_metadata_url: (string)
:param str sp_post_url: (string)
"""
pulumi.set(__self__, "certificate_url", certificate_url)
pulumi.set(__self__, "sp_base_url", sp_base_url)
pulumi.set(__self__, "sp_entity_id", sp_entity_id)
pulumi.set(__self__, "sp_metadata_url", sp_metadata_url)
pulumi.set(__self__, "sp_post_url", sp_post_url)
@property
@pulumi.getter(name="certificateUrl")
def certificate_url(self) -> str:
"""
(string)
"""
return pulumi.get(self, "certificate_url")
@property
@pulumi.getter(name="spBaseUrl")
def sp_base_url(self) -> str:
return pulumi.get(self, "sp_base_url")
@property
@pulumi.getter(name="spEntityId")
def sp_entity_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sp_entity_id")
@property
@pulumi.getter(name="spMetadataUrl")
def sp_metadata_url(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sp_metadata_url")
@property
@pulumi.getter(name="spPostUrl")
def sp_post_url(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sp_post_url")
@pulumi.output_type
class GetIdPControllerUserMetadataResult(dict):
def __init__(__self__, *,
certificate_url: str,
sp_base_url: str,
sp_entity_id: str,
sp_metadata_url: str,
sp_post_url: str):
"""
:param str certificate_url: (string)
:param str sp_entity_id: (string)
:param str sp_metadata_url: (string)
:param str sp_post_url: (string)
"""
pulumi.set(__self__, "certificate_url", certificate_url)
pulumi.set(__self__, "sp_base_url", sp_base_url)
pulumi.set(__self__, "sp_entity_id", sp_entity_id)
pulumi.set(__self__, "sp_metadata_url", sp_metadata_url)
pulumi.set(__self__, "sp_post_url", sp_post_url)
@property
@pulumi.getter(name="certificateUrl")
def certificate_url(self) -> str:
"""
(string)
"""
return pulumi.get(self, "certificate_url")
@property
@pulumi.getter(name="spBaseUrl")
def sp_base_url(self) -> str:
return pulumi.get(self, "sp_base_url")
@property
@pulumi.getter(name="spEntityId")
def sp_entity_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sp_entity_id")
@property
@pulumi.getter(name="spMetadataUrl")
def sp_metadata_url(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sp_metadata_url")
@property
@pulumi.getter(name="spPostUrl")
def sp_post_url(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sp_post_url") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/idpcontroller/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetIdPControllerResult',
'AwaitableGetIdPControllerResult',
'get_id_p_controller',
'get_id_p_controller_output',
]
@pulumi.output_type
class GetIdPControllerResult:
"""
A collection of values returned by getIdPController.
"""
def __init__(__self__, admin_metadatas=None, admin_sp_signing_cert_id=None, auto_provision=None, creation_time=None, description=None, disable_saml_based_policy=None, domain_lists=None, enable_scim_based_policy=None, enabled=None, id=None, idp_entity_id=None, login_name_attribute=None, login_url=None, modified_time=None, modifiedby=None, name=None, reauth_on_user_update=None, redirect_binding=None, scim_enabled=None, scim_service_provider_endpoint=None, scim_shared_secret_exists=None, sign_saml_request=None, sso_types=None, use_custom_sp_metadata=None, user_metadatas=None, user_sp_signing_cert_id=None):
if admin_metadatas and not isinstance(admin_metadatas, list):
raise TypeError("Expected argument 'admin_metadatas' to be a list")
pulumi.set(__self__, "admin_metadatas", admin_metadatas)
if admin_sp_signing_cert_id and not isinstance(admin_sp_signing_cert_id, str):
raise TypeError("Expected argument 'admin_sp_signing_cert_id' to be a str")
pulumi.set(__self__, "admin_sp_signing_cert_id", admin_sp_signing_cert_id)
if auto_provision and not isinstance(auto_provision, str):
raise TypeError("Expected argument 'auto_provision' to be a str")
pulumi.set(__self__, "auto_provision", auto_provision)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if disable_saml_based_policy and not isinstance(disable_saml_based_policy, bool):
raise TypeError("Expected argument 'disable_saml_based_policy' to be a bool")
pulumi.set(__self__, "disable_saml_based_policy", disable_saml_based_policy)
if domain_lists and not isinstance(domain_lists, list):
raise TypeError("Expected argument 'domain_lists' to be a list")
pulumi.set(__self__, "domain_lists", domain_lists)
if enable_scim_based_policy and not isinstance(enable_scim_based_policy, bool):
raise TypeError("Expected argument 'enable_scim_based_policy' to be a bool")
pulumi.set(__self__, "enable_scim_based_policy", enable_scim_based_policy)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if idp_entity_id and not isinstance(idp_entity_id, str):
raise TypeError("Expected argument 'idp_entity_id' to be a str")
pulumi.set(__self__, "idp_entity_id", idp_entity_id)
if login_name_attribute and not isinstance(login_name_attribute, str):
raise TypeError("Expected argument 'login_name_attribute' to be a str")
pulumi.set(__self__, "login_name_attribute", login_name_attribute)
if login_url and not isinstance(login_url, str):
raise TypeError("Expected argument 'login_url' to be a str")
pulumi.set(__self__, "login_url", login_url)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if reauth_on_user_update and not isinstance(reauth_on_user_update, bool):
raise TypeError("Expected argument 'reauth_on_user_update' to be a bool")
pulumi.set(__self__, "reauth_on_user_update", reauth_on_user_update)
if redirect_binding and not isinstance(redirect_binding, bool):
raise TypeError("Expected argument 'redirect_binding' to be a bool")
pulumi.set(__self__, "redirect_binding", redirect_binding)
if scim_enabled and not isinstance(scim_enabled, bool):
raise TypeError("Expected argument 'scim_enabled' to be a bool")
pulumi.set(__self__, "scim_enabled", scim_enabled)
if scim_service_provider_endpoint and not isinstance(scim_service_provider_endpoint, str):
raise TypeError("Expected argument 'scim_service_provider_endpoint' to be a str")
pulumi.set(__self__, "scim_service_provider_endpoint", scim_service_provider_endpoint)
if scim_shared_secret_exists and not isinstance(scim_shared_secret_exists, bool):
raise TypeError("Expected argument 'scim_shared_secret_exists' to be a bool")
pulumi.set(__self__, "scim_shared_secret_exists", scim_shared_secret_exists)
if sign_saml_request and not isinstance(sign_saml_request, str):
raise TypeError("Expected argument 'sign_saml_request' to be a str")
pulumi.set(__self__, "sign_saml_request", sign_saml_request)
if sso_types and not isinstance(sso_types, list):
raise TypeError("Expected argument 'sso_types' to be a list")
pulumi.set(__self__, "sso_types", sso_types)
if use_custom_sp_metadata and not isinstance(use_custom_sp_metadata, bool):
raise TypeError("Expected argument 'use_custom_sp_metadata' to be a bool")
pulumi.set(__self__, "use_custom_sp_metadata", use_custom_sp_metadata)
if user_metadatas and not isinstance(user_metadatas, list):
raise TypeError("Expected argument 'user_metadatas' to be a list")
pulumi.set(__self__, "user_metadatas", user_metadatas)
if user_sp_signing_cert_id and not isinstance(user_sp_signing_cert_id, str):
raise TypeError("Expected argument 'user_sp_signing_cert_id' to be a str")
pulumi.set(__self__, "user_sp_signing_cert_id", user_sp_signing_cert_id)
@property
@pulumi.getter(name="adminMetadatas")
def admin_metadatas(self) -> Sequence['outputs.GetIdPControllerAdminMetadataResult']:
"""
(Computed)
"""
return pulumi.get(self, "admin_metadatas")
@property
@pulumi.getter(name="adminSpSigningCertId")
def admin_sp_signing_cert_id(self) -> str:
return pulumi.get(self, "admin_sp_signing_cert_id")
@property
@pulumi.getter(name="autoProvision")
def auto_provision(self) -> str:
"""
(string)
"""
return pulumi.get(self, "auto_provision")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="disableSamlBasedPolicy")
def disable_saml_based_policy(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "disable_saml_based_policy")
@property
@pulumi.getter(name="domainLists")
def domain_lists(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "domain_lists")
@property
@pulumi.getter(name="enableScimBasedPolicy")
def enable_scim_based_policy(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enable_scim_based_policy")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) Default value if null is True
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> str:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpEntityId")
def idp_entity_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "idp_entity_id")
@property
@pulumi.getter(name="loginNameAttribute")
def login_name_attribute(self) -> str:
"""
(string)
"""
return pulumi.get(self, "login_name_attribute")
@property
@pulumi.getter(name="loginUrl")
def login_url(self) -> str:
"""
(string)
"""
return pulumi.get(self, "login_url")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="reauthOnUserUpdate")
def reauth_on_user_update(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "reauth_on_user_update")
@property
@pulumi.getter(name="redirectBinding")
def redirect_binding(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "redirect_binding")
@property
@pulumi.getter(name="scimEnabled")
def scim_enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "scim_enabled")
@property
@pulumi.getter(name="scimServiceProviderEndpoint")
def scim_service_provider_endpoint(self) -> str:
"""
(string)
"""
return pulumi.get(self, "scim_service_provider_endpoint")
@property
@pulumi.getter(name="scimSharedSecretExists")
def scim_shared_secret_exists(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "scim_shared_secret_exists")
@property
@pulumi.getter(name="signSamlRequest")
def sign_saml_request(self) -> str:
"""
(string)
"""
return pulumi.get(self, "sign_saml_request")
@property
@pulumi.getter(name="ssoTypes")
def sso_types(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "sso_types")
@property
@pulumi.getter(name="useCustomSpMetadata")
def use_custom_sp_metadata(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "use_custom_sp_metadata")
@property
@pulumi.getter(name="userMetadatas")
def user_metadatas(self) -> Sequence['outputs.GetIdPControllerUserMetadataResult']:
"""
(Computed)
"""
return pulumi.get(self, "user_metadatas")
@property
@pulumi.getter(name="userSpSigningCertId")
def user_sp_signing_cert_id(self) -> str:
return pulumi.get(self, "user_sp_signing_cert_id")
class AwaitableGetIdPControllerResult(GetIdPControllerResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetIdPControllerResult(
admin_metadatas=self.admin_metadatas,
admin_sp_signing_cert_id=self.admin_sp_signing_cert_id,
auto_provision=self.auto_provision,
creation_time=self.creation_time,
description=self.description,
disable_saml_based_policy=self.disable_saml_based_policy,
domain_lists=self.domain_lists,
enable_scim_based_policy=self.enable_scim_based_policy,
enabled=self.enabled,
id=self.id,
idp_entity_id=self.idp_entity_id,
login_name_attribute=self.login_name_attribute,
login_url=self.login_url,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
reauth_on_user_update=self.reauth_on_user_update,
redirect_binding=self.redirect_binding,
scim_enabled=self.scim_enabled,
scim_service_provider_endpoint=self.scim_service_provider_endpoint,
scim_shared_secret_exists=self.scim_shared_secret_exists,
sign_saml_request=self.sign_saml_request,
sso_types=self.sso_types,
use_custom_sp_metadata=self.use_custom_sp_metadata,
user_metadatas=self.user_metadatas,
user_sp_signing_cert_id=self.user_sp_signing_cert_id)
def get_id_p_controller(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetIdPControllerResult:
"""
Use the **zpa_idp_controller** data source to get information about an Identity Provider created in the Zscaler Private Access cloud. This data source is required when creating:
1. Access policy Rules
2. Access policy timeout rules
3. Access policy forwarding rules
4. Access policy inspection rules
5. Access policy isolation rules
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.idpController.get_id_p_controller(name="idp_name")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.idpController.get_id_p_controller(id="1234567890")
```
:param str id: The name of the Identity Provider (IdP) to be exported.
:param str name: The name of the Identity Provider (IdP) to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:idpController/getIdPController:getIdPController', __args__, opts=opts, typ=GetIdPControllerResult).value
return AwaitableGetIdPControllerResult(
admin_metadatas=__ret__.admin_metadatas,
admin_sp_signing_cert_id=__ret__.admin_sp_signing_cert_id,
auto_provision=__ret__.auto_provision,
creation_time=__ret__.creation_time,
description=__ret__.description,
disable_saml_based_policy=__ret__.disable_saml_based_policy,
domain_lists=__ret__.domain_lists,
enable_scim_based_policy=__ret__.enable_scim_based_policy,
enabled=__ret__.enabled,
id=__ret__.id,
idp_entity_id=__ret__.idp_entity_id,
login_name_attribute=__ret__.login_name_attribute,
login_url=__ret__.login_url,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
reauth_on_user_update=__ret__.reauth_on_user_update,
redirect_binding=__ret__.redirect_binding,
scim_enabled=__ret__.scim_enabled,
scim_service_provider_endpoint=__ret__.scim_service_provider_endpoint,
scim_shared_secret_exists=__ret__.scim_shared_secret_exists,
sign_saml_request=__ret__.sign_saml_request,
sso_types=__ret__.sso_types,
use_custom_sp_metadata=__ret__.use_custom_sp_metadata,
user_metadatas=__ret__.user_metadatas,
user_sp_signing_cert_id=__ret__.user_sp_signing_cert_id)
@_utilities.lift_output_func(get_id_p_controller)
def get_id_p_controller_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetIdPControllerResult]:
"""
Use the **zpa_idp_controller** data source to get information about an Identity Provider created in the Zscaler Private Access cloud. This data source is required when creating:
1. Access policy Rules
2. Access policy timeout rules
3. Access policy forwarding rules
4. Access policy inspection rules
5. Access policy isolation rules
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.idpController.get_id_p_controller(name="idp_name")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.idpController.get_id_p_controller(id="1234567890")
```
:param str id: The name of the Identity Provider (IdP) to be exported.
:param str name: The name of the Identity Provider (IdP) to be exported.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/idpcontroller/get_id_p_controller.py | get_id_p_controller.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = [
'GetApplicationSegmentBrowserAccessResult',
'AwaitableGetApplicationSegmentBrowserAccessResult',
'get_application_segment_browser_access',
'get_application_segment_browser_access_output',
]
@pulumi.output_type
class GetApplicationSegmentBrowserAccessResult:
"""
A collection of values returned by getApplicationSegmentBrowserAccess.
"""
def __init__(__self__, bypass_type=None, clientless_apps=None, config_space=None, description=None, domain_names=None, double_encrypt=None, enabled=None, health_check_type=None, health_reporting=None, id=None, ip_anchored=None, is_cname_enabled=None, name=None, passive_health_enabled=None, segment_group_id=None, segment_group_name=None, server_groups=None, tcp_port_ranges=None, udp_port_ranges=None):
if bypass_type and not isinstance(bypass_type, str):
raise TypeError("Expected argument 'bypass_type' to be a str")
pulumi.set(__self__, "bypass_type", bypass_type)
if clientless_apps and not isinstance(clientless_apps, list):
raise TypeError("Expected argument 'clientless_apps' to be a list")
pulumi.set(__self__, "clientless_apps", clientless_apps)
if config_space and not isinstance(config_space, str):
raise TypeError("Expected argument 'config_space' to be a str")
pulumi.set(__self__, "config_space", config_space)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if domain_names and not isinstance(domain_names, list):
raise TypeError("Expected argument 'domain_names' to be a list")
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt and not isinstance(double_encrypt, bool):
raise TypeError("Expected argument 'double_encrypt' to be a bool")
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if health_check_type and not isinstance(health_check_type, str):
raise TypeError("Expected argument 'health_check_type' to be a str")
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting and not isinstance(health_reporting, str):
raise TypeError("Expected argument 'health_reporting' to be a str")
pulumi.set(__self__, "health_reporting", health_reporting)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if ip_anchored and not isinstance(ip_anchored, bool):
raise TypeError("Expected argument 'ip_anchored' to be a bool")
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled and not isinstance(is_cname_enabled, bool):
raise TypeError("Expected argument 'is_cname_enabled' to be a bool")
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if passive_health_enabled and not isinstance(passive_health_enabled, bool):
raise TypeError("Expected argument 'passive_health_enabled' to be a bool")
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id and not isinstance(segment_group_id, str):
raise TypeError("Expected argument 'segment_group_id' to be a str")
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name and not isinstance(segment_group_name, str):
raise TypeError("Expected argument 'segment_group_name' to be a str")
pulumi.set(__self__, "segment_group_name", segment_group_name)
if server_groups and not isinstance(server_groups, list):
raise TypeError("Expected argument 'server_groups' to be a list")
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges and not isinstance(tcp_port_ranges, list):
raise TypeError("Expected argument 'tcp_port_ranges' to be a list")
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges and not isinstance(udp_port_ranges, list):
raise TypeError("Expected argument 'udp_port_ranges' to be a list")
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> str:
"""
(string) Indicates whether users can bypass ZPA to access applications. Default: `NEVER`. Supported values: `ALWAYS`, `NEVER`, `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="clientlessApps")
def clientless_apps(self) -> Sequence['outputs.GetApplicationSegmentBrowserAccessClientlessAppResult']:
return pulumi.get(self, "clientless_apps")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Sequence[str]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> bool:
"""
(string) Whether Double Encryption is enabled or disabled for the app. Default: false. Boolean: `true`, `false`.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> str:
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> str:
"""
(string)
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> bool:
"""
(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors. Default: true. Boolean: `true`, `false`.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
(string)
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Sequence['outputs.GetApplicationSegmentBrowserAccessServerGroupResult']:
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Sequence[str]:
"""
(string) TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Sequence[str]:
"""
(string) UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
class AwaitableGetApplicationSegmentBrowserAccessResult(GetApplicationSegmentBrowserAccessResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetApplicationSegmentBrowserAccessResult(
bypass_type=self.bypass_type,
clientless_apps=self.clientless_apps,
config_space=self.config_space,
description=self.description,
domain_names=self.domain_names,
double_encrypt=self.double_encrypt,
enabled=self.enabled,
health_check_type=self.health_check_type,
health_reporting=self.health_reporting,
id=self.id,
ip_anchored=self.ip_anchored,
is_cname_enabled=self.is_cname_enabled,
name=self.name,
passive_health_enabled=self.passive_health_enabled,
segment_group_id=self.segment_group_id,
segment_group_name=self.segment_group_name,
server_groups=self.server_groups,
tcp_port_ranges=self.tcp_port_ranges,
udp_port_ranges=self.udp_port_ranges)
def get_application_segment_browser_access(id: Optional[str] = None,
name: Optional[str] = None,
tcp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessTcpPortRangeArgs']]] = None,
udp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessUdpPortRangeArgs']]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetApplicationSegmentBrowserAccessResult:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationSegment.get_application_segment_browser_access(name="example")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationSegment.get_application_segment_browser_access(id="123456789")
```
:param str id: This field defines the id of the application server.
:param str name: This field defines the name of the server.
:param Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessTcpPortRangeArgs']] tcp_port_ranges: (string) TCP port ranges used to access the app.
* `from:`
* `to:`
:param Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessUdpPortRangeArgs']] udp_port_ranges: (string) UDP port ranges used to access the app.
* `from:`
* `to:`
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
__args__['tcpPortRanges'] = tcp_port_ranges
__args__['udpPortRanges'] = udp_port_ranges
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ApplicationSegment/getApplicationSegmentBrowserAccess:getApplicationSegmentBrowserAccess', __args__, opts=opts, typ=GetApplicationSegmentBrowserAccessResult).value
return AwaitableGetApplicationSegmentBrowserAccessResult(
bypass_type=__ret__.bypass_type,
clientless_apps=__ret__.clientless_apps,
config_space=__ret__.config_space,
description=__ret__.description,
domain_names=__ret__.domain_names,
double_encrypt=__ret__.double_encrypt,
enabled=__ret__.enabled,
health_check_type=__ret__.health_check_type,
health_reporting=__ret__.health_reporting,
id=__ret__.id,
ip_anchored=__ret__.ip_anchored,
is_cname_enabled=__ret__.is_cname_enabled,
name=__ret__.name,
passive_health_enabled=__ret__.passive_health_enabled,
segment_group_id=__ret__.segment_group_id,
segment_group_name=__ret__.segment_group_name,
server_groups=__ret__.server_groups,
tcp_port_ranges=__ret__.tcp_port_ranges,
udp_port_ranges=__ret__.udp_port_ranges)
@_utilities.lift_output_func(get_application_segment_browser_access)
def get_application_segment_browser_access_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessTcpPortRangeArgs']]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessUdpPortRangeArgs']]]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetApplicationSegmentBrowserAccessResult]:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationSegment.get_application_segment_browser_access(name="example")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationSegment.get_application_segment_browser_access(id="123456789")
```
:param str id: This field defines the id of the application server.
:param str name: This field defines the name of the server.
:param Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessTcpPortRangeArgs']] tcp_port_ranges: (string) TCP port ranges used to access the app.
* `from:`
* `to:`
:param Sequence[pulumi.InputType['GetApplicationSegmentBrowserAccessUdpPortRangeArgs']] udp_port_ranges: (string) UDP port ranges used to access the app.
* `from:`
* `to:`
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/get_application_segment_browser_access.py | get_application_segment_browser_access.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'ApplicationSegmentBrowserAccessClientlessAppArgs',
'ApplicationSegmentBrowserAccessServerGroupArgs',
'ApplicationSegmentInspectionCommonAppsDtoArgs',
'ApplicationSegmentInspectionCommonAppsDtoAppsConfigArgs',
'ApplicationSegmentInspectionServerGroupArgs',
'ApplicationSegmentPRACommonAppsDtoArgs',
'ApplicationSegmentPRACommonAppsDtoAppsConfigArgs',
'ApplicationSegmentPRAServerGroupArgs',
'ApplicationSegmentServerGroupArgs',
'BrowserAccessClientlessAppArgs',
'BrowserAccessServerGroupArgs',
'GetApplicationSegmentBrowserAccessTcpPortRangeArgs',
'GetApplicationSegmentBrowserAccessUdpPortRangeArgs',
'GetApplicationSegmentInspectionTcpPortRangeArgs',
'GetApplicationSegmentInspectionUdpPortRangeArgs',
'GetApplicationSegmentPRATcpPortRangeArgs',
'GetApplicationSegmentPRAUdpPortRangeArgs',
'GetApplicationSegmentTcpPortRangeArgs',
'GetApplicationSegmentUdpPortRangeArgs',
]
@pulumi.input_type
class ApplicationSegmentBrowserAccessClientlessAppArgs:
def __init__(__self__, *,
application_port: pulumi.Input[str],
application_protocol: pulumi.Input[str],
certificate_id: pulumi.Input[str],
name: pulumi.Input[str],
allow_options: Optional[pulumi.Input[bool]] = None,
cname: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
hidden: Optional[pulumi.Input[bool]] = None,
id: Optional[pulumi.Input[str]] = None,
local_domain: Optional[pulumi.Input[str]] = None,
path: Optional[pulumi.Input[str]] = None,
trust_untrusted_cert: Optional[pulumi.Input[bool]] = None):
"""
:param pulumi.Input[str] application_port: Port for the BA app.
:param pulumi.Input[str] application_protocol: Protocol for the BA app. Supported values: `HTTP` and `HTTPS`
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[bool] allow_options: If you want ZPA to forward unauthenticated HTTP preflight OPTIONS requests from the browser to the app.. Supported values: `true` and `false`
:param pulumi.Input[str] cname: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[str] domain: Domain name or IP address of the BA app.
:param pulumi.Input[bool] enabled: (Optional) - Whether this app is enabled or not.
:param pulumi.Input[bool] hidden: (Optional)
:param pulumi.Input[str] local_domain: (Optional)
:param pulumi.Input[str] path: (Optional)
:param pulumi.Input[bool] trust_untrusted_cert: (Optional)
"""
pulumi.set(__self__, "application_port", application_port)
pulumi.set(__self__, "application_protocol", application_protocol)
pulumi.set(__self__, "certificate_id", certificate_id)
pulumi.set(__self__, "name", name)
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if path is not None:
pulumi.set(__self__, "path", path)
if trust_untrusted_cert is not None:
pulumi.set(__self__, "trust_untrusted_cert", trust_untrusted_cert)
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> pulumi.Input[str]:
"""
Port for the BA app.
"""
return pulumi.get(self, "application_port")
@application_port.setter
def application_port(self, value: pulumi.Input[str]):
pulumi.set(self, "application_port", value)
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> pulumi.Input[str]:
"""
Protocol for the BA app. Supported values: `HTTP` and `HTTPS`
"""
return pulumi.get(self, "application_protocol")
@application_protocol.setter
def application_protocol(self, value: pulumi.Input[str]):
pulumi.set(self, "application_protocol", value)
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> pulumi.Input[str]:
return pulumi.get(self, "certificate_id")
@certificate_id.setter
def certificate_id(self, value: pulumi.Input[str]):
pulumi.set(self, "certificate_id", value)
@property
@pulumi.getter
def name(self) -> pulumi.Input[str]:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: pulumi.Input[str]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[pulumi.Input[bool]]:
"""
If you want ZPA to forward unauthenticated HTTP preflight OPTIONS requests from the browser to the app.. Supported values: `true` and `false`
"""
return pulumi.get(self, "allow_options")
@allow_options.setter
def allow_options(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "allow_options", value)
@property
@pulumi.getter
def cname(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "cname")
@cname.setter
def cname(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "cname", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def domain(self) -> Optional[pulumi.Input[str]]:
"""
Domain name or IP address of the BA app.
"""
return pulumi.get(self, "domain")
@domain.setter
def domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "domain", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) - Whether this app is enabled or not.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def hidden(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "hidden")
@hidden.setter
def hidden(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "hidden", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "local_domain")
@local_domain.setter
def local_domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "local_domain", value)
@property
@pulumi.getter
def path(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "path")
@path.setter
def path(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "path", value)
@property
@pulumi.getter(name="trustUntrustedCert")
def trust_untrusted_cert(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "trust_untrusted_cert")
@trust_untrusted_cert.setter
def trust_untrusted_cert(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "trust_untrusted_cert", value)
@pulumi.input_type
class ApplicationSegmentBrowserAccessServerGroupArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class ApplicationSegmentInspectionCommonAppsDtoArgs:
def __init__(__self__, *,
apps_configs: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoAppsConfigArgs']]]] = None):
if apps_configs is not None:
pulumi.set(__self__, "apps_configs", apps_configs)
@property
@pulumi.getter(name="appsConfigs")
def apps_configs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoAppsConfigArgs']]]]:
return pulumi.get(self, "apps_configs")
@apps_configs.setter
def apps_configs(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoAppsConfigArgs']]]]):
pulumi.set(self, "apps_configs", value)
@pulumi.input_type
class ApplicationSegmentInspectionCommonAppsDtoAppsConfigArgs:
def __init__(__self__, *,
allow_options: Optional[pulumi.Input[bool]] = None,
app_id: Optional[pulumi.Input[str]] = None,
app_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
application_port: Optional[pulumi.Input[str]] = None,
application_protocol: Optional[pulumi.Input[str]] = None,
certificate_id: Optional[pulumi.Input[str]] = None,
certificate_name: Optional[pulumi.Input[str]] = None,
cname: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
hidden: Optional[pulumi.Input[bool]] = None,
id: Optional[pulumi.Input[str]] = None,
local_domain: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
portal: Optional[pulumi.Input[bool]] = None,
trust_untrusted_cert: Optional[pulumi.Input[bool]] = None):
"""
:param pulumi.Input[Sequence[pulumi.Input[str]]] app_types: Indicates the type of application as inspection. Supported value: `INSPECT`
:param pulumi.Input[str] application_port: Port for the Inspection Application Segment.
:param pulumi.Input[str] application_protocol: Protocol for the Inspection Application Segment.. Supported values: `HTTP` and `HTTPS`
:param pulumi.Input[str] certificate_id: ID of the signing certificate. This field is required if the applicationProtocol is set to `HTTPS`. The certificateId is not supported if the applicationProtocol is set to `HTTP`.
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[str] domain: Domain name of the Inspection Application Segment.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] name: Name of the Inspection Application Segment.
"""
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if app_id is not None:
pulumi.set(__self__, "app_id", app_id)
if app_types is not None:
pulumi.set(__self__, "app_types", app_types)
if application_port is not None:
pulumi.set(__self__, "application_port", application_port)
if application_protocol is not None:
pulumi.set(__self__, "application_protocol", application_protocol)
if certificate_id is not None:
pulumi.set(__self__, "certificate_id", certificate_id)
if certificate_name is not None:
pulumi.set(__self__, "certificate_name", certificate_name)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if name is not None:
pulumi.set(__self__, "name", name)
if portal is not None:
pulumi.set(__self__, "portal", portal)
if trust_untrusted_cert is not None:
pulumi.set(__self__, "trust_untrusted_cert", trust_untrusted_cert)
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "allow_options")
@allow_options.setter
def allow_options(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "allow_options", value)
@property
@pulumi.getter(name="appId")
def app_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "app_id")
@app_id.setter
def app_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "app_id", value)
@property
@pulumi.getter(name="appTypes")
def app_types(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Indicates the type of application as inspection. Supported value: `INSPECT`
"""
return pulumi.get(self, "app_types")
@app_types.setter
def app_types(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "app_types", value)
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> Optional[pulumi.Input[str]]:
"""
Port for the Inspection Application Segment.
"""
return pulumi.get(self, "application_port")
@application_port.setter
def application_port(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "application_port", value)
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> Optional[pulumi.Input[str]]:
"""
Protocol for the Inspection Application Segment.. Supported values: `HTTP` and `HTTPS`
"""
return pulumi.get(self, "application_protocol")
@application_protocol.setter
def application_protocol(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "application_protocol", value)
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> Optional[pulumi.Input[str]]:
"""
ID of the signing certificate. This field is required if the applicationProtocol is set to `HTTPS`. The certificateId is not supported if the applicationProtocol is set to `HTTP`.
"""
return pulumi.get(self, "certificate_id")
@certificate_id.setter
def certificate_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "certificate_id", value)
@property
@pulumi.getter(name="certificateName")
def certificate_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "certificate_name")
@certificate_name.setter
def certificate_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "certificate_name", value)
@property
@pulumi.getter
def cname(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "cname")
@cname.setter
def cname(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "cname", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def domain(self) -> Optional[pulumi.Input[str]]:
"""
Domain name of the Inspection Application Segment.
"""
return pulumi.get(self, "domain")
@domain.setter
def domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "domain", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def hidden(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "hidden")
@hidden.setter
def hidden(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "hidden", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "local_domain")
@local_domain.setter
def local_domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "local_domain", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Inspection Application Segment.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def portal(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "portal")
@portal.setter
def portal(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "portal", value)
@property
@pulumi.getter(name="trustUntrustedCert")
def trust_untrusted_cert(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "trust_untrusted_cert")
@trust_untrusted_cert.setter
def trust_untrusted_cert(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "trust_untrusted_cert", value)
@pulumi.input_type
class ApplicationSegmentInspectionServerGroupArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class ApplicationSegmentPRACommonAppsDtoArgs:
def __init__(__self__, *,
apps_configs: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRACommonAppsDtoAppsConfigArgs']]]] = None):
if apps_configs is not None:
pulumi.set(__self__, "apps_configs", apps_configs)
@property
@pulumi.getter(name="appsConfigs")
def apps_configs(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRACommonAppsDtoAppsConfigArgs']]]]:
return pulumi.get(self, "apps_configs")
@apps_configs.setter
def apps_configs(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRACommonAppsDtoAppsConfigArgs']]]]):
pulumi.set(self, "apps_configs", value)
@pulumi.input_type
class ApplicationSegmentPRACommonAppsDtoAppsConfigArgs:
def __init__(__self__, *,
allow_options: Optional[pulumi.Input[bool]] = None,
app_id: Optional[pulumi.Input[str]] = None,
app_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
application_port: Optional[pulumi.Input[str]] = None,
application_protocol: Optional[pulumi.Input[str]] = None,
cname: Optional[pulumi.Input[str]] = None,
connection_security: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
hidden: Optional[pulumi.Input[bool]] = None,
id: Optional[pulumi.Input[str]] = None,
local_domain: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
portal: Optional[pulumi.Input[bool]] = None):
"""
:param pulumi.Input[Sequence[pulumi.Input[str]]] app_types: Indicates the type of application as Privileged Remote Access. Supported value: `SECURE_REMOTE_ACCESS`
:param pulumi.Input[str] application_port: Port for the Privileged Remote Access
:param pulumi.Input[str] application_protocol: Protocol for the Privileged Remote Access. Supported values: `RDP` and `SSH`
:param pulumi.Input[str] connection_security: Parameter required when `application_protocol` is of type `RDP`
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[str] domain: Domain name of the Privileged Remote Access
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] name: Name of the Privileged Remote Access
"""
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if app_id is not None:
pulumi.set(__self__, "app_id", app_id)
if app_types is not None:
pulumi.set(__self__, "app_types", app_types)
if application_port is not None:
pulumi.set(__self__, "application_port", application_port)
if application_protocol is not None:
pulumi.set(__self__, "application_protocol", application_protocol)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if connection_security is not None:
pulumi.set(__self__, "connection_security", connection_security)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if name is not None:
pulumi.set(__self__, "name", name)
if portal is not None:
pulumi.set(__self__, "portal", portal)
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "allow_options")
@allow_options.setter
def allow_options(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "allow_options", value)
@property
@pulumi.getter(name="appId")
def app_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "app_id")
@app_id.setter
def app_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "app_id", value)
@property
@pulumi.getter(name="appTypes")
def app_types(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
Indicates the type of application as Privileged Remote Access. Supported value: `SECURE_REMOTE_ACCESS`
"""
return pulumi.get(self, "app_types")
@app_types.setter
def app_types(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "app_types", value)
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> Optional[pulumi.Input[str]]:
"""
Port for the Privileged Remote Access
"""
return pulumi.get(self, "application_port")
@application_port.setter
def application_port(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "application_port", value)
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> Optional[pulumi.Input[str]]:
"""
Protocol for the Privileged Remote Access. Supported values: `RDP` and `SSH`
"""
return pulumi.get(self, "application_protocol")
@application_protocol.setter
def application_protocol(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "application_protocol", value)
@property
@pulumi.getter
def cname(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "cname")
@cname.setter
def cname(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "cname", value)
@property
@pulumi.getter(name="connectionSecurity")
def connection_security(self) -> Optional[pulumi.Input[str]]:
"""
Parameter required when `application_protocol` is of type `RDP`
"""
return pulumi.get(self, "connection_security")
@connection_security.setter
def connection_security(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "connection_security", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def domain(self) -> Optional[pulumi.Input[str]]:
"""
Domain name of the Privileged Remote Access
"""
return pulumi.get(self, "domain")
@domain.setter
def domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "domain", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def hidden(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "hidden")
@hidden.setter
def hidden(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "hidden", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "local_domain")
@local_domain.setter
def local_domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "local_domain", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Privileged Remote Access
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def portal(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "portal")
@portal.setter
def portal(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "portal", value)
@pulumi.input_type
class ApplicationSegmentPRAServerGroupArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class ApplicationSegmentServerGroupArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class BrowserAccessClientlessAppArgs:
def __init__(__self__, *,
application_port: pulumi.Input[str],
application_protocol: pulumi.Input[str],
certificate_id: pulumi.Input[str],
name: pulumi.Input[str],
allow_options: Optional[pulumi.Input[bool]] = None,
cname: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
hidden: Optional[pulumi.Input[bool]] = None,
id: Optional[pulumi.Input[str]] = None,
local_domain: Optional[pulumi.Input[str]] = None,
path: Optional[pulumi.Input[str]] = None,
trust_untrusted_cert: Optional[pulumi.Input[bool]] = None):
pulumi.set(__self__, "application_port", application_port)
pulumi.set(__self__, "application_protocol", application_protocol)
pulumi.set(__self__, "certificate_id", certificate_id)
pulumi.set(__self__, "name", name)
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if path is not None:
pulumi.set(__self__, "path", path)
if trust_untrusted_cert is not None:
pulumi.set(__self__, "trust_untrusted_cert", trust_untrusted_cert)
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> pulumi.Input[str]:
return pulumi.get(self, "application_port")
@application_port.setter
def application_port(self, value: pulumi.Input[str]):
pulumi.set(self, "application_port", value)
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> pulumi.Input[str]:
return pulumi.get(self, "application_protocol")
@application_protocol.setter
def application_protocol(self, value: pulumi.Input[str]):
pulumi.set(self, "application_protocol", value)
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> pulumi.Input[str]:
return pulumi.get(self, "certificate_id")
@certificate_id.setter
def certificate_id(self, value: pulumi.Input[str]):
pulumi.set(self, "certificate_id", value)
@property
@pulumi.getter
def name(self) -> pulumi.Input[str]:
return pulumi.get(self, "name")
@name.setter
def name(self, value: pulumi.Input[str]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "allow_options")
@allow_options.setter
def allow_options(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "allow_options", value)
@property
@pulumi.getter
def cname(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "cname")
@cname.setter
def cname(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "cname", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def domain(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "domain")
@domain.setter
def domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "domain", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def hidden(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "hidden")
@hidden.setter
def hidden(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "hidden", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "local_domain")
@local_domain.setter
def local_domain(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "local_domain", value)
@property
@pulumi.getter
def path(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "path")
@path.setter
def path(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "path", value)
@property
@pulumi.getter(name="trustUntrustedCert")
def trust_untrusted_cert(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "trust_untrusted_cert")
@trust_untrusted_cert.setter
def trust_untrusted_cert(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "trust_untrusted_cert", value)
@pulumi.input_type
class BrowserAccessServerGroupArgs:
def __init__(__self__, *,
ids: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class GetApplicationSegmentBrowserAccessTcpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value)
@pulumi.input_type
class GetApplicationSegmentBrowserAccessUdpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value)
@pulumi.input_type
class GetApplicationSegmentInspectionTcpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value)
@pulumi.input_type
class GetApplicationSegmentInspectionUdpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value)
@pulumi.input_type
class GetApplicationSegmentPRATcpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value)
@pulumi.input_type
class GetApplicationSegmentPRAUdpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value)
@pulumi.input_type
class GetApplicationSegmentTcpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value)
@pulumi.input_type
class GetApplicationSegmentUdpPortRangeArgs:
def __init__(__self__, *,
from_: Optional[str] = None,
to: Optional[str] = None):
if from_ is not None:
pulumi.set(__self__, "from_", from_)
if to is not None:
pulumi.set(__self__, "to", to)
@property
@pulumi.getter(name="from")
def from_(self) -> Optional[str]:
return pulumi.get(self, "from_")
@from_.setter
def from_(self, value: Optional[str]):
pulumi.set(self, "from_", value)
@property
@pulumi.getter
def to(self) -> Optional[str]:
return pulumi.get(self, "to")
@to.setter
def to(self, value: Optional[str]):
pulumi.set(self, "to", value) | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['ApplicationSegmentPRAArgs', 'ApplicationSegmentPRA']
@pulumi.input_type
class ApplicationSegmentPRAArgs:
def __init__(__self__, *,
segment_group_id: pulumi.Input[str],
server_groups: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]],
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs']] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
The set of arguments for constructing a ApplicationSegmentPRA resource.
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs'] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Privileged Remote Access
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
pulumi.set(__self__, "segment_group_id", segment_group_id)
pulumi.set(__self__, "server_groups", server_groups)
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if common_apps_dto is not None:
pulumi.set(__self__, "common_apps_dto", common_apps_dto)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if domain_names is not None:
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Input[str]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: pulumi.Input[str]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="commonAppsDto")
def common_apps_dto(self) -> Optional[pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs']]:
"""
List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
"""
return pulumi.get(self, "common_apps_dto")
@common_apps_dto.setter
def common_apps_dto(self, value: Optional[pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs']]):
pulumi.set(self, "common_apps_dto", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Privileged Remote Access
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
@pulumi.input_type
class _ApplicationSegmentPRAState:
def __init__(__self__, *,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs']] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
Input properties used for looking up and filtering ApplicationSegmentPRA resources.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs'] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Privileged Remote Access
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if common_apps_dto is not None:
pulumi.set(__self__, "common_apps_dto", common_apps_dto)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if domain_names is not None:
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id is not None:
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if server_groups is not None:
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="commonAppsDto")
def common_apps_dto(self) -> Optional[pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs']]:
"""
List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
"""
return pulumi.get(self, "common_apps_dto")
@common_apps_dto.setter
def common_apps_dto(self, value: Optional[pulumi.Input['ApplicationSegmentPRACommonAppsDtoArgs']]):
pulumi.set(self, "common_apps_dto", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Privileged Remote Access
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> Optional[pulumi.Input[str]]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentPRAServerGroupArgs']]]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
class ApplicationSegmentPRA(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input[pulumi.InputType['ApplicationSegmentPRACommonAppsDtoArgs']]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentPRAServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
"""
The **zpa_application_segment_pra** resource creates an application segment for Privileged Remote Access in the Zscaler Private Access cloud. This resource can then be referenced in an access policy rule, access policy timeout rule, access policy client forwarding rule and inspection policy. This resource supports Privileged Remote Access for both `RDP` and `SSH`.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
this = zpa.application_segment.ApplicationSegmentPRA("this",
description="PRA_Example",
enabled=True,
health_reporting="ON_ACCESS",
bypass_type="NEVER",
is_cname_enabled=True,
tcp_port_ranges=[
"22",
"22",
"3389",
"3389",
],
domain_names=[
"ssh_pra.example.com",
"rdp_pra.example.com",
],
segment_group_id=zpa_segment_group["this"]["id"],
server_groups=[zpa.application_segment.ApplicationSegmentPRAServerGroupArgs(
ids=[zpa_server_group["this"]["id"]],
)],
common_apps_dto=zpa.application_segment.ApplicationSegmentPRACommonAppsDtoArgs(
apps_configs=[
zpa.application_segment.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs(
name="ssh_pra",
domain="ssh_pra.example.com",
application_protocol="SSH",
application_port="22",
enabled=True,
app_types=["SECURE_REMOTE_ACCESS"],
),
zpa.application_segment.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs(
name="rdp_pra",
domain="rdp_pra.example.com",
application_protocol="RDP",
connection_security="ANY",
application_port="3389",
enabled=True,
app_types=["SECURE_REMOTE_ACCESS"],
),
],
))
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Application Segment can be imported by using `<APPLICATION SEGMENT ID>` or `<APPLICATION SEGMENT NAME>` as the import ID.
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentPRA:ApplicationSegmentPRA example <application_segment_id>
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentPRA:ApplicationSegmentPRA example <application_segment_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[pulumi.InputType['ApplicationSegmentPRACommonAppsDtoArgs']] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Privileged Remote Access
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentPRAServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: ApplicationSegmentPRAArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zpa_application_segment_pra** resource creates an application segment for Privileged Remote Access in the Zscaler Private Access cloud. This resource can then be referenced in an access policy rule, access policy timeout rule, access policy client forwarding rule and inspection policy. This resource supports Privileged Remote Access for both `RDP` and `SSH`.
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
this = zpa.application_segment.ApplicationSegmentPRA("this",
description="PRA_Example",
enabled=True,
health_reporting="ON_ACCESS",
bypass_type="NEVER",
is_cname_enabled=True,
tcp_port_ranges=[
"22",
"22",
"3389",
"3389",
],
domain_names=[
"ssh_pra.example.com",
"rdp_pra.example.com",
],
segment_group_id=zpa_segment_group["this"]["id"],
server_groups=[zpa.application_segment.ApplicationSegmentPRAServerGroupArgs(
ids=[zpa_server_group["this"]["id"]],
)],
common_apps_dto=zpa.application_segment.ApplicationSegmentPRACommonAppsDtoArgs(
apps_configs=[
zpa.application_segment.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs(
name="ssh_pra",
domain="ssh_pra.example.com",
application_protocol="SSH",
application_port="22",
enabled=True,
app_types=["SECURE_REMOTE_ACCESS"],
),
zpa.application_segment.ApplicationSegmentPRACommonAppsDtoAppsConfigArgs(
name="rdp_pra",
domain="rdp_pra.example.com",
application_protocol="RDP",
connection_security="ANY",
application_port="3389",
enabled=True,
app_types=["SECURE_REMOTE_ACCESS"],
),
],
))
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Application Segment can be imported by using `<APPLICATION SEGMENT ID>` or `<APPLICATION SEGMENT NAME>` as the import ID.
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentPRA:ApplicationSegmentPRA example <application_segment_id>
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentPRA:ApplicationSegmentPRA example <application_segment_name>
```
:param str resource_name: The name of the resource.
:param ApplicationSegmentPRAArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ApplicationSegmentPRAArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input[pulumi.InputType['ApplicationSegmentPRACommonAppsDtoArgs']]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentPRAServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ApplicationSegmentPRAArgs.__new__(ApplicationSegmentPRAArgs)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["common_apps_dto"] = common_apps_dto
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
if segment_group_id is None and not opts.urn:
raise TypeError("Missing required property 'segment_group_id'")
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
if server_groups is None and not opts.urn:
raise TypeError("Missing required property 'server_groups'")
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
super(ApplicationSegmentPRA, __self__).__init__(
'zpa:ApplicationSegment/applicationSegmentPRA:ApplicationSegmentPRA',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input[pulumi.InputType['ApplicationSegmentPRACommonAppsDtoArgs']]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentPRAServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'ApplicationSegmentPRA':
"""
Get an existing ApplicationSegmentPRA resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[pulumi.InputType['ApplicationSegmentPRACommonAppsDtoArgs']] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Privileged Remote Access
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentPRAServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ApplicationSegmentPRAState.__new__(_ApplicationSegmentPRAState)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["common_apps_dto"] = common_apps_dto
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
return ApplicationSegmentPRA(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> pulumi.Output[str]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="commonAppsDto")
def common_apps_dto(self) -> pulumi.Output['outputs.ApplicationSegmentPRACommonAppsDto']:
"""
List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
"""
return pulumi.get(self, "common_apps_dto")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Output[Sequence[str]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> pulumi.Output[bool]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[bool]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> pulumi.Output[str]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> pulumi.Output[bool]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> pulumi.Output[bool]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the Privileged Remote Access
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> pulumi.Output[bool]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Output[str]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> pulumi.Output[str]:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Output[Sequence['outputs.ApplicationSegmentPRAServerGroup']]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/application_segment_pra.py | application_segment_pra.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['ApplicationSegmentBrowserAccessArgs', 'ApplicationSegmentBrowserAccess']
@pulumi.input_type
class ApplicationSegmentBrowserAccessArgs:
def __init__(__self__, *,
clientless_apps: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessClientlessAppArgs']]],
domain_names: pulumi.Input[Sequence[pulumi.Input[str]]],
segment_group_id: pulumi.Input[str],
server_groups: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]],
bypass_type: Optional[pulumi.Input[str]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
The set of arguments for constructing a ApplicationSegmentBrowserAccess resource.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications. Default value is: `NEVER` and supported values are: `ALWAYS`, `NEVER` and `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
:param pulumi.Input[str] config_space: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `SIEM`
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) - Whether this app is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `NONE`
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[bool] ip_anchored: (Optional) - If Source IP Anchoring for use with ZIA, is enabled or disabled for the app. Supported values are `true` and `false`
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
pulumi.set(__self__, "clientless_apps", clientless_apps)
pulumi.set(__self__, "domain_names", domain_names)
pulumi.set(__self__, "segment_group_id", segment_group_id)
pulumi.set(__self__, "server_groups", server_groups)
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="clientlessApps")
def clientless_apps(self) -> pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessClientlessAppArgs']]]:
return pulumi.get(self, "clientless_apps")
@clientless_apps.setter
def clientless_apps(self, value: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessClientlessAppArgs']]]):
pulumi.set(self, "clientless_apps", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Input[str]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: pulumi.Input[str]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications. Default value is: `NEVER` and supported values are: `ALWAYS`, `NEVER` and `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `SIEM`
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) - Whether this app is enabled or not.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `NONE`
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) - If Source IP Anchoring for use with ZIA, is enabled or disabled for the app. Supported values are `true` and `false`
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
@pulumi.input_type
class _ApplicationSegmentBrowserAccessState:
def __init__(__self__, *,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessClientlessAppArgs']]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
Input properties used for looking up and filtering ApplicationSegmentBrowserAccess resources.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications. Default value is: `NEVER` and supported values are: `ALWAYS`, `NEVER` and `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
:param pulumi.Input[str] config_space: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `SIEM`
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) - Whether this app is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `NONE`
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[bool] ip_anchored: (Optional) - If Source IP Anchoring for use with ZIA, is enabled or disabled for the app. Supported values are `true` and `false`
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if clientless_apps is not None:
pulumi.set(__self__, "clientless_apps", clientless_apps)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if domain_names is not None:
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id is not None:
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if server_groups is not None:
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications. Default value is: `NEVER` and supported values are: `ALWAYS`, `NEVER` and `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="clientlessApps")
def clientless_apps(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessClientlessAppArgs']]]]:
return pulumi.get(self, "clientless_apps")
@clientless_apps.setter
def clientless_apps(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessClientlessAppArgs']]]]):
pulumi.set(self, "clientless_apps", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `SIEM`
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) - Whether this app is enabled or not.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `NONE`
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) - If Source IP Anchoring for use with ZIA, is enabled or disabled for the app. Supported values are `true` and `false`
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> Optional[pulumi.Input[str]]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentBrowserAccessServerGroupArgs']]]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
class ApplicationSegmentBrowserAccess(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessClientlessAppArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
test_cert = zpa.BrowserCertificate.get_ba_certificate(name="sales.acme.com")
# ZPA Segment Group resource
example_segment_group = zpa.segment_group.SegmentGroup("exampleSegmentGroup",
description="Example",
enabled=True)
example_app_connector_group = zpa.AppConnectorGroup.get_app_connector_group(name="AWS-Connector")
# ZPA Server Group resource
example_server_group = zpa.server_group.ServerGroup("exampleServerGroup",
description="Example",
enabled=True,
dynamic_discovery=True,
app_connector_groups=[zpa.server_group.ServerGroupAppConnectorGroupArgs(
ids=[example_app_connector_group.id],
)])
# Create Browser Access Application
browser_access_apps = zpa.application_segment.ApplicationSegmentBrowserAccess("browserAccessApps",
description="Browser Access Apps",
enabled=True,
health_reporting="ON_ACCESS",
bypass_type="NEVER",
tcp_port_ranges=[
"80",
"80",
],
domain_names=["sales.acme.com"],
segment_group_id=example_segment_group.id,
clientless_apps=[zpa.application_segment.ApplicationSegmentBrowserAccessClientlessAppArgs(
name="sales.acme.com",
application_protocol="HTTP",
application_port="80",
certificate_id=test_cert.id,
trust_untrusted_cert=True,
enabled=True,
domain="sales.acme.com",
)],
server_groups=[zpa.application_segment.ApplicationSegmentBrowserAccessServerGroupArgs(
ids=[example_server_group.id],
)])
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) **zpa_application_segment_browser_access** Application Segment Browser Access can be imported by using <`BROWSER ACCESS ID`> or `<<BROWSER ACCESS NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentBrowserAccess:ApplicationSegmentBrowserAccess example <browser_access_id>.
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentBrowserAccess:ApplicationSegmentBrowserAccess example <browser_access_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications. Default value is: `NEVER` and supported values are: `ALWAYS`, `NEVER` and `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
:param pulumi.Input[str] config_space: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `SIEM`
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) - Whether this app is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `NONE`
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[bool] ip_anchored: (Optional) - If Source IP Anchoring for use with ZIA, is enabled or disabled for the app. Supported values are `true` and `false`
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: ApplicationSegmentBrowserAccessArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
test_cert = zpa.BrowserCertificate.get_ba_certificate(name="sales.acme.com")
# ZPA Segment Group resource
example_segment_group = zpa.segment_group.SegmentGroup("exampleSegmentGroup",
description="Example",
enabled=True)
example_app_connector_group = zpa.AppConnectorGroup.get_app_connector_group(name="AWS-Connector")
# ZPA Server Group resource
example_server_group = zpa.server_group.ServerGroup("exampleServerGroup",
description="Example",
enabled=True,
dynamic_discovery=True,
app_connector_groups=[zpa.server_group.ServerGroupAppConnectorGroupArgs(
ids=[example_app_connector_group.id],
)])
# Create Browser Access Application
browser_access_apps = zpa.application_segment.ApplicationSegmentBrowserAccess("browserAccessApps",
description="Browser Access Apps",
enabled=True,
health_reporting="ON_ACCESS",
bypass_type="NEVER",
tcp_port_ranges=[
"80",
"80",
],
domain_names=["sales.acme.com"],
segment_group_id=example_segment_group.id,
clientless_apps=[zpa.application_segment.ApplicationSegmentBrowserAccessClientlessAppArgs(
name="sales.acme.com",
application_protocol="HTTP",
application_port="80",
certificate_id=test_cert.id,
trust_untrusted_cert=True,
enabled=True,
domain="sales.acme.com",
)],
server_groups=[zpa.application_segment.ApplicationSegmentBrowserAccessServerGroupArgs(
ids=[example_server_group.id],
)])
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) **zpa_application_segment_browser_access** Application Segment Browser Access can be imported by using <`BROWSER ACCESS ID`> or `<<BROWSER ACCESS NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentBrowserAccess:ApplicationSegmentBrowserAccess example <browser_access_id>.
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentBrowserAccess:ApplicationSegmentBrowserAccess example <browser_access_name>
```
:param str resource_name: The name of the resource.
:param ApplicationSegmentBrowserAccessArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ApplicationSegmentBrowserAccessArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessClientlessAppArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ApplicationSegmentBrowserAccessArgs.__new__(ApplicationSegmentBrowserAccessArgs)
__props__.__dict__["bypass_type"] = bypass_type
if clientless_apps is None and not opts.urn:
raise TypeError("Missing required property 'clientless_apps'")
__props__.__dict__["clientless_apps"] = clientless_apps
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
if domain_names is None and not opts.urn:
raise TypeError("Missing required property 'domain_names'")
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
if segment_group_id is None and not opts.urn:
raise TypeError("Missing required property 'segment_group_id'")
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
if server_groups is None and not opts.urn:
raise TypeError("Missing required property 'server_groups'")
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
super(ApplicationSegmentBrowserAccess, __self__).__init__(
'zpa:ApplicationSegment/applicationSegmentBrowserAccess:ApplicationSegmentBrowserAccess',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessClientlessAppArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'ApplicationSegmentBrowserAccess':
"""
Get an existing ApplicationSegmentBrowserAccess resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications. Default value is: `NEVER` and supported values are: `ALWAYS`, `NEVER` and `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
:param pulumi.Input[str] config_space: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `SIEM`
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) - Whether this app is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `NONE`
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[bool] ip_anchored: (Optional) - If Source IP Anchoring for use with ZIA, is enabled or disabled for the app. Supported values are `true` and `false`
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentBrowserAccessServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ApplicationSegmentBrowserAccessState.__new__(_ApplicationSegmentBrowserAccessState)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["clientless_apps"] = clientless_apps
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
return ApplicationSegmentBrowserAccess(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications. Default value is: `NEVER` and supported values are: `ALWAYS`, `NEVER` and `ON_NET`. The value `NEVER` indicates the use of the client forwarding policy.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="clientlessApps")
def clientless_apps(self) -> pulumi.Output[Sequence['outputs.ApplicationSegmentBrowserAccessClientlessApp']]:
return pulumi.get(self, "clientless_apps")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `SIEM`
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Output[Sequence[str]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[bool]:
"""
(Optional) - Whether this app is enabled or not.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> pulumi.Output[str]:
"""
(Optional) Default: `DEFAULT`. Supported values: `DEFAULT`, `NONE`
"""
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> pulumi.Output[str]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "icmp_access_type")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) - If Source IP Anchoring for use with ZIA, is enabled or disabled for the app. Supported values are `true` and `false`
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> pulumi.Output[bool]:
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Output[str]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> pulumi.Output[str]:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Output[Sequence['outputs.ApplicationSegmentBrowserAccessServerGroup']]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/application_segment_browser_access.py | application_segment_browser_access.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['BrowserAccessArgs', 'BrowserAccess']
@pulumi.input_type
class BrowserAccessArgs:
def __init__(__self__, *,
clientless_apps: pulumi.Input[Sequence[pulumi.Input['BrowserAccessClientlessAppArgs']]],
domain_names: pulumi.Input[Sequence[pulumi.Input[str]]],
segment_group_id: pulumi.Input[str],
server_groups: pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]],
bypass_type: Optional[pulumi.Input[str]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
The set of arguments for constructing a BrowserAccess resource.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]] server_groups: List of the server group IDs.
:param pulumi.Input[str] bypass_type: Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET.
The value NEVER indicates the use of the client forwarding policy.
:param pulumi.Input[str] description: Description of the application.
:param pulumi.Input[bool] double_encrypt: Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[str] health_reporting: Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[bool] is_cname_enabled: Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the
connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
pulumi.set(__self__, "clientless_apps", clientless_apps)
pulumi.set(__self__, "domain_names", domain_names)
pulumi.set(__self__, "segment_group_id", segment_group_id)
pulumi.set(__self__, "server_groups", server_groups)
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="clientlessApps")
def clientless_apps(self) -> pulumi.Input[Sequence[pulumi.Input['BrowserAccessClientlessAppArgs']]]:
return pulumi.get(self, "clientless_apps")
@clientless_apps.setter
def clientless_apps(self, value: pulumi.Input[Sequence[pulumi.Input['BrowserAccessClientlessAppArgs']]]):
pulumi.set(self, "clientless_apps", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Input[str]:
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: pulumi.Input[str]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]]:
"""
List of the server group IDs.
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET.
The value NEVER indicates the use of the client forwarding policy.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the
connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
@pulumi.input_type
class _BrowserAccessState:
def __init__(__self__, *,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input['BrowserAccessClientlessAppArgs']]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
Input properties used for looking up and filtering BrowserAccess resources.
:param pulumi.Input[str] bypass_type: Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET.
The value NEVER indicates the use of the client forwarding policy.
:param pulumi.Input[str] description: Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[str] health_reporting: Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[bool] is_cname_enabled: Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the
connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]] server_groups: List of the server group IDs.
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if clientless_apps is not None:
pulumi.set(__self__, "clientless_apps", clientless_apps)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if domain_names is not None:
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id is not None:
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if server_groups is not None:
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET.
The value NEVER indicates the use of the client forwarding policy.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="clientlessApps")
def clientless_apps(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['BrowserAccessClientlessAppArgs']]]]:
return pulumi.get(self, "clientless_apps")
@clientless_apps.setter
def clientless_apps(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['BrowserAccessClientlessAppArgs']]]]):
pulumi.set(self, "clientless_apps", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the
connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]]]:
"""
List of the server group IDs.
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['BrowserAccessServerGroupArgs']]]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
class BrowserAccess(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessClientlessAppArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
"""
Create a BrowserAccess resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET.
The value NEVER indicates the use of the client forwarding policy.
:param pulumi.Input[str] description: Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[str] health_reporting: Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[bool] is_cname_enabled: Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the
connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessServerGroupArgs']]]] server_groups: List of the server group IDs.
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: BrowserAccessArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
Create a BrowserAccess resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param BrowserAccessArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(BrowserAccessArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessClientlessAppArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = BrowserAccessArgs.__new__(BrowserAccessArgs)
__props__.__dict__["bypass_type"] = bypass_type
if clientless_apps is None and not opts.urn:
raise TypeError("Missing required property 'clientless_apps'")
__props__.__dict__["clientless_apps"] = clientless_apps
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
if domain_names is None and not opts.urn:
raise TypeError("Missing required property 'domain_names'")
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
if segment_group_id is None and not opts.urn:
raise TypeError("Missing required property 'segment_group_id'")
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
if server_groups is None and not opts.urn:
raise TypeError("Missing required property 'server_groups'")
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
super(BrowserAccess, __self__).__init__(
'zpa:ApplicationSegment/browserAccess:BrowserAccess',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
clientless_apps: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessClientlessAppArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'BrowserAccess':
"""
Get an existing BrowserAccess resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET.
The value NEVER indicates the use of the client forwarding policy.
:param pulumi.Input[str] description: Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[str] health_reporting: Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
:param pulumi.Input[bool] is_cname_enabled: Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the
connectors.
:param pulumi.Input[str] name: Name of the application.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['BrowserAccessServerGroupArgs']]]] server_groups: List of the server group IDs.
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _BrowserAccessState.__new__(_BrowserAccessState)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["clientless_apps"] = clientless_apps
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
return BrowserAccess(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> pulumi.Output[Optional[str]]:
"""
Indicates whether users can bypass ZPA to access applications. Default: NEVER. Supported values: ALWAYS, NEVER, ON_NET.
The value NEVER indicates the use of the client forwarding policy.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="clientlessApps")
def clientless_apps(self) -> pulumi.Output[Sequence['outputs.BrowserAccessClientlessApp']]:
return pulumi.get(self, "clientless_apps")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Output[Sequence[str]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> pulumi.Output[Optional[bool]]:
"""
Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[bool]:
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> pulumi.Output[str]:
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> pulumi.Output[str]:
"""
Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "icmp_access_type")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> pulumi.Output[Optional[bool]]:
"""
Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the
connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> pulumi.Output[bool]:
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Output[str]:
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> pulumi.Output[str]:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Output[Sequence['outputs.BrowserAccessServerGroup']]:
"""
List of the server group IDs.
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/browser_access.py | browser_access.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = [
'GetApplicationSegmentInspectionResult',
'AwaitableGetApplicationSegmentInspectionResult',
'get_application_segment_inspection',
'get_application_segment_inspection_output',
]
@pulumi.output_type
class GetApplicationSegmentInspectionResult:
"""
A collection of values returned by getApplicationSegmentInspection.
"""
def __init__(__self__, bypass_type=None, creation_time=None, description=None, domain_names=None, double_encrypt=None, enabled=None, health_check_type=None, health_reporting=None, icmp_access_type=None, id=None, inspection_apps=None, ip_anchored=None, is_cname_enabled=None, modified_by=None, modified_time=None, name=None, passive_health_enabled=None, segment_group_id=None, segment_group_name=None, select_connector_close_to_app=None, server_groups=None, tcp_port_ranges=None, udp_port_ranges=None):
if bypass_type and not isinstance(bypass_type, str):
raise TypeError("Expected argument 'bypass_type' to be a str")
pulumi.set(__self__, "bypass_type", bypass_type)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if domain_names and not isinstance(domain_names, list):
raise TypeError("Expected argument 'domain_names' to be a list")
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt and not isinstance(double_encrypt, bool):
raise TypeError("Expected argument 'double_encrypt' to be a bool")
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if health_check_type and not isinstance(health_check_type, str):
raise TypeError("Expected argument 'health_check_type' to be a str")
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting and not isinstance(health_reporting, str):
raise TypeError("Expected argument 'health_reporting' to be a str")
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type and not isinstance(icmp_access_type, str):
raise TypeError("Expected argument 'icmp_access_type' to be a str")
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if inspection_apps and not isinstance(inspection_apps, list):
raise TypeError("Expected argument 'inspection_apps' to be a list")
pulumi.set(__self__, "inspection_apps", inspection_apps)
if ip_anchored and not isinstance(ip_anchored, bool):
raise TypeError("Expected argument 'ip_anchored' to be a bool")
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled and not isinstance(is_cname_enabled, bool):
raise TypeError("Expected argument 'is_cname_enabled' to be a bool")
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if modified_by and not isinstance(modified_by, str):
raise TypeError("Expected argument 'modified_by' to be a str")
pulumi.set(__self__, "modified_by", modified_by)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if passive_health_enabled and not isinstance(passive_health_enabled, bool):
raise TypeError("Expected argument 'passive_health_enabled' to be a bool")
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id and not isinstance(segment_group_id, str):
raise TypeError("Expected argument 'segment_group_id' to be a str")
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name and not isinstance(segment_group_name, str):
raise TypeError("Expected argument 'segment_group_name' to be a str")
pulumi.set(__self__, "segment_group_name", segment_group_name)
if select_connector_close_to_app and not isinstance(select_connector_close_to_app, bool):
raise TypeError("Expected argument 'select_connector_close_to_app' to be a bool")
pulumi.set(__self__, "select_connector_close_to_app", select_connector_close_to_app)
if server_groups and not isinstance(server_groups, list):
raise TypeError("Expected argument 'server_groups' to be a list")
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges and not isinstance(tcp_port_ranges, list):
raise TypeError("Expected argument 'tcp_port_ranges' to be a list")
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges and not isinstance(udp_port_ranges, list):
raise TypeError("Expected argument 'udp_port_ranges' to be a list")
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> str:
"""
(string) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(String)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Sequence[str]:
"""
(string) List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> bool:
"""
(bool) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> str:
"""
(string)
"""
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> str:
"""
(string) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> str:
"""
(string)
"""
return pulumi.get(self, "icmp_access_type")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="inspectionApps")
def inspection_apps(self) -> Sequence['outputs.GetApplicationSegmentInspectionInspectionAppResult']:
"""
(string) TCP port ranges used to access the app.
* `app_id:` - (string)
* `name:` - (string) Name of the Inspection Application
* `description:` - (string) Description of the Inspection Application
* `domain:` - (string) Domain name of the inspection application
"""
return pulumi.get(self, "inspection_apps")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> bool:
"""
(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter(name="modifiedBy")
def modified_by(self) -> str:
return pulumi.get(self, "modified_by")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(String)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> str:
"""
(String) Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> str:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="selectConnectorCloseToApp")
def select_connector_close_to_app(self) -> bool:
return pulumi.get(self, "select_connector_close_to_app")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Sequence['outputs.GetApplicationSegmentInspectionServerGroupResult']:
"""
(string) List of Server Group IDs
* `id:` - (string) List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Sequence[str]:
"""
(string) TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Sequence[str]:
"""
(string) UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
class AwaitableGetApplicationSegmentInspectionResult(GetApplicationSegmentInspectionResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetApplicationSegmentInspectionResult(
bypass_type=self.bypass_type,
creation_time=self.creation_time,
description=self.description,
domain_names=self.domain_names,
double_encrypt=self.double_encrypt,
enabled=self.enabled,
health_check_type=self.health_check_type,
health_reporting=self.health_reporting,
icmp_access_type=self.icmp_access_type,
id=self.id,
inspection_apps=self.inspection_apps,
ip_anchored=self.ip_anchored,
is_cname_enabled=self.is_cname_enabled,
modified_by=self.modified_by,
modified_time=self.modified_time,
name=self.name,
passive_health_enabled=self.passive_health_enabled,
segment_group_id=self.segment_group_id,
segment_group_name=self.segment_group_name,
select_connector_close_to_app=self.select_connector_close_to_app,
server_groups=self.server_groups,
tcp_port_ranges=self.tcp_port_ranges,
udp_port_ranges=self.udp_port_ranges)
def get_application_segment_inspection(id: Optional[str] = None,
name: Optional[str] = None,
tcp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentInspectionTcpPortRangeArgs']]] = None,
udp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentInspectionUdpPortRangeArgs']]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetApplicationSegmentInspectionResult:
"""
Use the **zpa_application_segment_inspection** data source to get information about an inspection application segment in the Zscaler Private Access cloud. This resource can then be referenced in a ZPA access inspection policy. This resource supports ZPA Inspection for both `HTTP` and `HTTPS`.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_inspection(name="ZPA_Inspection_Example")
```
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_inspection(id="123456789")
```
:param str id: The ID of the Inspection Application Segment to be exported.
:param str name: The name of the Inspection Application Segment to be exported.
:param Sequence[pulumi.InputType['GetApplicationSegmentInspectionTcpPortRangeArgs']] tcp_port_ranges: (string) TCP port ranges used to access the app.
* `from:`
* `to:`
:param Sequence[pulumi.InputType['GetApplicationSegmentInspectionUdpPortRangeArgs']] udp_port_ranges: (string) UDP port ranges used to access the app.
* `from:`
* `to:`
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
__args__['tcpPortRanges'] = tcp_port_ranges
__args__['udpPortRanges'] = udp_port_ranges
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ApplicationSegment/getApplicationSegmentInspection:getApplicationSegmentInspection', __args__, opts=opts, typ=GetApplicationSegmentInspectionResult).value
return AwaitableGetApplicationSegmentInspectionResult(
bypass_type=__ret__.bypass_type,
creation_time=__ret__.creation_time,
description=__ret__.description,
domain_names=__ret__.domain_names,
double_encrypt=__ret__.double_encrypt,
enabled=__ret__.enabled,
health_check_type=__ret__.health_check_type,
health_reporting=__ret__.health_reporting,
icmp_access_type=__ret__.icmp_access_type,
id=__ret__.id,
inspection_apps=__ret__.inspection_apps,
ip_anchored=__ret__.ip_anchored,
is_cname_enabled=__ret__.is_cname_enabled,
modified_by=__ret__.modified_by,
modified_time=__ret__.modified_time,
name=__ret__.name,
passive_health_enabled=__ret__.passive_health_enabled,
segment_group_id=__ret__.segment_group_id,
segment_group_name=__ret__.segment_group_name,
select_connector_close_to_app=__ret__.select_connector_close_to_app,
server_groups=__ret__.server_groups,
tcp_port_ranges=__ret__.tcp_port_ranges,
udp_port_ranges=__ret__.udp_port_ranges)
@_utilities.lift_output_func(get_application_segment_inspection)
def get_application_segment_inspection_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentInspectionTcpPortRangeArgs']]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentInspectionUdpPortRangeArgs']]]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetApplicationSegmentInspectionResult]:
"""
Use the **zpa_application_segment_inspection** data source to get information about an inspection application segment in the Zscaler Private Access cloud. This resource can then be referenced in a ZPA access inspection policy. This resource supports ZPA Inspection for both `HTTP` and `HTTPS`.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_inspection(name="ZPA_Inspection_Example")
```
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_inspection(id="123456789")
```
:param str id: The ID of the Inspection Application Segment to be exported.
:param str name: The name of the Inspection Application Segment to be exported.
:param Sequence[pulumi.InputType['GetApplicationSegmentInspectionTcpPortRangeArgs']] tcp_port_ranges: (string) TCP port ranges used to access the app.
* `from:`
* `to:`
:param Sequence[pulumi.InputType['GetApplicationSegmentInspectionUdpPortRangeArgs']] udp_port_ranges: (string) UDP port ranges used to access the app.
* `from:`
* `to:`
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/get_application_segment_inspection.py | get_application_segment_inspection.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'ApplicationSegmentBrowserAccessClientlessApp',
'ApplicationSegmentBrowserAccessServerGroup',
'ApplicationSegmentInspectionCommonAppsDto',
'ApplicationSegmentInspectionCommonAppsDtoAppsConfig',
'ApplicationSegmentInspectionServerGroup',
'ApplicationSegmentPRACommonAppsDto',
'ApplicationSegmentPRACommonAppsDtoAppsConfig',
'ApplicationSegmentPRAServerGroup',
'ApplicationSegmentServerGroup',
'BrowserAccessClientlessApp',
'BrowserAccessServerGroup',
'GetApplicationSegmentBrowserAccessClientlessAppResult',
'GetApplicationSegmentBrowserAccessServerGroupResult',
'GetApplicationSegmentInspectionInspectionAppResult',
'GetApplicationSegmentInspectionServerGroupResult',
'GetApplicationSegmentPRAServerGroupResult',
'GetApplicationSegmentPRASraAppResult',
'GetApplicationSegmentServerGroupResult',
]
@pulumi.output_type
class ApplicationSegmentBrowserAccessClientlessApp(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "applicationPort":
suggest = "application_port"
elif key == "applicationProtocol":
suggest = "application_protocol"
elif key == "certificateId":
suggest = "certificate_id"
elif key == "allowOptions":
suggest = "allow_options"
elif key == "localDomain":
suggest = "local_domain"
elif key == "trustUntrustedCert":
suggest = "trust_untrusted_cert"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ApplicationSegmentBrowserAccessClientlessApp. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ApplicationSegmentBrowserAccessClientlessApp.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ApplicationSegmentBrowserAccessClientlessApp.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
application_port: str,
application_protocol: str,
certificate_id: str,
name: str,
allow_options: Optional[bool] = None,
cname: Optional[str] = None,
description: Optional[str] = None,
domain: Optional[str] = None,
enabled: Optional[bool] = None,
hidden: Optional[bool] = None,
id: Optional[str] = None,
local_domain: Optional[str] = None,
path: Optional[str] = None,
trust_untrusted_cert: Optional[bool] = None):
"""
:param str application_port: Port for the BA app.
:param str application_protocol: Protocol for the BA app. Supported values: `HTTP` and `HTTPS`
:param str name: Name of the application.
:param bool allow_options: If you want ZPA to forward unauthenticated HTTP preflight OPTIONS requests from the browser to the app.. Supported values: `true` and `false`
:param str cname: (Optional)
:param str description: (Optional) Description of the application.
:param str domain: Domain name or IP address of the BA app.
:param bool enabled: (Optional) - Whether this app is enabled or not.
:param bool hidden: (Optional)
:param str local_domain: (Optional)
:param str path: (Optional)
:param bool trust_untrusted_cert: (Optional)
"""
pulumi.set(__self__, "application_port", application_port)
pulumi.set(__self__, "application_protocol", application_protocol)
pulumi.set(__self__, "certificate_id", certificate_id)
pulumi.set(__self__, "name", name)
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if path is not None:
pulumi.set(__self__, "path", path)
if trust_untrusted_cert is not None:
pulumi.set(__self__, "trust_untrusted_cert", trust_untrusted_cert)
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> str:
"""
Port for the BA app.
"""
return pulumi.get(self, "application_port")
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> str:
"""
Protocol for the BA app. Supported values: `HTTP` and `HTTPS`
"""
return pulumi.get(self, "application_protocol")
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> str:
return pulumi.get(self, "certificate_id")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the application.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[bool]:
"""
If you want ZPA to forward unauthenticated HTTP preflight OPTIONS requests from the browser to the app.. Supported values: `true` and `false`
"""
return pulumi.get(self, "allow_options")
@property
@pulumi.getter
def cname(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "cname")
@property
@pulumi.getter
def description(self) -> Optional[str]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def domain(self) -> Optional[str]:
"""
Domain name or IP address of the BA app.
"""
return pulumi.get(self, "domain")
@property
@pulumi.getter
def enabled(self) -> Optional[bool]:
"""
(Optional) - Whether this app is enabled or not.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def hidden(self) -> Optional[bool]:
"""
(Optional)
"""
return pulumi.get(self, "hidden")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "local_domain")
@property
@pulumi.getter
def path(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "path")
@property
@pulumi.getter(name="trustUntrustedCert")
def trust_untrusted_cert(self) -> Optional[bool]:
"""
(Optional)
"""
return pulumi.get(self, "trust_untrusted_cert")
@pulumi.output_type
class ApplicationSegmentBrowserAccessServerGroup(dict):
def __init__(__self__, *,
ids: Sequence[str]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
return pulumi.get(self, "ids")
@pulumi.output_type
class ApplicationSegmentInspectionCommonAppsDto(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "appsConfigs":
suggest = "apps_configs"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ApplicationSegmentInspectionCommonAppsDto. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ApplicationSegmentInspectionCommonAppsDto.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ApplicationSegmentInspectionCommonAppsDto.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
apps_configs: Optional[Sequence['outputs.ApplicationSegmentInspectionCommonAppsDtoAppsConfig']] = None):
if apps_configs is not None:
pulumi.set(__self__, "apps_configs", apps_configs)
@property
@pulumi.getter(name="appsConfigs")
def apps_configs(self) -> Optional[Sequence['outputs.ApplicationSegmentInspectionCommonAppsDtoAppsConfig']]:
return pulumi.get(self, "apps_configs")
@pulumi.output_type
class ApplicationSegmentInspectionCommonAppsDtoAppsConfig(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "allowOptions":
suggest = "allow_options"
elif key == "appId":
suggest = "app_id"
elif key == "appTypes":
suggest = "app_types"
elif key == "applicationPort":
suggest = "application_port"
elif key == "applicationProtocol":
suggest = "application_protocol"
elif key == "certificateId":
suggest = "certificate_id"
elif key == "certificateName":
suggest = "certificate_name"
elif key == "localDomain":
suggest = "local_domain"
elif key == "trustUntrustedCert":
suggest = "trust_untrusted_cert"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ApplicationSegmentInspectionCommonAppsDtoAppsConfig. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ApplicationSegmentInspectionCommonAppsDtoAppsConfig.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ApplicationSegmentInspectionCommonAppsDtoAppsConfig.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
allow_options: Optional[bool] = None,
app_id: Optional[str] = None,
app_types: Optional[Sequence[str]] = None,
application_port: Optional[str] = None,
application_protocol: Optional[str] = None,
certificate_id: Optional[str] = None,
certificate_name: Optional[str] = None,
cname: Optional[str] = None,
description: Optional[str] = None,
domain: Optional[str] = None,
enabled: Optional[bool] = None,
hidden: Optional[bool] = None,
id: Optional[str] = None,
local_domain: Optional[str] = None,
name: Optional[str] = None,
portal: Optional[bool] = None,
trust_untrusted_cert: Optional[bool] = None):
"""
:param Sequence[str] app_types: Indicates the type of application as inspection. Supported value: `INSPECT`
:param str application_port: Port for the Inspection Application Segment.
:param str application_protocol: Protocol for the Inspection Application Segment.. Supported values: `HTTP` and `HTTPS`
:param str certificate_id: ID of the signing certificate. This field is required if the applicationProtocol is set to `HTTPS`. The certificateId is not supported if the applicationProtocol is set to `HTTP`.
:param str description: (Optional) Description of the application.
:param str domain: Domain name of the Inspection Application Segment.
:param bool enabled: Whether this application is enabled or not
:param str name: Name of the Inspection Application Segment.
"""
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if app_id is not None:
pulumi.set(__self__, "app_id", app_id)
if app_types is not None:
pulumi.set(__self__, "app_types", app_types)
if application_port is not None:
pulumi.set(__self__, "application_port", application_port)
if application_protocol is not None:
pulumi.set(__self__, "application_protocol", application_protocol)
if certificate_id is not None:
pulumi.set(__self__, "certificate_id", certificate_id)
if certificate_name is not None:
pulumi.set(__self__, "certificate_name", certificate_name)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if name is not None:
pulumi.set(__self__, "name", name)
if portal is not None:
pulumi.set(__self__, "portal", portal)
if trust_untrusted_cert is not None:
pulumi.set(__self__, "trust_untrusted_cert", trust_untrusted_cert)
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[bool]:
return pulumi.get(self, "allow_options")
@property
@pulumi.getter(name="appId")
def app_id(self) -> Optional[str]:
return pulumi.get(self, "app_id")
@property
@pulumi.getter(name="appTypes")
def app_types(self) -> Optional[Sequence[str]]:
"""
Indicates the type of application as inspection. Supported value: `INSPECT`
"""
return pulumi.get(self, "app_types")
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> Optional[str]:
"""
Port for the Inspection Application Segment.
"""
return pulumi.get(self, "application_port")
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> Optional[str]:
"""
Protocol for the Inspection Application Segment.. Supported values: `HTTP` and `HTTPS`
"""
return pulumi.get(self, "application_protocol")
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> Optional[str]:
"""
ID of the signing certificate. This field is required if the applicationProtocol is set to `HTTPS`. The certificateId is not supported if the applicationProtocol is set to `HTTP`.
"""
return pulumi.get(self, "certificate_id")
@property
@pulumi.getter(name="certificateName")
def certificate_name(self) -> Optional[str]:
return pulumi.get(self, "certificate_name")
@property
@pulumi.getter
def cname(self) -> Optional[str]:
return pulumi.get(self, "cname")
@property
@pulumi.getter
def description(self) -> Optional[str]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def domain(self) -> Optional[str]:
"""
Domain name of the Inspection Application Segment.
"""
return pulumi.get(self, "domain")
@property
@pulumi.getter
def enabled(self) -> Optional[bool]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def hidden(self) -> Optional[bool]:
return pulumi.get(self, "hidden")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[str]:
return pulumi.get(self, "local_domain")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
Name of the Inspection Application Segment.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def portal(self) -> Optional[bool]:
return pulumi.get(self, "portal")
@property
@pulumi.getter(name="trustUntrustedCert")
def trust_untrusted_cert(self) -> Optional[bool]:
return pulumi.get(self, "trust_untrusted_cert")
@pulumi.output_type
class ApplicationSegmentInspectionServerGroup(dict):
def __init__(__self__, *,
ids: Sequence[str]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
return pulumi.get(self, "ids")
@pulumi.output_type
class ApplicationSegmentPRACommonAppsDto(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "appsConfigs":
suggest = "apps_configs"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ApplicationSegmentPRACommonAppsDto. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ApplicationSegmentPRACommonAppsDto.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ApplicationSegmentPRACommonAppsDto.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
apps_configs: Optional[Sequence['outputs.ApplicationSegmentPRACommonAppsDtoAppsConfig']] = None):
if apps_configs is not None:
pulumi.set(__self__, "apps_configs", apps_configs)
@property
@pulumi.getter(name="appsConfigs")
def apps_configs(self) -> Optional[Sequence['outputs.ApplicationSegmentPRACommonAppsDtoAppsConfig']]:
return pulumi.get(self, "apps_configs")
@pulumi.output_type
class ApplicationSegmentPRACommonAppsDtoAppsConfig(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "allowOptions":
suggest = "allow_options"
elif key == "appId":
suggest = "app_id"
elif key == "appTypes":
suggest = "app_types"
elif key == "applicationPort":
suggest = "application_port"
elif key == "applicationProtocol":
suggest = "application_protocol"
elif key == "connectionSecurity":
suggest = "connection_security"
elif key == "localDomain":
suggest = "local_domain"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in ApplicationSegmentPRACommonAppsDtoAppsConfig. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
ApplicationSegmentPRACommonAppsDtoAppsConfig.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
ApplicationSegmentPRACommonAppsDtoAppsConfig.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
allow_options: Optional[bool] = None,
app_id: Optional[str] = None,
app_types: Optional[Sequence[str]] = None,
application_port: Optional[str] = None,
application_protocol: Optional[str] = None,
cname: Optional[str] = None,
connection_security: Optional[str] = None,
description: Optional[str] = None,
domain: Optional[str] = None,
enabled: Optional[bool] = None,
hidden: Optional[bool] = None,
id: Optional[str] = None,
local_domain: Optional[str] = None,
name: Optional[str] = None,
portal: Optional[bool] = None):
"""
:param Sequence[str] app_types: Indicates the type of application as Privileged Remote Access. Supported value: `SECURE_REMOTE_ACCESS`
:param str application_port: Port for the Privileged Remote Access
:param str application_protocol: Protocol for the Privileged Remote Access. Supported values: `RDP` and `SSH`
:param str connection_security: Parameter required when `application_protocol` is of type `RDP`
:param str description: (Optional) Description of the application.
:param str domain: Domain name of the Privileged Remote Access
:param bool enabled: Whether this application is enabled or not
:param str name: Name of the Privileged Remote Access
"""
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if app_id is not None:
pulumi.set(__self__, "app_id", app_id)
if app_types is not None:
pulumi.set(__self__, "app_types", app_types)
if application_port is not None:
pulumi.set(__self__, "application_port", application_port)
if application_protocol is not None:
pulumi.set(__self__, "application_protocol", application_protocol)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if connection_security is not None:
pulumi.set(__self__, "connection_security", connection_security)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if name is not None:
pulumi.set(__self__, "name", name)
if portal is not None:
pulumi.set(__self__, "portal", portal)
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[bool]:
return pulumi.get(self, "allow_options")
@property
@pulumi.getter(name="appId")
def app_id(self) -> Optional[str]:
return pulumi.get(self, "app_id")
@property
@pulumi.getter(name="appTypes")
def app_types(self) -> Optional[Sequence[str]]:
"""
Indicates the type of application as Privileged Remote Access. Supported value: `SECURE_REMOTE_ACCESS`
"""
return pulumi.get(self, "app_types")
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> Optional[str]:
"""
Port for the Privileged Remote Access
"""
return pulumi.get(self, "application_port")
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> Optional[str]:
"""
Protocol for the Privileged Remote Access. Supported values: `RDP` and `SSH`
"""
return pulumi.get(self, "application_protocol")
@property
@pulumi.getter
def cname(self) -> Optional[str]:
return pulumi.get(self, "cname")
@property
@pulumi.getter(name="connectionSecurity")
def connection_security(self) -> Optional[str]:
"""
Parameter required when `application_protocol` is of type `RDP`
"""
return pulumi.get(self, "connection_security")
@property
@pulumi.getter
def description(self) -> Optional[str]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def domain(self) -> Optional[str]:
"""
Domain name of the Privileged Remote Access
"""
return pulumi.get(self, "domain")
@property
@pulumi.getter
def enabled(self) -> Optional[bool]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def hidden(self) -> Optional[bool]:
return pulumi.get(self, "hidden")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[str]:
return pulumi.get(self, "local_domain")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
Name of the Privileged Remote Access
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def portal(self) -> Optional[bool]:
return pulumi.get(self, "portal")
@pulumi.output_type
class ApplicationSegmentPRAServerGroup(dict):
def __init__(__self__, *,
ids: Sequence[str]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
return pulumi.get(self, "ids")
@pulumi.output_type
class ApplicationSegmentServerGroup(dict):
def __init__(__self__, *,
ids: Sequence[str]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
return pulumi.get(self, "ids")
@pulumi.output_type
class BrowserAccessClientlessApp(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "applicationPort":
suggest = "application_port"
elif key == "applicationProtocol":
suggest = "application_protocol"
elif key == "certificateId":
suggest = "certificate_id"
elif key == "allowOptions":
suggest = "allow_options"
elif key == "localDomain":
suggest = "local_domain"
elif key == "trustUntrustedCert":
suggest = "trust_untrusted_cert"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in BrowserAccessClientlessApp. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
BrowserAccessClientlessApp.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
BrowserAccessClientlessApp.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
application_port: str,
application_protocol: str,
certificate_id: str,
name: str,
allow_options: Optional[bool] = None,
cname: Optional[str] = None,
description: Optional[str] = None,
domain: Optional[str] = None,
enabled: Optional[bool] = None,
hidden: Optional[bool] = None,
id: Optional[str] = None,
local_domain: Optional[str] = None,
path: Optional[str] = None,
trust_untrusted_cert: Optional[bool] = None):
pulumi.set(__self__, "application_port", application_port)
pulumi.set(__self__, "application_protocol", application_protocol)
pulumi.set(__self__, "certificate_id", certificate_id)
pulumi.set(__self__, "name", name)
if allow_options is not None:
pulumi.set(__self__, "allow_options", allow_options)
if cname is not None:
pulumi.set(__self__, "cname", cname)
if description is not None:
pulumi.set(__self__, "description", description)
if domain is not None:
pulumi.set(__self__, "domain", domain)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if hidden is not None:
pulumi.set(__self__, "hidden", hidden)
if id is not None:
pulumi.set(__self__, "id", id)
if local_domain is not None:
pulumi.set(__self__, "local_domain", local_domain)
if path is not None:
pulumi.set(__self__, "path", path)
if trust_untrusted_cert is not None:
pulumi.set(__self__, "trust_untrusted_cert", trust_untrusted_cert)
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> str:
return pulumi.get(self, "application_port")
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> str:
return pulumi.get(self, "application_protocol")
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> str:
return pulumi.get(self, "certificate_id")
@property
@pulumi.getter
def name(self) -> str:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> Optional[bool]:
return pulumi.get(self, "allow_options")
@property
@pulumi.getter
def cname(self) -> Optional[str]:
return pulumi.get(self, "cname")
@property
@pulumi.getter
def description(self) -> Optional[str]:
return pulumi.get(self, "description")
@property
@pulumi.getter
def domain(self) -> Optional[str]:
return pulumi.get(self, "domain")
@property
@pulumi.getter
def enabled(self) -> Optional[bool]:
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def hidden(self) -> Optional[bool]:
return pulumi.get(self, "hidden")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> Optional[str]:
return pulumi.get(self, "local_domain")
@property
@pulumi.getter
def path(self) -> Optional[str]:
return pulumi.get(self, "path")
@property
@pulumi.getter(name="trustUntrustedCert")
def trust_untrusted_cert(self) -> Optional[bool]:
return pulumi.get(self, "trust_untrusted_cert")
@pulumi.output_type
class BrowserAccessServerGroup(dict):
def __init__(__self__, *,
ids: Sequence[str]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
return pulumi.get(self, "ids")
@pulumi.output_type
class GetApplicationSegmentBrowserAccessClientlessAppResult(dict):
def __init__(__self__, *,
allow_options: bool,
app_id: str,
application_port: str,
application_protocol: str,
certificate_id: str,
certificate_name: str,
cname: str,
description: str,
domain: str,
enabled: bool,
hidden: bool,
id: str,
local_domain: str,
name: str,
path: str,
trust_untrusted_cert: bool):
"""
:param bool allow_options: (bool)
:param str application_port: (string)
:param str application_protocol: (string)
:param str certificate_id: (string)
:param str certificate_name: (string)
:param str cname: (string)
:param str description: (string)
:param str domain: (string)
:param bool enabled: (bool)
:param bool hidden: (bool)
:param str id: This field defines the id of the application server.
:param str local_domain: (string)
:param str name: This field defines the name of the server.
:param str path: (string)
:param bool trust_untrusted_cert: (bool)
"""
pulumi.set(__self__, "allow_options", allow_options)
pulumi.set(__self__, "app_id", app_id)
pulumi.set(__self__, "application_port", application_port)
pulumi.set(__self__, "application_protocol", application_protocol)
pulumi.set(__self__, "certificate_id", certificate_id)
pulumi.set(__self__, "certificate_name", certificate_name)
pulumi.set(__self__, "cname", cname)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "domain", domain)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "hidden", hidden)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "local_domain", local_domain)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "path", path)
pulumi.set(__self__, "trust_untrusted_cert", trust_untrusted_cert)
@property
@pulumi.getter(name="allowOptions")
def allow_options(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "allow_options")
@property
@pulumi.getter(name="appId")
def app_id(self) -> str:
return pulumi.get(self, "app_id")
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> str:
"""
(string)
"""
return pulumi.get(self, "application_port")
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> str:
"""
(string)
"""
return pulumi.get(self, "application_protocol")
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> str:
"""
(string)
"""
return pulumi.get(self, "certificate_id")
@property
@pulumi.getter(name="certificateName")
def certificate_name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "certificate_name")
@property
@pulumi.getter
def cname(self) -> str:
"""
(string)
"""
return pulumi.get(self, "cname")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def domain(self) -> str:
"""
(string)
"""
return pulumi.get(self, "domain")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def hidden(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "hidden")
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the id of the application server.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="localDomain")
def local_domain(self) -> str:
"""
(string)
"""
return pulumi.get(self, "local_domain")
@property
@pulumi.getter
def name(self) -> str:
"""
This field defines the name of the server.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def path(self) -> str:
"""
(string)
"""
return pulumi.get(self, "path")
@property
@pulumi.getter(name="trustUntrustedCert")
def trust_untrusted_cert(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "trust_untrusted_cert")
@pulumi.output_type
class GetApplicationSegmentBrowserAccessServerGroupResult(dict):
def __init__(__self__, *,
ids: Sequence[str]):
"""
:param Sequence[str] ids: This field defines the id of the application server.
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
"""
This field defines the id of the application server.
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class GetApplicationSegmentInspectionInspectionAppResult(dict):
def __init__(__self__, *,
app_id: str,
application_port: str,
application_protocol: str,
certificate_id: str,
certificate_name: str,
description: str,
domain: str,
enabled: bool,
id: str,
name: str):
"""
:param str application_port: (string) TCP/UDP Port for ZPA Inspection.
:param str application_protocol: (string) Protocol for the Inspection Application. Supported values: `HTTP` and `HTTPS`
:param str certificate_id: (string) - ID of the signing certificate. This field is required if the applicationProtocol is set to `HTTPS`. The certificateId is not supported if the applicationProtocol is set to `HTTP`.
:param str certificate_name: (string) - Parameter required when `application_protocol` is of type `HTTPS`
:param str description: (string) Description of the application.
:param bool enabled: (bool) Whether this application is enabled or not
:param str id: The ID of the Inspection Application Segment to be exported.
:param str name: The name of the Inspection Application Segment to be exported.
"""
pulumi.set(__self__, "app_id", app_id)
pulumi.set(__self__, "application_port", application_port)
pulumi.set(__self__, "application_protocol", application_protocol)
pulumi.set(__self__, "certificate_id", certificate_id)
pulumi.set(__self__, "certificate_name", certificate_name)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "domain", domain)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter(name="appId")
def app_id(self) -> str:
return pulumi.get(self, "app_id")
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> str:
"""
(string) TCP/UDP Port for ZPA Inspection.
"""
return pulumi.get(self, "application_port")
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> str:
"""
(string) Protocol for the Inspection Application. Supported values: `HTTP` and `HTTPS`
"""
return pulumi.get(self, "application_protocol")
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> str:
"""
(string) - ID of the signing certificate. This field is required if the applicationProtocol is set to `HTTPS`. The certificateId is not supported if the applicationProtocol is set to `HTTP`.
"""
return pulumi.get(self, "certificate_id")
@property
@pulumi.getter(name="certificateName")
def certificate_name(self) -> str:
"""
(string) - Parameter required when `application_protocol` is of type `HTTPS`
"""
return pulumi.get(self, "certificate_name")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def domain(self) -> str:
return pulumi.get(self, "domain")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the Inspection Application Segment to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the Inspection Application Segment to be exported.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetApplicationSegmentInspectionServerGroupResult(dict):
def __init__(__self__, *,
ids: Sequence[str]):
"""
:param Sequence[str] ids: The ID of the Inspection Application Segment to be exported.
"""
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
"""
The ID of the Inspection Application Segment to be exported.
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class GetApplicationSegmentPRAServerGroupResult(dict):
def __init__(__self__, *,
ids: Sequence[str]):
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Sequence[str]:
return pulumi.get(self, "ids")
@pulumi.output_type
class GetApplicationSegmentPRASraAppResult(dict):
def __init__(__self__, *,
app_id: str,
application_port: str,
application_protocol: str,
certificate_id: str,
certificate_name: str,
connection_security: str,
description: str,
domain: str,
enabled: bool,
hidden: bool,
id: str,
name: str,
portal: bool):
"""
:param str application_port: (string) Port for the Privileged Remote Accessvalues: `RDP` and `SSH`
:param str application_protocol: (string) Protocol for the Privileged Remote Access. Supported values: `RDP` and `SSH`
:param str connection_security: (string) - Parameter required when `application_protocol` is of type `RDP`
:param str description: (string) Description of the application.
:param bool enabled: (bool) Whether this application is enabled or not
:param str name: The name of the PRA Application Segment to be exported.
"""
pulumi.set(__self__, "app_id", app_id)
pulumi.set(__self__, "application_port", application_port)
pulumi.set(__self__, "application_protocol", application_protocol)
pulumi.set(__self__, "certificate_id", certificate_id)
pulumi.set(__self__, "certificate_name", certificate_name)
pulumi.set(__self__, "connection_security", connection_security)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "domain", domain)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "hidden", hidden)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "portal", portal)
@property
@pulumi.getter(name="appId")
def app_id(self) -> str:
return pulumi.get(self, "app_id")
@property
@pulumi.getter(name="applicationPort")
def application_port(self) -> str:
"""
(string) Port for the Privileged Remote Accessvalues: `RDP` and `SSH`
"""
return pulumi.get(self, "application_port")
@property
@pulumi.getter(name="applicationProtocol")
def application_protocol(self) -> str:
"""
(string) Protocol for the Privileged Remote Access. Supported values: `RDP` and `SSH`
"""
return pulumi.get(self, "application_protocol")
@property
@pulumi.getter(name="certificateId")
def certificate_id(self) -> str:
return pulumi.get(self, "certificate_id")
@property
@pulumi.getter(name="certificateName")
def certificate_name(self) -> str:
return pulumi.get(self, "certificate_name")
@property
@pulumi.getter(name="connectionSecurity")
def connection_security(self) -> str:
"""
(string) - Parameter required when `application_protocol` is of type `RDP`
"""
return pulumi.get(self, "connection_security")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def domain(self) -> str:
return pulumi.get(self, "domain")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def hidden(self) -> bool:
return pulumi.get(self, "hidden")
@property
@pulumi.getter
def id(self) -> str:
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the PRA Application Segment to be exported.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def portal(self) -> bool:
return pulumi.get(self, "portal")
@pulumi.output_type
class GetApplicationSegmentServerGroupResult(dict):
def __init__(__self__, *,
config_space: str,
creation_time: str,
description: str,
dynamic_discovery: bool,
enabled: bool,
id: str,
modified_time: str,
modifiedby: str,
name: str):
"""
:param str description: Description of the application.
:param bool enabled: Whether this application is enabled or not. Default: false. Supported values: `true`, `false`.
:param str name: Name of the application.
"""
pulumi.set(__self__, "config_space", config_space)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "dynamic_discovery", dynamic_discovery)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="dynamicDiscovery")
def dynamic_discovery(self) -> bool:
return pulumi.get(self, "dynamic_discovery")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
Whether this application is enabled or not. Default: false. Supported values: `true`, `false`.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> str:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
Name of the application.
"""
return pulumi.get(self, "name") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['ApplicationSegmentInspectionArgs', 'ApplicationSegmentInspection']
@pulumi.input_type
class ApplicationSegmentInspectionArgs:
def __init__(__self__, *,
segment_group_id: pulumi.Input[str],
server_groups: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]],
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs']] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
The set of arguments for constructing a ApplicationSegmentInspection resource.
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs'] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Inspection Application Segment.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
pulumi.set(__self__, "segment_group_id", segment_group_id)
pulumi.set(__self__, "server_groups", server_groups)
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if common_apps_dto is not None:
pulumi.set(__self__, "common_apps_dto", common_apps_dto)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if domain_names is not None:
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Input[str]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: pulumi.Input[str]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="commonAppsDto")
def common_apps_dto(self) -> Optional[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs']]:
"""
List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
"""
return pulumi.get(self, "common_apps_dto")
@common_apps_dto.setter
def common_apps_dto(self, value: Optional[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs']]):
pulumi.set(self, "common_apps_dto", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Inspection Application Segment.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
@pulumi.input_type
class _ApplicationSegmentInspectionState:
def __init__(__self__, *,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs']] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
Input properties used for looking up and filtering ApplicationSegmentInspection resources.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs'] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Inspection Application Segment.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if common_apps_dto is not None:
pulumi.set(__self__, "common_apps_dto", common_apps_dto)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if domain_names is not None:
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id is not None:
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if server_groups is not None:
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="commonAppsDto")
def common_apps_dto(self) -> Optional[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs']]:
"""
List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
"""
return pulumi.get(self, "common_apps_dto")
@common_apps_dto.setter
def common_apps_dto(self, value: Optional[pulumi.Input['ApplicationSegmentInspectionCommonAppsDtoArgs']]):
pulumi.set(self, "common_apps_dto", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name of the Inspection Application Segment.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> Optional[pulumi.Input[str]]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentInspectionServerGroupArgs']]]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
class ApplicationSegmentInspection(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionCommonAppsDtoArgs']]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
"""
The **zpa_application_segment_inspection** resource creates an inspection application segment in the Zscaler Private Access cloud. This resource can then be referenced in an access policy inspection rule. This resource supports Inspection for both `HTTP` and `HTTPS`.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
jenkins = zpa.BrowserCertificate.get_ba_certificate(name="jenkins.securitygeek.io")
this = zpa.application_segment.ApplicationSegmentInspection("this",
description="ZPA_Inspection_Example",
enabled=True,
health_reporting="ON_ACCESS",
bypass_type="NEVER",
is_cname_enabled=True,
tcp_port_ranges=[
"443",
"443",
],
domain_names=["jenkins.example.com"],
segment_group_id=zpa_segment_group["this"]["id"],
server_groups=[zpa.application_segment.ApplicationSegmentInspectionServerGroupArgs(
ids=[zpa_server_group["this"]["id"]],
)],
common_apps_dto=zpa.application_segment.ApplicationSegmentInspectionCommonAppsDtoArgs(
apps_configs=[zpa.application_segment.ApplicationSegmentInspectionCommonAppsDtoAppsConfigArgs(
name="jenkins.example.com",
domain="jenkins.example.com",
application_protocol="HTTPS",
application_port="443",
certificate_id=jenkins.id,
enabled=True,
app_types=["INSPECT"],
)],
))
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Inspection Application Segment can be imported by using `<APPLICATION SEGMENT ID>` or `<APPLICATION SEGMENT NAME>` as the import ID.
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentInspection:ApplicationSegmentInspection example <application_segment_id>
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentInspection:ApplicationSegmentInspection example <application_segment_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionCommonAppsDtoArgs']] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Inspection Application Segment.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: ApplicationSegmentInspectionArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zpa_application_segment_inspection** resource creates an inspection application segment in the Zscaler Private Access cloud. This resource can then be referenced in an access policy inspection rule. This resource supports Inspection for both `HTTP` and `HTTPS`.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
jenkins = zpa.BrowserCertificate.get_ba_certificate(name="jenkins.securitygeek.io")
this = zpa.application_segment.ApplicationSegmentInspection("this",
description="ZPA_Inspection_Example",
enabled=True,
health_reporting="ON_ACCESS",
bypass_type="NEVER",
is_cname_enabled=True,
tcp_port_ranges=[
"443",
"443",
],
domain_names=["jenkins.example.com"],
segment_group_id=zpa_segment_group["this"]["id"],
server_groups=[zpa.application_segment.ApplicationSegmentInspectionServerGroupArgs(
ids=[zpa_server_group["this"]["id"]],
)],
common_apps_dto=zpa.application_segment.ApplicationSegmentInspectionCommonAppsDtoArgs(
apps_configs=[zpa.application_segment.ApplicationSegmentInspectionCommonAppsDtoAppsConfigArgs(
name="jenkins.example.com",
domain="jenkins.example.com",
application_protocol="HTTPS",
application_port="443",
certificate_id=jenkins.id,
enabled=True,
app_types=["INSPECT"],
)],
))
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Inspection Application Segment can be imported by using `<APPLICATION SEGMENT ID>` or `<APPLICATION SEGMENT NAME>` as the import ID.
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentInspection:ApplicationSegmentInspection example <application_segment_id>
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegmentInspection:ApplicationSegmentInspection example <application_segment_name>
```
:param str resource_name: The name of the resource.
:param ApplicationSegmentInspectionArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ApplicationSegmentInspectionArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionCommonAppsDtoArgs']]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ApplicationSegmentInspectionArgs.__new__(ApplicationSegmentInspectionArgs)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["common_apps_dto"] = common_apps_dto
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
if segment_group_id is None and not opts.urn:
raise TypeError("Missing required property 'segment_group_id'")
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
if server_groups is None and not opts.urn:
raise TypeError("Missing required property 'server_groups'")
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
super(ApplicationSegmentInspection, __self__).__init__(
'zpa:ApplicationSegment/applicationSegmentInspection:ApplicationSegmentInspection',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
common_apps_dto: Optional[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionCommonAppsDtoArgs']]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'ApplicationSegmentInspection':
"""
Get an existing ApplicationSegmentInspection resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionCommonAppsDtoArgs']] common_apps_dto: List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: Whether this application is enabled or not
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name of the Inspection Application Segment.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentInspectionServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ApplicationSegmentInspectionState.__new__(_ApplicationSegmentInspectionState)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["common_apps_dto"] = common_apps_dto
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
return ApplicationSegmentInspection(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> pulumi.Output[str]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="commonAppsDto")
def common_apps_dto(self) -> pulumi.Output['outputs.ApplicationSegmentInspectionCommonAppsDto']:
"""
List of applications (e.g., Inspection, Browser Access or Privileged Remote Access)
* `apps_config:` - (Required) List of applications to be configured
"""
return pulumi.get(self, "common_apps_dto")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Output[Sequence[str]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> pulumi.Output[bool]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[bool]:
"""
Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> pulumi.Output[str]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> pulumi.Output[bool]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> pulumi.Output[bool]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name of the Inspection Application Segment.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> pulumi.Output[bool]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Output[str]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> pulumi.Output[str]:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Output[Sequence['outputs.ApplicationSegmentInspectionServerGroup']]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/application_segment_inspection.py | application_segment_inspection.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = [
'GetApplicationSegmentPRAResult',
'AwaitableGetApplicationSegmentPRAResult',
'get_application_segment_pra',
'get_application_segment_pra_output',
]
@pulumi.output_type
class GetApplicationSegmentPRAResult:
"""
A collection of values returned by getApplicationSegmentPRA.
"""
def __init__(__self__, bypass_type=None, config_space=None, description=None, domain_names=None, double_encrypt=None, enabled=None, health_check_type=None, health_reporting=None, id=None, ip_anchored=None, is_cname_enabled=None, name=None, passive_health_enabled=None, segment_group_id=None, segment_group_name=None, server_groups=None, sra_apps=None, tcp_port_ranges=None, udp_port_ranges=None):
if bypass_type and not isinstance(bypass_type, str):
raise TypeError("Expected argument 'bypass_type' to be a str")
pulumi.set(__self__, "bypass_type", bypass_type)
if config_space and not isinstance(config_space, str):
raise TypeError("Expected argument 'config_space' to be a str")
pulumi.set(__self__, "config_space", config_space)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if domain_names and not isinstance(domain_names, list):
raise TypeError("Expected argument 'domain_names' to be a list")
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt and not isinstance(double_encrypt, bool):
raise TypeError("Expected argument 'double_encrypt' to be a bool")
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if health_check_type and not isinstance(health_check_type, str):
raise TypeError("Expected argument 'health_check_type' to be a str")
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting and not isinstance(health_reporting, str):
raise TypeError("Expected argument 'health_reporting' to be a str")
pulumi.set(__self__, "health_reporting", health_reporting)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if ip_anchored and not isinstance(ip_anchored, bool):
raise TypeError("Expected argument 'ip_anchored' to be a bool")
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled and not isinstance(is_cname_enabled, bool):
raise TypeError("Expected argument 'is_cname_enabled' to be a bool")
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if passive_health_enabled and not isinstance(passive_health_enabled, bool):
raise TypeError("Expected argument 'passive_health_enabled' to be a bool")
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id and not isinstance(segment_group_id, str):
raise TypeError("Expected argument 'segment_group_id' to be a str")
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name and not isinstance(segment_group_name, str):
raise TypeError("Expected argument 'segment_group_name' to be a str")
pulumi.set(__self__, "segment_group_name", segment_group_name)
if server_groups and not isinstance(server_groups, list):
raise TypeError("Expected argument 'server_groups' to be a list")
pulumi.set(__self__, "server_groups", server_groups)
if sra_apps and not isinstance(sra_apps, list):
raise TypeError("Expected argument 'sra_apps' to be a list")
pulumi.set(__self__, "sra_apps", sra_apps)
if tcp_port_ranges and not isinstance(tcp_port_ranges, list):
raise TypeError("Expected argument 'tcp_port_ranges' to be a list")
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges and not isinstance(udp_port_ranges, list):
raise TypeError("Expected argument 'udp_port_ranges' to be a list")
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> str:
"""
(string) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Sequence[str]:
"""
(string) List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> bool:
"""
(bool) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) Whether this application is enabled or not
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> str:
"""
(string)
"""
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> str:
"""
(string) Whether health reporting for the app is Continuous or On Access. Supported values: NONE, ON_ACCESS, CONTINUOUS.
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> bool:
"""
(bool) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> str:
"""
(String) Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> str:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Sequence['outputs.GetApplicationSegmentPRAServerGroupResult']:
"""
(string) List of Server Group IDs
* `id:` - (string) List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="sraApps")
def sra_apps(self) -> Sequence['outputs.GetApplicationSegmentPRASraAppResult']:
"""
(string) TCP port ranges used to access the app.
* `app_id:` - (string)
* `name:` - (string) Name of the Privileged Remote Access
* `description:` - (string) Description of the Privileged Remote Access
* `domain:` - (string) Domain name of the Privileged Remote Access
"""
return pulumi.get(self, "sra_apps")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Sequence[str]:
"""
(string) TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Sequence[str]:
"""
(string) UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
class AwaitableGetApplicationSegmentPRAResult(GetApplicationSegmentPRAResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetApplicationSegmentPRAResult(
bypass_type=self.bypass_type,
config_space=self.config_space,
description=self.description,
domain_names=self.domain_names,
double_encrypt=self.double_encrypt,
enabled=self.enabled,
health_check_type=self.health_check_type,
health_reporting=self.health_reporting,
id=self.id,
ip_anchored=self.ip_anchored,
is_cname_enabled=self.is_cname_enabled,
name=self.name,
passive_health_enabled=self.passive_health_enabled,
segment_group_id=self.segment_group_id,
segment_group_name=self.segment_group_name,
server_groups=self.server_groups,
sra_apps=self.sra_apps,
tcp_port_ranges=self.tcp_port_ranges,
udp_port_ranges=self.udp_port_ranges)
def get_application_segment_pra(id: Optional[str] = None,
name: Optional[str] = None,
tcp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentPRATcpPortRangeArgs']]] = None,
udp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentPRAUdpPortRangeArgs']]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetApplicationSegmentPRAResult:
"""
Use the **zpa_application_segment_pra** data source to get information about an application segment for Privileged Remote Access in the Zscaler Private Access cloud. This resource can then be referenced in an access policy rule, access policy timeout rule, access policy client forwarding rule and inspection policy. This resource supports Privileged Remote Access for both `RDP` and `SSH`.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_pra(name="PRA_Example")
```
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_pra(id="123456789")
```
:param str name: The name of the PRA Application Segment to be exported.
:param Sequence[pulumi.InputType['GetApplicationSegmentPRATcpPortRangeArgs']] tcp_port_ranges: (string) TCP port ranges used to access the app.
* `from:`
* `to:`
:param Sequence[pulumi.InputType['GetApplicationSegmentPRAUdpPortRangeArgs']] udp_port_ranges: (string) UDP port ranges used to access the app.
* `from:`
* `to:`
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
__args__['tcpPortRanges'] = tcp_port_ranges
__args__['udpPortRanges'] = udp_port_ranges
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ApplicationSegment/getApplicationSegmentPRA:getApplicationSegmentPRA', __args__, opts=opts, typ=GetApplicationSegmentPRAResult).value
return AwaitableGetApplicationSegmentPRAResult(
bypass_type=__ret__.bypass_type,
config_space=__ret__.config_space,
description=__ret__.description,
domain_names=__ret__.domain_names,
double_encrypt=__ret__.double_encrypt,
enabled=__ret__.enabled,
health_check_type=__ret__.health_check_type,
health_reporting=__ret__.health_reporting,
id=__ret__.id,
ip_anchored=__ret__.ip_anchored,
is_cname_enabled=__ret__.is_cname_enabled,
name=__ret__.name,
passive_health_enabled=__ret__.passive_health_enabled,
segment_group_id=__ret__.segment_group_id,
segment_group_name=__ret__.segment_group_name,
server_groups=__ret__.server_groups,
sra_apps=__ret__.sra_apps,
tcp_port_ranges=__ret__.tcp_port_ranges,
udp_port_ranges=__ret__.udp_port_ranges)
@_utilities.lift_output_func(get_application_segment_pra)
def get_application_segment_pra_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentPRATcpPortRangeArgs']]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentPRAUdpPortRangeArgs']]]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetApplicationSegmentPRAResult]:
"""
Use the **zpa_application_segment_pra** data source to get information about an application segment for Privileged Remote Access in the Zscaler Private Access cloud. This resource can then be referenced in an access policy rule, access policy timeout rule, access policy client forwarding rule and inspection policy. This resource supports Privileged Remote Access for both `RDP` and `SSH`.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_pra(name="PRA_Example")
```
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment_pra(id="123456789")
```
:param str name: The name of the PRA Application Segment to be exported.
:param Sequence[pulumi.InputType['GetApplicationSegmentPRATcpPortRangeArgs']] tcp_port_ranges: (string) TCP port ranges used to access the app.
* `from:`
* `to:`
:param Sequence[pulumi.InputType['GetApplicationSegmentPRAUdpPortRangeArgs']] udp_port_ranges: (string) UDP port ranges used to access the app.
* `from:`
* `to:`
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/get_application_segment_pra.py | get_application_segment_pra.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['ApplicationSegmentArgs', 'ApplicationSegment']
@pulumi.input_type
class ApplicationSegmentArgs:
def __init__(__self__, *,
domain_names: pulumi.Input[Sequence[pulumi.Input[str]]],
server_groups: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]],
bypass_type: Optional[pulumi.Input[str]] = None,
config_space: Optional[pulumi.Input[str]] = None,
default_idle_timeout: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
The set of arguments for constructing a ApplicationSegment resource.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) Whether this application is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name. The name of the App Connector Group to be exported.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
pulumi.set(__self__, "domain_names", domain_names)
pulumi.set(__self__, "server_groups", server_groups)
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if default_idle_timeout is not None:
pulumi.set(__self__, "default_idle_timeout", default_idle_timeout)
if description is not None:
pulumi.set(__self__, "description", description)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id is not None:
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter(name="defaultIdleTimeout")
def default_idle_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "default_idle_timeout")
@default_idle_timeout.setter
def default_idle_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "default_idle_timeout", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether this application is enabled or not.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name. The name of the App Connector Group to be exported.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> Optional[pulumi.Input[str]]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
@pulumi.input_type
class _ApplicationSegmentState:
def __init__(__self__, *,
bypass_type: Optional[pulumi.Input[str]] = None,
config_space: Optional[pulumi.Input[str]] = None,
default_idle_timeout: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
Input properties used for looking up and filtering ApplicationSegment resources.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) Whether this application is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name. The name of the App Connector Group to be exported.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
if bypass_type is not None:
pulumi.set(__self__, "bypass_type", bypass_type)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if default_idle_timeout is not None:
pulumi.set(__self__, "default_idle_timeout", default_idle_timeout)
if description is not None:
pulumi.set(__self__, "description", description)
if domain_names is not None:
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt is not None:
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if health_check_type is not None:
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting is not None:
pulumi.set(__self__, "health_reporting", health_reporting)
if icmp_access_type is not None:
pulumi.set(__self__, "icmp_access_type", icmp_access_type)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled is not None:
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if name is not None:
pulumi.set(__self__, "name", name)
if passive_health_enabled is not None:
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id is not None:
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name is not None:
pulumi.set(__self__, "segment_group_name", segment_group_name)
if server_groups is not None:
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges is not None:
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges is not None:
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@bypass_type.setter
def bypass_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "bypass_type", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter(name="defaultIdleTimeout")
def default_idle_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "default_idle_timeout")
@default_idle_timeout.setter
def default_idle_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "default_idle_timeout", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@domain_names.setter
def domain_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "domain_names", value)
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@double_encrypt.setter
def double_encrypt(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "double_encrypt", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Whether this application is enabled or not.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@health_check_type.setter
def health_check_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_check_type", value)
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@health_reporting.setter
def health_reporting(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "health_reporting", value)
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@icmp_access_type.setter
def icmp_access_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "icmp_access_type", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@is_cname_enabled.setter
def is_cname_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "is_cname_enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name. The name of the App Connector Group to be exported.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@passive_health_enabled.setter
def passive_health_enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "passive_health_enabled", value)
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> Optional[pulumi.Input[str]]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@segment_group_id.setter
def segment_group_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_id", value)
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "segment_group_name")
@segment_group_name.setter
def segment_group_name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "segment_group_name", value)
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]]]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@server_groups.setter
def server_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ApplicationSegmentServerGroupArgs']]]]):
pulumi.set(self, "server_groups", value)
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@tcp_port_ranges.setter
def tcp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "tcp_port_ranges", value)
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges")
@udp_port_ranges.setter
def udp_port_ranges(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "udp_port_ranges", value)
class ApplicationSegment(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
config_space: Optional[pulumi.Input[str]] = None,
default_idle_timeout: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
"""
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Application Segment can be imported by using `<APPLICATION SEGMENT ID>` or `<APPLICATION SEGMENT NAME>` as the import ID.
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegment:ApplicationSegment example <application_segment_id>
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegment:ApplicationSegment example <application_segment_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) Whether this application is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name. The name of the App Connector Group to be exported.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: ApplicationSegmentArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Application Segment can be imported by using `<APPLICATION SEGMENT ID>` or `<APPLICATION SEGMENT NAME>` as the import ID.
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegment:ApplicationSegment example <application_segment_id>
```
or
```sh
$ pulumi import zpa:ApplicationSegment/applicationSegment:ApplicationSegment example <application_segment_name>
```
:param str resource_name: The name of the resource.
:param ApplicationSegmentArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ApplicationSegmentArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
config_space: Optional[pulumi.Input[str]] = None,
default_idle_timeout: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ApplicationSegmentArgs.__new__(ApplicationSegmentArgs)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["config_space"] = config_space
__props__.__dict__["default_idle_timeout"] = default_idle_timeout
__props__.__dict__["description"] = description
if domain_names is None and not opts.urn:
raise TypeError("Missing required property 'domain_names'")
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
if server_groups is None and not opts.urn:
raise TypeError("Missing required property 'server_groups'")
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
super(ApplicationSegment, __self__).__init__(
'zpa:ApplicationSegment/applicationSegment:ApplicationSegment',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
bypass_type: Optional[pulumi.Input[str]] = None,
config_space: Optional[pulumi.Input[str]] = None,
default_idle_timeout: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
domain_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
double_encrypt: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
health_check_type: Optional[pulumi.Input[str]] = None,
health_reporting: Optional[pulumi.Input[str]] = None,
icmp_access_type: Optional[pulumi.Input[str]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
is_cname_enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
passive_health_enabled: Optional[pulumi.Input[bool]] = None,
segment_group_id: Optional[pulumi.Input[str]] = None,
segment_group_name: Optional[pulumi.Input[str]] = None,
server_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentServerGroupArgs']]]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None) -> 'ApplicationSegment':
"""
Get an existing ApplicationSegment resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] bypass_type: (Optional) Indicates whether users can bypass ZPA to access applications.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) Description of the application.
:param pulumi.Input[Sequence[pulumi.Input[str]]] domain_names: List of domains and IPs.
:param pulumi.Input[bool] double_encrypt: (Optional) Whether Double Encryption is enabled or disabled for the app.
:param pulumi.Input[bool] enabled: (Optional) Whether this application is enabled or not.
:param pulumi.Input[str] health_check_type: (Optional)
:param pulumi.Input[str] health_reporting: (Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
:param pulumi.Input[str] icmp_access_type: (Optional)
:param pulumi.Input[bool] ip_anchored: (Optional)
:param pulumi.Input[bool] is_cname_enabled: (Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
:param pulumi.Input[str] name: Name. The name of the App Connector Group to be exported.
:param pulumi.Input[bool] passive_health_enabled: (Optional)
:param pulumi.Input[str] segment_group_id: List of Segment Group IDs
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ApplicationSegmentServerGroupArgs']]]] server_groups: List of Server Group IDs
:param pulumi.Input[Sequence[pulumi.Input[str]]] tcp_port_ranges: TCP port ranges used to access the app.
:param pulumi.Input[Sequence[pulumi.Input[str]]] udp_port_ranges: UDP port ranges used to access the app.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ApplicationSegmentState.__new__(_ApplicationSegmentState)
__props__.__dict__["bypass_type"] = bypass_type
__props__.__dict__["config_space"] = config_space
__props__.__dict__["default_idle_timeout"] = default_idle_timeout
__props__.__dict__["description"] = description
__props__.__dict__["domain_names"] = domain_names
__props__.__dict__["double_encrypt"] = double_encrypt
__props__.__dict__["enabled"] = enabled
__props__.__dict__["health_check_type"] = health_check_type
__props__.__dict__["health_reporting"] = health_reporting
__props__.__dict__["icmp_access_type"] = icmp_access_type
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["is_cname_enabled"] = is_cname_enabled
__props__.__dict__["name"] = name
__props__.__dict__["passive_health_enabled"] = passive_health_enabled
__props__.__dict__["segment_group_id"] = segment_group_id
__props__.__dict__["segment_group_name"] = segment_group_name
__props__.__dict__["server_groups"] = server_groups
__props__.__dict__["tcp_port_ranges"] = tcp_port_ranges
__props__.__dict__["udp_port_ranges"] = udp_port_ranges
return ApplicationSegment(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> pulumi.Output[str]:
"""
(Optional) Indicates whether users can bypass ZPA to access applications.
"""
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="defaultIdleTimeout")
def default_idle_timeout(self) -> pulumi.Output[str]:
return pulumi.get(self, "default_idle_timeout")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Description of the application.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> pulumi.Output[Sequence[str]]:
"""
List of domains and IPs.
"""
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) Whether Double Encryption is enabled or disabled for the app.
"""
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) Whether this application is enabled or not.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) Whether health reporting for the app is Continuous or On Access. Supported values: `NONE`, `ON_ACCESS`, `CONTINUOUS`.
"""
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter(name="icmpAccessType")
def icmp_access_type(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "icmp_access_type")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> pulumi.Output[bool]:
"""
(Optional) Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.
"""
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name. The name of the App Connector Group to be exported.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> pulumi.Output[bool]:
"""
(Optional)
"""
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> pulumi.Output[str]:
"""
List of Segment Group IDs
"""
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> pulumi.Output[str]:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> pulumi.Output[Sequence['outputs.ApplicationSegmentServerGroup']]:
"""
List of Server Group IDs
"""
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
TCP port ranges used to access the app.
"""
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> pulumi.Output[Sequence[str]]:
"""
UDP port ranges used to access the app.
"""
return pulumi.get(self, "udp_port_ranges") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/application_segment.py | application_segment.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = [
'GetApplicationSegmentResult',
'AwaitableGetApplicationSegmentResult',
'get_application_segment',
'get_application_segment_output',
]
@pulumi.output_type
class GetApplicationSegmentResult:
"""
A collection of values returned by getApplicationSegment.
"""
def __init__(__self__, bypass_type=None, config_space=None, creation_time=None, default_idle_timeout=None, default_max_age=None, description=None, domain_names=None, double_encrypt=None, enabled=None, health_check_type=None, health_reporting=None, id=None, ip_anchored=None, is_cname_enabled=None, modified_time=None, modifiedby=None, name=None, passive_health_enabled=None, segment_group_id=None, segment_group_name=None, select_connector_close_to_app=None, server_groups=None, tcp_port_ranges=None, udp_port_ranges=None):
if bypass_type and not isinstance(bypass_type, str):
raise TypeError("Expected argument 'bypass_type' to be a str")
pulumi.set(__self__, "bypass_type", bypass_type)
if config_space and not isinstance(config_space, str):
raise TypeError("Expected argument 'config_space' to be a str")
pulumi.set(__self__, "config_space", config_space)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if default_idle_timeout and not isinstance(default_idle_timeout, str):
raise TypeError("Expected argument 'default_idle_timeout' to be a str")
pulumi.set(__self__, "default_idle_timeout", default_idle_timeout)
if default_max_age and not isinstance(default_max_age, str):
raise TypeError("Expected argument 'default_max_age' to be a str")
pulumi.set(__self__, "default_max_age", default_max_age)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if domain_names and not isinstance(domain_names, list):
raise TypeError("Expected argument 'domain_names' to be a list")
pulumi.set(__self__, "domain_names", domain_names)
if double_encrypt and not isinstance(double_encrypt, bool):
raise TypeError("Expected argument 'double_encrypt' to be a bool")
pulumi.set(__self__, "double_encrypt", double_encrypt)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if health_check_type and not isinstance(health_check_type, str):
raise TypeError("Expected argument 'health_check_type' to be a str")
pulumi.set(__self__, "health_check_type", health_check_type)
if health_reporting and not isinstance(health_reporting, str):
raise TypeError("Expected argument 'health_reporting' to be a str")
pulumi.set(__self__, "health_reporting", health_reporting)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if ip_anchored and not isinstance(ip_anchored, bool):
raise TypeError("Expected argument 'ip_anchored' to be a bool")
pulumi.set(__self__, "ip_anchored", ip_anchored)
if is_cname_enabled and not isinstance(is_cname_enabled, bool):
raise TypeError("Expected argument 'is_cname_enabled' to be a bool")
pulumi.set(__self__, "is_cname_enabled", is_cname_enabled)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if passive_health_enabled and not isinstance(passive_health_enabled, bool):
raise TypeError("Expected argument 'passive_health_enabled' to be a bool")
pulumi.set(__self__, "passive_health_enabled", passive_health_enabled)
if segment_group_id and not isinstance(segment_group_id, str):
raise TypeError("Expected argument 'segment_group_id' to be a str")
pulumi.set(__self__, "segment_group_id", segment_group_id)
if segment_group_name and not isinstance(segment_group_name, str):
raise TypeError("Expected argument 'segment_group_name' to be a str")
pulumi.set(__self__, "segment_group_name", segment_group_name)
if select_connector_close_to_app and not isinstance(select_connector_close_to_app, bool):
raise TypeError("Expected argument 'select_connector_close_to_app' to be a bool")
pulumi.set(__self__, "select_connector_close_to_app", select_connector_close_to_app)
if server_groups and not isinstance(server_groups, list):
raise TypeError("Expected argument 'server_groups' to be a list")
pulumi.set(__self__, "server_groups", server_groups)
if tcp_port_ranges and not isinstance(tcp_port_ranges, list):
raise TypeError("Expected argument 'tcp_port_ranges' to be a list")
pulumi.set(__self__, "tcp_port_ranges", tcp_port_ranges)
if udp_port_ranges and not isinstance(udp_port_ranges, list):
raise TypeError("Expected argument 'udp_port_ranges' to be a list")
pulumi.set(__self__, "udp_port_ranges", udp_port_ranges)
@property
@pulumi.getter(name="bypassType")
def bypass_type(self) -> str:
return pulumi.get(self, "bypass_type")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter(name="defaultIdleTimeout")
def default_idle_timeout(self) -> str:
return pulumi.get(self, "default_idle_timeout")
@property
@pulumi.getter(name="defaultMaxAge")
def default_max_age(self) -> str:
return pulumi.get(self, "default_max_age")
@property
@pulumi.getter
def description(self) -> str:
return pulumi.get(self, "description")
@property
@pulumi.getter(name="domainNames")
def domain_names(self) -> Sequence[str]:
return pulumi.get(self, "domain_names")
@property
@pulumi.getter(name="doubleEncrypt")
def double_encrypt(self) -> bool:
return pulumi.get(self, "double_encrypt")
@property
@pulumi.getter
def enabled(self) -> bool:
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="healthCheckType")
def health_check_type(self) -> str:
return pulumi.get(self, "health_check_type")
@property
@pulumi.getter(name="healthReporting")
def health_reporting(self) -> str:
return pulumi.get(self, "health_reporting")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> bool:
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="isCnameEnabled")
def is_cname_enabled(self) -> bool:
return pulumi.get(self, "is_cname_enabled")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter(name="passiveHealthEnabled")
def passive_health_enabled(self) -> bool:
return pulumi.get(self, "passive_health_enabled")
@property
@pulumi.getter(name="segmentGroupId")
def segment_group_id(self) -> str:
return pulumi.get(self, "segment_group_id")
@property
@pulumi.getter(name="segmentGroupName")
def segment_group_name(self) -> str:
return pulumi.get(self, "segment_group_name")
@property
@pulumi.getter(name="selectConnectorCloseToApp")
def select_connector_close_to_app(self) -> bool:
return pulumi.get(self, "select_connector_close_to_app")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Sequence['outputs.GetApplicationSegmentServerGroupResult']:
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="tcpPortRanges")
def tcp_port_ranges(self) -> Sequence[str]:
return pulumi.get(self, "tcp_port_ranges")
@property
@pulumi.getter(name="udpPortRanges")
def udp_port_ranges(self) -> Sequence[str]:
return pulumi.get(self, "udp_port_ranges")
class AwaitableGetApplicationSegmentResult(GetApplicationSegmentResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetApplicationSegmentResult(
bypass_type=self.bypass_type,
config_space=self.config_space,
creation_time=self.creation_time,
default_idle_timeout=self.default_idle_timeout,
default_max_age=self.default_max_age,
description=self.description,
domain_names=self.domain_names,
double_encrypt=self.double_encrypt,
enabled=self.enabled,
health_check_type=self.health_check_type,
health_reporting=self.health_reporting,
id=self.id,
ip_anchored=self.ip_anchored,
is_cname_enabled=self.is_cname_enabled,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
passive_health_enabled=self.passive_health_enabled,
segment_group_id=self.segment_group_id,
segment_group_name=self.segment_group_name,
select_connector_close_to_app=self.select_connector_close_to_app,
server_groups=self.server_groups,
tcp_port_ranges=self.tcp_port_ranges,
udp_port_ranges=self.udp_port_ranges)
def get_application_segment(id: Optional[str] = None,
name: Optional[str] = None,
tcp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentTcpPortRangeArgs']]] = None,
udp_port_ranges: Optional[Sequence[pulumi.InputType['GetApplicationSegmentUdpPortRangeArgs']]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetApplicationSegmentResult:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment(name="example")
```
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment(id="123456789")
```
:param str name: Name of the application.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
__args__['tcpPortRanges'] = tcp_port_ranges
__args__['udpPortRanges'] = udp_port_ranges
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ApplicationSegment/getApplicationSegment:getApplicationSegment', __args__, opts=opts, typ=GetApplicationSegmentResult).value
return AwaitableGetApplicationSegmentResult(
bypass_type=__ret__.bypass_type,
config_space=__ret__.config_space,
creation_time=__ret__.creation_time,
default_idle_timeout=__ret__.default_idle_timeout,
default_max_age=__ret__.default_max_age,
description=__ret__.description,
domain_names=__ret__.domain_names,
double_encrypt=__ret__.double_encrypt,
enabled=__ret__.enabled,
health_check_type=__ret__.health_check_type,
health_reporting=__ret__.health_reporting,
id=__ret__.id,
ip_anchored=__ret__.ip_anchored,
is_cname_enabled=__ret__.is_cname_enabled,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
passive_health_enabled=__ret__.passive_health_enabled,
segment_group_id=__ret__.segment_group_id,
segment_group_name=__ret__.segment_group_name,
select_connector_close_to_app=__ret__.select_connector_close_to_app,
server_groups=__ret__.server_groups,
tcp_port_ranges=__ret__.tcp_port_ranges,
udp_port_ranges=__ret__.udp_port_ranges)
@_utilities.lift_output_func(get_application_segment)
def get_application_segment_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
tcp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentTcpPortRangeArgs']]]]] = None,
udp_port_ranges: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetApplicationSegmentUdpPortRangeArgs']]]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetApplicationSegmentResult]:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment(name="example")
```
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.ApplicationSegment.get_application_segment(id="123456789")
```
:param str name: Name of the application.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationsegment/get_application_segment.py | get_application_segment.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = ['ApplicationServerArgs', 'ApplicationServer']
@pulumi.input_type
class ApplicationServerArgs:
def __init__(__self__, *,
address: pulumi.Input[str],
app_server_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a ApplicationServer resource.
:param pulumi.Input[str] address: Address. The address of the application server to be exported.
:param pulumi.Input[Sequence[pulumi.Input[str]]] app_server_group_ids: (Optional) This field defines the list of server group IDs.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) This field defines the description of the server.
:param pulumi.Input[bool] enabled: (Optional) This field defines the status of the server.
:param pulumi.Input[str] name: Name. The name of the application server to be exported.
"""
pulumi.set(__self__, "address", address)
if app_server_group_ids is not None:
pulumi.set(__self__, "app_server_group_ids", app_server_group_ids)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def address(self) -> pulumi.Input[str]:
"""
Address. The address of the application server to be exported.
"""
return pulumi.get(self, "address")
@address.setter
def address(self, value: pulumi.Input[str]):
pulumi.set(self, "address", value)
@property
@pulumi.getter(name="appServerGroupIds")
def app_server_group_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
(Optional) This field defines the list of server group IDs.
"""
return pulumi.get(self, "app_server_group_ids")
@app_server_group_ids.setter
def app_server_group_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "app_server_group_ids", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) This field defines the description of the server.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) This field defines the status of the server.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name. The name of the application server to be exported.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class _ApplicationServerState:
def __init__(__self__, *,
address: Optional[pulumi.Input[str]] = None,
app_server_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering ApplicationServer resources.
:param pulumi.Input[str] address: Address. The address of the application server to be exported.
:param pulumi.Input[Sequence[pulumi.Input[str]]] app_server_group_ids: (Optional) This field defines the list of server group IDs.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) This field defines the description of the server.
:param pulumi.Input[bool] enabled: (Optional) This field defines the status of the server.
:param pulumi.Input[str] name: Name. The name of the application server to be exported.
"""
if address is not None:
pulumi.set(__self__, "address", address)
if app_server_group_ids is not None:
pulumi.set(__self__, "app_server_group_ids", app_server_group_ids)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def address(self) -> Optional[pulumi.Input[str]]:
"""
Address. The address of the application server to be exported.
"""
return pulumi.get(self, "address")
@address.setter
def address(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "address", value)
@property
@pulumi.getter(name="appServerGroupIds")
def app_server_group_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
(Optional) This field defines the list of server group IDs.
"""
return pulumi.get(self, "app_server_group_ids")
@app_server_group_ids.setter
def app_server_group_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "app_server_group_ids", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) This field defines the description of the server.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) This field defines the status of the server.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
Name. The name of the application server to be exported.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
class ApplicationServer(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
address: Optional[pulumi.Input[str]] = None,
app_server_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Application Server can be imported by using `<APPLICATION SERVER ID>` or `<APPLICATION SERVER NAME>` as the import ID For example
```sh
$ pulumi import zpa:ApplicationServer/applicationServer:ApplicationServer example <application_server_id>
```
or
```sh
$ pulumi import zpa:ApplicationServer/applicationServer:ApplicationServer example <application_server_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] address: Address. The address of the application server to be exported.
:param pulumi.Input[Sequence[pulumi.Input[str]]] app_server_group_ids: (Optional) This field defines the list of server group IDs.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) This field defines the description of the server.
:param pulumi.Input[bool] enabled: (Optional) This field defines the status of the server.
:param pulumi.Input[str] name: Name. The name of the application server to be exported.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: ApplicationServerArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Application Server can be imported by using `<APPLICATION SERVER ID>` or `<APPLICATION SERVER NAME>` as the import ID For example
```sh
$ pulumi import zpa:ApplicationServer/applicationServer:ApplicationServer example <application_server_id>
```
or
```sh
$ pulumi import zpa:ApplicationServer/applicationServer:ApplicationServer example <application_server_name>
```
:param str resource_name: The name of the resource.
:param ApplicationServerArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ApplicationServerArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
address: Optional[pulumi.Input[str]] = None,
app_server_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ApplicationServerArgs.__new__(ApplicationServerArgs)
if address is None and not opts.urn:
raise TypeError("Missing required property 'address'")
__props__.__dict__["address"] = address
__props__.__dict__["app_server_group_ids"] = app_server_group_ids
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["enabled"] = enabled
__props__.__dict__["name"] = name
super(ApplicationServer, __self__).__init__(
'zpa:ApplicationServer/applicationServer:ApplicationServer',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
address: Optional[pulumi.Input[str]] = None,
app_server_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None) -> 'ApplicationServer':
"""
Get an existing ApplicationServer resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] address: Address. The address of the application server to be exported.
:param pulumi.Input[Sequence[pulumi.Input[str]]] app_server_group_ids: (Optional) This field defines the list of server group IDs.
:param pulumi.Input[str] config_space: (Optional)
:param pulumi.Input[str] description: (Optional) This field defines the description of the server.
:param pulumi.Input[bool] enabled: (Optional) This field defines the status of the server.
:param pulumi.Input[str] name: Name. The name of the application server to be exported.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ApplicationServerState.__new__(_ApplicationServerState)
__props__.__dict__["address"] = address
__props__.__dict__["app_server_group_ids"] = app_server_group_ids
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["enabled"] = enabled
__props__.__dict__["name"] = name
return ApplicationServer(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def address(self) -> pulumi.Output[str]:
"""
Address. The address of the application server to be exported.
"""
return pulumi.get(self, "address")
@property
@pulumi.getter(name="appServerGroupIds")
def app_server_group_ids(self) -> pulumi.Output[Sequence[str]]:
"""
(Optional) This field defines the list of server group IDs.
"""
return pulumi.get(self, "app_server_group_ids")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
"""
(Optional)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> pulumi.Output[str]:
"""
(Optional) This field defines the description of the server.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[bool]:
"""
(Optional) This field defines the status of the server.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
Name. The name of the application server to be exported.
"""
return pulumi.get(self, "name") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationserver/application_server.py | application_server.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetApplicationServerResult',
'AwaitableGetApplicationServerResult',
'get_application_server',
'get_application_server_output',
]
@pulumi.output_type
class GetApplicationServerResult:
"""
A collection of values returned by getApplicationServer.
"""
def __init__(__self__, address=None, app_server_group_ids=None, config_space=None, creation_time=None, description=None, enabled=None, id=None, modified_time=None, modifiedby=None, name=None):
if address and not isinstance(address, str):
raise TypeError("Expected argument 'address' to be a str")
pulumi.set(__self__, "address", address)
if app_server_group_ids and not isinstance(app_server_group_ids, list):
raise TypeError("Expected argument 'app_server_group_ids' to be a list")
pulumi.set(__self__, "app_server_group_ids", app_server_group_ids)
if config_space and not isinstance(config_space, str):
raise TypeError("Expected argument 'config_space' to be a str")
pulumi.set(__self__, "config_space", config_space)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def address(self) -> str:
"""
(string) This field defines the domain or IP address of the server.
"""
return pulumi.get(self, "address")
@property
@pulumi.getter(name="appServerGroupIds")
def app_server_group_ids(self) -> Sequence[str]:
"""
(Set of String) This field defines the list of server groups IDs.
"""
return pulumi.get(self, "app_server_group_ids")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) This field defines the description of the server.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) This field defines the status of the server.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
class AwaitableGetApplicationServerResult(GetApplicationServerResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetApplicationServerResult(
address=self.address,
app_server_group_ids=self.app_server_group_ids,
config_space=self.config_space,
creation_time=self.creation_time,
description=self.description,
enabled=self.enabled,
id=self.id,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name)
def get_application_server(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetApplicationServerResult:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationServer.get_application_server(name="server.example.com")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationServer.get_application_server(id="1234567890")
```
:param str id: This field defines the id of the application server.
:param str name: This field defines the name of the server.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ApplicationServer/getApplicationServer:getApplicationServer', __args__, opts=opts, typ=GetApplicationServerResult).value
return AwaitableGetApplicationServerResult(
address=__ret__.address,
app_server_group_ids=__ret__.app_server_group_ids,
config_space=__ret__.config_space,
creation_time=__ret__.creation_time,
description=__ret__.description,
enabled=__ret__.enabled,
id=__ret__.id,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name)
@_utilities.lift_output_func(get_application_server)
def get_application_server_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetApplicationServerResult]:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationServer.get_application_server(name="server.example.com")
```
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ApplicationServer.get_application_server(id="1234567890")
```
:param str id: This field defines the id of the application server.
:param str name: This field defines the name of the server.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/applicationserver/get_application_server.py | get_application_server.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetCloudConnectorGroupCloudConnectorResult',
]
@pulumi.output_type
class GetCloudConnectorGroupCloudConnectorResult(dict):
def __init__(__self__, *,
creation_time: str,
description: str,
enabled: bool,
fingerprint: str,
id: str,
ipacls: Sequence[Any],
issued_cert_id: str,
modified_time: str,
modifiedby: str,
name: str,
signing_cert: Mapping[str, Any]):
"""
:param str creation_time: (string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
:param str description: (string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
:param bool enabled: (bool) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
:param str id: This field defines the id of the cloud connector group.
:param str issued_cert_id: (string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
:param str modified_time: (string)- Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
:param str name: This field defines the name of the cloud connector group.
"""
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "fingerprint", fingerprint)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "ipacls", ipacls)
pulumi.set(__self__, "issued_cert_id", issued_cert_id)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "signing_cert", signing_cert)
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def fingerprint(self) -> str:
return pulumi.get(self, "fingerprint")
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the id of the cloud connector group.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def ipacls(self) -> Sequence[Any]:
return pulumi.get(self, "ipacls")
@property
@pulumi.getter(name="issuedCertId")
def issued_cert_id(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "issued_cert_id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)- Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
This field defines the name of the cloud connector group.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="signingCert")
def signing_cert(self) -> Mapping[str, Any]:
return pulumi.get(self, "signing_cert") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/cloudconnectorgroup/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetCloudConnectorGroupResult',
'AwaitableGetCloudConnectorGroupResult',
'get_cloud_connector_group',
'get_cloud_connector_group_output',
]
@pulumi.output_type
class GetCloudConnectorGroupResult:
"""
A collection of values returned by getCloudConnectorGroup.
"""
def __init__(__self__, cloud_connectors=None, creation_time=None, description=None, enabled=None, geolocation_id=None, id=None, modified_time=None, modifiedby=None, name=None, zia_cloud=None, zia_org_id=None):
if cloud_connectors and not isinstance(cloud_connectors, list):
raise TypeError("Expected argument 'cloud_connectors' to be a list")
pulumi.set(__self__, "cloud_connectors", cloud_connectors)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if geolocation_id and not isinstance(geolocation_id, str):
raise TypeError("Expected argument 'geolocation_id' to be a str")
pulumi.set(__self__, "geolocation_id", geolocation_id)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if zia_cloud and not isinstance(zia_cloud, str):
raise TypeError("Expected argument 'zia_cloud' to be a str")
pulumi.set(__self__, "zia_cloud", zia_cloud)
if zia_org_id and not isinstance(zia_org_id, str):
raise TypeError("Expected argument 'zia_org_id' to be a str")
pulumi.set(__self__, "zia_org_id", zia_org_id)
@property
@pulumi.getter(name="cloudConnectors")
def cloud_connectors(self) -> Sequence['outputs.GetCloudConnectorGroupCloudConnectorResult']:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "cloud_connectors")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="geolocationId")
def geolocation_id(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "geolocation_id")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)- Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
(string) - This field defines the name of the cloud connector group.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="ziaCloud")
def zia_cloud(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "zia_cloud")
@property
@pulumi.getter(name="ziaOrgId")
def zia_org_id(self) -> str:
"""
(string) - Only applicable for a GET request. Ignored in PUT/POST/DELETE requests.
"""
return pulumi.get(self, "zia_org_id")
class AwaitableGetCloudConnectorGroupResult(GetCloudConnectorGroupResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetCloudConnectorGroupResult(
cloud_connectors=self.cloud_connectors,
creation_time=self.creation_time,
description=self.description,
enabled=self.enabled,
geolocation_id=self.geolocation_id,
id=self.id,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
zia_cloud=self.zia_cloud,
zia_org_id=self.zia_org_id)
def get_cloud_connector_group(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCloudConnectorGroupResult:
"""
Use the **zpa_cloud_connector_group** data source to get information about a cloud connector group created from the Zscaler Private Access cloud. This data source can then be referenced within an Access Policy rule
> **NOTE:** A Cloud Connector Group resource is created in the Zscaler Cloud Connector cloud and replicated to the ZPA cloud. This resource can then be referenced in a Access Policy Rule where the Object Type = `CLOUD_CONNECTOR_GROUP` is being used.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.CloudConnectorGroup.get_cloud_connector_group(name="AWS-Cloud")
```
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.CloudConnectorGroup.get_cloud_connector_group(id="1234567890")
```
:param str id: This field defines the id of the cloud connector group.
:param str name: This field defines the name of the cloud connector group.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:CloudConnectorGroup/getCloudConnectorGroup:getCloudConnectorGroup', __args__, opts=opts, typ=GetCloudConnectorGroupResult).value
return AwaitableGetCloudConnectorGroupResult(
cloud_connectors=__ret__.cloud_connectors,
creation_time=__ret__.creation_time,
description=__ret__.description,
enabled=__ret__.enabled,
geolocation_id=__ret__.geolocation_id,
id=__ret__.id,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
zia_cloud=__ret__.zia_cloud,
zia_org_id=__ret__.zia_org_id)
@_utilities.lift_output_func(get_cloud_connector_group)
def get_cloud_connector_group_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetCloudConnectorGroupResult]:
"""
Use the **zpa_cloud_connector_group** data source to get information about a cloud connector group created from the Zscaler Private Access cloud. This data source can then be referenced within an Access Policy rule
> **NOTE:** A Cloud Connector Group resource is created in the Zscaler Cloud Connector cloud and replicated to the ZPA cloud. This resource can then be referenced in a Access Policy Rule where the Object Type = `CLOUD_CONNECTOR_GROUP` is being used.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.CloudConnectorGroup.get_cloud_connector_group(name="AWS-Cloud")
```
```python
import pulumi
import pulumi_zpa as zpa
foo = zpa.CloudConnectorGroup.get_cloud_connector_group(id="1234567890")
```
:param str id: This field defines the id of the cloud connector group.
:param str name: This field defines the name of the cloud connector group.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/cloudconnectorgroup/get_cloud_connector_group.py | get_cloud_connector_group.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'PolicyAccessTimeOutRuleConditionArgs',
'PolicyAccessTimeOutRuleConditionOperandArgs',
]
@pulumi.input_type
class PolicyAccessTimeOutRuleConditionArgs:
def __init__(__self__, *,
operator: pulumi.Input[str],
id: Optional[pulumi.Input[str]] = None,
negated: Optional[pulumi.Input[bool]] = None,
operands: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionOperandArgs']]]] = None):
pulumi.set(__self__, "operator", operator)
if id is not None:
pulumi.set(__self__, "id", id)
if negated is not None:
pulumi.set(__self__, "negated", negated)
if operands is not None:
pulumi.set(__self__, "operands", operands)
@property
@pulumi.getter
def operator(self) -> pulumi.Input[str]:
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: pulumi.Input[str]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter
def negated(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "negated")
@negated.setter
def negated(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "negated", value)
@property
@pulumi.getter
def operands(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionOperandArgs']]]]:
return pulumi.get(self, "operands")
@operands.setter
def operands(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionOperandArgs']]]]):
pulumi.set(self, "operands", value)
@pulumi.input_type
class PolicyAccessTimeOutRuleConditionOperandArgs:
def __init__(__self__, *,
lhs: pulumi.Input[str],
object_type: pulumi.Input[str],
id: Optional[pulumi.Input[str]] = None,
idp_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
rhs: Optional[pulumi.Input[str]] = None,
rhs_lists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
pulumi.set(__self__, "lhs", lhs)
pulumi.set(__self__, "object_type", object_type)
if id is not None:
pulumi.set(__self__, "id", id)
if idp_id is not None:
pulumi.set(__self__, "idp_id", idp_id)
if name is not None:
pulumi.set(__self__, "name", name)
if rhs is not None:
pulumi.set(__self__, "rhs", rhs)
if rhs_lists is not None:
pulumi.set(__self__, "rhs_lists", rhs_lists)
@property
@pulumi.getter
def lhs(self) -> pulumi.Input[str]:
return pulumi.get(self, "lhs")
@lhs.setter
def lhs(self, value: pulumi.Input[str]):
pulumi.set(self, "lhs", value)
@property
@pulumi.getter(name="objectType")
def object_type(self) -> pulumi.Input[str]:
return pulumi.get(self, "object_type")
@object_type.setter
def object_type(self, value: pulumi.Input[str]):
pulumi.set(self, "object_type", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "idp_id")
@idp_id.setter
def idp_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "idp_id", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def rhs(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "rhs")
@rhs.setter
def rhs(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "rhs", value)
@property
@pulumi.getter(name="rhsLists")
def rhs_lists(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
return pulumi.get(self, "rhs_lists")
@rhs_lists.setter
def rhs_lists(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "rhs_lists", value) | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/timeoutpolicy/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['PolicyAccessTimeOutRuleArgs', 'PolicyAccessTimeOutRule']
@pulumi.input_type
class PolicyAccessTimeOutRuleArgs:
def __init__(__self__, *,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a PolicyAccessTimeOutRule resource.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
if action is not None:
pulumi.set(__self__, "action", action)
if action_id is not None:
pulumi.set(__self__, "action_id", action_id)
if bypass_default_rule is not None:
pulumi.set(__self__, "bypass_default_rule", bypass_default_rule)
if conditions is not None:
pulumi.set(__self__, "conditions", conditions)
if custom_msg is not None:
pulumi.set(__self__, "custom_msg", custom_msg)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if description is not None:
pulumi.set(__self__, "description", description)
if lss_default_rule is not None:
pulumi.set(__self__, "lss_default_rule", lss_default_rule)
if name is not None:
pulumi.set(__self__, "name", name)
if operator is not None:
pulumi.set(__self__, "operator", operator)
if policy_set_id is not None:
pulumi.set(__self__, "policy_set_id", policy_set_id)
if policy_type is not None:
pulumi.set(__self__, "policy_type", policy_type)
if priority is not None:
pulumi.set(__self__, "priority", priority)
if reauth_default_rule is not None:
pulumi.set(__self__, "reauth_default_rule", reauth_default_rule)
if reauth_idle_timeout is not None:
pulumi.set(__self__, "reauth_idle_timeout", reauth_idle_timeout)
if reauth_timeout is not None:
pulumi.set(__self__, "reauth_timeout", reauth_timeout)
if rule_order is not None:
pulumi.set(__self__, "rule_order", rule_order)
if zpn_inspection_profile_id is not None:
pulumi.set(__self__, "zpn_inspection_profile_id", zpn_inspection_profile_id)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing the rule action.
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="actionId")
def action_id(self) -> Optional[pulumi.Input[str]]:
"""
This field defines the description of the server.
"""
return pulumi.get(self, "action_id")
@action_id.setter
def action_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action_id", value)
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "bypass_default_rule")
@bypass_default_rule.setter
def bypass_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "bypass_default_rule", value)
@property
@pulumi.getter
def conditions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]]]:
"""
This is for proviidng the set of conditions for the policy.
"""
return pulumi.get(self, "conditions")
@conditions.setter
def conditions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]]]):
pulumi.set(self, "conditions", value)
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "custom_msg")
@custom_msg.setter
def custom_msg(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "custom_msg", value)
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[pulumi.Input[bool]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "default_rule")
@default_rule.setter
def default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "default_rule", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
This is the description of the access policy.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "lss_default_rule")
@lss_default_rule.setter
def lss_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "lss_default_rule", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
This is the name of the policy.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def operator(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_set_id")
@policy_set_id.setter
def policy_set_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_set_id", value)
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_type")
@policy_type.setter
def policy_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_type", value)
@property
@pulumi.getter
def priority(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "priority")
@priority.setter
def priority(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "priority", value)
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "reauth_default_rule")
@reauth_default_rule.setter
def reauth_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "reauth_default_rule", value)
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_idle_timeout")
@reauth_idle_timeout.setter
def reauth_idle_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_idle_timeout", value)
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_timeout")
@reauth_timeout.setter
def reauth_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_timeout", value)
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "rule_order")
@rule_order.setter
def rule_order(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "rule_order", value)
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "zpn_inspection_profile_id")
@zpn_inspection_profile_id.setter
def zpn_inspection_profile_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpn_inspection_profile_id", value)
@pulumi.input_type
class _PolicyAccessTimeOutRuleState:
def __init__(__self__, *,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering PolicyAccessTimeOutRule resources.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
if action is not None:
pulumi.set(__self__, "action", action)
if action_id is not None:
pulumi.set(__self__, "action_id", action_id)
if bypass_default_rule is not None:
pulumi.set(__self__, "bypass_default_rule", bypass_default_rule)
if conditions is not None:
pulumi.set(__self__, "conditions", conditions)
if custom_msg is not None:
pulumi.set(__self__, "custom_msg", custom_msg)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if description is not None:
pulumi.set(__self__, "description", description)
if lss_default_rule is not None:
pulumi.set(__self__, "lss_default_rule", lss_default_rule)
if name is not None:
pulumi.set(__self__, "name", name)
if operator is not None:
pulumi.set(__self__, "operator", operator)
if policy_set_id is not None:
pulumi.set(__self__, "policy_set_id", policy_set_id)
if policy_type is not None:
pulumi.set(__self__, "policy_type", policy_type)
if priority is not None:
pulumi.set(__self__, "priority", priority)
if reauth_default_rule is not None:
pulumi.set(__self__, "reauth_default_rule", reauth_default_rule)
if reauth_idle_timeout is not None:
pulumi.set(__self__, "reauth_idle_timeout", reauth_idle_timeout)
if reauth_timeout is not None:
pulumi.set(__self__, "reauth_timeout", reauth_timeout)
if rule_order is not None:
pulumi.set(__self__, "rule_order", rule_order)
if zpn_inspection_profile_id is not None:
pulumi.set(__self__, "zpn_inspection_profile_id", zpn_inspection_profile_id)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing the rule action.
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="actionId")
def action_id(self) -> Optional[pulumi.Input[str]]:
"""
This field defines the description of the server.
"""
return pulumi.get(self, "action_id")
@action_id.setter
def action_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action_id", value)
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "bypass_default_rule")
@bypass_default_rule.setter
def bypass_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "bypass_default_rule", value)
@property
@pulumi.getter
def conditions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]]]:
"""
This is for proviidng the set of conditions for the policy.
"""
return pulumi.get(self, "conditions")
@conditions.setter
def conditions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['PolicyAccessTimeOutRuleConditionArgs']]]]):
pulumi.set(self, "conditions", value)
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> Optional[pulumi.Input[str]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "custom_msg")
@custom_msg.setter
def custom_msg(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "custom_msg", value)
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[pulumi.Input[bool]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "default_rule")
@default_rule.setter
def default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "default_rule", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
This is the description of the access policy.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "lss_default_rule")
@lss_default_rule.setter
def lss_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "lss_default_rule", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
This is the name of the policy.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def operator(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_set_id")
@policy_set_id.setter
def policy_set_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_set_id", value)
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_type")
@policy_type.setter
def policy_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_type", value)
@property
@pulumi.getter
def priority(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "priority")
@priority.setter
def priority(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "priority", value)
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "reauth_default_rule")
@reauth_default_rule.setter
def reauth_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "reauth_default_rule", value)
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_idle_timeout")
@reauth_idle_timeout.setter
def reauth_idle_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_idle_timeout", value)
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_timeout")
@reauth_timeout.setter
def reauth_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_timeout", value)
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "rule_order")
@rule_order.setter
def rule_order(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "rule_order", value)
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "zpn_inspection_profile_id")
@zpn_inspection_profile_id.setter
def zpn_inspection_profile_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpn_inspection_profile_id", value)
class PolicyAccessTimeOutRule(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessTimeOutRuleConditionArgs']]]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
Create a PolicyAccessTimeOutRule resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessTimeOutRuleConditionArgs']]]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[PolicyAccessTimeOutRuleArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
Create a PolicyAccessTimeOutRule resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param PolicyAccessTimeOutRuleArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(PolicyAccessTimeOutRuleArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessTimeOutRuleConditionArgs']]]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = PolicyAccessTimeOutRuleArgs.__new__(PolicyAccessTimeOutRuleArgs)
__props__.__dict__["action"] = action
__props__.__dict__["action_id"] = action_id
__props__.__dict__["bypass_default_rule"] = bypass_default_rule
__props__.__dict__["conditions"] = conditions
__props__.__dict__["custom_msg"] = custom_msg
__props__.__dict__["default_rule"] = default_rule
__props__.__dict__["description"] = description
__props__.__dict__["lss_default_rule"] = lss_default_rule
__props__.__dict__["name"] = name
__props__.__dict__["operator"] = operator
__props__.__dict__["policy_set_id"] = policy_set_id
__props__.__dict__["policy_type"] = policy_type
__props__.__dict__["priority"] = priority
__props__.__dict__["reauth_default_rule"] = reauth_default_rule
__props__.__dict__["reauth_idle_timeout"] = reauth_idle_timeout
__props__.__dict__["reauth_timeout"] = reauth_timeout
__props__.__dict__["rule_order"] = rule_order
__props__.__dict__["zpn_inspection_profile_id"] = zpn_inspection_profile_id
super(PolicyAccessTimeOutRule, __self__).__init__(
'zpa:TimeoutPolicy/policyAccessTimeOutRule:PolicyAccessTimeOutRule',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessTimeOutRuleConditionArgs']]]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None) -> 'PolicyAccessTimeOutRule':
"""
Get an existing PolicyAccessTimeOutRule resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] action: This is for providing the rule action.
:param pulumi.Input[str] action_id: This field defines the description of the server.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['PolicyAccessTimeOutRuleConditionArgs']]]] conditions: This is for proviidng the set of conditions for the policy.
:param pulumi.Input[str] custom_msg: This is for providing a customer message for the user.
:param pulumi.Input[bool] default_rule: This is for providing a customer message for the user.
:param pulumi.Input[str] description: This is the description of the access policy.
:param pulumi.Input[str] name: This is the name of the policy.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _PolicyAccessTimeOutRuleState.__new__(_PolicyAccessTimeOutRuleState)
__props__.__dict__["action"] = action
__props__.__dict__["action_id"] = action_id
__props__.__dict__["bypass_default_rule"] = bypass_default_rule
__props__.__dict__["conditions"] = conditions
__props__.__dict__["custom_msg"] = custom_msg
__props__.__dict__["default_rule"] = default_rule
__props__.__dict__["description"] = description
__props__.__dict__["lss_default_rule"] = lss_default_rule
__props__.__dict__["name"] = name
__props__.__dict__["operator"] = operator
__props__.__dict__["policy_set_id"] = policy_set_id
__props__.__dict__["policy_type"] = policy_type
__props__.__dict__["priority"] = priority
__props__.__dict__["reauth_default_rule"] = reauth_default_rule
__props__.__dict__["reauth_idle_timeout"] = reauth_idle_timeout
__props__.__dict__["reauth_timeout"] = reauth_timeout
__props__.__dict__["rule_order"] = rule_order
__props__.__dict__["zpn_inspection_profile_id"] = zpn_inspection_profile_id
return PolicyAccessTimeOutRule(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def action(self) -> pulumi.Output[Optional[str]]:
"""
This is for providing the rule action.
"""
return pulumi.get(self, "action")
@property
@pulumi.getter(name="actionId")
def action_id(self) -> pulumi.Output[Optional[str]]:
"""
This field defines the description of the server.
"""
return pulumi.get(self, "action_id")
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "bypass_default_rule")
@property
@pulumi.getter
def conditions(self) -> pulumi.Output[Sequence['outputs.PolicyAccessTimeOutRuleCondition']]:
"""
This is for proviidng the set of conditions for the policy.
"""
return pulumi.get(self, "conditions")
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> pulumi.Output[Optional[str]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "custom_msg")
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> pulumi.Output[Optional[bool]]:
"""
This is for providing a customer message for the user.
"""
return pulumi.get(self, "default_rule")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
This is the description of the access policy.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "lss_default_rule")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
This is the name of the policy.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def operator(self) -> pulumi.Output[str]:
return pulumi.get(self, "operator")
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> pulumi.Output[str]:
return pulumi.get(self, "policy_set_id")
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> pulumi.Output[str]:
return pulumi.get(self, "policy_type")
@property
@pulumi.getter
def priority(self) -> pulumi.Output[str]:
return pulumi.get(self, "priority")
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "reauth_default_rule")
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "reauth_idle_timeout")
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "reauth_timeout")
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> pulumi.Output[str]:
return pulumi.get(self, "rule_order")
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "zpn_inspection_profile_id") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/timeoutpolicy/policy_access_time_out_rule.py | policy_access_time_out_rule.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'PolicyAccessTimeOutRuleCondition',
'PolicyAccessTimeOutRuleConditionOperand',
]
@pulumi.output_type
class PolicyAccessTimeOutRuleCondition(dict):
def __init__(__self__, *,
operator: str,
id: Optional[str] = None,
negated: Optional[bool] = None,
operands: Optional[Sequence['outputs.PolicyAccessTimeOutRuleConditionOperand']] = None):
pulumi.set(__self__, "operator", operator)
if id is not None:
pulumi.set(__self__, "id", id)
if negated is not None:
pulumi.set(__self__, "negated", negated)
if operands is not None:
pulumi.set(__self__, "operands", operands)
@property
@pulumi.getter
def operator(self) -> str:
return pulumi.get(self, "operator")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter
def negated(self) -> Optional[bool]:
return pulumi.get(self, "negated")
@property
@pulumi.getter
def operands(self) -> Optional[Sequence['outputs.PolicyAccessTimeOutRuleConditionOperand']]:
return pulumi.get(self, "operands")
@pulumi.output_type
class PolicyAccessTimeOutRuleConditionOperand(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "objectType":
suggest = "object_type"
elif key == "idpId":
suggest = "idp_id"
elif key == "rhsLists":
suggest = "rhs_lists"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in PolicyAccessTimeOutRuleConditionOperand. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
PolicyAccessTimeOutRuleConditionOperand.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
PolicyAccessTimeOutRuleConditionOperand.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
lhs: str,
object_type: str,
id: Optional[str] = None,
idp_id: Optional[str] = None,
name: Optional[str] = None,
rhs: Optional[str] = None,
rhs_lists: Optional[Sequence[str]] = None):
pulumi.set(__self__, "lhs", lhs)
pulumi.set(__self__, "object_type", object_type)
if id is not None:
pulumi.set(__self__, "id", id)
if idp_id is not None:
pulumi.set(__self__, "idp_id", idp_id)
if name is not None:
pulumi.set(__self__, "name", name)
if rhs is not None:
pulumi.set(__self__, "rhs", rhs)
if rhs_lists is not None:
pulumi.set(__self__, "rhs_lists", rhs_lists)
@property
@pulumi.getter
def lhs(self) -> str:
return pulumi.get(self, "lhs")
@property
@pulumi.getter(name="objectType")
def object_type(self) -> str:
return pulumi.get(self, "object_type")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> Optional[str]:
return pulumi.get(self, "idp_id")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter
def rhs(self) -> Optional[str]:
return pulumi.get(self, "rhs")
@property
@pulumi.getter(name="rhsLists")
def rhs_lists(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "rhs_lists") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/timeoutpolicy/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'LSSConfigControllerConfigArgs',
'LSSConfigControllerConnectorGroupArgs',
'LSSConfigControllerPolicyRuleResourceArgs',
'LSSConfigControllerPolicyRuleResourceConditionArgs',
'LSSConfigControllerPolicyRuleResourceConditionOperandArgs',
'GetLSSConfigControllerConfigArgs',
]
@pulumi.input_type
class LSSConfigControllerConfigArgs:
def __init__(__self__, *,
format: pulumi.Input[str],
lss_host: pulumi.Input[str],
lss_port: pulumi.Input[str],
name: pulumi.Input[str],
source_log_type: pulumi.Input[str],
audit_message: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[str]] = None,
use_tls: Optional[pulumi.Input[bool]] = None):
"""
:param pulumi.Input[str] format: The format of the LSS resource. The supported formats are: `JSON`, `CSV`, and `TSV`
:param pulumi.Input[str] lss_host: The IP or FQDN of the SIEM (Log Receiver) where logs will be forwarded to.
:param pulumi.Input[str] lss_port: The destination port of the SIEM (Log Receiver) where logs will be forwarded to.
:param pulumi.Input[str] name: (Optional)
:param pulumi.Input[str] source_log_type: Refer to the log type documentation
:param pulumi.Input[str] audit_message: (Optional)
:param pulumi.Input[str] description: (Optional)
:param pulumi.Input[bool] enabled: (Optional)
:param pulumi.Input[Sequence[pulumi.Input[str]]] filters: (Optional)
:param pulumi.Input[str] id: App Connector Group ID(s) where logs will be forwarded to.
:param pulumi.Input[bool] use_tls: (Optional)
"""
pulumi.set(__self__, "format", format)
pulumi.set(__self__, "lss_host", lss_host)
pulumi.set(__self__, "lss_port", lss_port)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "source_log_type", source_log_type)
if audit_message is not None:
pulumi.set(__self__, "audit_message", audit_message)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if filters is not None:
pulumi.set(__self__, "filters", filters)
if id is not None:
pulumi.set(__self__, "id", id)
if use_tls is not None:
pulumi.set(__self__, "use_tls", use_tls)
@property
@pulumi.getter
def format(self) -> pulumi.Input[str]:
"""
The format of the LSS resource. The supported formats are: `JSON`, `CSV`, and `TSV`
"""
return pulumi.get(self, "format")
@format.setter
def format(self, value: pulumi.Input[str]):
pulumi.set(self, "format", value)
@property
@pulumi.getter(name="lssHost")
def lss_host(self) -> pulumi.Input[str]:
"""
The IP or FQDN of the SIEM (Log Receiver) where logs will be forwarded to.
"""
return pulumi.get(self, "lss_host")
@lss_host.setter
def lss_host(self, value: pulumi.Input[str]):
pulumi.set(self, "lss_host", value)
@property
@pulumi.getter(name="lssPort")
def lss_port(self) -> pulumi.Input[str]:
"""
The destination port of the SIEM (Log Receiver) where logs will be forwarded to.
"""
return pulumi.get(self, "lss_port")
@lss_port.setter
def lss_port(self, value: pulumi.Input[str]):
pulumi.set(self, "lss_port", value)
@property
@pulumi.getter
def name(self) -> pulumi.Input[str]:
"""
(Optional)
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: pulumi.Input[str]):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="sourceLogType")
def source_log_type(self) -> pulumi.Input[str]:
"""
Refer to the log type documentation
"""
return pulumi.get(self, "source_log_type")
@source_log_type.setter
def source_log_type(self, value: pulumi.Input[str]):
pulumi.set(self, "source_log_type", value)
@property
@pulumi.getter(name="auditMessage")
def audit_message(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "audit_message")
@audit_message.setter
def audit_message(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "audit_message", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def filters(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
(Optional)
"""
return pulumi.get(self, "filters")
@filters.setter
def filters(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "filters", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
"""
App Connector Group ID(s) where logs will be forwarded to.
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="useTls")
def use_tls(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "use_tls")
@use_tls.setter
def use_tls(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "use_tls", value)
@pulumi.input_type
class LSSConfigControllerConnectorGroupArgs:
def __init__(__self__, *,
ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
:param pulumi.Input[Sequence[pulumi.Input[str]]] ids: App Connector Group ID(s) where logs will be forwarded to.
"""
if ids is not None:
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
App Connector Group ID(s) where logs will be forwarded to.
"""
return pulumi.get(self, "ids")
@ids.setter
def ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "ids", value)
@pulumi.input_type
class LSSConfigControllerPolicyRuleResourceArgs:
def __init__(__self__, *,
name: pulumi.Input[str],
action: Optional[pulumi.Input[str]] = None,
action_id: Optional[pulumi.Input[str]] = None,
bypass_default_rule: Optional[pulumi.Input[bool]] = None,
conditions: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerPolicyRuleResourceConditionArgs']]]] = None,
custom_msg: Optional[pulumi.Input[str]] = None,
default_rule: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
lss_default_rule: Optional[pulumi.Input[bool]] = None,
operator: Optional[pulumi.Input[str]] = None,
policy_set_id: Optional[pulumi.Input[str]] = None,
policy_type: Optional[pulumi.Input[str]] = None,
priority: Optional[pulumi.Input[str]] = None,
reauth_default_rule: Optional[pulumi.Input[bool]] = None,
reauth_idle_timeout: Optional[pulumi.Input[str]] = None,
reauth_timeout: Optional[pulumi.Input[str]] = None,
rule_order: Optional[pulumi.Input[str]] = None,
zpn_inspection_profile_id: Optional[pulumi.Input[str]] = None):
"""
:param pulumi.Input[str] name: (Optional)
:param pulumi.Input[str] action: (Optional)
:param pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerPolicyRuleResourceConditionArgs']]] conditions: (Optional)
:param pulumi.Input[str] custom_msg: (Optional)
:param pulumi.Input[str] description: (Optional)
:param pulumi.Input[str] id: App Connector Group ID(s) where logs will be forwarded to.
:param pulumi.Input[str] operator: (Optional) - Supported values are: `AND` or `OR`
"""
pulumi.set(__self__, "name", name)
if action is not None:
pulumi.set(__self__, "action", action)
if action_id is not None:
pulumi.set(__self__, "action_id", action_id)
if bypass_default_rule is not None:
pulumi.set(__self__, "bypass_default_rule", bypass_default_rule)
if conditions is not None:
pulumi.set(__self__, "conditions", conditions)
if custom_msg is not None:
pulumi.set(__self__, "custom_msg", custom_msg)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if description is not None:
pulumi.set(__self__, "description", description)
if id is not None:
pulumi.set(__self__, "id", id)
if lss_default_rule is not None:
pulumi.set(__self__, "lss_default_rule", lss_default_rule)
if operator is not None:
pulumi.set(__self__, "operator", operator)
if policy_set_id is not None:
pulumi.set(__self__, "policy_set_id", policy_set_id)
if policy_type is not None:
pulumi.set(__self__, "policy_type", policy_type)
if priority is not None:
pulumi.set(__self__, "priority", priority)
if reauth_default_rule is not None:
pulumi.set(__self__, "reauth_default_rule", reauth_default_rule)
if reauth_idle_timeout is not None:
pulumi.set(__self__, "reauth_idle_timeout", reauth_idle_timeout)
if reauth_timeout is not None:
pulumi.set(__self__, "reauth_timeout", reauth_timeout)
if rule_order is not None:
pulumi.set(__self__, "rule_order", rule_order)
if zpn_inspection_profile_id is not None:
pulumi.set(__self__, "zpn_inspection_profile_id", zpn_inspection_profile_id)
@property
@pulumi.getter
def name(self) -> pulumi.Input[str]:
"""
(Optional)
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: pulumi.Input[str]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def action(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "action")
@action.setter
def action(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action", value)
@property
@pulumi.getter(name="actionId")
def action_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "action_id")
@action_id.setter
def action_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "action_id", value)
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "bypass_default_rule")
@bypass_default_rule.setter
def bypass_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "bypass_default_rule", value)
@property
@pulumi.getter
def conditions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerPolicyRuleResourceConditionArgs']]]]:
"""
(Optional)
"""
return pulumi.get(self, "conditions")
@conditions.setter
def conditions(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerPolicyRuleResourceConditionArgs']]]]):
pulumi.set(self, "conditions", value)
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "custom_msg")
@custom_msg.setter
def custom_msg(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "custom_msg", value)
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "default_rule")
@default_rule.setter
def default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "default_rule", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional)
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def id(self) -> Optional[pulumi.Input[str]]:
"""
App Connector Group ID(s) where logs will be forwarded to.
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "lss_default_rule")
@lss_default_rule.setter
def lss_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "lss_default_rule", value)
@property
@pulumi.getter
def operator(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) - Supported values are: `AND` or `OR`
"""
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_set_id")
@policy_set_id.setter
def policy_set_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_set_id", value)
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_type")
@policy_type.setter
def policy_type(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_type", value)
@property
@pulumi.getter
def priority(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "priority")
@priority.setter
def priority(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "priority", value)
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "reauth_default_rule")
@reauth_default_rule.setter
def reauth_default_rule(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "reauth_default_rule", value)
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_idle_timeout")
@reauth_idle_timeout.setter
def reauth_idle_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_idle_timeout", value)
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "reauth_timeout")
@reauth_timeout.setter
def reauth_timeout(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "reauth_timeout", value)
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "rule_order")
@rule_order.setter
def rule_order(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "rule_order", value)
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "zpn_inspection_profile_id")
@zpn_inspection_profile_id.setter
def zpn_inspection_profile_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "zpn_inspection_profile_id", value)
@pulumi.input_type
class LSSConfigControllerPolicyRuleResourceConditionArgs:
def __init__(__self__, *,
operator: pulumi.Input[str],
negated: Optional[pulumi.Input[bool]] = None,
operands: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerPolicyRuleResourceConditionOperandArgs']]]] = None):
"""
:param pulumi.Input[str] operator: (Optional) - Supported values are: `AND` or `OR`
:param pulumi.Input[bool] negated: (Optional)
"""
pulumi.set(__self__, "operator", operator)
if negated is not None:
pulumi.set(__self__, "negated", negated)
if operands is not None:
pulumi.set(__self__, "operands", operands)
@property
@pulumi.getter
def operator(self) -> pulumi.Input[str]:
"""
(Optional) - Supported values are: `AND` or `OR`
"""
return pulumi.get(self, "operator")
@operator.setter
def operator(self, value: pulumi.Input[str]):
pulumi.set(self, "operator", value)
@property
@pulumi.getter
def negated(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional)
"""
return pulumi.get(self, "negated")
@negated.setter
def negated(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "negated", value)
@property
@pulumi.getter
def operands(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerPolicyRuleResourceConditionOperandArgs']]]]:
return pulumi.get(self, "operands")
@operands.setter
def operands(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerPolicyRuleResourceConditionOperandArgs']]]]):
pulumi.set(self, "operands", value)
@pulumi.input_type
class LSSConfigControllerPolicyRuleResourceConditionOperandArgs:
def __init__(__self__, *,
object_type: pulumi.Input[str],
values: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
"""
:param pulumi.Input[str] object_type: (Optional) This is for specifying the policy critiera. Supported values: `APP`, `APP_GROUP`, `CLIENT_TYPE`, `TRUSTED_NETWORK`, `SAML`, `SCIM`, `SCIM_GROUP`
:param pulumi.Input[Sequence[pulumi.Input[str]]] values: (Optional) The below values are supported when choosing `object_type` of type `CLIENT_TYPE`.
"""
pulumi.set(__self__, "object_type", object_type)
if values is not None:
pulumi.set(__self__, "values", values)
@property
@pulumi.getter(name="objectType")
def object_type(self) -> pulumi.Input[str]:
"""
(Optional) This is for specifying the policy critiera. Supported values: `APP`, `APP_GROUP`, `CLIENT_TYPE`, `TRUSTED_NETWORK`, `SAML`, `SCIM`, `SCIM_GROUP`
"""
return pulumi.get(self, "object_type")
@object_type.setter
def object_type(self, value: pulumi.Input[str]):
pulumi.set(self, "object_type", value)
@property
@pulumi.getter
def values(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
"""
(Optional) The below values are supported when choosing `object_type` of type `CLIENT_TYPE`.
"""
return pulumi.get(self, "values")
@values.setter
def values(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
pulumi.set(self, "values", value)
@pulumi.input_type
class GetLSSConfigControllerConfigArgs:
def __init__(__self__, *,
audit_message: str,
description: str,
enabled: bool,
filters: Sequence[str],
format: str,
id: str,
lss_host: str,
lss_port: str,
name: str,
source_log_type: str,
use_tls: bool):
"""
:param str audit_message: (string)
:param str description: (string)
:param bool enabled: (bool)
:param Sequence[str] filters: (string)
:param str format: (string)
:param str id: This field defines the name of the log streaming resource.
:param str lss_host: (string)
:param str lss_port: (string)
:param str name: This field defines the name of the log streaming resource.
:param str source_log_type: (string)
"""
pulumi.set(__self__, "audit_message", audit_message)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "filters", filters)
pulumi.set(__self__, "format", format)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "lss_host", lss_host)
pulumi.set(__self__, "lss_port", lss_port)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "source_log_type", source_log_type)
pulumi.set(__self__, "use_tls", use_tls)
@property
@pulumi.getter(name="auditMessage")
def audit_message(self) -> str:
"""
(string)
"""
return pulumi.get(self, "audit_message")
@audit_message.setter
def audit_message(self, value: str):
pulumi.set(self, "audit_message", value)
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: str):
pulumi.set(self, "description", value)
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: bool):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter
def filters(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "filters")
@filters.setter
def filters(self, value: Sequence[str]):
pulumi.set(self, "filters", value)
@property
@pulumi.getter
def format(self) -> str:
"""
(string)
"""
return pulumi.get(self, "format")
@format.setter
def format(self, value: str):
pulumi.set(self, "format", value)
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "id")
@id.setter
def id(self, value: str):
pulumi.set(self, "id", value)
@property
@pulumi.getter(name="lssHost")
def lss_host(self) -> str:
"""
(string)
"""
return pulumi.get(self, "lss_host")
@lss_host.setter
def lss_host(self, value: str):
pulumi.set(self, "lss_host", value)
@property
@pulumi.getter(name="lssPort")
def lss_port(self) -> str:
"""
(string)
"""
return pulumi.get(self, "lss_port")
@lss_port.setter
def lss_port(self, value: str):
pulumi.set(self, "lss_port", value)
@property
@pulumi.getter
def name(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: str):
pulumi.set(self, "name", value)
@property
@pulumi.getter(name="sourceLogType")
def source_log_type(self) -> str:
"""
(string)
"""
return pulumi.get(self, "source_log_type")
@source_log_type.setter
def source_log_type(self, value: str):
pulumi.set(self, "source_log_type", value)
@property
@pulumi.getter(name="useTls")
def use_tls(self) -> bool:
return pulumi.get(self, "use_tls")
@use_tls.setter
def use_tls(self, value: bool):
pulumi.set(self, "use_tls", value) | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/lssconfig/_inputs.py | _inputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetLSSStatusCodesResult',
'AwaitableGetLSSStatusCodesResult',
'get_lss_status_codes',
]
@pulumi.output_type
class GetLSSStatusCodesResult:
"""
A collection of values returned by getLSSStatusCodes.
"""
def __init__(__self__, id=None, zpn_ast_auth_log=None, zpn_auth_log=None, zpn_sys_auth_log=None, zpn_trans_log=None):
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if zpn_ast_auth_log and not isinstance(zpn_ast_auth_log, dict):
raise TypeError("Expected argument 'zpn_ast_auth_log' to be a dict")
pulumi.set(__self__, "zpn_ast_auth_log", zpn_ast_auth_log)
if zpn_auth_log and not isinstance(zpn_auth_log, dict):
raise TypeError("Expected argument 'zpn_auth_log' to be a dict")
pulumi.set(__self__, "zpn_auth_log", zpn_auth_log)
if zpn_sys_auth_log and not isinstance(zpn_sys_auth_log, dict):
raise TypeError("Expected argument 'zpn_sys_auth_log' to be a dict")
pulumi.set(__self__, "zpn_sys_auth_log", zpn_sys_auth_log)
if zpn_trans_log and not isinstance(zpn_trans_log, dict):
raise TypeError("Expected argument 'zpn_trans_log' to be a dict")
pulumi.set(__self__, "zpn_trans_log", zpn_trans_log)
@property
@pulumi.getter
def id(self) -> str:
"""
The provider-assigned unique ID for this managed resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="zpnAstAuthLog")
def zpn_ast_auth_log(self) -> Mapping[str, str]:
return pulumi.get(self, "zpn_ast_auth_log")
@property
@pulumi.getter(name="zpnAuthLog")
def zpn_auth_log(self) -> Mapping[str, str]:
return pulumi.get(self, "zpn_auth_log")
@property
@pulumi.getter(name="zpnSysAuthLog")
def zpn_sys_auth_log(self) -> Mapping[str, str]:
return pulumi.get(self, "zpn_sys_auth_log")
@property
@pulumi.getter(name="zpnTransLog")
def zpn_trans_log(self) -> Mapping[str, str]:
return pulumi.get(self, "zpn_trans_log")
class AwaitableGetLSSStatusCodesResult(GetLSSStatusCodesResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetLSSStatusCodesResult(
id=self.id,
zpn_ast_auth_log=self.zpn_ast_auth_log,
zpn_auth_log=self.zpn_auth_log,
zpn_sys_auth_log=self.zpn_sys_auth_log,
zpn_trans_log=self.zpn_trans_log)
def get_lss_status_codes(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetLSSStatusCodesResult:
"""
Use the **zpa_lss_config_status_codes** data source to get information about all LSS status codes in the Zscaler Private Access cloud. This data source is required when the `filter` parameter in the LSS Config Controller resource is set. To learn more see the [Getting Details of All LSS Status Codes](https://help.zscaler.com/zpa/log-streaming-service-configuration-use-cases#GettingLSSStatusCodes)
> **NOTE** By Default the ZPA provider will return all status codes
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
this = zpa.LSSConfig.get_lss_status_codes()
```
"""
__args__ = dict()
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:LSSConfig/getLSSStatusCodes:getLSSStatusCodes', __args__, opts=opts, typ=GetLSSStatusCodesResult).value
return AwaitableGetLSSStatusCodesResult(
id=__ret__.id,
zpn_ast_auth_log=__ret__.zpn_ast_auth_log,
zpn_auth_log=__ret__.zpn_auth_log,
zpn_sys_auth_log=__ret__.zpn_sys_auth_log,
zpn_trans_log=__ret__.zpn_trans_log) | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/lssconfig/get_lss_status_codes.py | get_lss_status_codes.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetLSSClientTypesResult',
'AwaitableGetLSSClientTypesResult',
'get_lss_client_types',
]
@pulumi.output_type
class GetLSSClientTypesResult:
"""
A collection of values returned by getLSSClientTypes.
"""
def __init__(__self__, id=None, zpn_client_type_edge_connector=None, zpn_client_type_exporter=None, zpn_client_type_ip_anchoring=None, zpn_client_type_machine_tunnel=None, zpn_client_type_slogger=None, zpn_client_type_zapp=None):
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if zpn_client_type_edge_connector and not isinstance(zpn_client_type_edge_connector, str):
raise TypeError("Expected argument 'zpn_client_type_edge_connector' to be a str")
pulumi.set(__self__, "zpn_client_type_edge_connector", zpn_client_type_edge_connector)
if zpn_client_type_exporter and not isinstance(zpn_client_type_exporter, str):
raise TypeError("Expected argument 'zpn_client_type_exporter' to be a str")
pulumi.set(__self__, "zpn_client_type_exporter", zpn_client_type_exporter)
if zpn_client_type_ip_anchoring and not isinstance(zpn_client_type_ip_anchoring, str):
raise TypeError("Expected argument 'zpn_client_type_ip_anchoring' to be a str")
pulumi.set(__self__, "zpn_client_type_ip_anchoring", zpn_client_type_ip_anchoring)
if zpn_client_type_machine_tunnel and not isinstance(zpn_client_type_machine_tunnel, str):
raise TypeError("Expected argument 'zpn_client_type_machine_tunnel' to be a str")
pulumi.set(__self__, "zpn_client_type_machine_tunnel", zpn_client_type_machine_tunnel)
if zpn_client_type_slogger and not isinstance(zpn_client_type_slogger, str):
raise TypeError("Expected argument 'zpn_client_type_slogger' to be a str")
pulumi.set(__self__, "zpn_client_type_slogger", zpn_client_type_slogger)
if zpn_client_type_zapp and not isinstance(zpn_client_type_zapp, str):
raise TypeError("Expected argument 'zpn_client_type_zapp' to be a str")
pulumi.set(__self__, "zpn_client_type_zapp", zpn_client_type_zapp)
@property
@pulumi.getter
def id(self) -> str:
"""
The provider-assigned unique ID for this managed resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="zpnClientTypeEdgeConnector")
def zpn_client_type_edge_connector(self) -> str:
return pulumi.get(self, "zpn_client_type_edge_connector")
@property
@pulumi.getter(name="zpnClientTypeExporter")
def zpn_client_type_exporter(self) -> str:
return pulumi.get(self, "zpn_client_type_exporter")
@property
@pulumi.getter(name="zpnClientTypeIpAnchoring")
def zpn_client_type_ip_anchoring(self) -> str:
return pulumi.get(self, "zpn_client_type_ip_anchoring")
@property
@pulumi.getter(name="zpnClientTypeMachineTunnel")
def zpn_client_type_machine_tunnel(self) -> str:
return pulumi.get(self, "zpn_client_type_machine_tunnel")
@property
@pulumi.getter(name="zpnClientTypeSlogger")
def zpn_client_type_slogger(self) -> str:
return pulumi.get(self, "zpn_client_type_slogger")
@property
@pulumi.getter(name="zpnClientTypeZapp")
def zpn_client_type_zapp(self) -> str:
return pulumi.get(self, "zpn_client_type_zapp")
class AwaitableGetLSSClientTypesResult(GetLSSClientTypesResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetLSSClientTypesResult(
id=self.id,
zpn_client_type_edge_connector=self.zpn_client_type_edge_connector,
zpn_client_type_exporter=self.zpn_client_type_exporter,
zpn_client_type_ip_anchoring=self.zpn_client_type_ip_anchoring,
zpn_client_type_machine_tunnel=self.zpn_client_type_machine_tunnel,
zpn_client_type_slogger=self.zpn_client_type_slogger,
zpn_client_type_zapp=self.zpn_client_type_zapp)
def get_lss_client_types(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetLSSClientTypesResult:
"""
Use the **zpa_lss_config_client_types** data source to get information about all LSS client types in the Zscaler Private Access cloud. This data source is required when the defining a policy rule resource for an object type as `CLIENT_TYPE` parameter in the LSS Config Controller resource is set. To learn more see the To learn more see the [Getting Details of All LSS Status Codes](https://help.zscaler.com/zpa/log-streaming-service-configuration-use-cases#GettingLSSClientTypes)
> **NOTE** By Default the ZPA provider will return all client types
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.LSSConfig.get_lss_client_types()
```
"""
__args__ = dict()
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:LSSConfig/getLSSClientTypes:getLSSClientTypes', __args__, opts=opts, typ=GetLSSClientTypesResult).value
return AwaitableGetLSSClientTypesResult(
id=__ret__.id,
zpn_client_type_edge_connector=__ret__.zpn_client_type_edge_connector,
zpn_client_type_exporter=__ret__.zpn_client_type_exporter,
zpn_client_type_ip_anchoring=__ret__.zpn_client_type_ip_anchoring,
zpn_client_type_machine_tunnel=__ret__.zpn_client_type_machine_tunnel,
zpn_client_type_slogger=__ret__.zpn_client_type_slogger,
zpn_client_type_zapp=__ret__.zpn_client_type_zapp) | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/lssconfig/get_lss_client_types.py | get_lss_client_types.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = [
'GetLSSConfigControllerResult',
'AwaitableGetLSSConfigControllerResult',
'get_lss_config_controller',
'get_lss_config_controller_output',
]
@pulumi.output_type
class GetLSSConfigControllerResult:
"""
A collection of values returned by getLSSConfigController.
"""
def __init__(__self__, configs=None, connector_groups=None, id=None, policy_rules=None):
if configs and not isinstance(configs, list):
raise TypeError("Expected argument 'configs' to be a list")
pulumi.set(__self__, "configs", configs)
if connector_groups and not isinstance(connector_groups, list):
raise TypeError("Expected argument 'connector_groups' to be a list")
pulumi.set(__self__, "connector_groups", connector_groups)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if policy_rules and not isinstance(policy_rules, list):
raise TypeError("Expected argument 'policy_rules' to be a list")
pulumi.set(__self__, "policy_rules", policy_rules)
@property
@pulumi.getter
def configs(self) -> Sequence['outputs.GetLSSConfigControllerConfigResult']:
"""
(Computed)
"""
return pulumi.get(self, "configs")
@property
@pulumi.getter(name="connectorGroups")
def connector_groups(self) -> Sequence['outputs.GetLSSConfigControllerConnectorGroupResult']:
"""
(Computed)
"""
return pulumi.get(self, "connector_groups")
@property
@pulumi.getter
def id(self) -> Optional[str]:
"""
(string)
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="policyRules")
def policy_rules(self) -> Sequence['outputs.GetLSSConfigControllerPolicyRuleResult']:
return pulumi.get(self, "policy_rules")
class AwaitableGetLSSConfigControllerResult(GetLSSConfigControllerResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetLSSConfigControllerResult(
configs=self.configs,
connector_groups=self.connector_groups,
id=self.id,
policy_rules=self.policy_rules)
def get_lss_config_controller(configs: Optional[Sequence[pulumi.InputType['GetLSSConfigControllerConfigArgs']]] = None,
id: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetLSSConfigControllerResult:
"""
Use the **zpa_lss_config_controller** data source to get information about a Log Streaming (LSS) configuration resource created in the Zscaler Private Access.
:param Sequence[pulumi.InputType['GetLSSConfigControllerConfigArgs']] configs: (Computed)
:param str id: This field defines the name of the log streaming resource.
"""
__args__ = dict()
__args__['configs'] = configs
__args__['id'] = id
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:LSSConfig/getLSSConfigController:getLSSConfigController', __args__, opts=opts, typ=GetLSSConfigControllerResult).value
return AwaitableGetLSSConfigControllerResult(
configs=__ret__.configs,
connector_groups=__ret__.connector_groups,
id=__ret__.id,
policy_rules=__ret__.policy_rules)
@_utilities.lift_output_func(get_lss_config_controller)
def get_lss_config_controller_output(configs: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetLSSConfigControllerConfigArgs']]]]] = None,
id: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetLSSConfigControllerResult]:
"""
Use the **zpa_lss_config_controller** data source to get information about a Log Streaming (LSS) configuration resource created in the Zscaler Private Access.
:param Sequence[pulumi.InputType['GetLSSConfigControllerConfigArgs']] configs: (Computed)
:param str id: This field defines the name of the log streaming resource.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/lssconfig/get_lss_config_controller.py | get_lss_config_controller.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'LSSConfigControllerConfig',
'LSSConfigControllerConnectorGroup',
'LSSConfigControllerPolicyRuleResource',
'LSSConfigControllerPolicyRuleResourceCondition',
'LSSConfigControllerPolicyRuleResourceConditionOperand',
'GetLSSConfigControllerConfigResult',
'GetLSSConfigControllerConnectorGroupResult',
'GetLSSConfigControllerPolicyRuleResult',
'GetLSSConfigControllerPolicyRuleConditionResult',
'GetLSSConfigControllerPolicyRuleConditionOperandResult',
]
@pulumi.output_type
class LSSConfigControllerConfig(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "lssHost":
suggest = "lss_host"
elif key == "lssPort":
suggest = "lss_port"
elif key == "sourceLogType":
suggest = "source_log_type"
elif key == "auditMessage":
suggest = "audit_message"
elif key == "useTls":
suggest = "use_tls"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in LSSConfigControllerConfig. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
LSSConfigControllerConfig.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
LSSConfigControllerConfig.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
format: str,
lss_host: str,
lss_port: str,
name: str,
source_log_type: str,
audit_message: Optional[str] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
filters: Optional[Sequence[str]] = None,
id: Optional[str] = None,
use_tls: Optional[bool] = None):
"""
:param str format: The format of the LSS resource. The supported formats are: `JSON`, `CSV`, and `TSV`
:param str lss_host: The IP or FQDN of the SIEM (Log Receiver) where logs will be forwarded to.
:param str lss_port: The destination port of the SIEM (Log Receiver) where logs will be forwarded to.
:param str name: (Optional)
:param str source_log_type: Refer to the log type documentation
:param str audit_message: (Optional)
:param str description: (Optional)
:param bool enabled: (Optional)
:param Sequence[str] filters: (Optional)
:param str id: App Connector Group ID(s) where logs will be forwarded to.
:param bool use_tls: (Optional)
"""
pulumi.set(__self__, "format", format)
pulumi.set(__self__, "lss_host", lss_host)
pulumi.set(__self__, "lss_port", lss_port)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "source_log_type", source_log_type)
if audit_message is not None:
pulumi.set(__self__, "audit_message", audit_message)
if description is not None:
pulumi.set(__self__, "description", description)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if filters is not None:
pulumi.set(__self__, "filters", filters)
if id is not None:
pulumi.set(__self__, "id", id)
if use_tls is not None:
pulumi.set(__self__, "use_tls", use_tls)
@property
@pulumi.getter
def format(self) -> str:
"""
The format of the LSS resource. The supported formats are: `JSON`, `CSV`, and `TSV`
"""
return pulumi.get(self, "format")
@property
@pulumi.getter(name="lssHost")
def lss_host(self) -> str:
"""
The IP or FQDN of the SIEM (Log Receiver) where logs will be forwarded to.
"""
return pulumi.get(self, "lss_host")
@property
@pulumi.getter(name="lssPort")
def lss_port(self) -> str:
"""
The destination port of the SIEM (Log Receiver) where logs will be forwarded to.
"""
return pulumi.get(self, "lss_port")
@property
@pulumi.getter
def name(self) -> str:
"""
(Optional)
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="sourceLogType")
def source_log_type(self) -> str:
"""
Refer to the log type documentation
"""
return pulumi.get(self, "source_log_type")
@property
@pulumi.getter(name="auditMessage")
def audit_message(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "audit_message")
@property
@pulumi.getter
def description(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> Optional[bool]:
"""
(Optional)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def filters(self) -> Optional[Sequence[str]]:
"""
(Optional)
"""
return pulumi.get(self, "filters")
@property
@pulumi.getter
def id(self) -> Optional[str]:
"""
App Connector Group ID(s) where logs will be forwarded to.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="useTls")
def use_tls(self) -> Optional[bool]:
"""
(Optional)
"""
return pulumi.get(self, "use_tls")
@pulumi.output_type
class LSSConfigControllerConnectorGroup(dict):
def __init__(__self__, *,
ids: Optional[Sequence[str]] = None):
"""
:param Sequence[str] ids: App Connector Group ID(s) where logs will be forwarded to.
"""
if ids is not None:
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Optional[Sequence[str]]:
"""
App Connector Group ID(s) where logs will be forwarded to.
"""
return pulumi.get(self, "ids")
@pulumi.output_type
class LSSConfigControllerPolicyRuleResource(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "actionId":
suggest = "action_id"
elif key == "bypassDefaultRule":
suggest = "bypass_default_rule"
elif key == "customMsg":
suggest = "custom_msg"
elif key == "defaultRule":
suggest = "default_rule"
elif key == "lssDefaultRule":
suggest = "lss_default_rule"
elif key == "policySetId":
suggest = "policy_set_id"
elif key == "policyType":
suggest = "policy_type"
elif key == "reauthDefaultRule":
suggest = "reauth_default_rule"
elif key == "reauthIdleTimeout":
suggest = "reauth_idle_timeout"
elif key == "reauthTimeout":
suggest = "reauth_timeout"
elif key == "ruleOrder":
suggest = "rule_order"
elif key == "zpnInspectionProfileId":
suggest = "zpn_inspection_profile_id"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in LSSConfigControllerPolicyRuleResource. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
LSSConfigControllerPolicyRuleResource.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
LSSConfigControllerPolicyRuleResource.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
name: str,
action: Optional[str] = None,
action_id: Optional[str] = None,
bypass_default_rule: Optional[bool] = None,
conditions: Optional[Sequence['outputs.LSSConfigControllerPolicyRuleResourceCondition']] = None,
custom_msg: Optional[str] = None,
default_rule: Optional[bool] = None,
description: Optional[str] = None,
id: Optional[str] = None,
lss_default_rule: Optional[bool] = None,
operator: Optional[str] = None,
policy_set_id: Optional[str] = None,
policy_type: Optional[str] = None,
priority: Optional[str] = None,
reauth_default_rule: Optional[bool] = None,
reauth_idle_timeout: Optional[str] = None,
reauth_timeout: Optional[str] = None,
rule_order: Optional[str] = None,
zpn_inspection_profile_id: Optional[str] = None):
"""
:param str name: (Optional)
:param str action: (Optional)
:param Sequence['LSSConfigControllerPolicyRuleResourceConditionArgs'] conditions: (Optional)
:param str custom_msg: (Optional)
:param str description: (Optional)
:param str id: App Connector Group ID(s) where logs will be forwarded to.
:param str operator: (Optional) - Supported values are: `AND` or `OR`
"""
pulumi.set(__self__, "name", name)
if action is not None:
pulumi.set(__self__, "action", action)
if action_id is not None:
pulumi.set(__self__, "action_id", action_id)
if bypass_default_rule is not None:
pulumi.set(__self__, "bypass_default_rule", bypass_default_rule)
if conditions is not None:
pulumi.set(__self__, "conditions", conditions)
if custom_msg is not None:
pulumi.set(__self__, "custom_msg", custom_msg)
if default_rule is not None:
pulumi.set(__self__, "default_rule", default_rule)
if description is not None:
pulumi.set(__self__, "description", description)
if id is not None:
pulumi.set(__self__, "id", id)
if lss_default_rule is not None:
pulumi.set(__self__, "lss_default_rule", lss_default_rule)
if operator is not None:
pulumi.set(__self__, "operator", operator)
if policy_set_id is not None:
pulumi.set(__self__, "policy_set_id", policy_set_id)
if policy_type is not None:
pulumi.set(__self__, "policy_type", policy_type)
if priority is not None:
pulumi.set(__self__, "priority", priority)
if reauth_default_rule is not None:
pulumi.set(__self__, "reauth_default_rule", reauth_default_rule)
if reauth_idle_timeout is not None:
pulumi.set(__self__, "reauth_idle_timeout", reauth_idle_timeout)
if reauth_timeout is not None:
pulumi.set(__self__, "reauth_timeout", reauth_timeout)
if rule_order is not None:
pulumi.set(__self__, "rule_order", rule_order)
if zpn_inspection_profile_id is not None:
pulumi.set(__self__, "zpn_inspection_profile_id", zpn_inspection_profile_id)
@property
@pulumi.getter
def name(self) -> str:
"""
(Optional)
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def action(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "action")
@property
@pulumi.getter(name="actionId")
def action_id(self) -> Optional[str]:
return pulumi.get(self, "action_id")
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> Optional[bool]:
return pulumi.get(self, "bypass_default_rule")
@property
@pulumi.getter
def conditions(self) -> Optional[Sequence['outputs.LSSConfigControllerPolicyRuleResourceCondition']]:
"""
(Optional)
"""
return pulumi.get(self, "conditions")
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "custom_msg")
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> Optional[bool]:
return pulumi.get(self, "default_rule")
@property
@pulumi.getter
def description(self) -> Optional[str]:
"""
(Optional)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> Optional[str]:
"""
App Connector Group ID(s) where logs will be forwarded to.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> Optional[bool]:
return pulumi.get(self, "lss_default_rule")
@property
@pulumi.getter
def operator(self) -> Optional[str]:
"""
(Optional) - Supported values are: `AND` or `OR`
"""
return pulumi.get(self, "operator")
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> Optional[str]:
return pulumi.get(self, "policy_set_id")
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> Optional[str]:
return pulumi.get(self, "policy_type")
@property
@pulumi.getter
def priority(self) -> Optional[str]:
return pulumi.get(self, "priority")
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> Optional[bool]:
return pulumi.get(self, "reauth_default_rule")
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> Optional[str]:
return pulumi.get(self, "reauth_idle_timeout")
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> Optional[str]:
return pulumi.get(self, "reauth_timeout")
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> Optional[str]:
return pulumi.get(self, "rule_order")
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> Optional[str]:
return pulumi.get(self, "zpn_inspection_profile_id")
@pulumi.output_type
class LSSConfigControllerPolicyRuleResourceCondition(dict):
def __init__(__self__, *,
operator: str,
negated: Optional[bool] = None,
operands: Optional[Sequence['outputs.LSSConfigControllerPolicyRuleResourceConditionOperand']] = None):
"""
:param str operator: (Optional) - Supported values are: `AND` or `OR`
:param bool negated: (Optional)
"""
pulumi.set(__self__, "operator", operator)
if negated is not None:
pulumi.set(__self__, "negated", negated)
if operands is not None:
pulumi.set(__self__, "operands", operands)
@property
@pulumi.getter
def operator(self) -> str:
"""
(Optional) - Supported values are: `AND` or `OR`
"""
return pulumi.get(self, "operator")
@property
@pulumi.getter
def negated(self) -> Optional[bool]:
"""
(Optional)
"""
return pulumi.get(self, "negated")
@property
@pulumi.getter
def operands(self) -> Optional[Sequence['outputs.LSSConfigControllerPolicyRuleResourceConditionOperand']]:
return pulumi.get(self, "operands")
@pulumi.output_type
class LSSConfigControllerPolicyRuleResourceConditionOperand(dict):
@staticmethod
def __key_warning(key: str):
suggest = None
if key == "objectType":
suggest = "object_type"
if suggest:
pulumi.log.warn(f"Key '{key}' not found in LSSConfigControllerPolicyRuleResourceConditionOperand. Access the value via the '{suggest}' property getter instead.")
def __getitem__(self, key: str) -> Any:
LSSConfigControllerPolicyRuleResourceConditionOperand.__key_warning(key)
return super().__getitem__(key)
def get(self, key: str, default = None) -> Any:
LSSConfigControllerPolicyRuleResourceConditionOperand.__key_warning(key)
return super().get(key, default)
def __init__(__self__, *,
object_type: str,
values: Optional[Sequence[str]] = None):
"""
:param str object_type: (Optional) This is for specifying the policy critiera. Supported values: `APP`, `APP_GROUP`, `CLIENT_TYPE`, `TRUSTED_NETWORK`, `SAML`, `SCIM`, `SCIM_GROUP`
:param Sequence[str] values: (Optional) The below values are supported when choosing `object_type` of type `CLIENT_TYPE`.
"""
pulumi.set(__self__, "object_type", object_type)
if values is not None:
pulumi.set(__self__, "values", values)
@property
@pulumi.getter(name="objectType")
def object_type(self) -> str:
"""
(Optional) This is for specifying the policy critiera. Supported values: `APP`, `APP_GROUP`, `CLIENT_TYPE`, `TRUSTED_NETWORK`, `SAML`, `SCIM`, `SCIM_GROUP`
"""
return pulumi.get(self, "object_type")
@property
@pulumi.getter
def values(self) -> Optional[Sequence[str]]:
"""
(Optional) The below values are supported when choosing `object_type` of type `CLIENT_TYPE`.
"""
return pulumi.get(self, "values")
@pulumi.output_type
class GetLSSConfigControllerConfigResult(dict):
def __init__(__self__, *,
audit_message: str,
description: str,
enabled: bool,
filters: Sequence[str],
format: str,
id: str,
lss_host: str,
lss_port: str,
name: str,
source_log_type: str,
use_tls: bool):
"""
:param str audit_message: (string)
:param str description: (string)
:param bool enabled: (bool)
:param Sequence[str] filters: (string)
:param str format: (string)
:param str id: This field defines the name of the log streaming resource.
:param str lss_host: (string)
:param str lss_port: (string)
:param str name: This field defines the name of the log streaming resource.
:param str source_log_type: (string)
"""
pulumi.set(__self__, "audit_message", audit_message)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "filters", filters)
pulumi.set(__self__, "format", format)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "lss_host", lss_host)
pulumi.set(__self__, "lss_port", lss_port)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "source_log_type", source_log_type)
pulumi.set(__self__, "use_tls", use_tls)
@property
@pulumi.getter(name="auditMessage")
def audit_message(self) -> str:
"""
(string)
"""
return pulumi.get(self, "audit_message")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def filters(self) -> Sequence[str]:
"""
(string)
"""
return pulumi.get(self, "filters")
@property
@pulumi.getter
def format(self) -> str:
"""
(string)
"""
return pulumi.get(self, "format")
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="lssHost")
def lss_host(self) -> str:
"""
(string)
"""
return pulumi.get(self, "lss_host")
@property
@pulumi.getter(name="lssPort")
def lss_port(self) -> str:
"""
(string)
"""
return pulumi.get(self, "lss_port")
@property
@pulumi.getter
def name(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="sourceLogType")
def source_log_type(self) -> str:
"""
(string)
"""
return pulumi.get(self, "source_log_type")
@property
@pulumi.getter(name="useTls")
def use_tls(self) -> bool:
return pulumi.get(self, "use_tls")
@pulumi.output_type
class GetLSSConfigControllerConnectorGroupResult(dict):
def __init__(__self__, *,
id: str):
"""
:param str id: This field defines the name of the log streaming resource.
"""
pulumi.set(__self__, "id", id)
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "id")
@pulumi.output_type
class GetLSSConfigControllerPolicyRuleResult(dict):
def __init__(__self__, *,
action: str,
action_id: str,
bypass_default_rule: bool,
conditions: Sequence['outputs.GetLSSConfigControllerPolicyRuleConditionResult'],
creation_time: str,
custom_msg: str,
default_rule: bool,
description: str,
id: str,
isolation_default_rule: bool,
lss_default_rule: bool,
modified_time: str,
modifiedby: str,
name: str,
operator: str,
policy_set_id: str,
policy_type: str,
priority: str,
reauth_default_rule: bool,
reauth_idle_timeout: str,
reauth_timeout: str,
rule_order: str,
zpn_cbi_profile_id: str,
zpn_inspection_profile_id: str,
zpn_inspection_profile_name: str):
"""
:param str creation_time: (string)
:param str description: (string)
:param str id: This field defines the name of the log streaming resource.
:param str modified_time: (string)
:param str name: This field defines the name of the log streaming resource.
"""
pulumi.set(__self__, "action", action)
pulumi.set(__self__, "action_id", action_id)
pulumi.set(__self__, "bypass_default_rule", bypass_default_rule)
pulumi.set(__self__, "conditions", conditions)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "custom_msg", custom_msg)
pulumi.set(__self__, "default_rule", default_rule)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "isolation_default_rule", isolation_default_rule)
pulumi.set(__self__, "lss_default_rule", lss_default_rule)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "operator", operator)
pulumi.set(__self__, "policy_set_id", policy_set_id)
pulumi.set(__self__, "policy_type", policy_type)
pulumi.set(__self__, "priority", priority)
pulumi.set(__self__, "reauth_default_rule", reauth_default_rule)
pulumi.set(__self__, "reauth_idle_timeout", reauth_idle_timeout)
pulumi.set(__self__, "reauth_timeout", reauth_timeout)
pulumi.set(__self__, "rule_order", rule_order)
pulumi.set(__self__, "zpn_cbi_profile_id", zpn_cbi_profile_id)
pulumi.set(__self__, "zpn_inspection_profile_id", zpn_inspection_profile_id)
pulumi.set(__self__, "zpn_inspection_profile_name", zpn_inspection_profile_name)
@property
@pulumi.getter
def action(self) -> str:
return pulumi.get(self, "action")
@property
@pulumi.getter(name="actionId")
def action_id(self) -> str:
return pulumi.get(self, "action_id")
@property
@pulumi.getter(name="bypassDefaultRule")
def bypass_default_rule(self) -> bool:
return pulumi.get(self, "bypass_default_rule")
@property
@pulumi.getter
def conditions(self) -> Sequence['outputs.GetLSSConfigControllerPolicyRuleConditionResult']:
return pulumi.get(self, "conditions")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter(name="customMsg")
def custom_msg(self) -> str:
return pulumi.get(self, "custom_msg")
@property
@pulumi.getter(name="defaultRule")
def default_rule(self) -> bool:
return pulumi.get(self, "default_rule")
@property
@pulumi.getter
def description(self) -> str:
"""
(string)
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="isolationDefaultRule")
def isolation_default_rule(self) -> bool:
return pulumi.get(self, "isolation_default_rule")
@property
@pulumi.getter(name="lssDefaultRule")
def lss_default_rule(self) -> bool:
return pulumi.get(self, "lss_default_rule")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def operator(self) -> str:
return pulumi.get(self, "operator")
@property
@pulumi.getter(name="policySetId")
def policy_set_id(self) -> str:
return pulumi.get(self, "policy_set_id")
@property
@pulumi.getter(name="policyType")
def policy_type(self) -> str:
return pulumi.get(self, "policy_type")
@property
@pulumi.getter
def priority(self) -> str:
return pulumi.get(self, "priority")
@property
@pulumi.getter(name="reauthDefaultRule")
def reauth_default_rule(self) -> bool:
return pulumi.get(self, "reauth_default_rule")
@property
@pulumi.getter(name="reauthIdleTimeout")
def reauth_idle_timeout(self) -> str:
return pulumi.get(self, "reauth_idle_timeout")
@property
@pulumi.getter(name="reauthTimeout")
def reauth_timeout(self) -> str:
return pulumi.get(self, "reauth_timeout")
@property
@pulumi.getter(name="ruleOrder")
def rule_order(self) -> str:
return pulumi.get(self, "rule_order")
@property
@pulumi.getter(name="zpnCbiProfileId")
def zpn_cbi_profile_id(self) -> str:
return pulumi.get(self, "zpn_cbi_profile_id")
@property
@pulumi.getter(name="zpnInspectionProfileId")
def zpn_inspection_profile_id(self) -> str:
return pulumi.get(self, "zpn_inspection_profile_id")
@property
@pulumi.getter(name="zpnInspectionProfileName")
def zpn_inspection_profile_name(self) -> str:
return pulumi.get(self, "zpn_inspection_profile_name")
@pulumi.output_type
class GetLSSConfigControllerPolicyRuleConditionResult(dict):
def __init__(__self__, *,
creation_time: str,
id: str,
modified_time: str,
modifiedby: str,
negated: bool,
operands: Sequence['outputs.GetLSSConfigControllerPolicyRuleConditionOperandResult'],
operator: str):
"""
:param str creation_time: (string)
:param str id: This field defines the name of the log streaming resource.
:param str modified_time: (string)
"""
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "negated", negated)
pulumi.set(__self__, "operands", operands)
pulumi.set(__self__, "operator", operator)
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def negated(self) -> bool:
return pulumi.get(self, "negated")
@property
@pulumi.getter
def operands(self) -> Sequence['outputs.GetLSSConfigControllerPolicyRuleConditionOperandResult']:
return pulumi.get(self, "operands")
@property
@pulumi.getter
def operator(self) -> str:
return pulumi.get(self, "operator")
@pulumi.output_type
class GetLSSConfigControllerPolicyRuleConditionOperandResult(dict):
def __init__(__self__, *,
creation_time: str,
id: str,
idp_id: str,
lhs: str,
modified_time: str,
modifiedby: str,
name: str,
object_type: str,
operator: str,
rhs: str):
"""
:param str creation_time: (string)
:param str id: This field defines the name of the log streaming resource.
:param str modified_time: (string)
:param str name: This field defines the name of the log streaming resource.
"""
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "idp_id", idp_id)
pulumi.set(__self__, "lhs", lhs)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "object_type", object_type)
pulumi.set(__self__, "operator", operator)
pulumi.set(__self__, "rhs", rhs)
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def id(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> str:
return pulumi.get(self, "idp_id")
@property
@pulumi.getter
def lhs(self) -> str:
return pulumi.get(self, "lhs")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
This field defines the name of the log streaming resource.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="objectType")
def object_type(self) -> str:
return pulumi.get(self, "object_type")
@property
@pulumi.getter
def operator(self) -> str:
return pulumi.get(self, "operator")
@property
@pulumi.getter
def rhs(self) -> str:
return pulumi.get(self, "rhs") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/lssconfig/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['LSSConfigControllerArgs', 'LSSConfigController']
@pulumi.input_type
class LSSConfigControllerArgs:
def __init__(__self__, *,
config: Optional[pulumi.Input['LSSConfigControllerConfigArgs']] = None,
connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]]] = None,
policy_rule_resource: Optional[pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs']] = None):
"""
The set of arguments for constructing a LSSConfigController resource.
:param pulumi.Input['LSSConfigControllerConfigArgs'] config: (Required)
:param pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]] connector_groups: (Optional)
:param pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs'] policy_rule_resource: (Optional)
"""
if config is not None:
pulumi.set(__self__, "config", config)
if connector_groups is not None:
pulumi.set(__self__, "connector_groups", connector_groups)
if policy_rule_resource is not None:
pulumi.set(__self__, "policy_rule_resource", policy_rule_resource)
@property
@pulumi.getter
def config(self) -> Optional[pulumi.Input['LSSConfigControllerConfigArgs']]:
"""
(Required)
"""
return pulumi.get(self, "config")
@config.setter
def config(self, value: Optional[pulumi.Input['LSSConfigControllerConfigArgs']]):
pulumi.set(self, "config", value)
@property
@pulumi.getter(name="connectorGroups")
def connector_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]]]:
"""
(Optional)
"""
return pulumi.get(self, "connector_groups")
@connector_groups.setter
def connector_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]]]):
pulumi.set(self, "connector_groups", value)
@property
@pulumi.getter(name="policyRuleResource")
def policy_rule_resource(self) -> Optional[pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs']]:
"""
(Optional)
"""
return pulumi.get(self, "policy_rule_resource")
@policy_rule_resource.setter
def policy_rule_resource(self, value: Optional[pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs']]):
pulumi.set(self, "policy_rule_resource", value)
@pulumi.input_type
class _LSSConfigControllerState:
def __init__(__self__, *,
config: Optional[pulumi.Input['LSSConfigControllerConfigArgs']] = None,
connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]]] = None,
policy_rule_id: Optional[pulumi.Input[str]] = None,
policy_rule_resource: Optional[pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs']] = None):
"""
Input properties used for looking up and filtering LSSConfigController resources.
:param pulumi.Input['LSSConfigControllerConfigArgs'] config: (Required)
:param pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]] connector_groups: (Optional)
:param pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs'] policy_rule_resource: (Optional)
"""
if config is not None:
pulumi.set(__self__, "config", config)
if connector_groups is not None:
pulumi.set(__self__, "connector_groups", connector_groups)
if policy_rule_id is not None:
pulumi.set(__self__, "policy_rule_id", policy_rule_id)
if policy_rule_resource is not None:
pulumi.set(__self__, "policy_rule_resource", policy_rule_resource)
@property
@pulumi.getter
def config(self) -> Optional[pulumi.Input['LSSConfigControllerConfigArgs']]:
"""
(Required)
"""
return pulumi.get(self, "config")
@config.setter
def config(self, value: Optional[pulumi.Input['LSSConfigControllerConfigArgs']]):
pulumi.set(self, "config", value)
@property
@pulumi.getter(name="connectorGroups")
def connector_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]]]:
"""
(Optional)
"""
return pulumi.get(self, "connector_groups")
@connector_groups.setter
def connector_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LSSConfigControllerConnectorGroupArgs']]]]):
pulumi.set(self, "connector_groups", value)
@property
@pulumi.getter(name="policyRuleId")
def policy_rule_id(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "policy_rule_id")
@policy_rule_id.setter
def policy_rule_id(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "policy_rule_id", value)
@property
@pulumi.getter(name="policyRuleResource")
def policy_rule_resource(self) -> Optional[pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs']]:
"""
(Optional)
"""
return pulumi.get(self, "policy_rule_resource")
@policy_rule_resource.setter
def policy_rule_resource(self, value: Optional[pulumi.Input['LSSConfigControllerPolicyRuleResourceArgs']]):
pulumi.set(self, "policy_rule_resource", value)
class LSSConfigController(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
config: Optional[pulumi.Input[pulumi.InputType['LSSConfigControllerConfigArgs']]] = None,
connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LSSConfigControllerConnectorGroupArgs']]]]] = None,
policy_rule_resource: Optional[pulumi.Input[pulumi.InputType['LSSConfigControllerPolicyRuleResourceArgs']]] = None,
__props__=None):
"""
The **zpa_lss_config_controller** resource creates and manages Log Streaming Service (LSS) in the Zscaler Private Access cloud.
## Example 1 Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
zpn_ast_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_ast_auth_log")
# Create Log Receiver Configuration
example = zpa.lss_config.LSSConfigController("example",
config=zpa.lss_config.LSSConfigControllerConfigArgs(
name="Example",
description="Example",
enabled=True,
format=zpn_ast_auth_log.json,
lss_host="splunk.acme.com",
lss_port="11000",
source_log_type="zpn_ast_auth_log",
use_tls=True,
filters=[
"ZPN_STATUS_AUTH_FAILED",
"ZPN_STATUS_DISCONNECTED",
"ZPN_STATUS_AUTHENTICATED",
],
),
connector_groups=[zpa.lss_config.LSSConfigControllerConnectorGroupArgs(
ids=[zpa_app_connector_group["example"]["id"]],
)])
```
## Example 2 Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
zpn_trans_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_trans_log")
lss_siem_policy = zpa.PolicyType.get_policy_type(policy_type="SIEM_POLICY")
lss_user_activity = zpa.lss_config.LSSConfigController("lssUserActivity",
config=zpa.lss_config.LSSConfigControllerConfigArgs(
name="LSS User Activity",
description="LSS User Activity",
enabled=True,
format=zpn_trans_log.json,
lss_host="splunk.acme.com",
lss_port="11001",
source_log_type="zpn_trans_log",
use_tls=True,
),
policy_rule_resource=zpa.lss_config.LSSConfigControllerPolicyRuleResourceArgs(
name="policy_rule_resource-lss_user_activity",
action="ALLOW",
policy_set_id=lss_siem_policy.id,
conditions=[zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionArgs(
negated=False,
operator="OR",
operands=[
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_exporter"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_ip_anchoring"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_zapp"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_edge_connector"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_machine_tunnel"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_browser_isolation"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_slogger"],
),
],
)],
),
connector_groups=[zpa.lss_config.LSSConfigControllerConnectorGroupArgs(
ids=[zpa_app_connector_group["example"]["id"]],
)])
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer)
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[pulumi.InputType['LSSConfigControllerConfigArgs']] config: (Required)
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LSSConfigControllerConnectorGroupArgs']]]] connector_groups: (Optional)
:param pulumi.Input[pulumi.InputType['LSSConfigControllerPolicyRuleResourceArgs']] policy_rule_resource: (Optional)
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[LSSConfigControllerArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
The **zpa_lss_config_controller** resource creates and manages Log Streaming Service (LSS) in the Zscaler Private Access cloud.
## Example 1 Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
zpn_ast_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_ast_auth_log")
# Create Log Receiver Configuration
example = zpa.lss_config.LSSConfigController("example",
config=zpa.lss_config.LSSConfigControllerConfigArgs(
name="Example",
description="Example",
enabled=True,
format=zpn_ast_auth_log.json,
lss_host="splunk.acme.com",
lss_port="11000",
source_log_type="zpn_ast_auth_log",
use_tls=True,
filters=[
"ZPN_STATUS_AUTH_FAILED",
"ZPN_STATUS_DISCONNECTED",
"ZPN_STATUS_AUTHENTICATED",
],
),
connector_groups=[zpa.lss_config.LSSConfigControllerConnectorGroupArgs(
ids=[zpa_app_connector_group["example"]["id"]],
)])
```
## Example 2 Usage
```python
import pulumi
import pulumi_zpa as zpa
import zscaler_pulumi_zpa as zpa
zpn_trans_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_trans_log")
lss_siem_policy = zpa.PolicyType.get_policy_type(policy_type="SIEM_POLICY")
lss_user_activity = zpa.lss_config.LSSConfigController("lssUserActivity",
config=zpa.lss_config.LSSConfigControllerConfigArgs(
name="LSS User Activity",
description="LSS User Activity",
enabled=True,
format=zpn_trans_log.json,
lss_host="splunk.acme.com",
lss_port="11001",
source_log_type="zpn_trans_log",
use_tls=True,
),
policy_rule_resource=zpa.lss_config.LSSConfigControllerPolicyRuleResourceArgs(
name="policy_rule_resource-lss_user_activity",
action="ALLOW",
policy_set_id=lss_siem_policy.id,
conditions=[zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionArgs(
negated=False,
operator="OR",
operands=[
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_exporter"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_ip_anchoring"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_zapp"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_edge_connector"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_machine_tunnel"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_browser_isolation"],
),
zpa.lss_config.LSSConfigControllerPolicyRuleResourceConditionOperandArgs(
object_type="CLIENT_TYPE",
values=["zpn_client_type_slogger"],
),
],
)],
),
connector_groups=[zpa.lss_config.LSSConfigControllerConnectorGroupArgs(
ids=[zpa_app_connector_group["example"]["id"]],
)])
```
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer)
:param str resource_name: The name of the resource.
:param LSSConfigControllerArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(LSSConfigControllerArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
config: Optional[pulumi.Input[pulumi.InputType['LSSConfigControllerConfigArgs']]] = None,
connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LSSConfigControllerConnectorGroupArgs']]]]] = None,
policy_rule_resource: Optional[pulumi.Input[pulumi.InputType['LSSConfigControllerPolicyRuleResourceArgs']]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = LSSConfigControllerArgs.__new__(LSSConfigControllerArgs)
__props__.__dict__["config"] = config
__props__.__dict__["connector_groups"] = connector_groups
__props__.__dict__["policy_rule_resource"] = policy_rule_resource
__props__.__dict__["policy_rule_id"] = None
super(LSSConfigController, __self__).__init__(
'zpa:LSSConfig/lSSConfigController:LSSConfigController',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
config: Optional[pulumi.Input[pulumi.InputType['LSSConfigControllerConfigArgs']]] = None,
connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LSSConfigControllerConnectorGroupArgs']]]]] = None,
policy_rule_id: Optional[pulumi.Input[str]] = None,
policy_rule_resource: Optional[pulumi.Input[pulumi.InputType['LSSConfigControllerPolicyRuleResourceArgs']]] = None) -> 'LSSConfigController':
"""
Get an existing LSSConfigController resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[pulumi.InputType['LSSConfigControllerConfigArgs']] config: (Required)
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['LSSConfigControllerConnectorGroupArgs']]]] connector_groups: (Optional)
:param pulumi.Input[pulumi.InputType['LSSConfigControllerPolicyRuleResourceArgs']] policy_rule_resource: (Optional)
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _LSSConfigControllerState.__new__(_LSSConfigControllerState)
__props__.__dict__["config"] = config
__props__.__dict__["connector_groups"] = connector_groups
__props__.__dict__["policy_rule_id"] = policy_rule_id
__props__.__dict__["policy_rule_resource"] = policy_rule_resource
return LSSConfigController(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def config(self) -> pulumi.Output[Optional['outputs.LSSConfigControllerConfig']]:
"""
(Required)
"""
return pulumi.get(self, "config")
@property
@pulumi.getter(name="connectorGroups")
def connector_groups(self) -> pulumi.Output[Optional[Sequence['outputs.LSSConfigControllerConnectorGroup']]]:
"""
(Optional)
"""
return pulumi.get(self, "connector_groups")
@property
@pulumi.getter(name="policyRuleId")
def policy_rule_id(self) -> pulumi.Output[str]:
return pulumi.get(self, "policy_rule_id")
@property
@pulumi.getter(name="policyRuleResource")
def policy_rule_resource(self) -> pulumi.Output[Optional['outputs.LSSConfigControllerPolicyRuleResource']]:
"""
(Optional)
"""
return pulumi.get(self, "policy_rule_resource") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/lssconfig/lss_config_controller.py | lss_config_controller.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetLSSLogTypeFormatsResult',
'AwaitableGetLSSLogTypeFormatsResult',
'get_lss_log_type_formats',
'get_lss_log_type_formats_output',
]
@pulumi.output_type
class GetLSSLogTypeFormatsResult:
"""
A collection of values returned by getLSSLogTypeFormats.
"""
def __init__(__self__, csv=None, id=None, json=None, log_type=None, tsv=None):
if csv and not isinstance(csv, str):
raise TypeError("Expected argument 'csv' to be a str")
pulumi.set(__self__, "csv", csv)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if json and not isinstance(json, str):
raise TypeError("Expected argument 'json' to be a str")
pulumi.set(__self__, "json", json)
if log_type and not isinstance(log_type, str):
raise TypeError("Expected argument 'log_type' to be a str")
pulumi.set(__self__, "log_type", log_type)
if tsv and not isinstance(tsv, str):
raise TypeError("Expected argument 'tsv' to be a str")
pulumi.set(__self__, "tsv", tsv)
@property
@pulumi.getter
def csv(self) -> str:
return pulumi.get(self, "csv")
@property
@pulumi.getter
def id(self) -> str:
"""
The provider-assigned unique ID for this managed resource.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def json(self) -> str:
return pulumi.get(self, "json")
@property
@pulumi.getter(name="logType")
def log_type(self) -> str:
return pulumi.get(self, "log_type")
@property
@pulumi.getter
def tsv(self) -> str:
return pulumi.get(self, "tsv")
class AwaitableGetLSSLogTypeFormatsResult(GetLSSLogTypeFormatsResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetLSSLogTypeFormatsResult(
csv=self.csv,
id=self.id,
json=self.json,
log_type=self.log_type,
tsv=self.tsv)
def get_lss_log_type_formats(log_type: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetLSSLogTypeFormatsResult:
"""
Use the **zpa_lss_config_log_type_formats** data source to get information about all LSS log type formats in the Zscaler Private Access cloud. This data source is required when creating an LSS Config Controller resource.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
zpn_trans_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_trans_log")
zpn_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_auth_log")
zpn_ast_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_ast_auth_log")
zpn_http_trans_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_http_trans_log")
zpn_audit_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_audit_log")
zpn_sys_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_sys_auth_log")
zpn_ast_comprehensive_stats = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_ast_comprehensive_stats")
zpn_waf_http_exchanges_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_waf_http_exchanges_log")
zpn_pbroker_comprehensive_stats = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_pbroker_comprehensive_stats")
```
:param str log_type: The type of log to be exported.
"""
__args__ = dict()
__args__['logType'] = log_type
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:LSSConfig/getLSSLogTypeFormats:getLSSLogTypeFormats', __args__, opts=opts, typ=GetLSSLogTypeFormatsResult).value
return AwaitableGetLSSLogTypeFormatsResult(
csv=__ret__.csv,
id=__ret__.id,
json=__ret__.json,
log_type=__ret__.log_type,
tsv=__ret__.tsv)
@_utilities.lift_output_func(get_lss_log_type_formats)
def get_lss_log_type_formats_output(log_type: Optional[pulumi.Input[str]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetLSSLogTypeFormatsResult]:
"""
Use the **zpa_lss_config_log_type_formats** data source to get information about all LSS log type formats in the Zscaler Private Access cloud. This data source is required when creating an LSS Config Controller resource.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
zpn_trans_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_trans_log")
zpn_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_auth_log")
zpn_ast_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_ast_auth_log")
zpn_http_trans_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_http_trans_log")
zpn_audit_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_audit_log")
zpn_sys_auth_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_sys_auth_log")
zpn_ast_comprehensive_stats = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_ast_comprehensive_stats")
zpn_waf_http_exchanges_log = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_waf_http_exchanges_log")
zpn_pbroker_comprehensive_stats = zpa.LSSConfig.get_lss_log_type_formats(log_type="zpn_pbroker_comprehensive_stats")
```
:param str log_type: The type of log to be exported.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/lssconfig/get_lss_log_type_formats.py | get_lss_log_type_formats.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
__all__ = [
'GetSAMLAttributeResult',
'AwaitableGetSAMLAttributeResult',
'get_saml_attribute',
'get_saml_attribute_output',
]
@pulumi.output_type
class GetSAMLAttributeResult:
"""
A collection of values returned by getSAMLAttribute.
"""
def __init__(__self__, creation_time=None, id=None, idp_id=None, idp_name=None, modified_time=None, modifiedby=None, name=None, saml_name=None, user_attribute=None):
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if idp_id and not isinstance(idp_id, str):
raise TypeError("Expected argument 'idp_id' to be a str")
pulumi.set(__self__, "idp_id", idp_id)
if idp_name and not isinstance(idp_name, str):
raise TypeError("Expected argument 'idp_name' to be a str")
pulumi.set(__self__, "idp_name", idp_name)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if saml_name and not isinstance(saml_name, str):
raise TypeError("Expected argument 'saml_name' to be a str")
pulumi.set(__self__, "saml_name", saml_name)
if user_attribute and not isinstance(user_attribute, bool):
raise TypeError("Expected argument 'user_attribute' to be a bool")
pulumi.set(__self__, "user_attribute", user_attribute)
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def id(self) -> str:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="idpId")
def idp_id(self) -> str:
"""
(string) The ID of the IdP corresponding to the SAML attribute.
"""
return pulumi.get(self, "idp_id")
@property
@pulumi.getter(name="idpName")
def idp_name(self) -> Optional[str]:
return pulumi.get(self, "idp_name")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
"""
(string)
"""
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="samlName")
def saml_name(self) -> str:
"""
(string)
"""
return pulumi.get(self, "saml_name")
@property
@pulumi.getter(name="userAttribute")
def user_attribute(self) -> bool:
"""
(string)
"""
return pulumi.get(self, "user_attribute")
class AwaitableGetSAMLAttributeResult(GetSAMLAttributeResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetSAMLAttributeResult(
creation_time=self.creation_time,
id=self.id,
idp_id=self.idp_id,
idp_name=self.idp_name,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
saml_name=self.saml_name,
user_attribute=self.user_attribute)
def get_saml_attribute(id: Optional[str] = None,
idp_name: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSAMLAttributeResult:
"""
Use the **zpa_saml_attribute** data source to get information about a SAML Attributes from an Identity Provider (IdP). This data source can then be referenced in an Access Policy, Timeout policy, Forwarding Policy, Inspection Policy or Isolation Policy.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
email_user_sso = zpa.SamlAttribute.get_saml_attribute(name="Email_User SSO")
```
```python
import pulumi
import pulumi_zpa as zpa
department = zpa.SamlAttribute.get_saml_attribute(name="DepartmentName_IdP_Name_Users")
```
:param str id: The ID of the machine group to be exported.
:param str idp_name: The name of the IdP corresponding to the SAML attribute.
:param str name: The name of the saml attribute to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['idpName'] = idp_name
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:SamlAttribute/getSAMLAttribute:getSAMLAttribute', __args__, opts=opts, typ=GetSAMLAttributeResult).value
return AwaitableGetSAMLAttributeResult(
creation_time=__ret__.creation_time,
id=__ret__.id,
idp_id=__ret__.idp_id,
idp_name=__ret__.idp_name,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
saml_name=__ret__.saml_name,
user_attribute=__ret__.user_attribute)
@_utilities.lift_output_func(get_saml_attribute)
def get_saml_attribute_output(id: Optional[pulumi.Input[Optional[str]]] = None,
idp_name: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetSAMLAttributeResult]:
"""
Use the **zpa_saml_attribute** data source to get information about a SAML Attributes from an Identity Provider (IdP). This data source can then be referenced in an Access Policy, Timeout policy, Forwarding Policy, Inspection Policy or Isolation Policy.
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
email_user_sso = zpa.SamlAttribute.get_saml_attribute(name="Email_User SSO")
```
```python
import pulumi
import pulumi_zpa as zpa
department = zpa.SamlAttribute.get_saml_attribute(name="DepartmentName_IdP_Name_Users")
```
:param str id: The ID of the machine group to be exported.
:param str idp_name: The name of the IdP corresponding to the SAML attribute.
:param str name: The name of the saml attribute to be exported.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/samlattribute/get_saml_attribute.py | get_saml_attribute.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'ServerGroupAppConnectorGroup',
'ServerGroupApplication',
'ServerGroupServer',
'GetServerGroupAppConnectorGroupResult',
'GetServerGroupAppConnectorGroupConnectorResult',
'GetServerGroupAppConnectorGroupServerGroupResult',
'GetServerGroupApplicationResult',
'GetServerGroupServerResult',
]
@pulumi.output_type
class ServerGroupAppConnectorGroup(dict):
def __init__(__self__, *,
ids: Optional[Sequence[str]] = None):
if ids is not None:
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "ids")
@pulumi.output_type
class ServerGroupApplication(dict):
def __init__(__self__, *,
ids: Optional[Sequence[str]] = None):
if ids is not None:
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "ids")
@pulumi.output_type
class ServerGroupServer(dict):
def __init__(__self__, *,
ids: Optional[Sequence[str]] = None):
if ids is not None:
pulumi.set(__self__, "ids", ids)
@property
@pulumi.getter
def ids(self) -> Optional[Sequence[str]]:
return pulumi.get(self, "ids")
@pulumi.output_type
class GetServerGroupAppConnectorGroupResult(dict):
def __init__(__self__, *,
city_country: str,
connectors: Sequence['outputs.GetServerGroupAppConnectorGroupConnectorResult'],
country_code: str,
creation_time: str,
description: str,
dns_query_type: str,
enabled: bool,
geolocation_id: str,
id: str,
latitude: str,
location: str,
longitude: str,
modified_time: str,
modifiedby: str,
name: str,
server_groups: Sequence['outputs.GetServerGroupAppConnectorGroupServerGroupResult'],
siem_app_connector_group: bool,
upgrade_day: str,
upgrade_time_in_secs: str,
version_profile_id: str):
"""
:param str description: (string) This field is the description of the server group.
:param bool enabled: (bool) This field defines if the server group is enabled or disabled.
:param str id: The ID of the server group to be exported.
:param str name: The name of the server group to be exported.
"""
pulumi.set(__self__, "city_country", city_country)
pulumi.set(__self__, "connectors", connectors)
pulumi.set(__self__, "country_code", country_code)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "dns_query_type", dns_query_type)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "geolocation_id", geolocation_id)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "latitude", latitude)
pulumi.set(__self__, "location", location)
pulumi.set(__self__, "longitude", longitude)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
pulumi.set(__self__, "server_groups", server_groups)
pulumi.set(__self__, "siem_app_connector_group", siem_app_connector_group)
pulumi.set(__self__, "upgrade_day", upgrade_day)
pulumi.set(__self__, "upgrade_time_in_secs", upgrade_time_in_secs)
pulumi.set(__self__, "version_profile_id", version_profile_id)
@property
@pulumi.getter(name="cityCountry")
def city_country(self) -> str:
return pulumi.get(self, "city_country")
@property
@pulumi.getter
def connectors(self) -> Sequence['outputs.GetServerGroupAppConnectorGroupConnectorResult']:
return pulumi.get(self, "connectors")
@property
@pulumi.getter(name="countryCode")
def country_code(self) -> str:
return pulumi.get(self, "country_code")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="dnsQueryType")
def dns_query_type(self) -> str:
return pulumi.get(self, "dns_query_type")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="geolocationId")
def geolocation_id(self) -> str:
return pulumi.get(self, "geolocation_id")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the server group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def latitude(self) -> str:
return pulumi.get(self, "latitude")
@property
@pulumi.getter
def location(self) -> str:
return pulumi.get(self, "location")
@property
@pulumi.getter
def longitude(self) -> str:
return pulumi.get(self, "longitude")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the server group to be exported.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter(name="serverGroups")
def server_groups(self) -> Sequence['outputs.GetServerGroupAppConnectorGroupServerGroupResult']:
return pulumi.get(self, "server_groups")
@property
@pulumi.getter(name="siemAppConnectorGroup")
def siem_app_connector_group(self) -> bool:
return pulumi.get(self, "siem_app_connector_group")
@property
@pulumi.getter(name="upgradeDay")
def upgrade_day(self) -> str:
return pulumi.get(self, "upgrade_day")
@property
@pulumi.getter(name="upgradeTimeInSecs")
def upgrade_time_in_secs(self) -> str:
return pulumi.get(self, "upgrade_time_in_secs")
@property
@pulumi.getter(name="versionProfileId")
def version_profile_id(self) -> str:
return pulumi.get(self, "version_profile_id")
@pulumi.output_type
class GetServerGroupAppConnectorGroupConnectorResult(dict):
def __init__(__self__, *,
creation_time: str,
description: str,
enabled: bool,
fingerprint: str,
id: str,
issued_cert_id: str,
modified_time: str,
modifiedby: str,
upgrade_attempt: str,
name: Optional[str] = None):
"""
:param str description: (string) This field is the description of the server group.
:param bool enabled: (bool) This field defines if the server group is enabled or disabled.
:param str id: The ID of the server group to be exported.
:param str name: The name of the server group to be exported.
"""
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "fingerprint", fingerprint)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "issued_cert_id", issued_cert_id)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "upgrade_attempt", upgrade_attempt)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def fingerprint(self) -> str:
return pulumi.get(self, "fingerprint")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the server group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="issuedCertId")
def issued_cert_id(self) -> str:
return pulumi.get(self, "issued_cert_id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter(name="upgradeAttempt")
def upgrade_attempt(self) -> str:
return pulumi.get(self, "upgrade_attempt")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
The name of the server group to be exported.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetServerGroupAppConnectorGroupServerGroupResult(dict):
def __init__(__self__, *,
config_space: str,
creation_time: str,
description: str,
dynamic_discovery: bool,
enabled: bool,
id: str,
modified_time: str,
modifiedby: str,
name: Optional[str] = None):
"""
:param str config_space: (string)
:param str description: (string) This field is the description of the server group.
:param bool dynamic_discovery: (bool) This field controls dynamic discovery of the servers.
:param bool enabled: (bool) This field defines if the server group is enabled or disabled.
:param str id: The ID of the server group to be exported.
:param str name: The name of the server group to be exported.
"""
pulumi.set(__self__, "config_space", config_space)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "dynamic_discovery", dynamic_discovery)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="dynamicDiscovery")
def dynamic_discovery(self) -> bool:
"""
(bool) This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "dynamic_discovery")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the server group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
"""
The name of the server group to be exported.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetServerGroupApplicationResult(dict):
def __init__(__self__, *,
id: str,
name: str):
"""
:param str id: The ID of the server group to be exported.
:param str name: The name of the server group to be exported.
"""
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the server group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the server group to be exported.
"""
return pulumi.get(self, "name")
@pulumi.output_type
class GetServerGroupServerResult(dict):
def __init__(__self__, *,
address: str,
app_server_group_ids: Sequence[str],
config_space: str,
creation_time: str,
description: str,
enabled: bool,
id: str,
modified_time: str,
modifiedby: str,
name: str):
"""
:param str config_space: (string)
:param str description: (string) This field is the description of the server group.
:param bool enabled: (bool) This field defines if the server group is enabled or disabled.
:param str id: The ID of the server group to be exported.
:param str name: The name of the server group to be exported.
"""
pulumi.set(__self__, "address", address)
pulumi.set(__self__, "app_server_group_ids", app_server_group_ids)
pulumi.set(__self__, "config_space", config_space)
pulumi.set(__self__, "creation_time", creation_time)
pulumi.set(__self__, "description", description)
pulumi.set(__self__, "enabled", enabled)
pulumi.set(__self__, "id", id)
pulumi.set(__self__, "modified_time", modified_time)
pulumi.set(__self__, "modifiedby", modifiedby)
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def address(self) -> str:
return pulumi.get(self, "address")
@property
@pulumi.getter(name="appServerGroupIds")
def app_server_group_ids(self) -> Sequence[str]:
return pulumi.get(self, "app_server_group_ids")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> str:
"""
The ID of the server group to be exported.
"""
return pulumi.get(self, "id")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> str:
"""
The name of the server group to be exported.
"""
return pulumi.get(self, "name") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/servergroup/outputs.py | outputs.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
__all__ = [
'GetServerGroupResult',
'AwaitableGetServerGroupResult',
'get_server_group',
'get_server_group_output',
]
@pulumi.output_type
class GetServerGroupResult:
"""
A collection of values returned by getServerGroup.
"""
def __init__(__self__, app_connector_groups=None, applications=None, config_space=None, creation_time=None, description=None, dynamic_discovery=None, enabled=None, id=None, ip_anchored=None, modified_time=None, modifiedby=None, name=None, servers=None):
if app_connector_groups and not isinstance(app_connector_groups, list):
raise TypeError("Expected argument 'app_connector_groups' to be a list")
pulumi.set(__self__, "app_connector_groups", app_connector_groups)
if applications and not isinstance(applications, list):
raise TypeError("Expected argument 'applications' to be a list")
pulumi.set(__self__, "applications", applications)
if config_space and not isinstance(config_space, str):
raise TypeError("Expected argument 'config_space' to be a str")
pulumi.set(__self__, "config_space", config_space)
if creation_time and not isinstance(creation_time, str):
raise TypeError("Expected argument 'creation_time' to be a str")
pulumi.set(__self__, "creation_time", creation_time)
if description and not isinstance(description, str):
raise TypeError("Expected argument 'description' to be a str")
pulumi.set(__self__, "description", description)
if dynamic_discovery and not isinstance(dynamic_discovery, bool):
raise TypeError("Expected argument 'dynamic_discovery' to be a bool")
pulumi.set(__self__, "dynamic_discovery", dynamic_discovery)
if enabled and not isinstance(enabled, bool):
raise TypeError("Expected argument 'enabled' to be a bool")
pulumi.set(__self__, "enabled", enabled)
if id and not isinstance(id, str):
raise TypeError("Expected argument 'id' to be a str")
pulumi.set(__self__, "id", id)
if ip_anchored and not isinstance(ip_anchored, bool):
raise TypeError("Expected argument 'ip_anchored' to be a bool")
pulumi.set(__self__, "ip_anchored", ip_anchored)
if modified_time and not isinstance(modified_time, str):
raise TypeError("Expected argument 'modified_time' to be a str")
pulumi.set(__self__, "modified_time", modified_time)
if modifiedby and not isinstance(modifiedby, str):
raise TypeError("Expected argument 'modifiedby' to be a str")
pulumi.set(__self__, "modifiedby", modifiedby)
if name and not isinstance(name, str):
raise TypeError("Expected argument 'name' to be a str")
pulumi.set(__self__, "name", name)
if servers and not isinstance(servers, list):
raise TypeError("Expected argument 'servers' to be a list")
pulumi.set(__self__, "servers", servers)
@property
@pulumi.getter(name="appConnectorGroups")
def app_connector_groups(self) -> Sequence['outputs.GetServerGroupAppConnectorGroupResult']:
"""
(string)This field is a json array of app-connector-id only.
"""
return pulumi.get(self, "app_connector_groups")
@property
@pulumi.getter
def applications(self) -> Sequence['outputs.GetServerGroupApplicationResult']:
return pulumi.get(self, "applications")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> str:
"""
(string)
"""
return pulumi.get(self, "config_space")
@property
@pulumi.getter(name="creationTime")
def creation_time(self) -> str:
return pulumi.get(self, "creation_time")
@property
@pulumi.getter
def description(self) -> str:
"""
(string) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="dynamicDiscovery")
def dynamic_discovery(self) -> bool:
"""
(bool) This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "dynamic_discovery")
@property
@pulumi.getter
def enabled(self) -> bool:
"""
(bool) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter
def id(self) -> Optional[str]:
return pulumi.get(self, "id")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> bool:
"""
(bool)
"""
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter(name="modifiedTime")
def modified_time(self) -> str:
return pulumi.get(self, "modified_time")
@property
@pulumi.getter
def modifiedby(self) -> str:
return pulumi.get(self, "modifiedby")
@property
@pulumi.getter
def name(self) -> Optional[str]:
return pulumi.get(self, "name")
@property
@pulumi.getter
def servers(self) -> Sequence['outputs.GetServerGroupServerResult']:
return pulumi.get(self, "servers")
class AwaitableGetServerGroupResult(GetServerGroupResult):
# pylint: disable=using-constant-test
def __await__(self):
if False:
yield self
return GetServerGroupResult(
app_connector_groups=self.app_connector_groups,
applications=self.applications,
config_space=self.config_space,
creation_time=self.creation_time,
description=self.description,
dynamic_discovery=self.dynamic_discovery,
enabled=self.enabled,
id=self.id,
ip_anchored=self.ip_anchored,
modified_time=self.modified_time,
modifiedby=self.modifiedby,
name=self.name,
servers=self.servers)
def get_server_group(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetServerGroupResult:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ServerGroup.get_server_group(name="server_group_name")
```
:param str id: The ID of the server group to be exported.
:param str name: The name of the server group to be exported.
"""
__args__ = dict()
__args__['id'] = id
__args__['name'] = name
opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
__ret__ = pulumi.runtime.invoke('zpa:ServerGroup/getServerGroup:getServerGroup', __args__, opts=opts, typ=GetServerGroupResult).value
return AwaitableGetServerGroupResult(
app_connector_groups=__ret__.app_connector_groups,
applications=__ret__.applications,
config_space=__ret__.config_space,
creation_time=__ret__.creation_time,
description=__ret__.description,
dynamic_discovery=__ret__.dynamic_discovery,
enabled=__ret__.enabled,
id=__ret__.id,
ip_anchored=__ret__.ip_anchored,
modified_time=__ret__.modified_time,
modifiedby=__ret__.modifiedby,
name=__ret__.name,
servers=__ret__.servers)
@_utilities.lift_output_func(get_server_group)
def get_server_group_output(id: Optional[pulumi.Input[Optional[str]]] = None,
name: Optional[pulumi.Input[Optional[str]]] = None,
opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetServerGroupResult]:
"""
## Example Usage
```python
import pulumi
import pulumi_zpa as zpa
example = zpa.ServerGroup.get_server_group(name="server_group_name")
```
:param str id: The ID of the server group to be exported.
:param str name: The name of the server group to be exported.
"""
... | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/servergroup/get_server_group.py | get_server_group.py |
import copy
import warnings
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
from .. import _utilities
from . import outputs
from ._inputs import *
__all__ = ['ServerGroupArgs', 'ServerGroup']
@pulumi.input_type
class ServerGroupArgs:
def __init__(__self__, *,
app_connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]]] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
dynamic_discovery: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
servers: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]]] = None):
"""
The set of arguments for constructing a ServerGroup resource.
:param pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]] app_connector_groups: List of app-connector IDs.
:param pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]] applications: This field is a json array of app-connector-id only.
:param pulumi.Input[str] description: (Optional) This field is the description of the server group.
:param pulumi.Input[bool] dynamic_discovery: (Optional) This field controls dynamic discovery of the servers.
:param pulumi.Input[bool] enabled: (Optional) This field defines if the server group is enabled or disabled.
:param pulumi.Input[str] name: This field defines the name of the server group.
:param pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]] servers: (Block List) This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API.
"""
if app_connector_groups is not None:
pulumi.set(__self__, "app_connector_groups", app_connector_groups)
if applications is not None:
pulumi.set(__self__, "applications", applications)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if dynamic_discovery is not None:
pulumi.set(__self__, "dynamic_discovery", dynamic_discovery)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if name is not None:
pulumi.set(__self__, "name", name)
if servers is not None:
pulumi.set(__self__, "servers", servers)
@property
@pulumi.getter(name="appConnectorGroups")
def app_connector_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]]]:
"""
List of app-connector IDs.
"""
return pulumi.get(self, "app_connector_groups")
@app_connector_groups.setter
def app_connector_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]]]):
pulumi.set(self, "app_connector_groups", value)
@property
@pulumi.getter
def applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]]]:
"""
This field is a json array of app-connector-id only.
"""
return pulumi.get(self, "applications")
@applications.setter
def applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]]]):
pulumi.set(self, "applications", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="dynamicDiscovery")
def dynamic_discovery(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "dynamic_discovery")
@dynamic_discovery.setter
def dynamic_discovery(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "dynamic_discovery", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
This field defines the name of the server group.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def servers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]]]:
"""
(Block List) This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API.
"""
return pulumi.get(self, "servers")
@servers.setter
def servers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]]]):
pulumi.set(self, "servers", value)
@pulumi.input_type
class _ServerGroupState:
def __init__(__self__, *,
app_connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]]] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
dynamic_discovery: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
servers: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]]] = None):
"""
Input properties used for looking up and filtering ServerGroup resources.
:param pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]] app_connector_groups: List of app-connector IDs.
:param pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]] applications: This field is a json array of app-connector-id only.
:param pulumi.Input[str] description: (Optional) This field is the description of the server group.
:param pulumi.Input[bool] dynamic_discovery: (Optional) This field controls dynamic discovery of the servers.
:param pulumi.Input[bool] enabled: (Optional) This field defines if the server group is enabled or disabled.
:param pulumi.Input[str] name: This field defines the name of the server group.
:param pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]] servers: (Block List) This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API.
"""
if app_connector_groups is not None:
pulumi.set(__self__, "app_connector_groups", app_connector_groups)
if applications is not None:
pulumi.set(__self__, "applications", applications)
if config_space is not None:
pulumi.set(__self__, "config_space", config_space)
if description is not None:
pulumi.set(__self__, "description", description)
if dynamic_discovery is not None:
pulumi.set(__self__, "dynamic_discovery", dynamic_discovery)
if enabled is not None:
pulumi.set(__self__, "enabled", enabled)
if ip_anchored is not None:
pulumi.set(__self__, "ip_anchored", ip_anchored)
if name is not None:
pulumi.set(__self__, "name", name)
if servers is not None:
pulumi.set(__self__, "servers", servers)
@property
@pulumi.getter(name="appConnectorGroups")
def app_connector_groups(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]]]:
"""
List of app-connector IDs.
"""
return pulumi.get(self, "app_connector_groups")
@app_connector_groups.setter
def app_connector_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupAppConnectorGroupArgs']]]]):
pulumi.set(self, "app_connector_groups", value)
@property
@pulumi.getter
def applications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]]]:
"""
This field is a json array of app-connector-id only.
"""
return pulumi.get(self, "applications")
@applications.setter
def applications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupApplicationArgs']]]]):
pulumi.set(self, "applications", value)
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> Optional[pulumi.Input[str]]:
return pulumi.get(self, "config_space")
@config_space.setter
def config_space(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "config_space", value)
@property
@pulumi.getter
def description(self) -> Optional[pulumi.Input[str]]:
"""
(Optional) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@description.setter
def description(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "description", value)
@property
@pulumi.getter(name="dynamicDiscovery")
def dynamic_discovery(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "dynamic_discovery")
@dynamic_discovery.setter
def dynamic_discovery(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "dynamic_discovery", value)
@property
@pulumi.getter
def enabled(self) -> Optional[pulumi.Input[bool]]:
"""
(Optional) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@enabled.setter
def enabled(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "enabled", value)
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> Optional[pulumi.Input[bool]]:
return pulumi.get(self, "ip_anchored")
@ip_anchored.setter
def ip_anchored(self, value: Optional[pulumi.Input[bool]]):
pulumi.set(self, "ip_anchored", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
This field defines the name of the server group.
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@property
@pulumi.getter
def servers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]]]:
"""
(Block List) This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API.
"""
return pulumi.get(self, "servers")
@servers.setter
def servers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ServerGroupServerArgs']]]]):
pulumi.set(self, "servers", value)
class ServerGroup(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
app_connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupAppConnectorGroupArgs']]]]] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupApplicationArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
dynamic_discovery: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
servers: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupServerArgs']]]]] = None,
__props__=None):
"""
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# Create a App Connector Group
example_connector_group = zpa.app_connector_group.ConnectorGroup("exampleConnectorGroup",
description="Example",
enabled=True,
city_country="San Jose, CA",
country_code="US",
latitude="37.338",
longitude="-121.8863",
location="San Jose, CA, US",
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
override_version_profile=True,
version_profile_id="0",
dns_query_type="IPV4")
# Create a Server Group resource with Dynamic Discovery Enabled
example_server_group = zpa.server_group.ServerGroup("exampleServerGroup",
description="Example",
enabled=True,
dynamic_discovery=True,
app_connector_groups=[zpa.server_group.ServerGroupAppConnectorGroupArgs(
ids=[example_connector_group.id],
)],
opts=pulumi.ResourceOptions(depends_on=[example_connector_group]))
```
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# Create an application server
example_application_server = zpa.application_server.ApplicationServer("exampleApplicationServer",
description="Example",
address="server.example.com",
enabled=True)
# Create a App Connector Group
example_connector_group = zpa.app_connector_group.ConnectorGroup("exampleConnectorGroup",
description="Example",
enabled=True,
city_country="San Jose, CA",
country_code="US",
latitude="37.338",
longitude="-121.8863",
location="San Jose, CA, US",
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
override_version_profile=True,
version_profile_id="0",
dns_query_type="IPV4")
# ZPA Server Group resource with Dynamic Discovery Disabled
example_server_group = zpa.server_group.ServerGroup("exampleServerGroup",
description="Example",
enabled=True,
dynamic_discovery=False,
servers=[zpa.server_group.ServerGroupServerArgs(
ids=[example_application_server.id],
)],
app_connector_groups=[zpa.server_group.ServerGroupAppConnectorGroupArgs(
ids=[example_connector_group.id],
)],
opts=pulumi.ResourceOptions(depends_on=[
example_connector_group,
zpa_application_server["server"],
]))
```
### Required
* `name` - (Required) This field defines the name of the server group.
* `app_connector_groups` - (Required)
* `id` - (Required) The ID of this resource.
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Server Groups can be imported; use `<SERVER GROUP ID>` or `<SERVER GROUP NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ServerGroup/serverGroup:ServerGroup example <server_group_id>
```
or
```sh
$ pulumi import zpa:ServerGroup/serverGroup:ServerGroup example <server_group_name>
```
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupAppConnectorGroupArgs']]]] app_connector_groups: List of app-connector IDs.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupApplicationArgs']]]] applications: This field is a json array of app-connector-id only.
:param pulumi.Input[str] description: (Optional) This field is the description of the server group.
:param pulumi.Input[bool] dynamic_discovery: (Optional) This field controls dynamic discovery of the servers.
:param pulumi.Input[bool] enabled: (Optional) This field defines if the server group is enabled or disabled.
:param pulumi.Input[str] name: This field defines the name of the server group.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupServerArgs']]]] servers: (Block List) This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[ServerGroupArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
## Example Usage
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# Create a App Connector Group
example_connector_group = zpa.app_connector_group.ConnectorGroup("exampleConnectorGroup",
description="Example",
enabled=True,
city_country="San Jose, CA",
country_code="US",
latitude="37.338",
longitude="-121.8863",
location="San Jose, CA, US",
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
override_version_profile=True,
version_profile_id="0",
dns_query_type="IPV4")
# Create a Server Group resource with Dynamic Discovery Enabled
example_server_group = zpa.server_group.ServerGroup("exampleServerGroup",
description="Example",
enabled=True,
dynamic_discovery=True,
app_connector_groups=[zpa.server_group.ServerGroupAppConnectorGroupArgs(
ids=[example_connector_group.id],
)],
opts=pulumi.ResourceOptions(depends_on=[example_connector_group]))
```
```python
import pulumi
import zscaler_pulumi_zpa as zpa
# Create an application server
example_application_server = zpa.application_server.ApplicationServer("exampleApplicationServer",
description="Example",
address="server.example.com",
enabled=True)
# Create a App Connector Group
example_connector_group = zpa.app_connector_group.ConnectorGroup("exampleConnectorGroup",
description="Example",
enabled=True,
city_country="San Jose, CA",
country_code="US",
latitude="37.338",
longitude="-121.8863",
location="San Jose, CA, US",
upgrade_day="SUNDAY",
upgrade_time_in_secs="66600",
override_version_profile=True,
version_profile_id="0",
dns_query_type="IPV4")
# ZPA Server Group resource with Dynamic Discovery Disabled
example_server_group = zpa.server_group.ServerGroup("exampleServerGroup",
description="Example",
enabled=True,
dynamic_discovery=False,
servers=[zpa.server_group.ServerGroupServerArgs(
ids=[example_application_server.id],
)],
app_connector_groups=[zpa.server_group.ServerGroupAppConnectorGroupArgs(
ids=[example_connector_group.id],
)],
opts=pulumi.ResourceOptions(depends_on=[
example_connector_group,
zpa_application_server["server"],
]))
```
### Required
* `name` - (Required) This field defines the name of the server group.
* `app_connector_groups` - (Required)
* `id` - (Required) The ID of this resource.
## Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. [Visit](https://github.com/zscaler/zscaler-terraformer) Server Groups can be imported; use `<SERVER GROUP ID>` or `<SERVER GROUP NAME>` as the import ID. For example
```sh
$ pulumi import zpa:ServerGroup/serverGroup:ServerGroup example <server_group_id>
```
or
```sh
$ pulumi import zpa:ServerGroup/serverGroup:ServerGroup example <server_group_name>
```
:param str resource_name: The name of the resource.
:param ServerGroupArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(ServerGroupArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
app_connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupAppConnectorGroupArgs']]]]] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupApplicationArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
dynamic_discovery: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
servers: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupServerArgs']]]]] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = ServerGroupArgs.__new__(ServerGroupArgs)
__props__.__dict__["app_connector_groups"] = app_connector_groups
__props__.__dict__["applications"] = applications
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["dynamic_discovery"] = dynamic_discovery
__props__.__dict__["enabled"] = enabled
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["name"] = name
__props__.__dict__["servers"] = servers
super(ServerGroup, __self__).__init__(
'zpa:ServerGroup/serverGroup:ServerGroup',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
app_connector_groups: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupAppConnectorGroupArgs']]]]] = None,
applications: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupApplicationArgs']]]]] = None,
config_space: Optional[pulumi.Input[str]] = None,
description: Optional[pulumi.Input[str]] = None,
dynamic_discovery: Optional[pulumi.Input[bool]] = None,
enabled: Optional[pulumi.Input[bool]] = None,
ip_anchored: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
servers: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupServerArgs']]]]] = None) -> 'ServerGroup':
"""
Get an existing ServerGroup resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupAppConnectorGroupArgs']]]] app_connector_groups: List of app-connector IDs.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupApplicationArgs']]]] applications: This field is a json array of app-connector-id only.
:param pulumi.Input[str] description: (Optional) This field is the description of the server group.
:param pulumi.Input[bool] dynamic_discovery: (Optional) This field controls dynamic discovery of the servers.
:param pulumi.Input[bool] enabled: (Optional) This field defines if the server group is enabled or disabled.
:param pulumi.Input[str] name: This field defines the name of the server group.
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ServerGroupServerArgs']]]] servers: (Block List) This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _ServerGroupState.__new__(_ServerGroupState)
__props__.__dict__["app_connector_groups"] = app_connector_groups
__props__.__dict__["applications"] = applications
__props__.__dict__["config_space"] = config_space
__props__.__dict__["description"] = description
__props__.__dict__["dynamic_discovery"] = dynamic_discovery
__props__.__dict__["enabled"] = enabled
__props__.__dict__["ip_anchored"] = ip_anchored
__props__.__dict__["name"] = name
__props__.__dict__["servers"] = servers
return ServerGroup(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter(name="appConnectorGroups")
def app_connector_groups(self) -> pulumi.Output[Sequence['outputs.ServerGroupAppConnectorGroup']]:
"""
List of app-connector IDs.
"""
return pulumi.get(self, "app_connector_groups")
@property
@pulumi.getter
def applications(self) -> pulumi.Output[Sequence['outputs.ServerGroupApplication']]:
"""
This field is a json array of app-connector-id only.
"""
return pulumi.get(self, "applications")
@property
@pulumi.getter(name="configSpace")
def config_space(self) -> pulumi.Output[Optional[str]]:
return pulumi.get(self, "config_space")
@property
@pulumi.getter
def description(self) -> pulumi.Output[Optional[str]]:
"""
(Optional) This field is the description of the server group.
"""
return pulumi.get(self, "description")
@property
@pulumi.getter(name="dynamicDiscovery")
def dynamic_discovery(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) This field controls dynamic discovery of the servers.
"""
return pulumi.get(self, "dynamic_discovery")
@property
@pulumi.getter
def enabled(self) -> pulumi.Output[Optional[bool]]:
"""
(Optional) This field defines if the server group is enabled or disabled.
"""
return pulumi.get(self, "enabled")
@property
@pulumi.getter(name="ipAnchored")
def ip_anchored(self) -> pulumi.Output[Optional[bool]]:
return pulumi.get(self, "ip_anchored")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
This field defines the name of the server group.
"""
return pulumi.get(self, "name")
@property
@pulumi.getter
def servers(self) -> pulumi.Output[Sequence['outputs.ServerGroupServer']]:
"""
(Block List) This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API.
"""
return pulumi.get(self, "servers") | zscaler-pulumi-zpa | /zscaler_pulumi_zpa-0.0.4.tar.gz/zscaler_pulumi_zpa-0.0.4/zscaler_pulumi_zpa/servergroup/server_group.py | server_group.py |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.