Security Rules - List

Service:

Virtual Networks

API Version:

2023-09-01

Ottiene tutte le regole di sicurezza in un gruppo di sicurezza di rete.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
networkSecurityGroupName	path	True	string	Nome del gruppo di sicurezza di rete.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione API client.

Risposte

Nome	Tipo	Descrizione
200 OK	SecurityRuleListResult	Richiesta completata. L'operazione restituisce un elenco di risorse SecurityRule.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ApplicationSecurityGroup	Un gruppo di sicurezza delle applicazioni in un gruppo di risorse.
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
ProvisioningState	Stato di provisioning corrente.
SecurityRule	Regola di sicurezza di rete.
SecurityRuleAccess	Indica se il traffico di rete è consentito o negato.
SecurityRuleDirection	Direzione della regola. L'elemento direction specifica se la regola verrà valutata sul traffico in ingresso o in uscita.
SecurityRuleListResult	Risposta per la chiamata al servizio API ListSecurityRule. Recupera tutte le regole di sicurezza appartenenti a un gruppo di sicurezza di rete.
SecurityRuleProtocol	Protocollo di rete a cui si applica la regola.

ApplicationSecurityGroup

Un gruppo di sicurezza delle applicazioni in un gruppo di risorse.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa del gruppo di sicurezza dell'applicazione.
properties.resourceGuid	string	Proprietà GUID della risorsa del gruppo di sicurezza dell'applicazione. Identifica in modo univoco una risorsa, anche se l'utente modifica il nome o esegue la migrazione della risorsa tra sottoscrizioni o gruppi di risorse.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

ProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Deleting	string
Failed	string
Succeeded	string
Updating	string

SecurityRule

Regola di sicurezza di rete.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.access	SecurityRuleAccess	Il traffico di rete è consentito o negato.
properties.description	string	Descrizione per la regola. Limitato a 140 caratteri.
properties.destinationAddressPrefix	string	Prefisso dell'indirizzo di destinazione. CIDR o intervallo IP di destinazione. L'asterisco '*' può essere usato anche per trovare le corrispondenze con tutti gli indirizzi IP di origine. È anche possibile usare tag predefiniti, ad esempio "VirtualNetwork", "AzureLoadBalancer" e "Internet".
properties.destinationAddressPrefixes	string[]	Prefissi dell'indirizzo di destinazione. CIDR o intervalli IP di destinazione.
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	Gruppo di sicurezza dell'applicazione specificato come destinazione.
properties.destinationPortRange	string	Porta o intervallo di destinazione. Intero o intervallo compreso tra 0 e 65535. L'asterisco '*' può essere usato anche per trovare le corrispondenze con tutte le porte.
properties.destinationPortRanges	string[]	Intervalli di porte di destinazione.
properties.direction	SecurityRuleDirection	Direzione della regola. L'elemento direction specifica se la regola verrà valutata sul traffico in ingresso o in uscita.
properties.priority	integer	Priorità della regola. Il valore può essere compreso tra 100 e 4096. Il numero di priorità deve essere univoco per ogni regola nella raccolta. Più basso è il numero di priorità, maggiore sarà la priorità della regola.
properties.protocol	SecurityRuleProtocol	Protocollo di rete a cui si applica la regola.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa della regola di sicurezza.
properties.sourceAddressPrefix	string	Intervallo DI INDIRIZZI IP di origine o CIDR. L'asterisco '*' può essere usato anche per trovare le corrispondenze con tutti gli indirizzi IP di origine. È anche possibile usare tag predefiniti, ad esempio "VirtualNetwork", "AzureLoadBalancer" e "Internet". Se si tratta di una regola di ingresso, specifica da dove proviene il traffico di rete.
properties.sourceAddressPrefixes	string[]	Intervalli CIDR o IP di origine.
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	Gruppo di sicurezza dell'applicazione specificato come origine.
properties.sourcePortRange	string	Porta o intervallo di origine. Intero o intervallo compreso tra 0 e 65535. L'asterisco '*' può essere usato anche per trovare le corrispondenze con tutte le porte.
properties.sourcePortRanges	string[]	Intervalli di porte di origine.
type	string	Tipo di risorsa.

SecurityRuleAccess

Indica se il traffico di rete è consentito o negato.

Nome	Tipo	Descrizione
Allow	string
Deny	string

SecurityRuleDirection

Direzione della regola. L'elemento direction specifica se la regola verrà valutata sul traffico in ingresso o in uscita.

Nome	Tipo	Descrizione
Inbound	string
Outbound	string

SecurityRuleListResult

Risposta per la chiamata al servizio API ListSecurityRule. Recupera tutte le regole di sicurezza appartenenti a un gruppo di sicurezza di rete.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set di risultati successivo.
value	SecurityRule[]	Regole di sicurezza in un gruppo di sicurezza di rete.

SecurityRuleProtocol

Protocollo di rete a cui si applica la regola.

Nome	Tipo	Descrizione
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string