Virtual Hubs - Get Outbound Routes

Référence

Service:: Virtual WAN

Version d'API:: 2024-05-01

Obtient les itinéraires sortants configurés pour le hub virtuel sur une connexion particulière.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources du VirtualHub.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
virtualHubName	path	True	string	Nom du VirtualHub.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
connectionType	string	Type de la ressource de connexion spécifiée comme ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection et P2SConnection.
resourceUri	string	Ressource de connexion dont les itinéraires sortants sont demandés.

Réponses

Nom	Type	Description
200 OK	EffectiveRouteMapRouteList	Demande réussie. Retourne la liste des itinéraires de carte de routage effectifs ou suit l’en-tête d’emplacement de la liste des itinéraires sortants.
202 Accepted		Accepté et l’opération se termine de façon asynchrone.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Outbound Routes for the Virtual Hub on a Particular Connection

Exemple de requête

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/outboundRoutes?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.GetOutboundRoutesParameters;

/**
 * Samples for VirtualHubs GetOutboundRoutes.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/GetOutboundRoutes.json
     */
    /**
     * Sample code: Outbound Routes for the Virtual Hub on a Particular Connection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        outboundRoutesForTheVirtualHubOnAParticularConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().getOutboundRoutes("rg1", "virtualHub1",
            new GetOutboundRoutesParameters().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_outbound_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_outbound_routes(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub1",
        get_outbound_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/GetOutboundRoutes.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/GetOutboundRoutes.json
func ExampleVirtualHubsClient_BeginGetOutboundRoutes() {
	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().BeginGetOutboundRoutes(ctx, "rg1", "virtualHub1", armnetwork.GetOutboundRoutesParameters{
		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 outbound routes configured for the Virtual Hub on a particular connection.
 *
 * @summary Gets the outbound 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/GetOutboundRoutes.json
 */
async function outboundRoutesForTheVirtualHubOnAParticularConnection() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const getOutboundRoutesParameters = {
    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.beginGetOutboundRoutesAndWait(
    resourceGroupName,
    virtualHubName,
    getOutboundRoutesParameters,
  );
  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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Code d’état:: 202

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

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
EffectiveRouteMapRoute	Itinéraire RouteMap effectif configuré sur la ressource de connexion.
EffectiveRouteMapRouteList	Liste EffectiveRouteMapRoute.
GetOutboundRoutesParameters	Paramètres spécifiant la ressource de connexion dont les itinéraires sortants sont demandés.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

EffectiveRouteMapRoute

Itinéraire RouteMap effectif configuré sur la ressource de connexion.

Nom	Type	Description
asPath	string	ASPath de cette route.
bgpCommunities	string	Communautés BGP de l’itinéraire.
prefix	string	Préfixe d’adresse de l’itinéraire.

EffectiveRouteMapRouteList

Liste EffectiveRouteMapRoute.

Nom	Type	Description
value	EffectiveRouteMapRoute[]	Liste des itinéraires RouteMap effectifs configurés sur la ressource de connexion.

GetOutboundRoutesParameters

Paramètres spécifiant la ressource de connexion dont les itinéraires sortants sont demandés.

Nom	Type	Description
connectionType	string	Type de la ressource de connexion spécifiée comme ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection et P2SConnection.
resourceUri	string	Ressource de connexion dont les itinéraires sortants sont demandés.

Partager via

Virtual Hubs - Get Outbound Routes

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Outbound Routes for the Virtual Hub on a Particular Connection

Exemple de requête

Exemple de réponse

Définitions

CloudError

CloudErrorBody

EffectiveRouteMapRoute

EffectiveRouteMapRouteList

GetOutboundRoutesParameters

Ressources supplémentaires