Network Interfaces - List Effective Network Security Groups

Referensi

Service:: Virtual Networks

API Version:: 2021-08-01

Mendapatkan semua grup keamanan jaringan yang diterapkan ke antarmuka jaringan.

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

Parameter URI

Name	In	Required	Type	Description
networkInterfaceName	path	True	string	Nama antarmuka jaringan.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API klien.

Respons

Name	Type	Description
200 OK	EffectiveNetworkSecurityGroupListResult	Permintaan berhasil. Operasi mengembalikan daftar sumber daya NetworkSecurityGroup.
202 Accepted		Diterima dan operasi akan selesai secara asinkron.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

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=2021-08-01

import com.azure.core.util.Context;

/** Samples for NetworkInterfaces ListEffectiveNetworkSecurityGroups. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/NetworkInterfaceEffectiveNSGList.json
     */
    /**
     * Sample code: List network interface effective network security groups.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listNetworkInterfaceEffectiveNetworkSecurityGroups(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getNetworkInterfaces()
            .listEffectiveNetworkSecurityGroups("rg1", "nic1", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2021-08-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()
	client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/2021-08-01/examples/NetworkInterfaceEffectiveNSGList.json
 */
async function listNetworkInterfaceEffectiveNetworkSecurityGroups() {
  const subscriptionId = "subid";
  const resourceGroupName = "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);
}

listNetworkInterfaceEffectiveNetworkSecurityGroups().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

Definisi

CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan.
EffectiveNetworkSecurityGroup	Kelompok keamanan jaringan yang efektif.
EffectiveNetworkSecurityGroupAssociation	Asosiasi kelompok keamanan jaringan yang efektif.
EffectiveNetworkSecurityGroupListResult	Respons untuk mencantumkan panggilan layanan API grup keamanan jaringan yang efektif.
EffectiveNetworkSecurityRule	Aturan keamanan jaringan yang efektif.
EffectiveSecurityRuleProtocol	Protokol jaringan yang berlaku untuk aturan ini.
SecurityRuleAccess	Apakah lalu lintas jaringan diizinkan atau ditolak.
SecurityRuleDirection	Arah aturan. Arah menentukan apakah aturan akan dievaluasi pada lalu lintas masuk atau keluar.
SubResource	Referensi ke subsumber daya lain.

CloudError

Respons kesalahan dari layanan.

Name	Type	Description
error	CloudErrorBody	Isi kesalahan cloud.

CloudErrorBody

Respons kesalahan dari layanan.

Name	Type	Description
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan tersebut.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

EffectiveNetworkSecurityGroup

Kelompok keamanan jaringan yang efektif.

Name	Type	Description
association	EffectiveNetworkSecurityGroupAssociation	Sumber daya terkait.
effectiveSecurityRules	EffectiveNetworkSecurityRule[]	Kumpulan aturan keamanan yang efektif.
networkSecurityGroup	SubResource	ID grup keamanan jaringan yang diterapkan.
tagMap	object	Pemetaan tag ke daftar Alamat IP yang disertakan dalam tag.

EffectiveNetworkSecurityGroupAssociation

Asosiasi kelompok keamanan jaringan yang efektif.

Name	Type	Description
networkInterface	SubResource	ID antarmuka jaringan jika ditetapkan.
networkManager	SubResource	ID manajer jaringan Azure jika ditetapkan.
subnet	SubResource	ID subnet jika ditetapkan.

EffectiveNetworkSecurityGroupListResult

Respons untuk mencantumkan panggilan layanan API grup keamanan jaringan yang efektif.

Name	Type	Description
nextLink	string	URL untuk mendapatkan serangkaian hasil berikutnya.
value	EffectiveNetworkSecurityGroup[]	Daftar kelompok keamanan jaringan yang efektif.

EffectiveNetworkSecurityRule

Aturan keamanan jaringan yang efektif.

Name	Type	Description
access	SecurityRuleAccess	Apakah lalu lintas jaringan diizinkan atau ditolak.
destinationAddressPrefix	string	Awalan alamat tujuan.
destinationAddressPrefixes	string[]	Awalan alamat tujuan. Nilai yang diharapkan termasuk rentang IP CIDR, Tag Default (VirtualNetwork, AzureLoadBalancer, Internet), Tag Sistem, dan tanda bintang (*).
destinationPortRange	string	Port atau rentang tujuan.
destinationPortRanges	string[]	Rentang port tujuan. Nilai yang diharapkan mencakup bilangan bulat tunggal antara 0 dan 65535, rentang yang menggunakan '-' sebagai pemisah (misalnya 100-400), atau tanda bintang (*).
direction	SecurityRuleDirection	Arah aturan.
expandedDestinationAddressPrefix	string[]	Awalan alamat tujuan yang diperluas.
expandedSourceAddressPrefix	string[]	Awalan alamat sumber yang diperluas.
name	string	Nama aturan keamanan yang ditentukan oleh pengguna (jika dibuat oleh pengguna).
priority	integer	Prioritas aturan.
protocol	EffectiveSecurityRuleProtocol	Protokol jaringan yang berlaku untuk aturan ini.
sourceAddressPrefix	string	Awalan alamat sumber.
sourceAddressPrefixes	string[]	Awalan alamat sumber. Nilai yang diharapkan termasuk rentang IP CIDR, Tag Default (VirtualNetwork, AzureLoadBalancer, Internet), Tag Sistem, dan tanda bintang (*).
sourcePortRange	string	Port atau rentang sumber.
sourcePortRanges	string[]	Rentang port sumber. Nilai yang diharapkan mencakup bilangan bulat tunggal antara 0 dan 65535, rentang yang menggunakan '-' sebagai pemisah (misalnya 100-400), atau tanda bintang (*).

EffectiveSecurityRuleProtocol

Protokol jaringan yang berlaku untuk aturan ini.

Name	Type	Description
All	string
Tcp	string
Udp	string

SecurityRuleAccess

Apakah lalu lintas jaringan diizinkan atau ditolak.

Name	Type	Description
Allow	string
Deny	string

SecurityRuleDirection

Arah aturan. Arah menentukan apakah aturan akan dievaluasi pada lalu lintas masuk atau keluar.

Name	Type	Description
Inbound	string
Outbound	string

SubResource

Referensi ke subsumber daya lain.

Name	Type	Description
id	string	ID Sumber Daya.