Network Interfaces - Get Effective Route Table

서비스:

Virtual Networks

API 버전:

2024-05-01

네트워크 인터페이스에 적용된 모든 경로 테이블을 가져옵니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveRouteTable?api-version=2024-05-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	EffectiveRouteListResult	요청이 성공했습니다. 이 작업은 EffectRoute 리소스 목록을 반환합니다.
202 Accepted		수락되고 작업이 비동기적으로 완료됩니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Show network interface effective route tables

샘플 요청

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/effectiveRouteTable?api-version=2024-05-01

Java

/**
 * Samples for NetworkInterfaces GetEffectiveRouteTable.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * NetworkInterfaceEffectiveRouteTableList.json
     */
    /**
     * Sample code: Show network interface effective route tables.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void showNetworkInterfaceEffectiveRouteTables(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkInterfaces().getEffectiveRouteTable("rg1", "nic1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_interface_effective_route_table_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_get_effective_route_table(
        resource_group_name="rg1",
        network_interface_name="nic1",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkInterfaceEffectiveRouteTableList.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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json
func ExampleInterfacesClient_BeginGetEffectiveRouteTable() {
	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().BeginGetEffectiveRouteTable(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.EffectiveRouteListResult = armnetwork.EffectiveRouteListResult{
	// 	Value: []*armnetwork.EffectiveRoute{
	// 		{
	// 			AddressPrefix: []*string{
	// 				to.Ptr("172.20.2.0/24")},
	// 				NextHopIPAddress: []*string{
	// 				},
	// 				NextHopType: to.Ptr(armnetwork.RouteNextHopTypeVnetLocal),
	// 				Source: to.Ptr(armnetwork.EffectiveRouteSourceDefault),
	// 				State: to.Ptr(armnetwork.EffectiveRouteStateActive),
	// 			},
	// 			{
	// 				AddressPrefix: []*string{
	// 					to.Ptr("0.0.0.0/0")},
	// 					NextHopIPAddress: []*string{
	// 					},
	// 					NextHopType: to.Ptr(armnetwork.RouteNextHopTypeInternet),
	// 					Source: to.Ptr(armnetwork.EffectiveRouteSourceDefault),
	// 					State: to.Ptr(armnetwork.EffectiveRouteStateActive),
	// 				},
	// 				{
	// 					AddressPrefix: []*string{
	// 						to.Ptr("10.0.0.0/8")},
	// 						NextHopIPAddress: []*string{
	// 						},
	// 						NextHopType: to.Ptr(armnetwork.RouteNextHopTypeNone),
	// 						Source: to.Ptr(armnetwork.EffectiveRouteSourceDefault),
	// 						State: to.Ptr(armnetwork.EffectiveRouteStateActive),
	// 					},
	// 					{
	// 						AddressPrefix: []*string{
	// 							to.Ptr("100.64.0.0/10")},
	// 							NextHopIPAddress: []*string{
	// 							},
	// 							NextHopType: to.Ptr(armnetwork.RouteNextHopTypeNone),
	// 							Source: to.Ptr(armnetwork.EffectiveRouteSourceDefault),
	// 							State: to.Ptr(armnetwork.EffectiveRouteStateActive),
	// 						},
	// 						{
	// 							AddressPrefix: []*string{
	// 								to.Ptr("172.16.0.0/12")},
	// 								NextHopIPAddress: []*string{
	// 								},
	// 								NextHopType: to.Ptr(armnetwork.RouteNextHopTypeNone),
	// 								Source: to.Ptr(armnetwork.EffectiveRouteSourceDefault),
	// 								State: to.Ptr(armnetwork.EffectiveRouteStateActive),
	// 							},
	// 							{
	// 								AddressPrefix: []*string{
	// 									to.Ptr("192.168.0.0/16")},
	// 									NextHopIPAddress: []*string{
	// 									},
	// 									NextHopType: to.Ptr(armnetwork.RouteNextHopTypeNone),
	// 									Source: to.Ptr(armnetwork.EffectiveRouteSourceDefault),
	// 									State: to.Ptr(armnetwork.EffectiveRouteStateActive),
	// 							}},
	// 						}
}

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 route tables applied to a network interface.
 *
 * @summary Gets all route tables applied to a network interface.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json
 */
async function showNetworkInterfaceEffectiveRouteTables() {
  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.beginGetEffectiveRouteTableAndWait(
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json
// this example is just showing the usage of "NetworkInterfaces_GetEffectiveRouteTable" 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<EffectiveRouteListResult> lro = await networkInterface.GetEffectiveRouteTableAsync(WaitUntil.Completed);
EffectiveRouteListResult 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

샘플 응답

상태 코드:

200

{
  "value": [
    {
      "source": "Default",
      "state": "Active",
      "addressPrefix": [
        "172.20.2.0/24"
      ],
      "nextHopType": "VnetLocal",
      "nextHopIpAddress": []
    },
    {
      "source": "Default",
      "state": "Active",
      "addressPrefix": [
        "0.0.0.0/0"
      ],
      "nextHopType": "Internet",
      "nextHopIpAddress": []
    },
    {
      "source": "Default",
      "state": "Active",
      "addressPrefix": [
        "10.0.0.0/8"
      ],
      "nextHopType": "None",
      "nextHopIpAddress": []
    },
    {
      "source": "Default",
      "state": "Active",
      "addressPrefix": [
        "100.64.0.0/10"
      ],
      "nextHopType": "None",
      "nextHopIpAddress": []
    },
    {
      "source": "Default",
      "state": "Active",
      "addressPrefix": [
        "172.16.0.0/12"
      ],
      "nextHopType": "None",
      "nextHopIpAddress": []
    },
    {
      "source": "Default",
      "state": "Active",
      "addressPrefix": [
        "192.168.0.0/16"
      ],
      "nextHopType": "None",
      "nextHopIpAddress": []
    }
  ]
}

상태 코드:

202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-05-01

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
EffectiveRoute	유효 경로입니다.
EffectiveRouteListResult	목록 유효 경로 API 서비스 호출에 대한 응답입니다.
EffectiveRouteSource	경로를 만든 사람입니다.
EffectiveRouteState	유효 경로의 값입니다.
RouteNextHopType	패킷을 보내야 하는 Azure 홉의 유형입니다.

CloudError

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

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

CloudErrorBody

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

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

EffectiveRoute

유효 경로입니다.

Name	형식	Description
addressPrefix	string[]	CIDR 표기법에서 유효 경로의 주소 접두사입니다.
disableBgpRoutePropagation	boolean	true이면 온-프레미스 경로가 서브넷의 네트워크 인터페이스로 전파되지 않습니다.
name	string	사용자 정의 경로의 이름입니다. 선택 사항입니다.
nextHopIpAddress	string[]	유효 경로의 다음 홉 IP 주소입니다.
nextHopType	RouteNextHopType	패킷을 보내야 하는 Azure 홉의 유형입니다.
source	EffectiveRouteSource	경로를 만든 사람입니다.
state	EffectiveRouteState	유효 경로의 값입니다.

EffectiveRouteListResult

목록 유효 경로 API 서비스 호출에 대한 응답입니다.

Name	형식	Description
nextLink	string	다음 결과 집합을 가져올 URL입니다.
value	EffectiveRoute[]	유효 경로 목록입니다.

EffectiveRouteSource

경로를 만든 사람입니다.

Name	형식	Description
Default	string
Unknown	string
User	string
VirtualNetworkGateway	string

EffectiveRouteState

유효 경로의 값입니다.

Name	형식	Description
Active	string
Invalid	string

RouteNextHopType

패킷을 보내야 하는 Azure 홉의 유형입니다.

Name	형식	Description
Internet	string
None	string
VirtualAppliance	string
VirtualNetworkGateway	string
VnetLocal	string