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

checkpoint.getManagementDataAccessRule

Explore with Pulumi AI

Use this data source to get information on an existing Check Point Access Rule.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";

const accessRule = new checkpoint.ManagementAccessRule("accessRule", {
    contents: ["Any"],
    customFields: {},
    destinations: ["Any"],
    installOns: ["Policy Targets"],
    layer: "Network",
    position: {
        top: "top",
    },
    services: ["Any"],
    sources: ["Any"],
    times: ["Any"],
    track: {
        accounting: "false",
        alert: "none",
        enable_firewall_session: "false",
        per_connection: "true",
        per_session: "false",
        type: "Log",
    },
    vpn: "Any",
});
const dataAccessRule = checkpoint.getManagementDataAccessRuleOutput({
    layer: accessRule.layer,
    name: accessRule.name,
});
Copy
import pulumi
import pulumi_checkpoint as checkpoint

access_rule = checkpoint.ManagementAccessRule("accessRule",
    contents=["Any"],
    custom_fields={},
    destinations=["Any"],
    install_ons=["Policy Targets"],
    layer="Network",
    position={
        "top": "top",
    },
    services=["Any"],
    sources=["Any"],
    times=["Any"],
    track={
        "accounting": "false",
        "alert": "none",
        "enable_firewall_session": "false",
        "per_connection": "true",
        "per_session": "false",
        "type": "Log",
    },
    vpn="Any")
