Firewall Policy Rule Collection Groups - List

Service:

Virtual Networks

API Version:

2023-09-01

Listy wszystkie grupy FirewallPolicyRuleCollectionGroups w zasobie FirewallPolicy.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups?api-version=2023-09-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
firewallPolicyName	path	True	string	Nazwa zasad zapory.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	FirewallPolicyRuleCollectionGroupListResult	Powodzenie. Operacja zwraca listę zasobów FirewallPolicyRuleCollectionGroup.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List all FirewallPolicyRuleCollectionGroup With Web Categories

List all FirewallPolicyRuleCollectionGroups for a given FirewallPolicy

List all FirewallPolicyRuleCollectionGroups with IpGroups for a given FirewallPolicy

List all FirewallPolicyRuleCollectionGroup With Web Categories

Sample Request

HTTP

GET https://management.azure.com/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups?api-version=2023-09-01

Java

/**
 * Samples for FirewallPolicyRuleCollectionGroups List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json
     */
    /**
     * Sample code: List all FirewallPolicyRuleCollectionGroup With Web Categories.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllFirewallPolicyRuleCollectionGroupWithWebCategories(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getFirewallPolicyRuleCollectionGroups().list("rg1", "firewallPolicy",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python firewall_policy_rule_collection_group_with_web_categories_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e747cc13-97d4-4a79-b463-42d7f4e558f2",
    )

    response = client.firewall_policy_rule_collection_groups.list(
        resource_group_name="rg1",
        firewall_policy_name="firewallPolicy",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json
func ExampleFirewallPolicyRuleCollectionGroupsClient_NewListPager_listAllFirewallPolicyRuleCollectionGroupWithWebCategories() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewFirewallPolicyRuleCollectionGroupsClient().NewListPager("rg1", "firewallPolicy", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.FirewallPolicyRuleCollectionGroupListResult = armnetwork.FirewallPolicyRuleCollectionGroupListResult{
		// 	Value: []*armnetwork.FirewallPolicyRuleCollectionGroup{
		// 		{
		// 			ID: to.Ptr("/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1"),
		// 			Name: to.Ptr("ruleCollectionGroup1"),
		// 			Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
		// 			Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
		// 				Priority: to.Ptr[int32](110),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
		// 					&armnetwork.FirewallPolicyFilterRuleCollection{
		// 						Name: to.Ptr("Example-Filter-Rule-Collection"),
		// 						Priority: to.Ptr[int32](120),
		// 						RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection),
		// 						Action: &armnetwork.FirewallPolicyFilterRuleCollectionAction{
		// 							Type: to.Ptr(armnetwork.FirewallPolicyFilterRuleCollectionActionTypeDeny),
		// 						},
		// 						Rules: []armnetwork.FirewallPolicyRuleClassification{
		// 							&armnetwork.ApplicationRule{
		// 								Name: to.Ptr("rule1"),
		// 								Description: to.Ptr("Deny inbound rule"),
		// 								RuleType: to.Ptr(armnetwork.FirewallPolicyRuleTypeApplicationRule),
		// 								Protocols: []*armnetwork.FirewallPolicyRuleApplicationProtocol{
		// 									{
		// 										Port: to.Ptr[int32](443),
		// 										ProtocolType: to.Ptr(armnetwork.FirewallPolicyRuleApplicationProtocolTypeHTTPS),
		// 								}},
		// 								SourceAddresses: []*string{
		// 									to.Ptr("216.58.216.164"),
		// 									to.Ptr("10.0.0.0/24")},
		// 									WebCategories: []*string{
		// 										to.Ptr("Hacking")},
		// 								}},
		// 						}},
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
 *
 * @summary Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json
 */
