Network Interfaces - List Effective Network Security Groups

참조

Service:: Virtual Networks

API Version:: 2023-09-01

네트워크 인터페이스에 적용된 모든 네트워크 보안 그룹을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
networkInterfaceName	path	True	string	네트워크 인터페이스의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	EffectiveNetworkSecurityGroupListResult	요청이 성공했습니다. 작업은 NetworkSecurityGroup 리소스 목록을 반환합니다.
202 Accepted		수락되고 작업이 비동기적으로 완료됩니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

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

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
EffectiveNetworkSecurityGroup	효과적인 네트워크 보안 그룹입니다.
EffectiveNetworkSecurityGroupAssociation	효과적인 네트워크 보안 그룹 연결입니다.
EffectiveNetworkSecurityGroupListResult	효과적인 네트워크 보안 그룹 API 서비스 호출 목록에 대한 응답입니다.
EffectiveNetworkSecurityRule	효과적인 네트워크 보안 규칙.
EffectiveSecurityRuleProtocol	이 규칙이 적용되는 네트워크 프로토콜입니다.
SecurityRuleAccess	네트워크 트래픽이 허용되는지 아니면 거부되는지 여부입니다.
SecurityRuleDirection	규칙의 방향입니다. direction은 규칙을 평가할 트래픽(들어오는 트래픽 또는 나가는 트래픽)을 지정합니다.
SubResource	다른 하위 리소스에 대한 참조입니다.

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	클라우드 오류 본문.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

EffectiveNetworkSecurityGroup

효과적인 네트워크 보안 그룹입니다.

Name	형식	Description
association	EffectiveNetworkSecurityGroupAssociation	연결된 리소스.
effectiveSecurityRules	EffectiveNetworkSecurityRule[]	효과적인 보안 규칙의 컬렉션입니다.
networkSecurityGroup	SubResource	적용되는 네트워크 보안 그룹의 ID입니다.
tagMap	object	태그를 태그에 포함된 IP 주소 목록에 매핑합니다.

EffectiveNetworkSecurityGroupAssociation

효과적인 네트워크 보안 그룹 연결입니다.

Name	형식	Description
networkInterface	SubResource	할당된 경우 네트워크 인터페이스의 ID입니다.
networkManager	SubResource	할당된 경우 Azure 네트워크 관리자의 ID입니다.
subnet	SubResource	할당된 경우 서브넷의 ID입니다.

EffectiveNetworkSecurityGroupListResult

효과적인 네트워크 보안 그룹 API 서비스 호출 목록에 대한 응답입니다.

Name	형식	Description
nextLink	string	다음 결과 집합을 가져올 URL입니다.
value	EffectiveNetworkSecurityGroup[]	효과적인 네트워크 보안 그룹의 목록입니다.

EffectiveNetworkSecurityRule

효과적인 네트워크 보안 규칙.

Name	형식	Description
access	SecurityRuleAccess	네트워크 트래픽이 허용되는지 아니면 거부되는지 여부입니다.
destinationAddressPrefix	string	대상 주소 접두사입니다.
destinationAddressPrefixes	string[]	대상 주소 접두사입니다. 예상 값에는 CIDR IP 범위, 기본 태그(VirtualNetwork, AzureLoadBalancer, 인터넷), 시스템 태그 및 별표(*)가 포함됩니다.
destinationPortRange	string	대상 포트 또는 범위입니다.
destinationPortRanges	string[]	대상 포트 범위입니다. 예상 값에는 0에서 65535 사이의 단일 정수, 구분 기호로 '-'를 사용하는 범위(예: 100-400) 또는 별표(*)가 포함됩니다.
direction	SecurityRuleDirection	규칙의 방향입니다.
expandedDestinationAddressPrefix	string[]	확장된 대상 주소 접두사입니다.
expandedSourceAddressPrefix	string[]	확장된 원본 주소 접두사입니다.
name	string	사용자가 지정한 보안 규칙의 이름입니다(사용자가 만든 경우).
priority	integer	규칙의 우선 순위입니다.
protocol	EffectiveSecurityRuleProtocol	이 규칙이 적용되는 네트워크 프로토콜입니다.
sourceAddressPrefix	string	원본 주소 접두사입니다.
sourceAddressPrefixes	string[]	원본 주소 접두사입니다. 예상 값에는 CIDR IP 범위, 기본 태그(VirtualNetwork, AzureLoadBalancer, 인터넷), 시스템 태그 및 별표(*)가 포함됩니다.
sourcePortRange	string	원본 포트 또는 범위입니다.
sourcePortRanges	string[]	원본 포트 범위입니다. 예상 값에는 0에서 65535 사이의 단일 정수, 구분 기호로 '-'를 사용하는 범위(예: 100-400) 또는 별표(*)가 포함됩니다.

EffectiveSecurityRuleProtocol

이 규칙이 적용되는 네트워크 프로토콜입니다.

Name	형식	Description
All	string
Tcp	string
Udp	string

SecurityRuleAccess

네트워크 트래픽이 허용되는지 아니면 거부되는지 여부입니다.

Name	형식	Description
Allow	string
Deny	string

SecurityRuleDirection

규칙의 방향입니다. direction은 규칙을 평가할 트래픽(들어오는 트래픽 또는 나가는 트래픽)을 지정합니다.

Name	형식	Description
Inbound	string
Outbound	string

SubResource

다른 하위 리소스에 대한 참조입니다.

Name	형식	Description
id	string	리소스 ID입니다.

Network Interfaces - List Effective Network Security Groups

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

List network interface effective network security groups

Sample Request

Sample Response

정의

CloudError

CloudErrorBody

EffectiveNetworkSecurityGroup

EffectiveNetworkSecurityGroupAssociation

EffectiveNetworkSecurityGroupListResult

EffectiveNetworkSecurityRule

EffectiveSecurityRuleProtocol

SecurityRuleAccess

SecurityRuleDirection

SubResource

추가 리소스