Virtual Network Gateways - Get Bgp Peer Status

Référence

Service:: Network Gateway

Version d'API:: 2024-05-01

L’opération GetBgpPeerStatus récupère l’état de tous les homologues BGP.

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

Avec des paramètres facultatifs:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus?peer={peer}&api-version=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
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.
virtualNetworkGatewayName	path	True	string	Nom de la passerelle de réseau virtuel.
api-version	query	True	string	Version de l’API cliente.
peer	query		string	Adresse IP de l’homologue pour récupérer l’état de.

Réponses

Nom	Type	Description
200 OK	BgpPeerStatusListResult	Liste des états d’homologue BGP.
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

GetVirtualNetworkGatewayBGPPeerStatus

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/getBgpPeerStatus?api-version=2024-05-01

package armnetwork_test

import (
	"context"
	"log"

	"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/VirtualNetworkGatewayGetBGPPeerStatus.json
func ExampleVirtualNetworkGatewaysClient_BeginGetBgpPeerStatus() {
	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.NewVirtualNetworkGatewaysClient().BeginGetBgpPeerStatus(ctx, "rg1", "vpngw", &armnetwork.VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions{Peer: 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.BgpPeerStatusListResult = armnetwork.BgpPeerStatusListResult{
	// }
}

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:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01

Code d’état:: 200

{}

Définitions

Nom	Description
BgpPeerState	État homologue BGP.
BgpPeerStatus	Détails de l’état de l’homologue BGP.
BgpPeerStatusListResult	Réponse pour l’appel du service d’API d’état homologue BGP de liste.
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.

BgpPeerState

État homologue BGP.

Nom	Type	Description
Connected	string
Connecting	string
Idle	string
Stopped	string
Unknown	string

BgpPeerStatus

Détails de l’état de l’homologue BGP.

Nom	Type	Description
asn	integer	Numéro de système autonome de l’homologue BGP distant.
connectedDuration	string	Pendant combien de temps le peering a été mis en place.
localAddress	string	Adresse locale de la passerelle de réseau virtuel.
messagesReceived	integer	Nombre de messages BGP reçus.
messagesSent	integer	Nombre de messages BGP envoyés.
neighbor	string	Homologue BGP distant.
routesReceived	integer	Nombre d’itinéraires appris par cet homologue.
state	BgpPeerState	État homologue BGP.

BgpPeerStatusListResult

Réponse pour l’appel du service d’API d’état homologue BGP de liste.

Nom	Type	Description
value	BgpPeerStatus[]	Liste des homologues BGP.

CloudError

Réponse d’erreur du service.

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

CloudErrorBody