Virtual Hubs - Get Inbound Routes

Referentie

Service:: Virtual WAN

API-versie:: 2024-05-01

Hiermee haalt u de binnenkomende routes op die zijn geconfigureerd voor de virtuele hub op een bepaalde verbinding.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/inboundRoutes?api-version=2024-05-01

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep van de VirtualHub.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
virtualHubName	path	True	string	De naam van de VirtualHub.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
connectionType	string	Het type van de opgegeven verbindingsresource, zoals ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection en P2SConnection.
resourceUri	string	De verbindingsresource waarvan binnenkomende routes worden aangevraagd.

Antwoorden

Name	Type	Description
200 OK	EffectiveRouteMapRouteList	Aanvraag is voltooid. Retourneert de lijst met de effectieve routekaartroutes of volgt de locatieheader voor de lijst met binnenkomende routes.
202 Accepted		Geaccepteerd en de bewerking wordt asynchroon voltooid.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Inbound Routes for the Virtual Hub on a Particular Connection

Voorbeeldaanvraag

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/inboundRoutes?api-version=2024-05-01

{
  "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
  "connectionType": "ExpressRouteConnection"
}


import com.azure.resourcemanager.network.models.GetInboundRoutesParameters;

/**
 * Samples for VirtualHubs GetInboundRoutes.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/GetInboundRoutes.json
     */
    /**
     * Sample code: Inbound Routes for the Virtual Hub on a Particular Connection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        inboundRoutesForTheVirtualHubOnAParticularConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().getInboundRoutes("rg1", "virtualHub1",
            new GetInboundRoutesParameters().withResourceUri(
                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1")
                .withConnectionType("ExpressRouteConnection"),
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python get_inbound_routes.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.virtual_hubs.begin_get_inbound_routes(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub1",
        get_inbound_routes_parameters={
            "connectionType": "ExpressRouteConnection",
            "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/GetInboundRoutes.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/azcore/to"
	"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/GetInboundRoutes.json
func ExampleVirtualHubsClient_BeginGetInboundRoutes() {
	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.NewVirtualHubsClient().BeginGetInboundRoutes(ctx, "rg1", "virtualHub1", armnetwork.GetInboundRoutesParameters{
		ConnectionType: to.Ptr("ExpressRouteConnection"),
		ResourceURI:    to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"),
	}, 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.EffectiveRouteMapRouteList = armnetwork.EffectiveRouteMapRouteList{
	// 	Value: []*armnetwork.EffectiveRouteMapRoute{
	// 		{
	// 			AsPath: to.Ptr("65520-65520"),
	// 			BgpCommunities: to.Ptr("4293853166,12076,51004"),
	// 			Prefix: to.Ptr("192.168.50.0/24"),
	// 		},
	// 		{
	// 			AsPath: to.Ptr("65520-65520-12076-12076"),
	// 			BgpCommunities: to.Ptr("4293787629,12076,51027,4293734188"),
	// 			Prefix: to.Ptr("10.200.0.0/16"),
	// 	}},
	// }
}

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 the inbound routes configured for the Virtual Hub on a particular connection.
 *
 * @summary Gets the inbound routes configured for the Virtual Hub on a particular connection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/GetInboundRoutes.json
 */
async function inboundRoutesForTheVirtualHubOnAParticularConnection() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const getInboundRoutesParameters = {
    connectionType: "ExpressRouteConnection",
    resourceUri:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.beginGetInboundRoutesAndWait(
    resourceGroupName,
    virtualHubName,
    getInboundRoutesParameters,
  );
  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 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/GetInboundRoutes.json
// this example is just showing the usage of "VirtualHubs_GetInboundRoutes" 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 VirtualHubResource created on azure
// for more information of creating VirtualHubResource, please refer to the document of VirtualHubResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualHubName = "virtualHub1";
ResourceIdentifier virtualHubResourceId = VirtualHubResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualHubName);
VirtualHubResource virtualHub = client.GetVirtualHubResource(virtualHubResourceId);

// invoke the operation
VirtualHubInboundRoutesContent content = new VirtualHubInboundRoutesContent
{
    ResourceUri = new Uri("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"),
    ConnectionType = "ExpressRouteConnection",
};
ArmOperation<EffectiveRouteMapRouteList> lro = await virtualHub.GetVirtualHubInboundRoutesAsync(WaitUntil.Completed, content);
EffectiveRouteMapRouteList 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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "prefix": "192.168.50.0/24",
      "asPath": "65520-65520",
      "bgpCommunities": "4293853166,12076,51004"
    },
    {
      "prefix": "10.200.0.0/16",
      "asPath": "65520-65520-12076-12076",
      "bgpCommunities": "4293787629,12076,51027,4293734188"
    }
  ]
}

Statuscode:: 202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
EffectiveRouteMapRoute	De effectieve RouteMap-route die is geconfigureerd voor de verbindingsresource.
EffectiveRouteMapRouteList	EffectiveRouteMapRoute List.
GetInboundRoutesParameters	De parameters die de verbindingsresource opgeven waarvan binnenkomende routes worden aangevraagd.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

EffectiveRouteMapRoute

De effectieve RouteMap-route die is geconfigureerd voor de verbindingsresource.

Name	Type	Description
asPath	string	Het ASPath van deze route.
bgpCommunities	string	BGP-community's van de route.
prefix	string	Het adresvoorvoegsel van de route.

EffectiveRouteMapRouteList

EffectiveRouteMapRoute List.

Name	Type	Description
value	EffectiveRouteMapRoute[]	De lijst met effectieve RouteMap-routes die zijn geconfigureerd voor de verbindingsresource.

GetInboundRoutesParameters

De parameters die de verbindingsresource opgeven waarvan binnenkomende routes worden aangevraagd.

Name	Type	Description
connectionType	string	Het type van de opgegeven verbindingsresource, zoals ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection en P2SConnection.
resourceUri	string	De verbindingsresource waarvan binnenkomende routes worden aangevraagd.