Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getFirewallRules
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.getFirewallRules

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

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

const exampleFirewallRules = cloudflare.getFirewallRules({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    id: "372e67954025e0ba6aaa6d586b9e0b60",
    action: "block",
    description: "mir",
    paused: false,
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_firewall_rules = cloudflare.get_firewall_rules(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    id="372e67954025e0ba6aaa6d586b9e0b60",
    action="block",
    description="mir",
    paused=False)

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupFirewallRules(ctx, &cloudflare.LookupFirewallRulesArgs{
			ZoneId:      "023e105f4ecef8ad9ca31a8372d0c353",
			Id:          pulumi.StringRef("372e67954025e0ba6aaa6d586b9e0b60"),
			Action:      pulumi.StringRef("block"),
			Description: pulumi.StringRef("mir"),
			Paused:      pulumi.BoolRef(false),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleFirewallRules = Cloudflare.GetFirewallRules.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Id = "372e67954025e0ba6aaa6d586b9e0b60",
        Action = "block",
        Description = "mir",
        Paused = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetFirewallRulesArgs;
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) {
        final var exampleFirewallRules = CloudflareFunctions.getFirewallRules(GetFirewallRulesArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .id("372e67954025e0ba6aaa6d586b9e0b60")
            .action("block")
            .description("mir")
            .paused(false)
            .build());

    }
}

    variables:
  exampleFirewallRules:
    fn::invoke:
      function: cloudflare:getFirewallRules
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        id: 372e67954025e0ba6aaa6d586b9e0b60
        action: block
        description: mir
        paused: false

    Using getFirewallRules

    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 getFirewallRules(args: GetFirewallRulesArgs, opts?: InvokeOptions): Promise<GetFirewallRulesResult>
function getFirewallRulesOutput(args: GetFirewallRulesOutputArgs, opts?: InvokeOptions): Output<GetFirewallRulesResult>
    def get_firewall_rules(action: Optional[str] = None,
                       description: Optional[str] = None,
                       id: Optional[str] = None,
                       max_items: Optional[int] = None,
                       paused: Optional[bool] = None,
                       zone_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFirewallRulesResult
def get_firewall_rules_output(action: Optional[pulumi.Input[str]] = None,
                       description: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       max_items: Optional[pulumi.Input[int]] = None,
                       paused: Optional[pulumi.Input[bool]] = None,
                       zone_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFirewallRulesResult]
    func LookupFirewallRules(ctx *Context, args *LookupFirewallRulesArgs, opts ...InvokeOption) (*LookupFirewallRulesResult, error)
func LookupFirewallRulesOutput(ctx *Context, args *LookupFirewallRulesOutputArgs, opts ...InvokeOption) LookupFirewallRulesResultOutput

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

    public static class GetFirewallRules 
{
    public static Task<GetFirewallRulesResult> InvokeAsync(GetFirewallRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetFirewallRulesResult> Invoke(GetFirewallRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFirewallRulesResult> getFirewallRules(GetFirewallRulesArgs args, InvokeOptions options)
public static Output<GetFirewallRulesResult> getFirewallRules(GetFirewallRulesArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getFirewallRules:getFirewallRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ZoneId string
    Identifier
    Action string
    The action to search for. Must be an exact match.
    Description string
    A case-insensitive string to find in the description.
    Id string
    The unique identifier of the firewall rule.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    ZoneId string
    Identifier
    Action string
    The action to search for. Must be an exact match.
    Description string
    A case-insensitive string to find in the description.
    Id string
    The unique identifier of the firewall rule.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    zoneId String
    Identifier
    action String
    The action to search for. Must be an exact match.
    description String
    A case-insensitive string to find in the description.
    id String
    The unique identifier of the firewall rule.
    maxItems Integer
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    zoneId string
    Identifier
    action string
    The action to search for. Must be an exact match.
    description string
    A case-insensitive string to find in the description.
    id string
    The unique identifier of the firewall rule.
    maxItems number
    Max items to fetch, default: 1000
    paused boolean
    When true, indicates that the firewall rule is currently paused.
    zone_id str
    Identifier
    action str
    The action to search for. Must be an exact match.
    description str
    A case-insensitive string to find in the description.
    id str
    The unique identifier of the firewall rule.
    max_items int
    Max items to fetch, default: 1000
    paused bool
    When true, indicates that the firewall rule is currently paused.
    zoneId String
    Identifier
    action String
    The action to search for. Must be an exact match.
    description String
    A case-insensitive string to find in the description.
    id String
    The unique identifier of the firewall rule.
    maxItems Number
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the firewall rule is currently paused.

    getFirewallRules Result

    The following output properties are available:

    Results List<GetFirewallRulesResult>
    The items returned by the data source
    ZoneId string
    Identifier
    Action string
    The action to search for. Must be an exact match.
    Description string
    A case-insensitive string to find in the description.
    Id string
    The unique identifier of the firewall rule.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    Results []GetFirewallRulesResult
    The items returned by the data source
    ZoneId string
    Identifier
    Action string
    The action to search for. Must be an exact match.
    Description string
    A case-insensitive string to find in the description.
    Id string
    The unique identifier of the firewall rule.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    results List<GetFirewallRulesResult>
    The items returned by the data source
    zoneId String
    Identifier
    action String
    The action to search for. Must be an exact match.
    description String
    A case-insensitive string to find in the description.
    id String
    The unique identifier of the firewall rule.
    maxItems Integer
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    results GetFirewallRulesResult[]
    The items returned by the data source
    zoneId string
    Identifier
    action string
    The action to search for. Must be an exact match.
    description string
    A case-insensitive string to find in the description.
    id string
    The unique identifier of the firewall rule.
    maxItems number
    Max items to fetch, default: 1000
    paused boolean
    When true, indicates that the firewall rule is currently paused.
    results Sequence[GetFirewallRulesResult]
    The items returned by the data source
    zone_id str
    Identifier
    action str
    The action to search for. Must be an exact match.
    description str
    A case-insensitive string to find in the description.
    id str
    The unique identifier of the firewall rule.
    max_items int
    Max items to fetch, default: 1000
    paused bool
    When true, indicates that the firewall rule is currently paused.
    results List<Property Map>
    The items returned by the data source
    zoneId String
    Identifier
    action String
    The action to search for. Must be an exact match.
    description String
    A case-insensitive string to find in the description.
    id String
    The unique identifier of the firewall rule.
    maxItems Number
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the firewall rule is currently paused.

    Supporting Types

    GetFirewallRulesResult

    Action string
    The action to apply to a matched request. The log action is only available on an Enterprise plan. Available values: "block", "challenge", "jschallenge", "managedchallenge", "allow", "log", "bypass".
    Description string
    An informative summary of the firewall rule.
    Filter GetFirewallRulesResultFilter
    Id string
    The unique identifier of the firewall rule.
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    Priority double
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    Products List<string>
    Ref string
    A short reference tag. Allows you to select related firewall rules.
    Action string
    The action to apply to a matched request. The log action is only available on an Enterprise plan. Available values: "block", "challenge", "jschallenge", "managedchallenge", "allow", "log", "bypass".
    Description string
    An informative summary of the firewall rule.
    Filter GetFirewallRulesResultFilter
    Id string
    The unique identifier of the firewall rule.
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    Priority float64
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    Products []string
    Ref string
    A short reference tag. Allows you to select related firewall rules.
    action String
    The action to apply to a matched request. The log action is only available on an Enterprise plan. Available values: "block", "challenge", "jschallenge", "managedchallenge", "allow", "log", "bypass".
    description String
    An informative summary of the firewall rule.
    filter GetFirewallRulesResultFilter
    id String
    The unique identifier of the firewall rule.
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    priority Double
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products List<String>
    ref String
    A short reference tag. Allows you to select related firewall rules.
    action string
    The action to apply to a matched request. The log action is only available on an Enterprise plan. Available values: "block", "challenge", "jschallenge", "managedchallenge", "allow", "log", "bypass".
    description string
    An informative summary of the firewall rule.
    filter GetFirewallRulesResultFilter
    id string
    The unique identifier of the firewall rule.
    paused boolean
    When true, indicates that the firewall rule is currently paused.
    priority number
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products string[]
    ref string
    A short reference tag. Allows you to select related firewall rules.
    action str
    The action to apply to a matched request. The log action is only available on an Enterprise plan. Available values: "block", "challenge", "jschallenge", "managedchallenge", "allow", "log", "bypass".
    description str
    An informative summary of the firewall rule.
    filter GetFirewallRulesResultFilter
    id str
    The unique identifier of the firewall rule.
    paused bool
    When true, indicates that the firewall rule is currently paused.
    priority float
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products Sequence[str]
    ref str
    A short reference tag. Allows you to select related firewall rules.
    action String
    The action to apply to a matched request. The log action is only available on an Enterprise plan. Available values: "block", "challenge", "jschallenge", "managedchallenge", "allow", "log", "bypass".
    description String
    An informative summary of the firewall rule.
    filter Property Map
    id String
    The unique identifier of the firewall rule.
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    priority Number
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products List<String>
    ref String
    A short reference tag. Allows you to select related firewall rules.

    GetFirewallRulesResultFilter

    Deleted bool
    When true, indicates that the firewall rule was deleted.
    Description string
    An informative summary of the filter.
    Expression string
    The filter expression. For more information, refer to Expressions.
    Id string
    The unique identifier of the filter.
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    A short reference tag. Allows you to select related filters.
    Deleted bool
    When true, indicates that the firewall rule was deleted.
    Description string
    An informative summary of the filter.
    Expression string
    The filter expression. For more information, refer to Expressions.
    Id string
    The unique identifier of the filter.
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    A short reference tag. Allows you to select related filters.
    deleted Boolean
    When true, indicates that the firewall rule was deleted.
    description String
    An informative summary of the filter.
    expression String
    The filter expression. For more information, refer to Expressions.
    id String
    The unique identifier of the filter.
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    A short reference tag. Allows you to select related filters.
    deleted boolean
    When true, indicates that the firewall rule was deleted.
    description string
    An informative summary of the filter.
    expression string
    The filter expression. For more information, refer to Expressions.
    id string
    The unique identifier of the filter.
    paused boolean
    When true, indicates that the filter is currently paused.
    ref string
    A short reference tag. Allows you to select related filters.
    deleted bool
    When true, indicates that the firewall rule was deleted.
    description str
    An informative summary of the filter.
    expression str
    The filter expression. For more information, refer to Expressions.
    id str
    The unique identifier of the filter.
    paused bool
    When true, indicates that the filter is currently paused.
    ref str
    A short reference tag. Allows you to select related filters.
    deleted Boolean
    When true, indicates that the firewall rule was deleted.
    description String
    An informative summary of the filter.
    expression String
    The filter expression. For more information, refer to Expressions.
    id String
    The unique identifier of the filter.
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    A short reference tag. Allows you to select related filters.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare