Security Rules - List

Service:

Virtual Networks

API Version:

2023-09-01

Obtient toutes les règles de sécurité d’un groupe de sécurité réseau.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
networkSecurityGroupName	path	True	string	Nom du groupe de sécurité réseau.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version d’API client.

Réponses

Nom	Type	Description
200 OK	SecurityRuleListResult	Demande réussie. L’opération retourne une liste de ressources SecurityRule.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

List network security rules in network security group

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules?api-version=2023-09-01

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_security_group_rule_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.security_rules.list(
        resource_group_name="rg1",
        network_security_group_name="testnsg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkSecurityGroupRuleList.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/NetworkSecurityGroupRuleList.json
func ExampleSecurityRulesClient_NewListPager() {
	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.NewSecurityRulesClient().NewListPager("rg1", "testnsg", 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.SecurityRuleListResult = armnetwork.SecurityRuleListResult{
		// 	Value: []*armnetwork.SecurityRule{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1"),
		// 			Name: to.Ptr("rule1"),
		// 			Properties: &armnetwork.SecurityRulePropertiesFormat{
		// 				Access: to.Ptr(armnetwork.SecurityRuleAccessAllow),
		// 				DestinationAddressPrefix: to.Ptr("*"),
		// 				DestinationPortRange: to.Ptr("80"),
		// 				Direction: to.Ptr(armnetwork.SecurityRuleDirectionInbound),
		// 				Priority: to.Ptr[int32](130),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				SourceAddressPrefix: to.Ptr("*"),
		// 				SourcePortRange: to.Ptr("*"),
		// 				Protocol: to.Ptr(armnetwork.SecurityRuleProtocolAsterisk),
		// 			},
		// 	}},
		// }
	}
}

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 Gets all security rules in a network security group.
 *
 * @summary Gets all security rules in a network security group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkSecurityGroupRuleList.json
 */
async function listNetworkSecurityRulesInNetworkSecurityGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityGroupName = "testnsg";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.securityRules.list(resourceGroupName, networkSecurityGroupName)) {
    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/NetworkSecurityGroupRuleList.json
// this example is just showing the usage of "SecurityRules_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 NetworkSecurityGroupResource created on azure
// for more information of creating NetworkSecurityGroupResource, please refer to the document of NetworkSecurityGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkSecurityGroupName = "testnsg";
ResourceIdentifier networkSecurityGroupResourceId = NetworkSecurityGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkSecurityGroupName);
NetworkSecurityGroupResource networkSecurityGroup = client.GetNetworkSecurityGroupResource(networkSecurityGroupResourceId);

// get the collection of this SecurityRuleResource
SecurityRuleCollection collection = networkSecurityGroup.GetSecurityRules();

// invoke the operation and iterate over the result
await foreach (SecurityRuleResource 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
    SecurityRuleData 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": "rule1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1",
      "properties": {
        "provisioningState": "Succeeded",
        "protocol": "*",
        "sourcePortRange": "*",
        "destinationPortRange": "80",
        "sourceAddressPrefix": "*",
        "destinationAddressPrefix": "*",
        "access": "Allow",
        "priority": 130,
        "direction": "Inbound"
      }
    }
  ]
}

Définitions

Nom	Description
ApplicationSecurityGroup	Un groupe de sécurité d’application dans un groupe de ressources.
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
ProvisioningState	État d’approvisionnement actuel.
SecurityRule	Règle de sécurité réseau.
SecurityRuleAccess	Indique si le trafic réseau est autorisé ou refusé.
SecurityRuleDirection	Direction de la règle. La direction indique si la règle est évaluée sur le trafic entrant ou sortant.
SecurityRuleListResult	Réponse à l’appel de service d’API ListSecurityRule. Récupère toutes les règles de sécurité qui appartiennent à un groupe de sécurité réseau.
SecurityRuleProtocol	Protocole réseau auquel la règle s'applique.

ApplicationSecurityGroup

Un groupe de sécurité d’application dans un groupe de ressources.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de la ressource
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de groupe de sécurité d’application.
properties.resourceGuid	string	Propriété GUID de ressource de la ressource de groupe de sécurité d’application. Il identifie de manière unique une ressource, même si l’utilisateur change son nom ou migre la ressource entre des abonnements ou des groupes de ressources.
tags	object	Balises de ressource.
type	string	Type de ressource.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SecurityRule

Règle de sécurité réseau.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de la ressource
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.access	SecurityRuleAccess	Le trafic réseau est autorisé ou refusé.
properties.description	string	Description pour cette règle. Limité à 140 caractères.
properties.destinationAddressPrefix	string	Préfixe d’adresse de destination. CIDR ou plage d’adresses IP de destination. Peut également utiliser un astérisque (*) pour établir une correspondance avec toutes les adresses IP sources. Les balises par défaut telles que « VirtualNetwork », « AzureLoadBalancer » et « Internet » peuvent également être utilisées.
properties.destinationAddressPrefixes	string[]	Préfixes d’adresse de destination. CIDR ou plages d’adresses IP de destination.
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	Groupe de sécurité d’application spécifié comme destination.
properties.destinationPortRange	string	Port ou plage de destination. Entier ou plage compris entre 0 et 65535. L’astérisque « * » peut également être utilisé pour faire correspondre tous les ports.
properties.destinationPortRanges	string[]	Plages de ports de destination.
properties.direction	SecurityRuleDirection	Direction de la règle. La direction indique si la règle est évaluée sur le trafic entrant ou sortant.
properties.priority	integer	Priorité de la règle. La valeur peut être comprise entre 100 et 4096. Le numéro de priorité doit être unique pour chaque règle de la collection. Plus le numéro de priorité est faible, plus la priorité de la règle est élevée.
properties.protocol	SecurityRuleProtocol	Protocole réseau auquel la règle s'applique.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de règle de sécurité.
properties.sourceAddressPrefix	string	CiDR ou plage d’adresses IP sources. Peut également utiliser un astérisque (*) pour établir une correspondance avec toutes les adresses IP sources. Les balises par défaut telles que « VirtualNetwork », « AzureLoadBalancer » et « Internet » peuvent également être utilisées. S’il s’agit d’une règle d’entrée, spécifie d’où provient le trafic réseau.
properties.sourceAddressPrefixes	string[]	Le CIDR ou les plages d’adresses IP sources.
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	Groupe de sécurité d’application spécifié en tant que source.
properties.sourcePortRange	string	Port ou plage source. Entier ou plage compris entre 0 et 65535. L’astérisque « * » peut également être utilisé pour faire correspondre tous les ports.
properties.sourcePortRanges	string[]	Plages de ports sources.
type	string	Type de la ressource.

SecurityRuleAccess

Indique si le trafic réseau est autorisé ou refusé.

Nom	Type	Description
Allow	string
Deny	string

SecurityRuleDirection

Direction de la règle. La direction indique si la règle est évaluée sur le trafic entrant ou sortant.

Nom	Type	Description
Inbound	string
Outbound	string

SecurityRuleListResult

Réponse à l’appel de service d’API ListSecurityRule. Récupère toutes les règles de sécurité qui appartiennent à un groupe de sécurité réseau.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir l’ensemble de résultats suivant.
value	SecurityRule[]	Règles de sécurité dans un groupe de sécurité réseau.

SecurityRuleProtocol

Protocole réseau auquel la règle s'applique.

Nom	Type	Description
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string