1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. getManagementThreatRulebase
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpoint.getManagementThreatRulebase

Explore with Pulumi AI

checkpoint logo
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:

    DereferenceGroupMembers bool
    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.
    FilterSettings Dictionary<string, string>
    Enable enforce end user domain. filter_settings blocks are documented below.
    HitsSettings 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<GetManagementThreatRulebaseOrder>
    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.
    ShowAsRanges bool
    ShowHits bool
    ShowMembership bool
    Indicates whether to calculate and show "groups" field for every object in reply.
    Uid string
    Object unique identifier.
    DereferenceGroupMembers bool
    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.
    FilterSettings map[string]string
    Enable enforce end user domain. filter_settings blocks are documented below.
    HitsSettings 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 []GetManagementThreatRulebaseOrder
    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.
    ShowAsRanges bool
    ShowHits bool
    ShowMembership bool
    Indicates whether to calculate and show "groups" field for every object in reply.
    Uid string
    Object unique identifier.
    dereferenceGroupMembers Boolean
    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.
    filterSettings Map<String,String>
    Enable enforce end user domain. filter_settings blocks are documented below.
    hitsSettings 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<GetManagementThreatRulebaseOrder>
    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.
    showAsRanges Boolean
    showHits Boolean
    showMembership Boolean
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid String
    Object unique identifier.
    dereferenceGroupMembers boolean
    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.
    filterSettings {[key: string]: string}
    Enable enforce end user domain. filter_settings blocks are documented below.
    hitsSettings {[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 GetManagementThreatRulebaseOrder[]
    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.
    showAsRanges boolean
    showHits boolean
    showMembership boolean
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid string
    Object unique identifier.
    dereference_group_members bool
    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[GetManagementThreatRulebaseOrder]
    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_ranges bool
    show_hits bool
    show_membership bool
    Indicates whether to calculate and show "groups" field for every object in reply.
    uid str
    Object unique identifier.
    dereferenceGroupMembers Boolean
    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.
    filterSettings Map<String>
    Enable enforce end user domain. filter_settings blocks are documented below.
    hitsSettings 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.
    showAsRanges Boolean
    showHits Boolean
    showMembership 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:

    Supporting Types

    GetManagementThreatRulebaseOrder

    Asc string
    Sorts results by the given field in ascending order.
    Desc string
    Sorts results by the given field in descending order.
    Asc string
    Sorts results by the given field in ascending order.
    Desc string
    Sorts results by the given field in descending order.
    asc String
    Sorts results by the given field in ascending order.
    desc String
    Sorts results by the given field in descending order.
    asc string
    Sorts results by the given field in ascending order.
    desc string
    Sorts results by the given field in descending order.
    asc str
    Sorts results by the given field in ascending order.
    desc str
    Sorts results by the given field in descending order.
    asc String
    Sorts results by the given field in ascending order.
    desc String
    Sorts results by the given field in descending order.

    GetManagementThreatRulebaseRulebase

    GetManagementThreatRulebaseRulebaseObjectsDictionary

    Name string
    Object name. Must be unique in the domain.
    Type string
    Uid string
    Object unique identifier.
    Name string
    Object name. Must be unique in the domain.
    Type string
    Uid string
    Object unique identifier.
    name String
    Object name. Must be unique in the domain.
    type String
    uid String
    Object unique identifier.
    name string
    Object name. Must be unique in the domain.
    type string
    uid string
    Object unique identifier.
    name str
    Object name. Must be unique in the domain.
    type str
    uid str
    Object unique identifier.
    name String
    Object name. Must be unique in the domain.
    type String
    uid String
    Object unique identifier.

    GetManagementThreatRulebaseRulebaseRulebase

    Action string
    Comments string
    DestinationNegate bool
    Destinations List<string>
    Enabled bool
    Exceptions List<string>
    ExceptionsLayer string
    InstallOns List<string>
    Name string
    Object name. Must be unique in the domain.
    ProtectedScopeNegate bool
    ProtectedScopes List<string>
    RuleNumber double
    ServiceNegate bool
    Services List<string>
    SourceNegate bool
    Sources List<string>
    Track string
    TrackSettings Dictionary<string, string>
    Type string
    Uid string
    Object unique identifier.
    Action string
    Comments string
    DestinationNegate bool
    Destinations []string
    Enabled bool
    Exceptions []string
    ExceptionsLayer string
    InstallOns []string
    Name string
    Object name. Must be unique in the domain.
    ProtectedScopeNegate bool
    ProtectedScopes []string
    RuleNumber float64
    ServiceNegate bool
    Services []string
    SourceNegate bool
    Sources []string
    Track string
    TrackSettings map[string]string
    Type string
    Uid string
    Object unique identifier.
    action String
    comments String
    destinationNegate Boolean
    destinations List<String>
    enabled Boolean
    exceptions List<String>
    exceptionsLayer String
    installOns List<String>
    name String
    Object name. Must be unique in the domain.
    protectedScopeNegate Boolean
    protectedScopes List<String>
    ruleNumber Double
    serviceNegate Boolean
    services List<String>
    sourceNegate Boolean
    sources List<String>
    track String
    trackSettings Map<String,String>
    type String
    uid String
    Object unique identifier.
    action string
    comments string
    destinationNegate boolean
    destinations string[]
    enabled boolean
    exceptions string[]
    exceptionsLayer string
    installOns string[]
    name string
    Object name. Must be unique in the domain.
    protectedScopeNegate boolean
    protectedScopes string[]
    ruleNumber number
    serviceNegate boolean
    services string[]
    sourceNegate boolean
    sources string[]
    track string
    trackSettings {[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_negate bool
    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
    destinationNegate Boolean
    destinations List<String>
    enabled Boolean
    exceptions List<String>
    exceptionsLayer String
    installOns List<String>
    name String
    Object name. Must be unique in the domain.
    protectedScopeNegate Boolean
    protectedScopes List<String>
    ruleNumber Number
    serviceNegate Boolean
    services List<String>
    sourceNegate Boolean
    sources List<String>
    track String
    trackSettings 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 logo
    checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw