Virtual Hub Bgp Connections - List Advertised Routes

Service:

Virtual WAN

Version d'API:

2025-05-01

Récupère la liste des routes que la connexion bgp du hub virtuel annonce à l’homologue spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
connectionName	path	True	string	Le nom de la connexion BGP.
hubName	path	True	string	Nom du hub virtuel.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK		Opération Azure terminée avec succès.
202 Accepted		Exploitation des ressources acceptée. En-têtes Location: string Retry-After: integer
Other Status Codes	CloudError	Réponse d’erreur inattendue.

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

VirtualRouterPeerListAdvertisedRoutes

Exemple de requête

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

Exemple de réponse

Code d’état:

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
    }
  ]
}

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	Une réponse d’erreur du service.
CloudErrorBody	Une réponse d’erreur du service.

CloudError

Objet

Une réponse d’erreur du service.

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

CloudErrorBody

Objet

Une 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[]	Une liste de 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.