Firewall Policy Rule Collection Group Drafts - Get

Reference

Service:: Virtual Networks

API Version:: 2024-03-01

Get Rule Collection Group Draft.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}/ruleCollectionGroupDrafts/default?api-version=2024-03-01

URI Parameters

Name	In	Required	Type	Description
firewallPolicyName	path	True	string	The name of the Firewall Policy. Regex pattern: `^[^_\W][\w-._]{0,79}(?<![-.])$`
resourceGroupName	path	True	string	The name of the resource group.
ruleCollectionGroupName	path	True	string	The name of the FirewallPolicyRuleCollectionGroup. Regex pattern: `^[^_\W][\w-._]{0,79}(?<![-.])$`
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	FirewallPolicyRuleCollectionGroupDraft	Request successful. The operation returns a Firewall Policy Rule Collection Group Draft resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

get rule collection group draft

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1/ruleCollectionGroupDrafts/default?api-version=2024-03-01


/**
 * Samples for FirewallPolicyRuleCollectionGroupDrafts Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/
     * FirewallPolicyRuleCollectionGroupDraftGet.json
     */
    /**
     * Sample code: get rule collection group draft.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRuleCollectionGroupDraft(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getFirewallPolicyRuleCollectionGroupDrafts().getWithResponse("rg1",
            "firewallPolicy", "ruleCollectionGroup1", 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

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_draft_get.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_group_drafts.get(
        resource_group_name="rg1",
        firewall_policy_name="firewallPolicy",
        rule_collection_group_name="ruleCollectionGroup1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.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

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json
func ExampleFirewallPolicyRuleCollectionGroupDraftsClient_Get() {
	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)
	}
	res, err := clientFactory.NewFirewallPolicyRuleCollectionGroupDraftsClient().Get(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.FirewallPolicyRuleCollectionGroupDraft = armnetwork.FirewallPolicyRuleCollectionGroupDraft{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1"),
	// 	Name: to.Ptr("ruleCollectionGroup1"),
	// 	Properties: &armnetwork.FirewallPolicyRuleCollectionGroupDraftProperties{
	// 		Priority: to.Ptr[int32](110),
	// 		RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
	// 			&armnetwork.FirewallPolicyFilterRuleCollection{
	// 				Name: to.Ptr("Example-Filter-Rule-Collection"),
	// 				Priority: to.Ptr[int32](200),
	// 				RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection),
	// 				Action: &armnetwork.FirewallPolicyFilterRuleCollectionAction{
	// 					Type: to.Ptr(armnetwork.FirewallPolicyFilterRuleCollectionActionTypeDeny),
	// 				},
	// 				Rules: []armnetwork.FirewallPolicyRuleClassification{
	// 					&armnetwork.Rule{
	// 						Name: to.Ptr("network-rule1"),
	// 						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

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

/**
 * This sample demonstrates how to Get Rule Collection Group Draft.
 *
 * @summary Get Rule Collection Group Draft.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json
 */
async function getRuleCollectionGroupDraft() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const firewallPolicyName = "firewallPolicy";
  const ruleCollectionGroupName = "ruleCollectionGroup1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.firewallPolicyRuleCollectionGroupDrafts.get(
    resourceGroupName,
    firewallPolicyName,
    ruleCollectionGroupName,
  );
  console.log(result);
}

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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json
// this example is just showing the usage of "FirewallPolicyRuleCollectionGroupDrafts_Get" 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 FirewallPolicyRuleCollectionGroupDraftResource created on azure
// for more information of creating FirewallPolicyRuleCollectionGroupDraftResource, please refer to the document of FirewallPolicyRuleCollectionGroupDraftResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string firewallPolicyName = "firewallPolicy";
string ruleCollectionGroupName = "ruleCollectionGroup1";
ResourceIdentifier firewallPolicyRuleCollectionGroupDraftResourceId = FirewallPolicyRuleCollectionGroupDraftResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, firewallPolicyName, ruleCollectionGroupName);
FirewallPolicyRuleCollectionGroupDraftResource firewallPolicyRuleCollectionGroupDraft = client.GetFirewallPolicyRuleCollectionGroupDraftResource(firewallPolicyRuleCollectionGroupDraftResourceId);

// invoke the operation
FirewallPolicyRuleCollectionGroupDraftResource result = await firewallPolicyRuleCollectionGroupDraft.GetAsync();

// the variable result 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
FirewallPolicyRuleCollectionGroupDraftData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "name": "ruleCollectionGroup1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1",
  "properties": {
    "priority": 110,
    "ruleCollections": [
      {
        "ruleCollectionType": "FirewallPolicyFilterRuleCollection",
        "name": "Example-Filter-Rule-Collection",
        "priority": 200,
        "action": {
          "type": "Deny"
        },
        "rules": [
          {
            "ruleType": "NetworkRule",
            "name": "network-rule1",
            "sourceAddresses": [
              "10.1.25.0/24"
            ],
            "destinationAddresses": [
              "*"
            ],
            "ipProtocols": [
              "TCP"
            ],
            "destinationPorts": [
              "*"
            ]
          }
        ]
      }
    ]
  }
}

Definitions

Name	Description
ApplicationRule	Rule of type application.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
FirewallPolicyFilterRuleCollection	Firewall Policy Filter Rule Collection.
FirewallPolicyFilterRuleCollectionAction	Properties of the FirewallPolicyFilterRuleCollectionAction.
FirewallPolicyFilterRuleCollectionActionType	The action type of a rule.
FirewallPolicyHttpHeaderToInsert	name and value of HTTP/S header to insert
FirewallPolicyNatRuleCollection	Firewall Policy NAT Rule Collection.
FirewallPolicyNatRuleCollectionAction	Properties of the FirewallPolicyNatRuleCollectionAction.
FirewallPolicyNatRuleCollectionActionType	The action type of a rule.
FirewallPolicyRuleApplicationProtocol	Properties of the application rule protocol.
FirewallPolicyRuleApplicationProtocolType	The application protocol type of a Rule.
FirewallPolicyRuleCollectionGroupDraft	Rule Collection Group resource.
FirewallPolicyRuleNetworkProtocol	The Network protocol of a Rule.
NatRule	Rule of type nat.
NetworkRule	Rule of type network.

ApplicationRule

Rule of type application.

Name	Type	Description
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.
httpHeadersToInsert	FirewallPolicyHttpHeaderToInsert[]	List of HTTP/S headers to insert.
name	string	Name of the rule.
protocols	FirewallPolicyRuleApplicationProtocol[]	Array of Application Protocols.
ruleType	string: ApplicationRule	Rule Type.
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.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

FirewallPolicyFilterRuleCollection

Firewall Policy Filter Rule Collection.

Name	Type	Description
action	FirewallPolicyFilterRuleCollectionAction	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.
ruleCollectionType	string: FirewallPolicyFilterRuleCollection	The type of the rule collection.
rules	FirewallPolicyRule[]: ApplicationRule[] NatRule[] NetworkRule[]	List of rules included in a rule collection.

FirewallPolicyFilterRuleCollectionAction

Properties of the FirewallPolicyFilterRuleCollectionAction.

Name	Type	Description
type	FirewallPolicyFilterRuleCollectionActionType	The type of action.

FirewallPolicyFilterRuleCollectionActionType

The action type of a rule.

Name	Type	Description
Allow	string
Deny	string

FirewallPolicyHttpHeaderToInsert

name and value of HTTP/S header to insert

Name	Type	Description
headerName	string	Contains the name of the header
headerValue	string	Contains the value of the header

FirewallPolicyNatRuleCollection

Firewall Policy NAT Rule Collection.

Name	Type	Description
action	FirewallPolicyNatRuleCollectionAction	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.
ruleCollectionType	string: FirewallPolicyNatRuleCollection	The type of the rule collection.
rules	FirewallPolicyRule[]: ApplicationRule[] NatRule[] NetworkRule[]	List of rules included in a rule collection.

FirewallPolicyNatRuleCollectionAction

Properties of the FirewallPolicyNatRuleCollectionAction.

Name	Type	Description
type	FirewallPolicyNatRuleCollectionActionType	The type of action.

FirewallPolicyNatRuleCollectionActionType

The action type of a rule.

Name	Type	Description
DNAT	string

FirewallPolicyRuleApplicationProtocol

Properties of the application rule protocol.

Name	Type	Description
port	integer	Port number for the protocol, cannot be greater than 64000.
protocolType	FirewallPolicyRuleApplicationProtocolType	Protocol type.

FirewallPolicyRuleApplicationProtocolType

The application protocol type of a Rule.

Name	Type	Description
Http	string
Https	string

FirewallPolicyRuleCollectionGroupDraft

Rule Collection Group resource.

Name	Type	Description
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.
properties.priority	integer	Priority of the Firewall Policy Rule Collection Group resource.
properties.ruleCollections	FirewallPolicyRuleCollection[]: FirewallPolicyFilterRuleCollection[] FirewallPolicyNatRuleCollection[]	Group of Firewall Policy rule collections.
properties.size	string	A read-only string that represents the size of the FirewallPolicyRuleCollectionGroupProperties in MB. (ex 1.2MB)
type	string	Rule Group type.

FirewallPolicyRuleNetworkProtocol

The Network protocol of a Rule.

Name	Type	Description
Any	string
ICMP	string
TCP	string
UDP	string

NatRule

Rule of type nat.

Name	Type	Description
description	string	Description of the rule.
destinationAddresses	string[]	List of destination IP addresses or Service Tags.
destinationPorts	string[]	List of destination ports.
ipProtocols	FirewallPolicyRuleNetworkProtocol[]	Array of FirewallPolicyRuleNetworkProtocols.
name	string	Name of the rule.
ruleType	string: NatRule	Rule Type.
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.

NetworkRule

Rule of type network.

Name	Type	Description
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	FirewallPolicyRuleNetworkProtocol[]	Array of FirewallPolicyRuleNetworkProtocols.
name	string	Name of the rule.
ruleType	string: NetworkRule	Rule Type.
sourceAddresses	string[]	List of source IP addresses for this rule.
sourceIpGroups	string[]	List of source IpGroups for this rule.