Virtual Hubs - Get Outbound Routes

Reference

Služba:: Virtual WAN

Verze rozhraní API:: 2024-05-01

Získá odchozí trasy nakonfigurované pro virtuální centrum v určitém připojení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků virtualhubu.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
virtualHubName	path	True	string	Název VirtualHubu.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
connectionType	string	Typ zadaného prostředku připojení, jako je ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection a P2SConnection.
resourceUri	string	Prostředek připojení, jehož odchozí trasy jsou požadovány.

Odpovědi

Name	Typ	Description
200 OK	EffectiveRouteMapRouteList	Žádost byla úspěšná. Vrátí seznam efektivních tras mapy tras tras nebo se řídí záhlavím umístění pro seznam odchozích tras.
202 Accepted		Akceptovaná a operace se dokončí asynchronně.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Outbound Routes for the Virtual Hub on a Particular Connection

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
    }
  ]
}

Stavový kód:: 202

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

Definice

Name	Description
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
EffectiveRouteMapRoute	Efektivní trasa RouteMap nakonfigurovaná pro prostředek připojení.
EffectiveRouteMapRouteList	EffectiveRouteMapRoute List.
GetOutboundRoutesParameters	Parametry určující prostředek připojení, jehož odchozí trasy se požadují.

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu.

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

EffectiveRouteMapRoute

Efektivní trasa RouteMap nakonfigurovaná pro prostředek připojení.

Name	Typ	Description
asPath	string	AsPath této trasy.
bgpCommunities	string	Komunity protokolu BGP trasy.
prefix	string	Předpona adresy trasy.

EffectiveRouteMapRouteList

EffectiveRouteMapRoute List.

Name	Typ	Description
value	EffectiveRouteMapRoute[]	Seznam efektivních tras RouteMap nakonfigurovaných pro prostředek připojení.

GetOutboundRoutesParameters

Parametry určující prostředek připojení, jehož odchozí trasy se požadují.

Name	Typ	Description
connectionType	string	Typ zadaného prostředku připojení, jako je ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection a P2SConnection.
resourceUri	string	Prostředek připojení, jehož odchozí trasy jsou požadovány.

Sdílet prostřednictvím

Virtual Hubs - Get Outbound Routes

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Outbound Routes for the Virtual Hub on a Particular Connection

Ukázkový požadavek

Ukázková odpověď

Definice

CloudError

CloudErrorBody

EffectiveRouteMapRoute

EffectiveRouteMapRouteList

GetOutboundRoutesParameters

Další materiály