async function listAllFirewallPolicyRuleCollectionGroupWithWebCategories() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "e747cc13-97d4-4a79-b463-42d7f4e558f2";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const firewallPolicyName = "firewallPolicy";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.firewallPolicyRuleCollectionGroups.list(
    resourceGroupName,
    firewallPolicyName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json
// this example is just showing the usage of "FirewallPolicyRuleCollectionGroups_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FirewallPolicyResource created on azure
// for more information of creating FirewallPolicyResource, please refer to the document of FirewallPolicyResource
string subscriptionId = "e747cc13-97d4-4a79-b463-42d7f4e558f2";
string resourceGroupName = "rg1";
string firewallPolicyName = "firewallPolicy";
ResourceIdentifier firewallPolicyResourceId = FirewallPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, firewallPolicyName);
FirewallPolicyResource firewallPolicy = client.GetFirewallPolicyResource(firewallPolicyResourceId);

// get the collection of this FirewallPolicyRuleCollectionGroupResource
FirewallPolicyRuleCollectionGroupCollection collection = firewallPolicy.GetFirewallPolicyRuleCollectionGroups();

// invoke the operation and iterate over the result
await foreach (FirewallPolicyRuleCollectionGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FirewallPolicyRuleCollectionGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "ruleCollectionGroup1",
      "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1",
      "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
      "properties": {
        "provisioningState": "Succeeded",
        "priority": 110,
        "ruleCollections": [
          {
            "name": "Example-Filter-Rule-Collection",
            "ruleCollectionType": "FirewallPolicyFilterRuleCollection",
            "priority": 120,
            "action": {
              "type": "Deny"
            },
            "rules": [
              {
                "ruleType": "ApplicationRule",
                "name": "rule1",
                "description": "Deny inbound rule",
                "protocols": [
                  {
                    "protocolType": "Https",
                    "port": 443
                  }
                ],
                "sourceAddresses": [
                  "216.58.216.164",
                  "10.0.0.0/24"
                ],
                "webCategories": [
                  "Hacking"
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

List all FirewallPolicyRuleCollectionGroups for a given FirewallPolicy

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups?api-version=2023-09-01

Java

/**
 * Samples for FirewallPolicyRuleCollectionGroups List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * FirewallPolicyRuleCollectionGroupList.json
     */
    /**
     * Sample code: List all FirewallPolicyRuleCollectionGroups for a given FirewallPolicy.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllFirewallPolicyRuleCollectionGroupsForAGivenFirewallPolicy(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getFirewallPolicyRuleCollectionGroups().list("rg1", "firewallPolicy",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python firewall_policy_rule_collection_group_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.firewall_policy_rule_collection_groups.list(
        resource_group_name="rg1",
        firewall_policy_name="firewallPolicy",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupList.json
func ExampleFirewallPolicyRuleCollectionGroupsClient_NewListPager_listAllFirewallPolicyRuleCollectionGroupsForAGivenFirewallPolicy() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewFirewallPolicyRuleCollectionGroupsClient().NewListPager("rg1", "firewallPolicy", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.FirewallPolicyRuleCollectionGroupListResult = armnetwork.FirewallPolicyRuleCollectionGroupListResult{
		// 	Value: []*armnetwork.FirewallPolicyRuleCollectionGroup{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1"),
		// 			Name: to.Ptr("ruleCollectionGroup1"),
		// 			Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
		// 			Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
		// 				Priority: to.Ptr[int32](110),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
		// 					&armnetwork.FirewallPolicyFilterRuleCollection{
		// 						Name: to.Ptr("Example-Filter-Rule-Collection"),
		// 						Priority: to.Ptr[int32](120),
		// 						RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection),
		// 						Action: &armnetwork.FirewallPolicyFilterRuleCollectionAction{
		// 							Type: to.Ptr(armnetwork.FirewallPolicyFilterRuleCollectionActionTypeDeny),
		// 						},
		// 						Rules: []armnetwork.FirewallPolicyRuleClassification{
		// 							&armnetwork.Rule{
		// 								Name: to.Ptr("network-rule-1"),
		// 								Description: to.Ptr("Network rule"),
		// 								RuleType: to.Ptr(armnetwork.FirewallPolicyRuleTypeNetworkRule),
		// 								DestinationAddresses: []*string{
		// 									to.Ptr("*")},
		// 									DestinationPorts: []*string{
		// 										to.Ptr("*")},
		// 										IPProtocols: []*armnetwork.FirewallPolicyRuleNetworkProtocol{
		// 											to.Ptr(armnetwork.FirewallPolicyRuleNetworkProtocolTCP)},
		// 											SourceAddresses: []*string{
		// 												to.Ptr("10.1.25.0/24")},
		// 										}},
		// 								}},
		// 							},
		// 					}},
		// 				}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
 *
 * @summary Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupList.json
 */
async function listAllFirewallPolicyRuleCollectionGroupsForAGivenFirewallPolicy() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const firewallPolicyName = "firewallPolicy";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.firewallPolicyRuleCollectionGroups.list(
    resourceGroupName,
    firewallPolicyName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupList.json
// this example is just showing the usage of "FirewallPolicyRuleCollectionGroups_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FirewallPolicyResource created on azure
// for more information of creating FirewallPolicyResource, please refer to the document of FirewallPolicyResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string firewallPolicyName = "firewallPolicy";
ResourceIdentifier firewallPolicyResourceId = FirewallPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, firewallPolicyName);
FirewallPolicyResource firewallPolicy = client.GetFirewallPolicyResource(firewallPolicyResourceId);

// get the collection of this FirewallPolicyRuleCollectionGroupResource
FirewallPolicyRuleCollectionGroupCollection collection = firewallPolicy.GetFirewallPolicyRuleCollectionGroups();

// invoke the operation and iterate over the result
await foreach (FirewallPolicyRuleCollectionGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FirewallPolicyRuleCollectionGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "ruleCollectionGroup1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1",
      "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
      "properties": {
        "provisioningState": "Succeeded",
        "priority": 110,
        "ruleCollections": [
          {
            "name": "Example-Filter-Rule-Collection",
            "ruleCollectionType": "FirewallPolicyFilterRuleCollection",
            "priority": 120,
            "action": {
              "type": "Deny"
            },
            "rules": [
              {
                "name": "network-rule-1",
                "ruleType": "NetworkRule",
                "description": "Network rule",
                "destinationAddresses": [
                  "*"
                ],
                "sourceAddresses": [
                  "10.1.25.0/24"
                ],
                "ipProtocols": [
                  "TCP"
                ],
                "destinationPorts": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

List all FirewallPolicyRuleCollectionGroups with IpGroups for a given FirewallPolicy

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups?api-version=2023-09-01

Java

/**
 * Samples for FirewallPolicyRuleCollectionGroups List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * FirewallPolicyRuleCollectionGroupWithIpGroupsList.json
     */
    /**
     * Sample code: List all FirewallPolicyRuleCollectionGroups with IpGroups for a given FirewallPolicy.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllFirewallPolicyRuleCollectionGroupsWithIpGroupsForAGivenFirewallPolicy(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getFirewallPolicyRuleCollectionGroups().list("rg1", "firewallPolicy",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python firewall_policy_rule_collection_group_with_ip_groups_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.firewall_policy_rule_collection_groups.list(
        resource_group_name="rg1",
        firewall_policy_name="firewallPolicy",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json
func ExampleFirewallPolicyRuleCollectionGroupsClient_NewListPager_listAllFirewallPolicyRuleCollectionGroupsWithIpGroupsForAGivenFirewallPolicy() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewFirewallPolicyRuleCollectionGroupsClient().NewListPager("rg1", "firewallPolicy", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.FirewallPolicyRuleCollectionGroupListResult = armnetwork.FirewallPolicyRuleCollectionGroupListResult{
		// 	Value: []*armnetwork.FirewallPolicyRuleCollectionGroup{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1"),
		// 			Name: to.Ptr("ruleCollectionGroup1"),
		// 			Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
		// 			Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
		// 				Priority: to.Ptr[int32](110),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
		// 					&armnetwork.FirewallPolicyFilterRuleCollection{
		// 						Name: to.Ptr("Example-Filter-Rule-Collection"),
		// 						Priority: to.Ptr[int32](120),
		// 						RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection),
		// 						Action: &armnetwork.FirewallPolicyFilterRuleCollectionAction{
		// 							Type: to.Ptr(armnetwork.FirewallPolicyFilterRuleCollectionActionTypeDeny),
		// 						},
		// 						Rules: []armnetwork.FirewallPolicyRuleClassification{
		// 							&armnetwork.Rule{
		// 								Name: to.Ptr("network-rule-1"),
		// 								Description: to.Ptr("Network rule"),
		// 								RuleType: to.Ptr(armnetwork.FirewallPolicyRuleTypeNetworkRule),
		// 								DestinationIPGroups: []*string{
		// 									to.Ptr("/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2")},
		// 									DestinationPorts: []*string{
		// 										to.Ptr("*")},
		// 										IPProtocols: []*armnetwork.FirewallPolicyRuleNetworkProtocol{
		// 											to.Ptr(armnetwork.FirewallPolicyRuleNetworkProtocolTCP)},
		// 											SourceIPGroups: []*string{
		// 												to.Ptr("/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1")},
		// 										}},
		// 								}},
		// 							},
		// 					}},
		// 				}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
 *
 * @summary Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json
 */
async function listAllFirewallPolicyRuleCollectionGroupsWithIPGroupsForAGivenFirewallPolicy() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const firewallPolicyName = "firewallPolicy";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.firewallPolicyRuleCollectionGroups.list(
    resourceGroupName,
    firewallPolicyName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json
// this example is just showing the usage of "FirewallPolicyRuleCollectionGroups_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FirewallPolicyResource created on azure
// for more information of creating FirewallPolicyResource, please refer to the document of FirewallPolicyResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string firewallPolicyName = "firewallPolicy";
ResourceIdentifier firewallPolicyResourceId = FirewallPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, firewallPolicyName);
FirewallPolicyResource firewallPolicy = client.GetFirewallPolicyResource(firewallPolicyResourceId);

// get the collection of this FirewallPolicyRuleCollectionGroupResource
FirewallPolicyRuleCollectionGroupCollection collection = firewallPolicy.GetFirewallPolicyRuleCollectionGroups();

// invoke the operation and iterate over the result
await foreach (FirewallPolicyRuleCollectionGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FirewallPolicyRuleCollectionGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "ruleCollectionGroup1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1",
      "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
      "properties": {
        "provisioningState": "Succeeded",
        "priority": 110,
        "ruleCollections": [
          {
            "name": "Example-Filter-Rule-Collection",
            "ruleCollectionType": "FirewallPolicyFilterRuleCollection",
            "priority": 120,
            "action": {
              "type": "Deny"
            },
            "rules": [
              {
                "name": "network-rule-1",
                "ruleType": "NetworkRule",
                "description": "Network rule",
                "sourceIpGroups": [
                  "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1"
                ],
                "destinationIpGroups": [
                  "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2"
                ],
                "ipProtocols": [
                  "TCP"
                ],
                "destinationPorts": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
ApplicationRule	Reguła typu aplikacja.
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
FirewallPolicyFilterRuleCollection	Kolekcja reguł filtru zasad zapory.
FirewallPolicyFilterRuleCollectionAction	Właściwości firewallPolicyFilterRuleCollectionAction.
FirewallPolicyFilterRuleCollectionActionType	Typ akcji reguły.
FirewallPolicyHttpHeaderToInsert	nazwa i wartość nagłówka HTTP/S do wstawienia
FirewallPolicyNatRuleCollection	Kolekcja reguł NAT zasad zapory.
FirewallPolicyNatRuleCollectionAction	Właściwości firewallPolicyNatRuleCollectionAction.
FirewallPolicyNatRuleCollectionActionType	Typ akcji reguły.
FirewallPolicyRuleApplicationProtocol	Właściwości protokołu reguły aplikacji.
FirewallPolicyRuleApplicationProtocolType	Typ protokołu aplikacji reguły.
FirewallPolicyRuleCollectionGroup	Zasób grupy kolekcji reguł.
FirewallPolicyRuleCollectionGroupListResult	Odpowiedź dla wywołania usługi interfejsu API ListFirewallPolicyRuleCollectionGroups.
FirewallPolicyRuleNetworkProtocol	Protokół sieciowy reguły.
NatRule	Reguła typu nat.
NetworkRule	Reguła typu sieć.
ProvisioningState	Bieżący stan aprowizacji.

ApplicationRule

Reguła typu aplikacja.

Nazwa	Typ	Opis
description	string	Opis reguły.
destinationAddresses	string[]	Lista docelowych adresów IP lub tagów usługi.
fqdnTags	string[]	Lista tagów FQDN dla tej reguły.
httpHeadersToInsert	FirewallPolicyHttpHeaderToInsert[]	Lista nagłówków HTTP/S do wstawienia.
name	string	Nazwa reguły.
protocols	FirewallPolicyRuleApplicationProtocol[]	Tablica protokołów aplikacji.
ruleType	string: ApplicationRule	Typ reguły.
sourceAddresses	string[]	Lista źródłowych adresów IP dla tej reguły.
sourceIpGroups	string[]	Lista źródłowych grup IpGroup dla tej reguły.
targetFqdns	string[]	Lista nazw FQDN dla tej reguły.
targetUrls	string[]	Lista adresów URL dla tego warunku reguły.
terminateTLS	boolean	Zakończ połączenia TLS dla tej reguły.
webCategories	string[]	Lista docelowych kategorii internetowych platformy Azure.

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

FirewallPolicyFilterRuleCollection

Kolekcja reguł filtru zasad zapory.

Nazwa	Typ	Opis
action	FirewallPolicyFilterRuleCollectionAction	Typ akcji kolekcji reguł filtru.
name	string	Nazwa kolekcji reguł.
priority	integer	Priorytet zasobu zbierania reguł zasad zapory.
ruleCollectionType	string: FirewallPolicyFilterRuleCollection	Typ kolekcji reguł.
rules	FirewallPolicyRule[]: ApplicationRule[] NatRule[] NetworkRule[]	Lista reguł uwzględnionych w kolekcji reguł.

FirewallPolicyFilterRuleCollectionAction

Właściwości firewallPolicyFilterRuleCollectionAction.

Nazwa	Typ	Opis
type	FirewallPolicyFilterRuleCollectionActionType	Typ akcji.

FirewallPolicyFilterRuleCollectionActionType

Typ akcji reguły.

Nazwa	Typ	Opis
Allow	string
Deny	string

FirewallPolicyHttpHeaderToInsert

nazwa i wartość nagłówka HTTP/S do wstawienia

Nazwa	Typ	Opis
headerName	string	Zawiera nazwę nagłówka
headerValue	string	Zawiera wartość nagłówka

FirewallPolicyNatRuleCollection

Kolekcja reguł NAT zasad zapory.

Nazwa	Typ	Opis
action	FirewallPolicyNatRuleCollectionAction	Typ akcji kolekcji reguł nat.
name	string	Nazwa kolekcji reguł.
priority	integer	Priorytet zasobu zbierania reguł zasad zapory.
ruleCollectionType	string: FirewallPolicyNatRuleCollection	Typ kolekcji reguł.
rules	FirewallPolicyRule[]: ApplicationRule[] NatRule[] NetworkRule[]	Lista reguł uwzględnionych w kolekcji reguł.

FirewallPolicyNatRuleCollectionAction

Właściwości firewallPolicyNatRuleCollectionAction.

Nazwa	Typ	Opis
type	FirewallPolicyNatRuleCollectionActionType	Typ akcji.

FirewallPolicyNatRuleCollectionActionType

Typ akcji reguły.

Nazwa	Typ	Opis
DNAT	string

FirewallPolicyRuleApplicationProtocol

Właściwości protokołu reguły aplikacji.

Nazwa	Typ	Opis
port	integer	Numer portu dla protokołu nie może być większy niż 64000.
protocolType	FirewallPolicyRuleApplicationProtocolType	Typ protokołu.

FirewallPolicyRuleApplicationProtocolType

Typ protokołu aplikacji reguły.

Nazwa	Typ	Opis
Http	string
Https	string

FirewallPolicyRuleCollectionGroup

Zasób grupy kolekcji reguł.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu, który jest unikatowy w grupie zasobów. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties.priority	integer	Priorytet zasobu grupy kolekcji reguł zasad zapory.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu grupy kolekcji reguł zasad zapory.
properties.ruleCollections	FirewallPolicyRuleCollection[]: FirewallPolicyFilterRuleCollection[] FirewallPolicyNatRuleCollection[]	Grupa kolekcji reguł zasad zapory.
properties.size	string	Ciąg tylko do odczytu reprezentujący rozmiar właściwości FirewallPolicyRuleCollectionGroupProperties w MB. (np. 1,2 MB)
type	string	Typ grupy reguł.

FirewallPolicyRuleCollectionGroupListResult

Odpowiedź dla wywołania usługi interfejsu API ListFirewallPolicyRuleCollectionGroups.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający uzyskanie następnego zestawu wyników.
value	FirewallPolicyRuleCollectionGroup[]	Lista grup FirewallPolicyRuleCollectionGroups w obszarze FirewallPolicy.

FirewallPolicyRuleNetworkProtocol

Protokół sieciowy reguły.

Nazwa	Typ	Opis
Any	string
ICMP	string
TCP	string
UDP	string

NatRule

Reguła typu nat.

Nazwa	Typ	Opis
description	string	Opis reguły.
destinationAddresses	string[]	Lista docelowych adresów IP lub tagów usługi.
destinationPorts	string[]	Lista portów docelowych.
ipProtocols	FirewallPolicyRuleNetworkProtocol[]	Tablica kolumn FirewallPolicyRuleNetworkProtocols.
name	string	Nazwa reguły.
ruleType	string: NatRule	Typ reguły.
sourceAddresses	string[]	Lista źródłowych adresów IP dla tej reguły.
sourceIpGroups	string[]	Lista źródłowych grup IpGroup dla tej reguły.
translatedAddress	string	Przetłumaczony adres dla tej reguły translatora adresów sieciowych.
translatedFqdn	string	Przetłumaczona nazwa FQDN dla tej reguły translatora adresów sieciowych.
translatedPort	string	Przetłumaczony port dla tej reguły translatora adresów sieciowych.

NetworkRule

Reguła typu sieć.

Nazwa	Typ	Opis
description	string	Opis reguły.
destinationAddresses	string[]	Lista docelowych adresów IP lub tagów usługi.
destinationFqdns	string[]	Lista docelowych nazw FQDN.
destinationIpGroups	string[]	Lista docelowych grup IpGroup dla tej reguły.
destinationPorts	string[]	Lista portów docelowych.
ipProtocols	FirewallPolicyRuleNetworkProtocol[]	Tablica kolumn FirewallPolicyRuleNetworkProtocols.
name	string	Nazwa reguły.
ruleType	string: NetworkRule	Typ reguły.
sourceAddresses	string[]	Lista źródłowych adresów IP dla tej reguły.
sourceIpGroups	string[]	Lista źródłowych grup IpGroup dla tej reguły.

ProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Deleting	string
Failed	string
Succeeded	string
Updating	string