Network Interfaces - List Effective Network Security Groups

Referencia

Service:: Virtual Networks

API Version:: 2023-09-01

Lekéri a hálózati adapterre alkalmazott összes hálózati biztonsági csoportot.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups?api-version=2023-09-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
networkInterfaceName	path	True	string	A hálózati adapter neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	EffectiveNetworkSecurityGroupListResult	A kérés sikeres. A művelet a NetworkSecurityGroup-erőforrások listáját adja vissza.
202 Accepted		Elfogadva, és a művelet aszinkron módon fejeződik be.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

List network interface effective network security groups

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/effectiveNetworkSecurityGroups?api-version=2023-09-01

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_interface_effective_nsg_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.network_interfaces.begin_list_effective_network_security_groups(
        resource_group_name="rg1",
        network_interface_name="nic1",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkInterfaceEffectiveNSGList.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/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/NetworkInterfaceEffectiveNSGList.json
func ExampleInterfacesClient_BeginListEffectiveNetworkSecurityGroups() {
	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)
	}
	poller, err := clientFactory.NewInterfacesClient().BeginListEffectiveNetworkSecurityGroups(ctx, "rg1", "nic1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.EffectiveNetworkSecurityGroupListResult = armnetwork.EffectiveNetworkSecurityGroupListResult{
	// 	Value: []*armnetwork.EffectiveNetworkSecurityGroup{
	// 		{
	// 			Association: &armnetwork.EffectiveNetworkSecurityGroupAssociation{
	// 				NetworkInterface: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1"),
	// 				},
	// 				NetworkManager: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1"),
	// 				},
	// 				Subnet: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default"),
	// 				},
	// 			},
	// 			EffectiveSecurityRules: []*armnetwork.EffectiveNetworkSecurityRule{
	// 				{
	// 					Name: to.Ptr("securityRules/rule1"),
	// 					Access: to.Ptr(armnetwork.SecurityRuleAccessAllow),
	// 					DestinationAddressPrefix: to.Ptr("0.0.0.0/32"),
	// 					DestinationPortRange: to.Ptr("6579-6579"),
	// 					Direction: to.Ptr(armnetwork.SecurityRuleDirectionInbound),
	// 					Priority: to.Ptr[int32](234),
	// 					SourceAddressPrefix: to.Ptr("0.0.0.0/32"),
	// 					SourcePortRange: to.Ptr("456-456"),
	// 					Protocol: to.Ptr(armnetwork.EffectiveSecurityRuleProtocolTCP),
	// 				},
	// 				{
	// 					Name: to.Ptr("securityRules/default-allow-rdp"),
	// 					Access: to.Ptr(armnetwork.SecurityRuleAccessAllow),
	// 					DestinationAddressPrefix: to.Ptr("0.0.0.0/0"),
	// 					DestinationPortRange: to.Ptr("3389-3389"),
	// 					Direction: to.Ptr(armnetwork.SecurityRuleDirectionInbound),
	// 					Priority: to.Ptr[int32](1000),
	// 					SourceAddressPrefix: to.Ptr("1.1.1.1/32"),
	// 					SourcePortRange: to.Ptr("0-65535"),
	// 					Protocol: to.Ptr(armnetwork.EffectiveSecurityRuleProtocolTCP),
	// 				},
	// 				{
	// 					Name: to.Ptr("defaultSecurityRules/AllowInternetOutBound"),
	// 					Access: to.Ptr(armnetwork.SecurityRuleAccessAllow),
	// 					DestinationAddressPrefix: to.Ptr("Internet"),
	// 					DestinationPortRange: to.Ptr("0-65535"),
	// 					Direction: to.Ptr(armnetwork.SecurityRuleDirectionOutbound),
	// 					ExpandedDestinationAddressPrefix: []*string{
	// 						to.Ptr("32.0.0.0/3"),
	// 						to.Ptr("4.0.0.0/6"),
	// 						to.Ptr("2.0.0.0/7"),
	// 						to.Ptr("1.0.0.0/8")},
	// 						Priority: to.Ptr[int32](65001),
	// 						SourceAddressPrefix: to.Ptr("0.0.0.0/0"),
	// 						SourcePortRange: to.Ptr("0-65535"),
	// 						Protocol: to.Ptr(armnetwork.EffectiveSecurityRuleProtocolAll),
	// 				}},
	// 				NetworkSecurityGroup: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg"),
	// 				},
	// 		}},
	// 	}
}

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 Gets all network security groups applied to a network interface.
 *
 * @summary Gets all network security groups applied to a network interface.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkInterfaceEffectiveNSGList.json
 */
async function listNetworkInterfaceEffectiveNetworkSecurityGroups() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkInterfaceName = "nic1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkInterfaces.beginListEffectiveNetworkSecurityGroupsAndWait(
    resourceGroupName,
    networkInterfaceName,
  );
  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 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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkInterfaceEffectiveNSGList.json
// this example is just showing the usage of "NetworkInterfaces_ListEffectiveNetworkSecurityGroups" 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 NetworkInterfaceResource created on azure
// for more information of creating NetworkInterfaceResource, please refer to the document of NetworkInterfaceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkInterfaceName = "nic1";
ResourceIdentifier networkInterfaceResourceId = NetworkInterfaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkInterfaceName);
NetworkInterfaceResource networkInterface = client.GetNetworkInterfaceResource(networkInterfaceResourceId);

// invoke the operation
ArmOperation<EffectiveNetworkSecurityGroupListResult> lro = await networkInterface.GetEffectiveNetworkSecurityGroupsAsync(WaitUntil.Completed);
EffectiveNetworkSecurityGroupListResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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": [
    {
      "networkSecurityGroup": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg"
      },
      "association": {
        "networkManager": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1"
        },
        "subnet": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default"
        },
        "networkInterface": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1"
        }
      },
      "effectiveSecurityRules": [
        {
          "name": "securityRules/rule1",
          "protocol": "Tcp",
          "sourcePortRange": "456-456",
          "destinationPortRange": "6579-6579",
          "sourceAddressPrefix": "0.0.0.0/32",
          "destinationAddressPrefix": "0.0.0.0/32",
          "access": "Allow",
          "priority": 234,
          "direction": "Inbound"
        },
        {
          "name": "securityRules/default-allow-rdp",
          "protocol": "Tcp",
          "sourcePortRange": "0-65535",
          "destinationPortRange": "3389-3389",
          "sourceAddressPrefix": "1.1.1.1/32",
          "destinationAddressPrefix": "0.0.0.0/0",
          "access": "Allow",
          "priority": 1000,
          "direction": "Inbound"
        },
        {
          "name": "defaultSecurityRules/AllowInternetOutBound",
          "protocol": "All",
          "sourcePortRange": "0-65535",
          "destinationPortRange": "0-65535",
          "sourceAddressPrefix": "0.0.0.0/0",
          "destinationAddressPrefix": "Internet",
          "expandedDestinationAddressPrefix": [
            "32.0.0.0/3",
            "4.0.0.0/6",
            "2.0.0.0/7",
            "1.0.0.0/8"
          ],
          "access": "Allow",
          "priority": 65001,
          "direction": "Outbound"
        }
      ]
    }
  ]
}

Status code:: 202

Location: https://management.azure.com//subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-09-01

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
EffectiveNetworkSecurityGroup	Érvényes hálózati biztonsági csoport.
EffectiveNetworkSecurityGroupAssociation	Az érvényes hálózati biztonsági csoport társítása.
EffectiveNetworkSecurityGroupListResult	Válasz az érvényes hálózati biztonsági csoportok API-szolgáltatáshívásainak listázásakor.
EffectiveNetworkSecurityRule	Érvényes hálózati biztonsági szabályok.
EffectiveSecurityRuleProtocol	Arra a hálózati protokollra vonatkozik, amelyre ez a szabály vonatkozik.
SecurityRuleAccess	Azt jelzi, hogy a hálózati forgalom engedélyezve van-e vagy megtagadva.
SecurityRuleDirection	A szabály iránya. Az irány határozza meg, hogy a rendszer kiértékeli-e a szabályt a bejövő vagy kimenő forgalomon.
SubResource	Hivatkozás másik alforrásra.

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a hibás tulajdonság neve.

EffectiveNetworkSecurityGroup

Érvényes hálózati biztonsági csoport.

Name	Típus	Description
association	EffectiveNetworkSecurityGroupAssociation	Társított erőforrások.
effectiveSecurityRules	EffectiveNetworkSecurityRule[]	A hatályos biztonsági szabályok gyűjteménye.
networkSecurityGroup	SubResource	Az alkalmazott hálózati biztonsági csoport azonosítója.
tagMap	object	Címkék leképezése a címkében szereplő IP-címek listájára.

EffectiveNetworkSecurityGroupAssociation

Az érvényes hálózati biztonsági csoport társítása.

Name	Típus	Description
networkInterface	SubResource	A hálózati adapter azonosítója, ha hozzá van rendelve.
networkManager	SubResource	Az Azure-hálózatkezelő azonosítója, ha hozzá van rendelve.
subnet	SubResource	Az alhálózat azonosítója, ha hozzá van rendelve.

EffectiveNetworkSecurityGroupListResult

Válasz az érvényes hálózati biztonsági csoportok API-szolgáltatáshívásainak listázásakor.

Name	Típus	Description
nextLink	string	A következő találatkészlet lekéréséhez tartozó URL-cím.
value	EffectiveNetworkSecurityGroup[]	A hatályos hálózati biztonsági csoportok listája.

EffectiveNetworkSecurityRule

Érvényes hálózati biztonsági szabályok.

Name	Típus	Description
access	SecurityRuleAccess	Azt jelzi, hogy a hálózati forgalom engedélyezve van-e vagy megtagadva.
destinationAddressPrefix	string	A célcím előtagja.
destinationAddressPrefixes	string[]	A célcímelőtagok. A várt értékek közé tartoznak a CIDR IP-tartományok, az alapértelmezett címkék (VirtualNetwork, AzureLoadBalancer, internet), a rendszercímkék és a csillag (*).
destinationPortRange	string	A célport vagy tartomány.
destinationPortRanges	string[]	A célporttartományok. A várt értékek közé tartozik egy 0 és 65535 közötti egész szám, egy "-" elválasztójelet (például 100-400) vagy csillagot (*) használó tartomány.
direction	SecurityRuleDirection	A szabály iránya.
expandedDestinationAddressPrefix	string[]	Bővített célcímelőtag.
expandedSourceAddressPrefix	string[]	A kibontott forráscímelőtag.
name	string	A felhasználó által megadott biztonsági szabály neve (ha a felhasználó hozta létre).
priority	integer	A szabály prioritása.
protocol	EffectiveSecurityRuleProtocol	Arra a hálózati protokollra vonatkozik, amelyre ez a szabály vonatkozik.
sourceAddressPrefix	string	A forráscím előtagja.
sourceAddressPrefixes	string[]	A forráscím előtagja. A várt értékek közé tartoznak a CIDR IP-tartományok, az alapértelmezett címkék (VirtualNetwork, AzureLoadBalancer, internet), a rendszercímkék és a csillag (*).
sourcePortRange	string	A forrásport vagy tartomány.
sourcePortRanges	string[]	A forrásporttartományok. A várt értékek közé tartozik egy 0 és 65535 közötti egész szám, egy "-" elválasztójelet (például 100-400) vagy csillagot (*) használó tartomány.

EffectiveSecurityRuleProtocol

Arra a hálózati protokollra vonatkozik, amelyre ez a szabály vonatkozik.

Name	Típus	Description
All	string
Tcp	string
Udp	string

SecurityRuleAccess

Azt jelzi, hogy a hálózati forgalom engedélyezve van-e vagy megtagadva.

Name	Típus	Description
Allow	string
Deny	string

SecurityRuleDirection

A szabály iránya. Az irány határozza meg, hogy a rendszer kiértékeli-e a szabályt a bejövő vagy kimenő forgalomon.

Name	Típus	Description
Inbound	string
Outbound	string

SubResource

Hivatkozás másik alforrásra.

Name	Típus	Description
id	string	Erőforrás-azonosító.

Network Interfaces - List Effective Network Security Groups

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

List network interface effective network security groups

Sample Request

Sample Response

Definíciók

CloudError

CloudErrorBody

EffectiveNetworkSecurityGroup

EffectiveNetworkSecurityGroupAssociation

EffectiveNetworkSecurityGroupListResult

EffectiveNetworkSecurityRule

EffectiveSecurityRuleProtocol

SecurityRuleAccess

SecurityRuleDirection

SubResource

További források