checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpoint.getManagementThreatRulebase
Explore with Pulumi AI
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
Use this data source to get information on an existing threat RuleBase.
Using getManagementThreatRulebase
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getManagementThreatRulebase(args: GetManagementThreatRulebaseArgs, opts?: InvokeOptions): Promise<GetManagementThreatRulebaseResult>
function getManagementThreatRulebaseOutput(args: GetManagementThreatRulebaseOutputArgs, opts?: InvokeOptions): Output<GetManagementThreatRulebaseResult>
def get_management_threat_rulebase(dereference_group_members: Optional[bool] = None,
filter: Optional[str] = None,
filter_settings: Optional[Mapping[str, str]] = None,
hits_settings: Optional[Mapping[str, str]] = None,
id: Optional[str] = None,
limit: Optional[float] = None,
name: Optional[str] = None,
offset: Optional[float] = None,
orders: Optional[Sequence[GetManagementThreatRulebaseOrder]] = None,
package: Optional[str] = None,
show_as_ranges: Optional[bool] = None,
show_hits: Optional[bool] = None,
show_membership: Optional[bool] = None,
uid: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetManagementThreatRulebaseResult
def get_management_threat_rulebase_output(dereference_group_members: Optional[pulumi.Input[bool]] = None,
filter: Optional[pulumi.Input[str]] = None,
filter_settings: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
hits_settings: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
id: Optional[pulumi.Input[str]] = None,
limit: Optional[pulumi.Input[float]] = None,
name: Optional[pulumi.Input[str]] = None,
offset: Optional[pulumi.Input[float]] = None,
orders: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagementThreatRulebaseOrderArgs]]]] = None,
package: Optional[pulumi.Input[str]] = None,
show_as_ranges: Optional[pulumi.Input[bool]] = None,
show_hits: Optional[pulumi.Input[bool]] = None,
show_membership: Optional[pulumi.Input[bool]] = None,
uid: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetManagementThreatRulebaseResult]
func GetManagementThreatRulebase(ctx *Context, args *GetManagementThreatRulebaseArgs, opts ...InvokeOption) (*GetManagementThreatRulebaseResult, error)
func GetManagementThreatRulebaseOutput(ctx *Context, args *GetManagementThreatRulebaseOutputArgs, opts ...InvokeOption) GetManagementThreatRulebaseResultOutput
> Note: This function is named GetManagementThreatRulebase
in the Go SDK.
public static class GetManagementThreatRulebase
{
public static Task<GetManagementThreatRulebaseResult> InvokeAsync(GetManagementThreatRulebaseArgs args, InvokeOptions? opts = null)
public static Output<GetManagementThreatRulebaseResult> Invoke(GetManagementThreatRulebaseInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetManagementThreatRulebaseResult> getManagementThreatRulebase(GetManagementThreatRulebaseArgs args, InvokeOptions options)
public static Output<GetManagementThreatRulebaseResult> getManagementThreatRulebase(GetManagementThreatRulebaseArgs args, InvokeOptions options)
fn::invoke:
function: checkpoint:index/getManagementThreatRulebase:getManagementThreatRulebase
arguments:
# arguments dictionary
The following arguments are supported:
- Dereference
Group boolMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- Filter string
- Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
- Filter
Settings Dictionary<string, string> - Enable enforce end user domain. filter_settings blocks are documented below.
- Hits
Settings Dictionary<string, string> - Id string
- Limit double
- The maximal number of returned results.
- Name string
- Object name. Must be unique in the domain.
- Offset double
- Number of the results to initially skip.
- Orders
List<Get
Management Threat Rulebase Order> - Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
- Package string
- Name of the package.
- Show
As boolRanges - Show
Hits bool - Show
Membership bool - Indicates whether to calculate and show "groups" field for every object in reply.
- Uid string
- Object unique identifier.
- Dereference
Group boolMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- Filter string
- Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
- Filter
Settings map[string]string - Enable enforce end user domain. filter_settings blocks are documented below.
- Hits
Settings map[string]string - Id string
- Limit float64
- The maximal number of returned results.
- Name string
- Object name. Must be unique in the domain.
- Offset float64
- Number of the results to initially skip.
- Orders
[]Get
Management Threat Rulebase Order - Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
- Package string
- Name of the package.
- Show
As boolRanges - Show
Hits bool - Show
Membership bool - Indicates whether to calculate and show "groups" field for every object in reply.
- Uid string
- Object unique identifier.
- dereference
Group BooleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter String
- Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
- filter
Settings Map<String,String> - Enable enforce end user domain. filter_settings blocks are documented below.
- hits
Settings Map<String,String> - id String
- limit Double
- The maximal number of returned results.
- name String
- Object name. Must be unique in the domain.
- offset Double
- Number of the results to initially skip.
- orders
List<Get
Management Threat Rulebase Order> - Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
- package_ String
- Name of the package.
- show
As BooleanRanges - show
Hits Boolean - show
Membership Boolean - Indicates whether to calculate and show "groups" field for every object in reply.
- uid String
- Object unique identifier.
- dereference
Group booleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter string
- Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
- filter
Settings {[key: string]: string} - Enable enforce end user domain. filter_settings blocks are documented below.
- hits
Settings {[key: string]: string} - id string
- limit number
- The maximal number of returned results.
- name string
- Object name. Must be unique in the domain.
- offset number
- Number of the results to initially skip.
- orders
Get
Management Threat Rulebase Order[] - Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
- package string
- Name of the package.
- show
As booleanRanges - show
Hits boolean - show
Membership boolean - Indicates whether to calculate and show "groups" field for every object in reply.
- uid string
- Object unique identifier.
- dereference_
group_ boolmembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter str
- Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
- filter_
settings Mapping[str, str] - Enable enforce end user domain. filter_settings blocks are documented below.
- hits_
settings Mapping[str, str] - id str
- limit float
- The maximal number of returned results.
- name str
- Object name. Must be unique in the domain.
- offset float
- Number of the results to initially skip.
- orders
Sequence[Get
Management Threat Rulebase Order] - Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
- package str
- Name of the package.
- show_
as_ boolranges - show_
hits bool - show_
membership bool - Indicates whether to calculate and show "groups" field for every object in reply.
- uid str
- Object unique identifier.
- dereference
Group BooleanMembers - Indicates whether to dereference "members" field by details level for every object in reply.
- filter String
- Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies.
- filter
Settings Map<String> - Enable enforce end user domain. filter_settings blocks are documented below.
- hits
Settings Map<String> - id String
- limit Number
- The maximal number of returned results.
- name String
- Object name. Must be unique in the domain.
- offset Number
- Number of the results to initially skip.
- orders List<Property Map>
- Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. orders blocks are documented below.
- package String
- Name of the package.
- show
As BooleanRanges - show
Hits Boolean - show
Membership Boolean - Indicates whether to calculate and show "groups" field for every object in reply.
- uid String
- Object unique identifier.
getManagementThreatRulebase Result
The following output properties are available:
- Id string
- Rulebases
List<Get
Management Threat Rulebase Rulebase> - Dereference
Group boolMembers - Filter string
- Filter
Settings Dictionary<string, string> - Hits
Settings Dictionary<string, string> - Limit double
- Name string
- Offset double
- Orders
List<Get
Management Threat Rulebase Order> - Package string
- Show
As boolRanges - Show
Hits bool - Show
Membership bool - Uid string
- Id string
- Rulebases
[]Get
Management Threat Rulebase Rulebase - Dereference
Group boolMembers - Filter string
- Filter
Settings map[string]string - Hits
Settings map[string]string - Limit float64
- Name string
- Offset float64
- Orders
[]Get
Management Threat Rulebase Order - Package string
- Show
As boolRanges - Show
Hits bool - Show
Membership bool - Uid string
- id String
- rulebases
List<Get
Management Threat Rulebase Rulebase> - dereference
Group BooleanMembers - filter String
- filter
Settings Map<String,String> - hits
Settings Map<String,String> - limit Double
- name String
- offset Double
- orders
List<Get
Management Threat Rulebase Order> - package_ String
- show
As BooleanRanges - show
Hits Boolean - show
Membership Boolean - uid String
- id string
- rulebases
Get
Management Threat Rulebase Rulebase[] - dereference
Group booleanMembers - filter string
- filter
Settings {[key: string]: string} - hits
Settings {[key: string]: string} - limit number
- name string
- offset number
- orders
Get
Management Threat Rulebase Order[] - package string
- show
As booleanRanges - show
Hits boolean - show
Membership boolean - uid string
- id str
- rulebases
Sequence[Get
Management Threat Rulebase Rulebase] - dereference_
group_ boolmembers - filter str
- filter_
settings Mapping[str, str] - hits_
settings Mapping[str, str] - limit float
- name str
- offset float
- orders
Sequence[Get
Management Threat Rulebase Order] - package str
- show_
as_ boolranges - show_
hits bool - show_
membership bool - uid str
- id String
- rulebases List<Property Map>
- dereference
Group BooleanMembers - filter String
- filter
Settings Map<String> - hits
Settings Map<String> - limit Number
- name String
- offset Number
- orders List<Property Map>
- package String
- show
As BooleanRanges - show
Hits Boolean - show
Membership Boolean - uid String
Supporting Types
GetManagementThreatRulebaseOrder
GetManagementThreatRulebaseRulebase
- from Number
- objects
Dictionaries List<Property Map> - rulebases List<Property Map>
- to Number
- total Number
GetManagementThreatRulebaseRulebaseObjectsDictionary
GetManagementThreatRulebaseRulebaseRulebase
- Action string
- Comments string
- Destination
Negate bool - Destinations List<string>
- Enabled bool
- Exceptions List<string>
- Exceptions
Layer string - Install
Ons List<string> - Name string
- Object name. Must be unique in the domain.
- Protected
Scope boolNegate - Protected
Scopes List<string> - Rule
Number double - Service
Negate bool - Services List<string>
- Source
Negate bool - Sources List<string>
- Track string
- Track
Settings Dictionary<string, string> - Type string
- Uid string
- Object unique identifier.
- Action string
- Comments string
- Destination
Negate bool - Destinations []string
- Enabled bool
- Exceptions []string
- Exceptions
Layer string - Install
Ons []string - Name string
- Object name. Must be unique in the domain.
- Protected
Scope boolNegate - Protected
Scopes []string - Rule
Number float64 - Service
Negate bool - Services []string
- Source
Negate bool - Sources []string
- Track string
- Track
Settings map[string]string - Type string
- Uid string
- Object unique identifier.
- action String
- comments String
- destination
Negate Boolean - destinations List<String>
- enabled Boolean
- exceptions List<String>
- exceptions
Layer String - install
Ons List<String> - name String
- Object name. Must be unique in the domain.
- protected
Scope BooleanNegate - protected
Scopes List<String> - rule
Number Double - service
Negate Boolean - services List<String>
- source
Negate Boolean - sources List<String>
- track String
- track
Settings Map<String,String> - type String
- uid String
- Object unique identifier.
- action string
- comments string
- destination
Negate boolean - destinations string[]
- enabled boolean
- exceptions string[]
- exceptions
Layer string - install
Ons string[] - name string
- Object name. Must be unique in the domain.
- protected
Scope booleanNegate - protected
Scopes string[] - rule
Number number - service
Negate boolean - services string[]
- source
Negate boolean - sources string[]
- track string
- track
Settings {[key: string]: string} - type string
- uid string
- Object unique identifier.
- action str
- comments str
- destination_
negate bool - destinations Sequence[str]
- enabled bool
- exceptions Sequence[str]
- exceptions_
layer str - install_
ons Sequence[str] - name str
- Object name. Must be unique in the domain.
- protected_
scope_ boolnegate - protected_
scopes Sequence[str] - rule_
number float - service_
negate bool - services Sequence[str]
- source_
negate bool - sources Sequence[str]
- track str
- track_
settings Mapping[str, str] - type str
- uid str
- Object unique identifier.
- action String
- comments String
- destination
Negate Boolean - destinations List<String>
- enabled Boolean
- exceptions List<String>
- exceptions
Layer String - install
Ons List<String> - name String
- Object name. Must be unique in the domain.
- protected
Scope BooleanNegate - protected
Scopes List<String> - rule
Number Number - service
Negate Boolean - services List<String>
- source
Negate Boolean - sources List<String>
- track String
- track
Settings Map<String> - type String
- uid String
- Object unique identifier.
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpoint
Terraform Provider.
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw