Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. cache
  5. getFirewallRule
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.cache.getFirewallRule

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a single firewall rule in a specified redis cache. Azure REST API version: 2023-04-01.

Other available API versions: 2023-05-01-preview, 2023-08-01, 2024-03-01, 2024-04-01-preview, 2024-11-01.

Using getFirewallRule

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 getFirewallRule(args: GetFirewallRuleArgs, opts?: InvokeOptions): Promise<GetFirewallRuleResult>
function getFirewallRuleOutput(args: GetFirewallRuleOutputArgs, opts?: InvokeOptions): Output<GetFirewallRuleResult>
Copy
def get_firewall_rule(cache_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      rule_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetFirewallRuleResult
def get_firewall_rule_output(cache_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      rule_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetFirewallRuleResult]
Copy
func LookupFirewallRule(ctx *Context, args *LookupFirewallRuleArgs, opts ...InvokeOption) (*LookupFirewallRuleResult, error)
func LookupFirewallRuleOutput(ctx *Context, args *LookupFirewallRuleOutputArgs, opts ...InvokeOption) LookupFirewallRuleResultOutput
Copy

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

public static class GetFirewallRule 
{
    public static Task<GetFirewallRuleResult> InvokeAsync(GetFirewallRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetFirewallRuleResult> Invoke(GetFirewallRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFirewallRuleResult> getFirewallRule(GetFirewallRuleArgs args, InvokeOptions options)
public static Output<GetFirewallRuleResult> getFirewallRule(GetFirewallRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cache:getFirewallRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CacheName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RuleName
This property is required.
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RuleName
This property is required.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
ruleName
This property is required.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ruleName
This property is required.
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
rule_name
This property is required.
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
ruleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the firewall rule.

getFirewallRule Result

The following output properties are available:

EndIP string
highest IP address included in the range
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
StartIP string
lowest IP address included in the range
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
EndIP string
highest IP address included in the range
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
StartIP string
lowest IP address included in the range
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
endIP String
highest IP address included in the range
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
startIP String
lowest IP address included in the range
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
endIP string
highest IP address included in the range
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
startIP string
lowest IP address included in the range
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
end_ip str
highest IP address included in the range
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
start_ip str
lowest IP address included in the range
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
endIP String
highest IP address included in the range
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
startIP String
lowest IP address included in the range
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native