data_access_rule = checkpoint.get_management_data_access_rule_output(layer=access_rule.layer,
    name=access_rule.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v2/checkpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		accessRule, err := checkpoint.NewManagementAccessRule(ctx, "accessRule", &checkpoint.ManagementAccessRuleArgs{
			Contents: pulumi.StringArray{
				pulumi.String("Any"),
			},
			CustomFields: pulumi.StringMap{},
			Destinations: pulumi.StringArray{
				pulumi.String("Any"),
			},
			InstallOns: pulumi.StringArray{
				pulumi.String("Policy Targets"),
			},
			Layer: pulumi.String("Network"),
			Position: pulumi.StringMap{
				"top": pulumi.String("top"),
			},
			Services: pulumi.StringArray{
				pulumi.String("Any"),
			},
			Sources: pulumi.StringArray{
				pulumi.String("Any"),
			},
			Times: pulumi.StringArray{
				pulumi.String("Any"),
			},
			Track: pulumi.StringMap{
				"accounting":              pulumi.String("false"),
				"alert":                   pulumi.String("none"),
				"enable_firewall_session": pulumi.String("false"),
				"per_connection":          pulumi.String("true"),
				"per_session":             pulumi.String("false"),
				"type":                    pulumi.String("Log"),
			},
			Vpn: pulumi.String("Any"),
		})
		if err != nil {
			return err
		}
		_ = checkpoint.GetManagementDataAccessRuleOutput(ctx, checkpoint.GetManagementDataAccessRuleOutputArgs{
			Layer: accessRule.Layer,
			Name:  accessRule.Name,
		}, nil)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkpoint = Pulumi.Checkpoint;

return await Deployment.RunAsync(() => 
{
    var accessRule = new Checkpoint.ManagementAccessRule("accessRule", new()
    {
        Contents = new[]
        {
            "Any",
        },
        CustomFields = null,
        Destinations = new[]
        {
            "Any",
        },
        InstallOns = new[]
        {
            "Policy Targets",
        },
        Layer = "Network",
        Position = 
        {
            { "top", "top" },
        },
        Services = new[]
        {
            "Any",
        },
        Sources = new[]
        {
            "Any",
        },
        Times = new[]
        {
            "Any",
        },
        Track = 
        {
            { "accounting", "false" },
            { "alert", "none" },
            { "enable_firewall_session", "false" },
            { "per_connection", "true" },
            { "per_session", "false" },
            { "type", "Log" },
        },
        Vpn = "Any",
    });

    var dataAccessRule = Checkpoint.GetManagementDataAccessRule.Invoke(new()
    {
        Layer = accessRule.Layer,
        Name = accessRule.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.ManagementAccessRule;
import com.pulumi.checkpoint.ManagementAccessRuleArgs;
import com.pulumi.checkpoint.CheckpointFunctions;
import com.pulumi.checkpoint.inputs.GetManagementDataAccessRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var accessRule = new ManagementAccessRule("accessRule", ManagementAccessRuleArgs.builder()
            .contents("Any")
            .customFields()
            .destinations("Any")
            .installOns("Policy Targets")
            .layer("Network")
            .position(Map.of("top", "top"))
            .services("Any")
            .sources("Any")
            .times("Any")
            .track(Map.ofEntries(
                Map.entry("accounting", false),
                Map.entry("alert", "none"),
                Map.entry("enable_firewall_session", false),
                Map.entry("per_connection", true),
                Map.entry("per_session", false),
                Map.entry("type", "Log")
            ))
            .vpn("Any")
            .build());

        final var dataAccessRule = CheckpointFunctions.getManagementDataAccessRule(GetManagementDataAccessRuleArgs.builder()
            .layer(accessRule.layer())
            .name(accessRule.name())
            .build());

    }
}
Copy
resources:
  accessRule:
    type: checkpoint:ManagementAccessRule
    properties:
      contents:
        - Any
      customFields: {}
      destinations:
        - Any
      installOns:
        - Policy Targets
      layer: Network
      position:
        top: top
      services:
        - Any
      sources:
        - Any
      times:
        - Any
      track:
        accounting: false
        alert: none
        enable_firewall_session: false
        per_connection: true
        per_session: false
        type: Log
      vpn: Any
variables:
  dataAccessRule:
    fn::invoke:
      function: checkpoint:getManagementDataAccessRule
      arguments:
        layer: ${accessRule.layer}
        name: ${accessRule.name}
Copy

Using getManagementDataAccessRule

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 getManagementDataAccessRule(args: GetManagementDataAccessRuleArgs, opts?: InvokeOptions): Promise<GetManagementDataAccessRuleResult>
function getManagementDataAccessRuleOutput(args: GetManagementDataAccessRuleOutputArgs, opts?: InvokeOptions): Output<GetManagementDataAccessRuleResult>
Copy
def get_management_data_access_rule(fields_with_uid_identifiers: Optional[Sequence[str]] = None,
                                    id: Optional[str] = None,
                                    layer: Optional[str] = None,
                                    name: Optional[str] = None,
                                    uid: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetManagementDataAccessRuleResult
def get_management_data_access_rule_output(fields_with_uid_identifiers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                    id: Optional[pulumi.Input[str]] = None,
                                    layer: Optional[pulumi.Input[str]] = None,
                                    name: Optional[pulumi.Input[str]] = None,
                                    uid: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetManagementDataAccessRuleResult]
Copy
func GetManagementDataAccessRule(ctx *Context, args *GetManagementDataAccessRuleArgs, opts ...InvokeOption) (*GetManagementDataAccessRuleResult, error)
func GetManagementDataAccessRuleOutput(ctx *Context, args *GetManagementDataAccessRuleOutputArgs, opts ...InvokeOption) GetManagementDataAccessRuleResultOutput
Copy

> Note: This function is named GetManagementDataAccessRule in the Go SDK.

public static class GetManagementDataAccessRule 
{
    public static Task<GetManagementDataAccessRuleResult> InvokeAsync(GetManagementDataAccessRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementDataAccessRuleResult> Invoke(GetManagementDataAccessRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagementDataAccessRuleResult> getManagementDataAccessRule(GetManagementDataAccessRuleArgs args, InvokeOptions options)
public static Output<GetManagementDataAccessRuleResult> getManagementDataAccessRule(GetManagementDataAccessRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: checkpoint:index/getManagementDataAccessRule:getManagementDataAccessRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Layer This property is required. string
Layer that the rule belongs to identified by the name or UID.
FieldsWithUidIdentifiers List<string>
List of resource fields that will use object UIDs as object identifiers. Default is object name.
Id string
Name string
Rule name.
Uid string
Object unique identifier.
Layer This property is required. string
Layer that the rule belongs to identified by the name or UID.
FieldsWithUidIdentifiers []string
List of resource fields that will use object UIDs as object identifiers. Default is object name.
Id string
Name string
Rule name.
Uid string
Object unique identifier.
layer This property is required. String
Layer that the rule belongs to identified by the name or UID.
fieldsWithUidIdentifiers List<String>
List of resource fields that will use object UIDs as object identifiers. Default is object name.
id String
name String
Rule name.
uid String
Object unique identifier.
layer This property is required. string
Layer that the rule belongs to identified by the name or UID.
fieldsWithUidIdentifiers string[]
List of resource fields that will use object UIDs as object identifiers. Default is object name.
id string
name string
Rule name.
uid string
Object unique identifier.
layer This property is required. str
Layer that the rule belongs to identified by the name or UID.
fields_with_uid_identifiers Sequence[str]
List of resource fields that will use object UIDs as object identifiers. Default is object name.
id str
name str
Rule name.
uid str
Object unique identifier.
layer This property is required. String
Layer that the rule belongs to identified by the name or UID.
fieldsWithUidIdentifiers List<String>
List of resource fields that will use object UIDs as object identifiers. Default is object name.
id String
name String
Rule name.
uid String
Object unique identifier.

getManagementDataAccessRule Result

The following output properties are available:

Action string
ActionSettings Dictionary<string, string>
Comments string
ContentDirection string
ContentNegate bool
Contents List<string>
CustomFields Dictionary<string, string>
DestinationNegate bool
Destinations List<string>
Enabled bool
Id string
InlineLayer string
InstallOns List<string>
Layer string
ServiceNegate bool
Services List<string>
SourceNegate bool
Sources List<string>
Times List<string>
Track Dictionary<string, string>
UserChecks List<GetManagementDataAccessRuleUserCheck>
Vpn string
VpnCommunities List<string>
VpnDirectionals List<GetManagementDataAccessRuleVpnDirectional>
FieldsWithUidIdentifiers List<string>
Name string
Uid string
action String
actionSettings Map<String,String>
comments String
contentDirection String
contentNegate Boolean
contents List<String>
customFields Map<String,String>
destinationNegate Boolean
destinations List<String>
enabled Boolean
id String
inlineLayer String
installOns List<String>
layer String
serviceNegate Boolean
services List<String>
sourceNegate Boolean
sources List<String>
times List<String>
track Map<String,String>
userChecks List<GetManagementDataAccessRuleUserCheck>
vpn String
vpnCommunities List<String>
vpnDirectionals List<GetManagementDataAccessRuleVpnDirectional>
fieldsWithUidIdentifiers List<String>
name String
uid String
action string
actionSettings {[key: string]: string}
comments string
contentDirection string
contentNegate boolean
contents string[]
customFields {[key: string]: string}
destinationNegate boolean
destinations string[]
enabled boolean
id string
inlineLayer string
installOns string[]
layer string
serviceNegate boolean
services string[]
sourceNegate boolean
sources string[]
times string[]
track {[key: string]: string}
userChecks GetManagementDataAccessRuleUserCheck[]
vpn string
vpnCommunities string[]
vpnDirectionals GetManagementDataAccessRuleVpnDirectional[]
fieldsWithUidIdentifiers string[]
name string
uid string
action String
actionSettings Map<String>
comments String
contentDirection String
contentNegate Boolean
contents List<String>
customFields Map<String>
destinationNegate Boolean
destinations List<String>
enabled Boolean
id String
inlineLayer String
installOns List<String>
layer String
serviceNegate Boolean
services List<String>
sourceNegate Boolean
sources List<String>
times List<String>
track Map<String>
userChecks List<Property Map>
vpn String
vpnCommunities List<String>
vpnDirectionals List<Property Map>
fieldsWithUidIdentifiers List<String>
name String
uid String

Supporting Types

GetManagementDataAccessRuleUserCheck

Confirm This property is required. string
CustomFrequencies This property is required. List<GetManagementDataAccessRuleUserCheckCustomFrequency>
Custom Frequency blocks are documented below.
Frequency This property is required. string
Interaction This property is required. string
Confirm This property is required. string
CustomFrequencies This property is required. []GetManagementDataAccessRuleUserCheckCustomFrequency
Custom Frequency blocks are documented below.
Frequency This property is required. string
Interaction This property is required. string
confirm This property is required. String
customFrequencies This property is required. List<GetManagementDataAccessRuleUserCheckCustomFrequency>
Custom Frequency blocks are documented below.
frequency This property is required. String
interaction This property is required. String
confirm This property is required. string
customFrequencies This property is required. GetManagementDataAccessRuleUserCheckCustomFrequency[]
Custom Frequency blocks are documented below.
frequency This property is required. string
interaction This property is required. string
confirm This property is required. str
custom_frequencies This property is required. Sequence[GetManagementDataAccessRuleUserCheckCustomFrequency]
Custom Frequency blocks are documented below.
frequency This property is required. str
interaction This property is required. str
confirm This property is required. String
customFrequencies This property is required. List<Property Map>
Custom Frequency blocks are documented below.
frequency This property is required. String
interaction This property is required. String

GetManagementDataAccessRuleUserCheckCustomFrequency

Every This property is required. double
Unit This property is required. string
Every This property is required. float64
Unit This property is required. string
every This property is required. Double
unit This property is required. String
every This property is required. number
unit This property is required. string
every This property is required. float
unit This property is required. str
every This property is required. Number
unit This property is required. String

GetManagementDataAccessRuleVpnDirectional

From This property is required. string
From VPN community.
To This property is required. string
To VPN community.
From This property is required. string
From VPN community.
To This property is required. string
To VPN community.
from This property is required. String
From VPN community.
to This property is required. String
To VPN community.
from This property is required. string
From VPN community.
to This property is required. string
To VPN community.
from_ This property is required. str
From VPN community.
to This property is required. str
To VPN community.
from This property is required. String
From VPN community.
to This property is required. String
To VPN community.

Package Details

Repository
checkpoint checkpointsw/terraform-provider-checkpoint
License
Notes
This Pulumi package is based on the checkpoint Terraform Provider.