Virtual Network Gateways - Get Bgp Peer Status

Der GetBgpPeerStatus-Vorgang ruft den Status aller BGP-Peers ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

virtualNetworkGatewayName
path True

string

Der Name des virtuellen Netzwerkgateways.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

peer
query

string

Die IP-Adresse des Peers, um den Status abzurufen.

Antworten

Name Typ Beschreibung
200 OK

BgpPeerStatusListResult

Der Azure-Vorgang wurde erfolgreich abgeschlossen.

202 Accepted

Ressourcenvorgang akzeptiert.

Header

  • Location: string
  • Retry-After: integer
Other Status Codes

Common.CloudError

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

GetVirtualNetworkGatewayBGPPeerStatus

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
BgpPeerState

Der BGP-Peer-Status.

BgpPeerStatus

BGP-Peerstatusdetails.

BgpPeerStatusListResult

Antwort für den BGP-Peerstatus-API-Dienstaufruf.

Common.CloudError

Eine Fehlerantwort vom Dienst.

Common.CloudErrorBody

Eine Fehlerantwort vom Dienst.

BgpPeerState

Der BGP-Peer-Status.

Wert Beschreibung
Unknown

Unbekannt

Stopped

Angehalten

Idle

Idle

Connecting

Verbindung

Connected

Verbunden

BgpPeerStatus

BGP-Peerstatusdetails.

Name Typ Beschreibung
asn

integer (int64)

minimum: 0
maximum: 4294967295

Die autonome Systemnummer des Remote-BGP-Peers.

connectedDuration

string

Wie lange das Peering schon aktiv ist.

localAddress

string

Die lokale Adresse des Gateways für virtuelle Netzwerke.

messagesReceived

integer (int64)

Die Anzahl der empfangenen BGP-Nachrichten.

messagesSent

integer (int64)

Die Anzahl der gesendeten BGP-Nachrichten.

neighbor

string

Der Remote-BGP-Peer.

routesReceived

integer (int64)

Die Anzahl der Routen, die von diesem Peer gelernt wurden.

state

BgpPeerState

Der BGP-Peer-Status.

BgpPeerStatusListResult

Antwort für den BGP-Peerstatus-API-Dienstaufruf.

Name Typ Beschreibung
value

BgpPeerStatus[]

Liste der BGP-Peers.

Common.CloudError

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
error

Common.CloudErrorBody

Cloud-Fehlertext.

Common.CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.

details

Common.CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

target

string

Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.