1. Packages
  2. Azure Native v1
  3. API Docs
  4. network
  5. getFirewallPolicyRuleCollectionGroup
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.network.getFirewallPolicyRuleCollectionGroup

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    Gets the specified FirewallPolicyRuleCollectionGroup. API Version: 2020-11-01.

    Using getFirewallPolicyRuleCollectionGroup

    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 getFirewallPolicyRuleCollectionGroup(args: GetFirewallPolicyRuleCollectionGroupArgs, opts?: InvokeOptions): Promise<GetFirewallPolicyRuleCollectionGroupResult>
    function getFirewallPolicyRuleCollectionGroupOutput(args: GetFirewallPolicyRuleCollectionGroupOutputArgs, opts?: InvokeOptions): Output<GetFirewallPolicyRuleCollectionGroupResult>
    def get_firewall_policy_rule_collection_group(firewall_policy_name: Optional[str] = None,
                                                  resource_group_name: Optional[str] = None,
                                                  rule_collection_group_name: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetFirewallPolicyRuleCollectionGroupResult
    def get_firewall_policy_rule_collection_group_output(firewall_policy_name: Optional[pulumi.Input[str]] = None,
                                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                                  rule_collection_group_name: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetFirewallPolicyRuleCollectionGroupResult]
    func LookupFirewallPolicyRuleCollectionGroup(ctx *Context, args *LookupFirewallPolicyRuleCollectionGroupArgs, opts ...InvokeOption) (*LookupFirewallPolicyRuleCollectionGroupResult, error)
    func LookupFirewallPolicyRuleCollectionGroupOutput(ctx *Context, args *LookupFirewallPolicyRuleCollectionGroupOutputArgs, opts ...InvokeOption) LookupFirewallPolicyRuleCollectionGroupResultOutput

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

    public static class GetFirewallPolicyRuleCollectionGroup 
    {
        public static Task<GetFirewallPolicyRuleCollectionGroupResult> InvokeAsync(GetFirewallPolicyRuleCollectionGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetFirewallPolicyRuleCollectionGroupResult> Invoke(GetFirewallPolicyRuleCollectionGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFirewallPolicyRuleCollectionGroupResult> getFirewallPolicyRuleCollectionGroup(GetFirewallPolicyRuleCollectionGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getFirewallPolicyRuleCollectionGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FirewallPolicyName string
    The name of the Firewall Policy.
    ResourceGroupName string
    The name of the resource group.
    RuleCollectionGroupName string
    The name of the FirewallPolicyRuleCollectionGroup.
    FirewallPolicyName string
    The name of the Firewall Policy.
    ResourceGroupName string
    The name of the resource group.
    RuleCollectionGroupName string
    The name of the FirewallPolicyRuleCollectionGroup.
    firewallPolicyName String
    The name of the Firewall Policy.
    resourceGroupName String
    The name of the resource group.
    ruleCollectionGroupName String
    The name of the FirewallPolicyRuleCollectionGroup.
    firewallPolicyName string
    The name of the Firewall Policy.
    resourceGroupName string
    The name of the resource group.
    ruleCollectionGroupName string
    The name of the FirewallPolicyRuleCollectionGroup.
    firewall_policy_name str
    The name of the Firewall Policy.
    resource_group_name str
    The name of the resource group.
    rule_collection_group_name str
    The name of the FirewallPolicyRuleCollectionGroup.
    firewallPolicyName String
    The name of the Firewall Policy.
    resourceGroupName String
    The name of the resource group.
    ruleCollectionGroupName String
    The name of the FirewallPolicyRuleCollectionGroup.

    getFirewallPolicyRuleCollectionGroup Result

    The following output properties are available:

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the firewall policy rule collection 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 Collection Group resource.
    RuleCollections List<Union<Pulumi.AzureNative.Network.Outputs.FirewallPolicyFilterRuleCollectionResponse, Pulumi.AzureNative.Network.Outputs.FirewallPolicyNatRuleCollectionResponse>>
    Group of Firewall Policy rule collections.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the firewall policy rule collection 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 Collection Group resource.
    RuleCollections []interface{}
    Group of Firewall Policy rule collections.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the firewall policy rule collection 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 Collection Group resource.
    ruleCollections List<Either<FirewallPolicyFilterRuleCollectionResponse,FirewallPolicyNatRuleCollectionResponse>>
    Group of Firewall Policy rule collections.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the firewall policy rule collection 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 Collection Group resource.
    ruleCollections (FirewallPolicyFilterRuleCollectionResponse | FirewallPolicyNatRuleCollectionResponse)[]
    Group of Firewall Policy rule collections.
    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 collection 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 Collection Group resource.
    rule_collections Sequence[Any]
    Group of Firewall Policy rule collections.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the firewall policy rule collection 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 Collection Group resource.
    ruleCollections List<Property Map | Property Map>
    Group of Firewall Policy rule collections.

    Supporting Types

    ApplicationRuleResponse

    Description string
    Description of the rule.
    DestinationAddresses List<string>
    List of destination IP addresses or Service Tags.
    FqdnTags List<string>
    List of FQDN Tags for this rule.
    Name string
    Name of the rule.
    Protocols List<Pulumi.AzureNative.Network.Inputs.FirewallPolicyRuleApplicationProtocolResponse>
    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.
    TargetUrls List<string>
    List of Urls for this rule condition.
    TerminateTLS bool
    Terminate TLS connections for this rule.
    WebCategories List<string>
    List of destination azure web categories.
    Description string
    Description of the rule.
    DestinationAddresses []string
    List of destination IP addresses or Service Tags.
    FqdnTags []string
    List of FQDN Tags for this rule.
    Name string
    Name of the rule.
    Protocols []FirewallPolicyRuleApplicationProtocolResponse
    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.
    TargetUrls []string
    List of Urls for this rule condition.
    TerminateTLS bool
    Terminate TLS connections for this rule.
    WebCategories []string
    List of destination azure web categories.
    description String
    Description of the rule.
    destinationAddresses List<String>
    List of destination IP addresses or Service Tags.
    fqdnTags List<String>
    List of FQDN Tags for this rule.
    name String
    Name of the rule.
    protocols List<FirewallPolicyRuleApplicationProtocolResponse>
    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.
    targetUrls List<String>
    List of Urls for this rule condition.
    terminateTLS Boolean
    Terminate TLS connections for this rule.
    webCategories List<String>
    List of destination azure web categories.
    description string
    Description of the rule.
    destinationAddresses string[]
    List of destination IP addresses or Service Tags.
    fqdnTags string[]
    List of FQDN Tags for this rule.
    name string
    Name of the rule.
    protocols FirewallPolicyRuleApplicationProtocolResponse[]
    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.
    targetUrls string[]
    List of Urls for this rule condition.
    terminateTLS boolean
    Terminate TLS connections for this rule.
    webCategories string[]
    List of destination azure web categories.
    description str
    Description of the rule.
    destination_addresses Sequence[str]
    List of destination IP addresses or Service Tags.
    fqdn_tags Sequence[str]
    List of FQDN Tags for this rule.
    name str
    Name of the rule.
    protocols Sequence[FirewallPolicyRuleApplicationProtocolResponse]
    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.
    target_urls Sequence[str]
    List of Urls for this rule condition.
    terminate_tls bool
    Terminate TLS connections for this rule.
    web_categories Sequence[str]
    List of destination azure web categories.
    description String
    Description of the rule.
    destinationAddresses List<String>
    List of destination IP addresses or Service Tags.
    fqdnTags List<String>
    List of FQDN Tags for this rule.
    name String
    Name of the rule.
    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.
    targetUrls List<String>
    List of Urls for this rule condition.
    terminateTLS Boolean
    Terminate TLS connections for this rule.
    webCategories List<String>
    List of destination azure web categories.

    FirewallPolicyFilterRuleCollectionActionResponse

    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.

    FirewallPolicyFilterRuleCollectionResponse

    Action Pulumi.AzureNative.Network.Inputs.FirewallPolicyFilterRuleCollectionActionResponse
    The action type of a Filter rule collection.
    Name string
    The name of the rule collection.
    Priority int
    Priority of the Firewall Policy Rule Collection resource.
    Rules List<object>
    List of rules included in a rule collection.
    Action FirewallPolicyFilterRuleCollectionActionResponse
    The action type of a Filter rule collection.
    Name string
    The name of the rule collection.
    Priority int
    Priority of the Firewall Policy Rule Collection resource.
    Rules []interface{}
    List of rules included in a rule collection.
    action FirewallPolicyFilterRuleCollectionActionResponse
    The action type of a Filter rule collection.
    name String
    The name of the rule collection.
    priority Integer
    Priority of the Firewall Policy Rule Collection resource.
    rules List<Object>
    List of rules included in a rule collection.
    action FirewallPolicyFilterRuleCollectionActionResponse
    The action type of a Filter rule collection.
    name string
    The name of the rule collection.
    priority number
    Priority of the Firewall Policy Rule Collection resource.
    rules (ApplicationRuleResponse | NatRuleResponse | NetworkRuleResponse)[]
    List of rules included in a rule collection.
    action FirewallPolicyFilterRuleCollectionActionResponse
    The action type of a Filter rule collection.
    name str
    The name of the rule collection.
    priority int
    Priority of the Firewall Policy Rule Collection resource.
    rules Sequence[Union[ApplicationRuleResponse, NatRuleResponse, NetworkRuleResponse]]
    List of rules included in a rule collection.
    action Property Map
    The action type of a Filter rule collection.
    name String
    The name of the rule collection.
    priority Number
    Priority of the Firewall Policy Rule Collection resource.
    rules List<Property Map | Property Map | Property Map>
    List of rules included in a rule collection.

    FirewallPolicyNatRuleCollectionActionResponse

    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.

    FirewallPolicyNatRuleCollectionResponse

    Action Pulumi.AzureNative.Network.Inputs.FirewallPolicyNatRuleCollectionActionResponse
    The action type of a Nat rule collection.
    Name string
    The name of the rule collection.
    Priority int
    Priority of the Firewall Policy Rule Collection resource.
    Rules List<object>
    List of rules included in a rule collection.
    Action FirewallPolicyNatRuleCollectionActionResponse
    The action type of a Nat rule collection.
    Name string
    The name of the rule collection.
    Priority int
    Priority of the Firewall Policy Rule Collection resource.
    Rules []interface{}
    List of rules included in a rule collection.
    action FirewallPolicyNatRuleCollectionActionResponse
    The action type of a Nat rule collection.
    name String
    The name of the rule collection.
    priority Integer
    Priority of the Firewall Policy Rule Collection resource.
    rules List<Object>
    List of rules included in a rule collection.
    action FirewallPolicyNatRuleCollectionActionResponse
    The action type of a Nat rule collection.
    name string
    The name of the rule collection.
    priority number
    Priority of the Firewall Policy Rule Collection resource.
    rules (ApplicationRuleResponse | NatRuleResponse | NetworkRuleResponse)[]
    List of rules included in a rule collection.
    action FirewallPolicyNatRuleCollectionActionResponse
    The action type of a Nat rule collection.
    name str
    The name of the rule collection.
    priority int
    Priority of the Firewall Policy Rule Collection resource.
    rules Sequence[Union[ApplicationRuleResponse, NatRuleResponse, NetworkRuleResponse]]
    List of rules included in a rule collection.
    action Property Map
    The action type of a Nat rule collection.
    name String
    The name of the rule collection.
    priority Number
    Priority of the Firewall Policy Rule Collection resource.
    rules List<Property Map | Property Map | Property Map>
    List of rules included in a rule collection.

    FirewallPolicyRuleApplicationProtocolResponse

    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.

    NatRuleResponse

    Description string
    Description of the rule.
    DestinationAddresses List<string>
    List of destination IP addresses or Service Tags.
    DestinationPorts List<string>
    List of destination ports.
    IpProtocols List<string>
    Array of FirewallPolicyRuleNetworkProtocols.
    Name string
    Name of the rule.
    SourceAddresses List<string>
    List of source IP addresses for this rule.
    SourceIpGroups List<string>
    List of source IpGroups for this rule.
    TranslatedAddress string
    The translated address for this NAT rule.
    TranslatedFqdn string
    The translated FQDN for this NAT rule.
    TranslatedPort string
    The translated port for this NAT rule.
    Description string
    Description of the rule.
    DestinationAddresses []string
    List of destination IP addresses or Service Tags.
    DestinationPorts []string
    List of destination ports.
    IpProtocols []string
    Array of FirewallPolicyRuleNetworkProtocols.
    Name string
    Name of the rule.
    SourceAddresses []string
    List of source IP addresses for this rule.
    SourceIpGroups []string
    List of source IpGroups for this rule.
    TranslatedAddress string
    The translated address for this NAT rule.
    TranslatedFqdn string
    The translated FQDN for this NAT rule.
    TranslatedPort string
    The translated port for this NAT rule.
    description String
    Description of the rule.
    destinationAddresses List<String>
    List of destination IP addresses or Service Tags.
    destinationPorts List<String>
    List of destination ports.
    ipProtocols List<String>
    Array of FirewallPolicyRuleNetworkProtocols.
    name String
    Name of the rule.
    sourceAddresses List<String>
    List of source IP addresses for this rule.
    sourceIpGroups List<String>
    List of source IpGroups for this rule.
    translatedAddress String
    The translated address for this NAT rule.
    translatedFqdn String
    The translated FQDN for this NAT rule.
    translatedPort String
    The translated port for this NAT rule.
    description string
    Description of the rule.
    destinationAddresses string[]
    List of destination IP addresses or Service Tags.
    destinationPorts string[]
    List of destination ports.
    ipProtocols string[]
    Array of FirewallPolicyRuleNetworkProtocols.
    name string
    Name of the rule.
    sourceAddresses string[]
    List of source IP addresses for this rule.
    sourceIpGroups string[]
    List of source IpGroups for this rule.
    translatedAddress string
    The translated address for this NAT rule.
    translatedFqdn string
    The translated FQDN for this NAT rule.
    translatedPort string
    The translated port for this NAT rule.
    description str
    Description of the rule.
    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 FirewallPolicyRuleNetworkProtocols.
    name str
    Name of the rule.
    source_addresses Sequence[str]
    List of source IP addresses for this rule.
    source_ip_groups Sequence[str]
    List of source IpGroups for this rule.
    translated_address str
    The translated address for this NAT rule.
    translated_fqdn str
    The translated FQDN for this NAT rule.
    translated_port str
    The translated port for this NAT rule.
    description String
    Description of the rule.
    destinationAddresses List<String>
    List of destination IP addresses or Service Tags.
    destinationPorts List<String>
    List of destination ports.
    ipProtocols List<String>
    Array of FirewallPolicyRuleNetworkProtocols.
    name String
    Name of the rule.
    sourceAddresses List<String>
    List of source IP addresses for this rule.
    sourceIpGroups List<String>
    List of source IpGroups for this rule.
    translatedAddress String
    The translated address for this NAT rule.
    translatedFqdn String
    The translated FQDN for this NAT rule.
    translatedPort String
    The translated port for this NAT rule.

    NetworkRuleResponse

    Description string
    Description of the rule.
    DestinationAddresses List<string>
    List of destination IP addresses or Service Tags.
    DestinationFqdns List<string>
    List of destination FQDNs.
    DestinationIpGroups List<string>
    List of destination IpGroups for this rule.
    DestinationPorts List<string>
    List of destination ports.
    IpProtocols List<string>
    Array of FirewallPolicyRuleNetworkProtocols.
    Name string
    Name of the rule.
    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.
    DestinationAddresses []string
    List of destination IP addresses or Service Tags.
    DestinationFqdns []string
    List of destination FQDNs.
    DestinationIpGroups []string
    List of destination IpGroups for this rule.
    DestinationPorts []string
    List of destination ports.
    IpProtocols []string
    Array of FirewallPolicyRuleNetworkProtocols.
    Name string
    Name of the rule.
    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.
    destinationAddresses List<String>
    List of destination IP addresses or Service Tags.
    destinationFqdns List<String>
    List of destination FQDNs.
    destinationIpGroups List<String>
    List of destination IpGroups for this rule.
    destinationPorts List<String>
    List of destination ports.
    ipProtocols List<String>
    Array of FirewallPolicyRuleNetworkProtocols.
    name String
    Name of the rule.
    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.
    destinationAddresses string[]
    List of destination IP addresses or Service Tags.
    destinationFqdns string[]
    List of destination FQDNs.
    destinationIpGroups string[]
    List of destination IpGroups for this rule.
    destinationPorts string[]
    List of destination ports.
    ipProtocols string[]
    Array of FirewallPolicyRuleNetworkProtocols.
    name string
    Name of the rule.
    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.
    destination_addresses Sequence[str]
    List of destination IP addresses or Service Tags.
    destination_fqdns Sequence[str]
    List of destination FQDNs.
    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 FirewallPolicyRuleNetworkProtocols.
    name str
    Name of the rule.
    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.
    destinationAddresses List<String>
    List of destination IP addresses or Service Tags.
    destinationFqdns List<String>
    List of destination FQDNs.
    destinationIpGroups List<String>
    List of destination IpGroups for this rule.
    destinationPorts List<String>
    List of destination ports.
    ipProtocols List<String>
    Array of FirewallPolicyRuleNetworkProtocols.
    name String
    Name of the rule.
    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-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi