Virtual Hub Bgp Connections - List Advertised Routes

Služba:

Virtual WAN

Verze rozhraní API:

2025-05-01

Načte seznam tras, které připojení BGP virtuálního centra inzeruje zadanému partnerskému uzlu.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/advertisedRoutes?api-version=2025-05-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
connectionName	path	True	string	Název připojení BGP.
hubName	path	True	string	Název virtuálního rozbočovače.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK		Operace Azure byla úspěšně dokončena.
202 Accepted		Operace prostředku byla přijata. Hlavičky Location: string Retry-After: integer
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

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

VirtualRouterPeerListAdvertisedRoutes

Ukázkový požadavek

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualRouter1/bgpConnections/peer1/advertisedRoutes?api-version=2025-05-01

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer.
 *
 * @summary Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/VirtualRouterPeerListAdvertisedRoute.json
 */
async function virtualRouterPeerListAdvertisedRoutes() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const hubName = "virtualRouter1";
  const connectionName = "peer1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubBgpConnections.beginListAdvertisedRoutesAndWait(
    resourceGroupName,
    hubName,
    connectionName,
  );
  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

{
  "RouteServiceRole_IN_0": [
    {
      "asPath": "65515",
      "localAddress": "10.85.3.4",
      "network": "10.45.0.0/16",
      "nextHop": "10.85.3.4",
      "origin": "Igp",
      "sourcePeer": "10.85.3.4",
      "weight": 0
    },
    {
      "asPath": "65515",
      "localAddress": "10.85.3.4",
      "network": "10.85.0.0/16",
      "nextHop": "10.85.3.4",
      "origin": "Igp",
      "sourcePeer": "10.85.3.4",
      "weight": 0
    },
    {
      "asPath": "65515",
      "localAddress": "10.85.3.4",
      "network": "10.100.0.0/16",
      "nextHop": "10.85.3.4",
      "origin": "Igp",
      "sourcePeer": "10.85.3.4",
      "weight": 0
    }
  ],
  "RouteServiceRole_IN_1": [
    {
      "asPath": "65515",
      "localAddress": "10.85.3.4",
      "network": "10.45.0.0/16",
      "nextHop": "10.85.3.4",
      "origin": "Igp",
      "sourcePeer": "10.85.3.4",
      "weight": 0
    },
    {
      "asPath": "65515",
      "localAddress": "10.85.3.4",
      "network": "10.85.0.0/16",
      "nextHop": "10.85.3.4",
      "origin": "Igp",
      "sourcePeer": "10.85.3.4",
      "weight": 0
    },
    {
      "asPath": "65515",
      "localAddress": "10.85.3.4",
      "network": "10.100.0.0/16",
      "nextHop": "10.85.3.4",
      "origin": "Igp",
      "sourcePeer": "10.85.3.4",
      "weight": 0
    }
  ]
}

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.

CloudError

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Tělo chyby cloudu.

CloudErrorBody

Objekt

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ě.