Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. redis
  5. FirewallRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.redis.FirewallRule

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

Uses Azure REST API version 2024-11-01.

Other available API versions: 2017-02-01, 2017-10-01, 2018-03-01, 2019-07-01, 2020-06-01, 2020-12-01, 2021-06-01, 2022-05-01, 2022-06-01, 2023-04-01, 2023-05-01-preview, 2023-08-01, 2024-03-01, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native redis [ApiVersion]. See the version guide for details.

Example Usage

RedisCacheFirewallRuleCreate

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

return await Deployment.RunAsync(() => 
{
    var firewallRule = new AzureNative.Redis.FirewallRule("firewallRule", new()
    {
        CacheName = "cache1",
        EndIP = "192.168.1.4",
        ResourceGroupName = "rg1",
        RuleName = "rule1",
        StartIP = "192.168.1.1",
    });

});
Copy
package main

import (
	redis "github.com/pulumi/pulumi-azure-native-sdk/redis/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redis.NewFirewallRule(ctx, "firewallRule", &redis.FirewallRuleArgs{
			CacheName:         pulumi.String("cache1"),
			EndIP:             pulumi.String("192.168.1.4"),
			ResourceGroupName: pulumi.String("rg1"),
			RuleName:          pulumi.String("rule1"),
			StartIP:           pulumi.String("192.168.1.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.redis.FirewallRule;
import com.pulumi.azurenative.redis.FirewallRuleArgs;
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 firewallRule = new FirewallRule("firewallRule", FirewallRuleArgs.builder()
            .cacheName("cache1")
            .endIP("192.168.1.4")
            .resourceGroupName("rg1")
            .ruleName("rule1")
            .startIP("192.168.1.1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const firewallRule = new azure_native.redis.FirewallRule("firewallRule", {
    cacheName: "cache1",
    endIP: "192.168.1.4",
    resourceGroupName: "rg1",
    ruleName: "rule1",
    startIP: "192.168.1.1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

firewall_rule = azure_native.redis.FirewallRule("firewallRule",
    cache_name="cache1",
    end_ip="192.168.1.4",
    resource_group_name="rg1",
    rule_name="rule1",
    start_ip="192.168.1.1")
Copy
resources:
  firewallRule:
    type: azure-native:redis:FirewallRule
    properties:
      cacheName: cache1
      endIP: 192.168.1.4
      resourceGroupName: rg1
      ruleName: rule1
      startIP: 192.168.1.1
Copy

Create FirewallRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: CustomResourceOptions);
@overload
def FirewallRule(resource_name: str,
                 args: FirewallRuleArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def FirewallRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cache_name: Optional[str] = None,
                 end_ip: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 start_ip: Optional[str] = None,
                 rule_name: Optional[str] = None)
func NewFirewallRule(ctx *Context, name string, args FirewallRuleArgs, opts ...ResourceOption) (*FirewallRule, error)
public FirewallRule(string name, FirewallRuleArgs args, CustomResourceOptions? opts = null)
public FirewallRule(String name, FirewallRuleArgs args)
public FirewallRule(String name, FirewallRuleArgs args, CustomResourceOptions options)

type: azure-native:redis:FirewallRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FirewallRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplefirewallRuleResourceResourceFromRedis = new AzureNative.Redis.FirewallRule("examplefirewallRuleResourceResourceFromRedis", new()
{
    CacheName = "string",
    EndIP = "string",
    ResourceGroupName = "string",
    StartIP = "string",
    RuleName = "string",
});
Copy
example, err := redis.NewFirewallRule(ctx, "examplefirewallRuleResourceResourceFromRedis", &redis.FirewallRuleArgs{
	CacheName:         pulumi.String("string"),
	EndIP:             pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	StartIP:           pulumi.String("string"),
	RuleName:          pulumi.String("string"),
})
Copy
var examplefirewallRuleResourceResourceFromRedis = new FirewallRule("examplefirewallRuleResourceResourceFromRedis", FirewallRuleArgs.builder()
    .cacheName("string")
    .endIP("string")
    .resourceGroupName("string")
    .startIP("string")
    .ruleName("string")
    .build());
Copy
examplefirewall_rule_resource_resource_from_redis = azure_native.redis.FirewallRule("examplefirewallRuleResourceResourceFromRedis",
    cache_name="string",
    end_ip="string",
    resource_group_name="string",
    start_ip="string",
    rule_name="string")
Copy
const examplefirewallRuleResourceResourceFromRedis = new azure_native.redis.FirewallRule("examplefirewallRuleResourceResourceFromRedis", {
    cacheName: "string",
    endIP: "string",
    resourceGroupName: "string",
    startIP: "string",
    ruleName: "string",
});
Copy
type: azure-native:redis:FirewallRule
properties:
    cacheName: string
    endIP: string
    resourceGroupName: string
    ruleName: string
    startIP: string
Copy

FirewallRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FirewallRule resource accepts the following input properties:

CacheName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
EndIP This property is required. string
highest IP address included in the range
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StartIP This property is required. string
lowest IP address included in the range
RuleName Changes to this property will trigger replacement. string
The name of the firewall rule.
CacheName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
EndIP This property is required. string
highest IP address included in the range
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StartIP This property is required. string
lowest IP address included in the range
RuleName Changes to this property will trigger replacement. string
The name of the firewall rule.
cacheName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
endIP This property is required. String
highest IP address included in the range
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
startIP This property is required. String
lowest IP address included in the range
ruleName Changes to this property will trigger replacement. String
The name of the firewall rule.
cacheName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
endIP This property is required. string
highest IP address included in the range
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
startIP This property is required. string
lowest IP address included in the range
ruleName Changes to this property will trigger replacement. string
The name of the firewall rule.
cache_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Redis cache.
end_ip This property is required. str
highest IP address included in the range
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
start_ip This property is required. str
lowest IP address included in the range
rule_name Changes to this property will trigger replacement. str
The name of the firewall rule.
cacheName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
endIP This property is required. String
highest IP address included in the range
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
startIP This property is required. String
lowest IP address included in the range
ruleName Changes to this property will trigger replacement. String
The name of the firewall rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the FirewallRule resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:redis:FirewallRule cache1/rule1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native