1. Packages
  2. Azure Classic
  3. API Docs
  4. redis
  5. FirewallRule

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.redis.FirewallRule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    Manages a Firewall Rule associated with a Redis Cache.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    import * as random from "@pulumi/random";
    
    const server = new random.RandomId("server", {
        keepers: {
            azi_id: "1",
        },
        byteLength: 8,
    });
    const example = new azure.core.ResourceGroup("example", {
        name: "redis-resourcegroup",
        location: "West Europe",
    });
    const exampleCache = new azure.redis.Cache("example", {
        name: pulumi.interpolate`redis${server.hex}`,
        location: example.location,
        resourceGroupName: example.name,
        capacity: 1,
        family: "P",
        skuName: "Premium",
        enableNonSslPort: false,
        redisConfiguration: {
            maxmemoryReserved: 2,
            maxmemoryDelta: 2,
            maxmemoryPolicy: "allkeys-lru",
        },
    });
    const exampleFirewallRule = new azure.redis.FirewallRule("example", {
        name: "someIPrange",
        redisCacheName: exampleCache.name,
        resourceGroupName: example.name,
        startIp: "1.2.3.4",
        endIp: "2.3.4.5",
    });
    
    import pulumi
    import pulumi_azure as azure
    import pulumi_random as random
    
    server = random.RandomId("server",
        keepers={
            "azi_id": "1",
        },
        byte_length=8)
    example = azure.core.ResourceGroup("example",
        name="redis-resourcegroup",
        location="West Europe")
    example_cache = azure.redis.Cache("example",
        name=server.hex.apply(lambda hex: f"redis{hex}"),
        location=example.location,
        resource_group_name=example.name,
        capacity=1,
        family="P",
        sku_name="Premium",
        enable_non_ssl_port=False,
        redis_configuration=azure.redis.CacheRedisConfigurationArgs(
            maxmemory_reserved=2,
            maxmemory_delta=2,
            maxmemory_policy="allkeys-lru",
        ))
    example_firewall_rule = azure.redis.FirewallRule("example",
        name="someIPrange",
        redis_cache_name=example_cache.name,
        resource_group_name=example.name,
        start_ip="1.2.3.4",
        end_ip="2.3.4.5")
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/redis"
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		server, err := random.NewRandomId(ctx, "server", &random.RandomIdArgs{
    			Keepers: pulumi.StringMap{
    				"azi_id": pulumi.String("1"),
    			},
    			ByteLength: pulumi.Int(8),
    		})
    		if err != nil {
    			return err
    		}
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("redis-resourcegroup"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleCache, err := redis.NewCache(ctx, "example", &redis.CacheArgs{
    			Name: server.Hex.ApplyT(func(hex string) (string, error) {
    				return fmt.Sprintf("redis%v", hex), nil
    			}).(pulumi.StringOutput),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Capacity:          pulumi.Int(1),
    			Family:            pulumi.String("P"),
    			SkuName:           pulumi.String("Premium"),
    			EnableNonSslPort:  pulumi.Bool(false),
    			RedisConfiguration: &redis.CacheRedisConfigurationArgs{
    				MaxmemoryReserved: pulumi.Int(2),
    				MaxmemoryDelta:    pulumi.Int(2),
    				MaxmemoryPolicy:   pulumi.String("allkeys-lru"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = redis.NewFirewallRule(ctx, "example", &redis.FirewallRuleArgs{
    			Name:              pulumi.String("someIPrange"),
    			RedisCacheName:    exampleCache.Name,
    			ResourceGroupName: example.Name,
    			StartIp:           pulumi.String("1.2.3.4"),
    			EndIp:             pulumi.String("2.3.4.5"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    using Random = Pulumi.Random;
    
    return await Deployment.RunAsync(() => 
    {
        var server = new Random.RandomId("server", new()
        {
            Keepers = 
            {
                { "azi_id", "1" },
            },
            ByteLength = 8,
        });
    
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "redis-resourcegroup",
            Location = "West Europe",
        });
    
        var exampleCache = new Azure.Redis.Cache("example", new()
        {
            Name = server.Hex.Apply(hex => $"redis{hex}"),
            Location = example.Location,
            ResourceGroupName = example.Name,
            Capacity = 1,
            Family = "P",
            SkuName = "Premium",
            EnableNonSslPort = false,
            RedisConfiguration = new Azure.Redis.Inputs.CacheRedisConfigurationArgs
            {
                MaxmemoryReserved = 2,
                MaxmemoryDelta = 2,
                MaxmemoryPolicy = "allkeys-lru",
            },
        });
    
        var exampleFirewallRule = new Azure.Redis.FirewallRule("example", new()
        {
            Name = "someIPrange",
            RedisCacheName = exampleCache.Name,
            ResourceGroupName = example.Name,
            StartIp = "1.2.3.4",
            EndIp = "2.3.4.5",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.random.RandomId;
    import com.pulumi.random.RandomIdArgs;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.redis.Cache;
    import com.pulumi.azure.redis.CacheArgs;
    import com.pulumi.azure.redis.inputs.CacheRedisConfigurationArgs;
    import com.pulumi.azure.redis.FirewallRule;
    import com.pulumi.azure.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 server = new RandomId("server", RandomIdArgs.builder()
                .keepers(Map.of("azi_id", 1))
                .byteLength(8)
                .build());
    
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("redis-resourcegroup")
                .location("West Europe")
                .build());
    
            var exampleCache = new Cache("exampleCache", CacheArgs.builder()
                .name(server.hex().applyValue(hex -> String.format("redis%s", hex)))
                .location(example.location())
                .resourceGroupName(example.name())
                .capacity(1)
                .family("P")
                .skuName("Premium")
                .enableNonSslPort(false)
                .redisConfiguration(CacheRedisConfigurationArgs.builder()
                    .maxmemoryReserved(2)
                    .maxmemoryDelta(2)
                    .maxmemoryPolicy("allkeys-lru")
                    .build())
                .build());
    
            var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
                .name("someIPrange")
                .redisCacheName(exampleCache.name())
                .resourceGroupName(example.name())
                .startIp("1.2.3.4")
                .endIp("2.3.4.5")
                .build());
    
        }
    }
    
    resources:
      server:
        type: random:RandomId
        properties:
          keepers:
            azi_id: 1
          byteLength: 8
      example:
        type: azure:core:ResourceGroup
        properties:
          name: redis-resourcegroup
          location: West Europe
      exampleCache:
        type: azure:redis:Cache
        name: example
        properties:
          name: redis${server.hex}
          location: ${example.location}
          resourceGroupName: ${example.name}
          capacity: 1
          family: P
          skuName: Premium
          enableNonSslPort: false
          redisConfiguration:
            maxmemoryReserved: 2
            maxmemoryDelta: 2
            maxmemoryPolicy: allkeys-lru
      exampleFirewallRule:
        type: azure:redis:FirewallRule
        name: example
        properties:
          name: someIPrange
          redisCacheName: ${exampleCache.name}
          resourceGroupName: ${example.name}
          startIp: 1.2.3.4
          endIp: 2.3.4.5
    

    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,
                     end_ip: Optional[str] = None,
                     redis_cache_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     start_ip: Optional[str] = None,
                     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:redis:FirewallRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var examplefirewallRuleResourceResourceFromRedisfirewallRule = new Azure.Redis.FirewallRule("examplefirewallRuleResourceResourceFromRedisfirewallRule", new()
    {
        EndIp = "string",
        RedisCacheName = "string",
        ResourceGroupName = "string",
        StartIp = "string",
        Name = "string",
    });
    
    example, err := redis.NewFirewallRule(ctx, "examplefirewallRuleResourceResourceFromRedisfirewallRule", &redis.FirewallRuleArgs{
    	EndIp:             pulumi.String("string"),
    	RedisCacheName:    pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	StartIp:           pulumi.String("string"),
    	Name:              pulumi.String("string"),
    })
    
    var examplefirewallRuleResourceResourceFromRedisfirewallRule = new FirewallRule("examplefirewallRuleResourceResourceFromRedisfirewallRule", FirewallRuleArgs.builder()
        .endIp("string")
        .redisCacheName("string")
        .resourceGroupName("string")
        .startIp("string")
        .name("string")
        .build());
    
    examplefirewall_rule_resource_resource_from_redisfirewall_rule = azure.redis.FirewallRule("examplefirewallRuleResourceResourceFromRedisfirewallRule",
        end_ip="string",
        redis_cache_name="string",
        resource_group_name="string",
        start_ip="string",
        name="string")
    
    const examplefirewallRuleResourceResourceFromRedisfirewallRule = new azure.redis.FirewallRule("examplefirewallRuleResourceResourceFromRedisfirewallRule", {
        endIp: "string",
        redisCacheName: "string",
        resourceGroupName: "string",
        startIp: "string",
        name: "string",
    });
    
    type: azure:redis:FirewallRule
    properties:
        endIp: string
        name: string
        redisCacheName: string
        resourceGroupName: string
        startIp: string
    

    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

    The FirewallRule resource accepts the following input properties:

    EndIp string
    The highest IP address included in the range.
    RedisCacheName string
    The name of the Redis Cache. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    StartIp string
    The lowest IP address included in the range
    Name string
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    EndIp string
    The highest IP address included in the range.
    RedisCacheName string
    The name of the Redis Cache. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    StartIp string
    The lowest IP address included in the range
    Name string
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    endIp String
    The highest IP address included in the range.
    redisCacheName String
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    startIp String
    The lowest IP address included in the range
    name String
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    endIp string
    The highest IP address included in the range.
    redisCacheName string
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    startIp string
    The lowest IP address included in the range
    name string
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    end_ip str
    The highest IP address included in the range.
    redis_cache_name str
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    start_ip str
    The lowest IP address included in the range
    name str
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    endIp String
    The highest IP address included in the range.
    redisCacheName String
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    startIp String
    The lowest IP address included in the range
    name String
    The name of the Firewall Rule. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FirewallRule Resource

    Get an existing FirewallRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FirewallRuleState, opts?: CustomResourceOptions): FirewallRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            end_ip: Optional[str] = None,
            name: Optional[str] = None,
            redis_cache_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            start_ip: Optional[str] = None) -> FirewallRule
    func GetFirewallRule(ctx *Context, name string, id IDInput, state *FirewallRuleState, opts ...ResourceOption) (*FirewallRule, error)
    public static FirewallRule Get(string name, Input<string> id, FirewallRuleState? state, CustomResourceOptions? opts = null)
    public static FirewallRule get(String name, Output<String> id, FirewallRuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    EndIp string
    The highest IP address included in the range.
    Name string
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    RedisCacheName string
    The name of the Redis Cache. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    StartIp string
    The lowest IP address included in the range
    EndIp string
    The highest IP address included in the range.
    Name string
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    RedisCacheName string
    The name of the Redis Cache. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    StartIp string
    The lowest IP address included in the range
    endIp String
    The highest IP address included in the range.
    name String
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    redisCacheName String
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    startIp String
    The lowest IP address included in the range
    endIp string
    The highest IP address included in the range.
    name string
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    redisCacheName string
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    startIp string
    The lowest IP address included in the range
    end_ip str
    The highest IP address included in the range.
    name str
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    redis_cache_name str
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    start_ip str
    The lowest IP address included in the range
    endIp String
    The highest IP address included in the range.
    name String
    The name of the Firewall Rule. Changing this forces a new resource to be created.
    redisCacheName String
    The name of the Redis Cache. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which this Redis Cache exists. Changing this forces a new resource to be created.
    startIp String
    The lowest IP address included in the range

    Import

    Redis Firewall Rules can be imported using the resource id, e.g.

    $ pulumi import azure:redis/firewallRule:FirewallRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Cache/redis/cache1/firewallRules/rule1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi