Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getFirewallPolicyRuleGroup
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getFirewallPolicyRuleGroup

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified FirewallPolicyRuleGroup.

Uses Azure REST API version 2020-04-01.

Other available API versions: 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getFirewallPolicyRuleGroup

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 getFirewallPolicyRuleGroup(args: GetFirewallPolicyRuleGroupArgs, opts?: InvokeOptions): Promise<GetFirewallPolicyRuleGroupResult>
function getFirewallPolicyRuleGroupOutput(args: GetFirewallPolicyRuleGroupOutputArgs, opts?: InvokeOptions): Output<GetFirewallPolicyRuleGroupResult>
Copy
def get_firewall_policy_rule_group(firewall_policy_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   rule_group_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetFirewallPolicyRuleGroupResult
def get_firewall_policy_rule_group_output(firewall_policy_name: Optional[pulumi.Input[str]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   rule_group_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetFirewallPolicyRuleGroupResult]
Copy
func LookupFirewallPolicyRuleGroup(ctx *Context, args *LookupFirewallPolicyRuleGroupArgs, opts ...InvokeOption) (*LookupFirewallPolicyRuleGroupResult, error)
func LookupFirewallPolicyRuleGroupOutput(ctx *Context, args *LookupFirewallPolicyRuleGroupOutputArgs, opts ...InvokeOption) LookupFirewallPolicyRuleGroupResultOutput
Copy

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

public static class GetFirewallPolicyRuleGroup 
{
    public static Task<GetFirewallPolicyRuleGroupResult> InvokeAsync(GetFirewallPolicyRuleGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetFirewallPolicyRuleGroupResult> Invoke(GetFirewallPolicyRuleGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFirewallPolicyRuleGroupResult> getFirewallPolicyRuleGroup(GetFirewallPolicyRuleGroupArgs args, InvokeOptions options)
public static Output<GetFirewallPolicyRuleGroupResult> getFirewallPolicyRuleGroup(GetFirewallPolicyRuleGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getFirewallPolicyRuleGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FirewallPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Firewall Policy.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RuleGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the FirewallPolicyRuleGroup.
FirewallPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Firewall Policy.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RuleGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the FirewallPolicyRuleGroup.
firewallPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Firewall Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
ruleGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the FirewallPolicyRuleGroup.
firewallPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Firewall Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ruleGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the FirewallPolicyRuleGroup.
firewall_policy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Firewall Policy.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
rule_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the FirewallPolicyRuleGroup.
firewallPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Firewall Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
ruleGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the FirewallPolicyRuleGroup.

getFirewallPolicyRuleGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the firewall policy rule group resource.
Type string
Rule Group type.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
Priority int
Priority of the Firewall Policy Rule Group resource.
Rules List<Union<Pulumi.AzureNative.Network.Outputs.FirewallPolicyFilterRuleResponse, Pulumi.AzureNative.Network.Outputs.FirewallPolicyNatRuleResponse>>
Group of Firewall Policy rules.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the firewall policy rule group resource.
Type string
Rule Group type.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
Priority int
Priority of the Firewall Policy Rule Group resource.
Rules []interface{}
Group of Firewall Policy rules.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the firewall policy rule group resource.
type String
Rule Group type.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
priority Integer
Priority of the Firewall Policy Rule Group resource.
rules List<Either<FirewallPolicyFilterRuleResponse,FirewallPolicyNatRuleResponse>>
Group of Firewall Policy rules.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
provisioningState string
The provisioning state of the firewall policy rule group resource.
type string
Rule Group type.
id string
Resource ID.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
priority number
Priority of the Firewall Policy Rule Group resource.
rules (FirewallPolicyFilterRuleResponse | FirewallPolicyNatRuleResponse)[]
Group of Firewall Policy rules.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
provisioning_state str
The provisioning state of the firewall policy rule group resource.
type str
Rule Group type.
id str
Resource ID.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
priority int
Priority of the Firewall Policy Rule Group resource.
rules Sequence[Any]
Group of Firewall Policy rules.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the firewall policy rule group resource.
type String
Rule Group type.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
priority Number
Priority of the Firewall Policy Rule Group resource.
rules List<Property Map | Property Map>
Group of Firewall Policy rules.

Supporting Types

ApplicationRuleConditionResponse

Description string
Description of the rule condition.
DestinationAddresses List<string>
List of destination IP addresses or Service Tags.
FqdnTags List<string>
List of FQDN Tags for this rule condition.
Name string
Name of the rule condition.
Protocols List<Pulumi.AzureNative.Network.Inputs.FirewallPolicyRuleConditionApplicationProtocolResponse>
Array of Application Protocols.
SourceAddresses List<string>
List of source IP addresses for this rule.
SourceIpGroups List<string>
List of source IpGroups for this rule.
TargetFqdns List<string>
List of FQDNs for this rule condition.
Description string
Description of the rule condition.
DestinationAddresses []string
List of destination IP addresses or Service Tags.
FqdnTags []string
List of FQDN Tags for this rule condition.
Name string
Name of the rule condition.
Protocols []FirewallPolicyRuleConditionApplicationProtocolResponse
Array of Application Protocols.
SourceAddresses []string
List of source IP addresses for this rule.
SourceIpGroups []string
List of source IpGroups for this rule.
TargetFqdns []string
List of FQDNs for this rule condition.
description String
Description of the rule condition.
destinationAddresses List<String>
List of destination IP addresses or Service Tags.
fqdnTags List<String>
List of FQDN Tags for this rule condition.
name String
Name of the rule condition.
protocols List<FirewallPolicyRuleConditionApplicationProtocolResponse>
Array of Application Protocols.
sourceAddresses List<String>
List of source IP addresses for this rule.
sourceIpGroups List<String>
List of source IpGroups for this rule.
targetFqdns List<String>
List of FQDNs for this rule condition.
description string
Description of the rule condition.
destinationAddresses string[]
List of destination IP addresses or Service Tags.
fqdnTags string[]
List of FQDN Tags for this rule condition.
name string
Name of the rule condition.
protocols FirewallPolicyRuleConditionApplicationProtocolResponse[]
Array of Application Protocols.
sourceAddresses string[]
List of source IP addresses for this rule.
sourceIpGroups string[]
List of source IpGroups for this rule.
targetFqdns string[]
List of FQDNs for this rule condition.
description str
Description of the rule condition.
destination_addresses Sequence[str]
List of destination IP addresses or Service Tags.
fqdn_tags Sequence[str]
List of FQDN Tags for this rule condition.
name str
Name of the rule condition.
protocols Sequence[FirewallPolicyRuleConditionApplicationProtocolResponse]
Array of Application Protocols.
source_addresses Sequence[str]
List of source IP addresses for this rule.
source_ip_groups Sequence[str]
List of source IpGroups for this rule.
target_fqdns Sequence[str]
List of FQDNs for this rule condition.
description String
Description of the rule condition.
destinationAddresses List<String>
List of destination IP addresses or Service Tags.
fqdnTags List<String>
List of FQDN Tags for this rule condition.
name String
Name of the rule condition.
protocols List<Property Map>
Array of Application Protocols.
sourceAddresses List<String>
List of source IP addresses for this rule.
sourceIpGroups List<String>
List of source IpGroups for this rule.
targetFqdns List<String>
List of FQDNs for this rule condition.

FirewallPolicyFilterRuleActionResponse

Type string
The type of action.
Type string
The type of action.
type String
The type of action.
type string
The type of action.
type str
The type of action.
type String
The type of action.

FirewallPolicyFilterRuleResponse

Action Pulumi.AzureNative.Network.Inputs.FirewallPolicyFilterRuleActionResponse
The action type of a Filter rule.
Name string
The name of the rule.
Priority int
Priority of the Firewall Policy Rule resource.
RuleConditions List<object>
Collection of rule conditions used by a rule.
Action FirewallPolicyFilterRuleActionResponse
The action type of a Filter rule.
Name string
The name of the rule.
Priority int
Priority of the Firewall Policy Rule resource.
RuleConditions []interface{}
Collection of rule conditions used by a rule.
action FirewallPolicyFilterRuleActionResponse
The action type of a Filter rule.
name String
The name of the rule.
priority Integer
Priority of the Firewall Policy Rule resource.
ruleConditions List<Object>
Collection of rule conditions used by a rule.
action FirewallPolicyFilterRuleActionResponse
The action type of a Filter rule.
name string
The name of the rule.
priority number
Priority of the Firewall Policy Rule resource.
ruleConditions (ApplicationRuleConditionResponse | NatRuleConditionResponse | NetworkRuleConditionResponse)[]
Collection of rule conditions used by a rule.
action FirewallPolicyFilterRuleActionResponse
The action type of a Filter rule.
name str
The name of the rule.
priority int
Priority of the Firewall Policy Rule resource.
rule_conditions Sequence[Union[ApplicationRuleConditionResponse, NatRuleConditionResponse, NetworkRuleConditionResponse]]
Collection of rule conditions used by a rule.
action Property Map
The action type of a Filter rule.
name String
The name of the rule.
priority Number
Priority of the Firewall Policy Rule resource.
ruleConditions List<Property Map | Property Map | Property Map>
Collection of rule conditions used by a rule.

FirewallPolicyNatRuleActionResponse

Type string
The type of action.
Type string
The type of action.
type String
The type of action.
type string
The type of action.
type str
The type of action.
type String
The type of action.

FirewallPolicyNatRuleResponse

Action Pulumi.AzureNative.Network.Inputs.FirewallPolicyNatRuleActionResponse
The action type of a Nat rule.
Name string
The name of the rule.
Priority int
Priority of the Firewall Policy Rule resource.
RuleCondition Pulumi.AzureNative.Network.Inputs.ApplicationRuleConditionResponse | Pulumi.AzureNative.Network.Inputs.NatRuleConditionResponse | Pulumi.AzureNative.Network.Inputs.NetworkRuleConditionResponse
The match conditions for incoming traffic.
TranslatedAddress string
The translated address for this NAT rule.
TranslatedPort string
The translated port for this NAT rule.
Action FirewallPolicyNatRuleActionResponse
The action type of a Nat rule.
Name string
The name of the rule.
Priority int
Priority of the Firewall Policy Rule resource.
RuleCondition ApplicationRuleConditionResponse | NatRuleConditionResponse | NetworkRuleConditionResponse
The match conditions for incoming traffic.
TranslatedAddress string
The translated address for this NAT rule.
TranslatedPort string
The translated port for this NAT rule.
action FirewallPolicyNatRuleActionResponse
The action type of a Nat rule.
name String
The name of the rule.
priority Integer
Priority of the Firewall Policy Rule resource.
ruleCondition ApplicationRuleConditionResponse | NatRuleConditionResponse | NetworkRuleConditionResponse
The match conditions for incoming traffic.
translatedAddress String
The translated address for this NAT rule.
translatedPort String
The translated port for this NAT rule.
action FirewallPolicyNatRuleActionResponse
The action type of a Nat rule.
name string
The name of the rule.
priority number
Priority of the Firewall Policy Rule resource.
ruleCondition ApplicationRuleConditionResponse | NatRuleConditionResponse | NetworkRuleConditionResponse
The match conditions for incoming traffic.
translatedAddress string
The translated address for this NAT rule.
translatedPort string
The translated port for this NAT rule.
action FirewallPolicyNatRuleActionResponse
The action type of a Nat rule.
name str
The name of the rule.
priority int
Priority of the Firewall Policy Rule resource.
rule_condition ApplicationRuleConditionResponse | NatRuleConditionResponse | NetworkRuleConditionResponse
The match conditions for incoming traffic.
translated_address str
The translated address for this NAT rule.
translated_port str
The translated port for this NAT rule.
action Property Map
The action type of a Nat rule.
name String
The name of the rule.
priority Number
Priority of the Firewall Policy Rule resource.
ruleCondition Property Map | Property Map | Property Map
The match conditions for incoming traffic.
translatedAddress String
The translated address for this NAT rule.
translatedPort String
The translated port for this NAT rule.

FirewallPolicyRuleConditionApplicationProtocolResponse

Port int
Port number for the protocol, cannot be greater than 64000.
ProtocolType string
Protocol type.
Port int
Port number for the protocol, cannot be greater than 64000.
ProtocolType string
Protocol type.
port Integer
Port number for the protocol, cannot be greater than 64000.
protocolType String
Protocol type.
port number
Port number for the protocol, cannot be greater than 64000.
protocolType string
Protocol type.
port int
Port number for the protocol, cannot be greater than 64000.
protocol_type str
Protocol type.
port Number
Port number for the protocol, cannot be greater than 64000.
protocolType String
Protocol type.

NatRuleConditionResponse

Description string
Description of the rule condition.
DestinationAddresses List<string>
List of destination IP addresses or Service Tags.
DestinationPorts List<string>
List of destination ports.
IpProtocols List<string>
Array of FirewallPolicyRuleConditionNetworkProtocols.
Name string
Name of the rule condition.
SourceAddresses List<string>
List of source IP addresses for this rule.
SourceIpGroups List<string>
List of source IpGroups for this rule.
Description string
Description of the rule condition.
DestinationAddresses []string
List of destination IP addresses or Service Tags.
DestinationPorts []string
List of destination ports.
IpProtocols []string
Array of FirewallPolicyRuleConditionNetworkProtocols.
Name string
Name of the rule condition.
SourceAddresses []string
List of source IP addresses for this rule.
SourceIpGroups []string
List of source IpGroups for this rule.
description String
Description of the rule condition.
destinationAddresses List<String>
List of destination IP addresses or Service Tags.
destinationPorts List<String>
List of destination ports.
ipProtocols List<String>
Array of FirewallPolicyRuleConditionNetworkProtocols.
name String
Name of the rule condition.
sourceAddresses List<String>
List of source IP addresses for this rule.
sourceIpGroups List<String>
List of source IpGroups for this rule.
description string
Description of the rule condition.
destinationAddresses string[]
List of destination IP addresses or Service Tags.
destinationPorts string[]
List of destination ports.
ipProtocols string[]
Array of FirewallPolicyRuleConditionNetworkProtocols.
name string
Name of the rule condition.
sourceAddresses string[]
List of source IP addresses for this rule.
sourceIpGroups string[]
List of source IpGroups for this rule.
description str
Description of the rule condition.
destination_addresses Sequence[str]
List of destination IP addresses or Service Tags.
destination_ports Sequence[str]
List of destination ports.
ip_protocols Sequence[str]
Array of FirewallPolicyRuleConditionNetworkProtocols.
name str
Name of the rule condition.
source_addresses Sequence[str]
List of source IP addresses for this rule.
source_ip_groups Sequence[str]
List of source IpGroups for this rule.
description String
Description of the rule condition.
destinationAddresses List<String>
List of destination IP addresses or Service Tags.
destinationPorts List<String>
List of destination ports.
ipProtocols List<String>
Array of FirewallPolicyRuleConditionNetworkProtocols.
name String
Name of the rule condition.
sourceAddresses List<String>
List of source IP addresses for this rule.
sourceIpGroups List<String>
List of source IpGroups for this rule.

NetworkRuleConditionResponse

Description string
Description of the rule condition.
DestinationAddresses List<string>
List of destination IP addresses or Service Tags.
DestinationIpGroups List<string>
List of destination IpGroups for this rule.
DestinationPorts List<string>
List of destination ports.
IpProtocols List<string>
Array of FirewallPolicyRuleConditionNetworkProtocols.
Name string
Name of the rule condition.
SourceAddresses List<string>
List of source IP addresses for this rule.
SourceIpGroups List<string>
List of source IpGroups for this rule.
Description string
Description of the rule condition.
DestinationAddresses []string
List of destination IP addresses or Service Tags.
DestinationIpGroups []string
List of destination IpGroups for this rule.
DestinationPorts []string
List of destination ports.
IpProtocols []string
Array of FirewallPolicyRuleConditionNetworkProtocols.
Name string
Name of the rule condition.
SourceAddresses []string
List of source IP addresses for this rule.
SourceIpGroups []string
List of source IpGroups for this rule.
description String
Description of the rule condition.
destinationAddresses List<String>
List of destination IP addresses or Service Tags.
destinationIpGroups List<String>
List of destination IpGroups for this rule.
destinationPorts List<String>
List of destination ports.
ipProtocols List<String>
Array of FirewallPolicyRuleConditionNetworkProtocols.
name String
Name of the rule condition.
sourceAddresses List<String>
List of source IP addresses for this rule.
sourceIpGroups List<String>
List of source IpGroups for this rule.
description string
Description of the rule condition.
destinationAddresses string[]
List of destination IP addresses or Service Tags.
destinationIpGroups string[]
List of destination IpGroups for this rule.
destinationPorts string[]
List of destination ports.
ipProtocols string[]
Array of FirewallPolicyRuleConditionNetworkProtocols.
name string
Name of the rule condition.
sourceAddresses string[]
List of source IP addresses for this rule.
sourceIpGroups string[]
List of source IpGroups for this rule.
description str
Description of the rule condition.
destination_addresses Sequence[str]
List of destination IP addresses or Service Tags.
destination_ip_groups Sequence[str]
List of destination IpGroups for this rule.
destination_ports Sequence[str]
List of destination ports.
ip_protocols Sequence[str]
Array of FirewallPolicyRuleConditionNetworkProtocols.
name str
Name of the rule condition.
source_addresses Sequence[str]
List of source IP addresses for this rule.
source_ip_groups Sequence[str]
List of source IpGroups for this rule.
description String
Description of the rule condition.
destinationAddresses List<String>
List of destination IP addresses or Service Tags.
destinationIpGroups List<String>
List of destination IpGroups for this rule.
destinationPorts List<String>
List of destination ports.
ipProtocols List<String>
Array of FirewallPolicyRuleConditionNetworkProtocols.
name String
Name of the rule condition.
sourceAddresses List<String>
List of source IP addresses for this rule.
sourceIpGroups List<String>
List of source IpGroups for this rule.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native