Virtual Network Gateways - Get Bgp Peer Status

L'operazione GetBgpPeerStatus recupera lo stato di tutti i peer BGP.

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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

subscriptionId
path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.

virtualNetworkGatewayName
path True

string

Nome del gateway di rete virtuale.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

peer
query

string

Indirizzo IP del peer di cui recuperare lo stato.

Risposte

Nome Tipo Descrizione
200 OK

BgpPeerStatusListResult

L'operazione di Azure è stata completata correttamente.

202 Accepted

Operazione sulle risorse accettata.

Intestazioni

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

Common.CloudError

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

GetVirtualNetworkGatewayBGPPeerStatus

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
BgpPeerState

Stato del peer BGP.

BgpPeerStatus

Dettagli sullo stato del peer BGP.

BgpPeerStatusListResult

Risposta per elencare la chiamata al servizio API per lo stato del peer BGP.

Common.CloudError

Risposta di errore dal servizio.

Common.CloudErrorBody

Risposta di errore dal servizio.

BgpPeerState

Stato del peer BGP.

Valore Descrizione
Unknown

Sconosciuto

Stopped

Fermato

Idle

Inattivo

Connecting

Connecting

Connected

Connesso

BgpPeerStatus

Dettagli sullo stato del peer BGP.

Nome Tipo Descrizione
asn

integer (int64)

minimum: 0
maximum: 4294967295

Numero di sistema autonomo del peer BGP remoto.

connectedDuration

string

Per quanto tempo il peering è stato attivo.

localAddress

string

Indirizzo locale del gateway di rete virtuale.

messagesReceived

integer (int64)

Numero di messaggi BGP ricevuti.

messagesSent

integer (int64)

Numero di messaggi BGP inviati.

neighbor

string

Il peer BGP remoto.

routesReceived

integer (int64)

Numero di route apprese da questo peer.

state

BgpPeerState

Stato del peer BGP.

BgpPeerStatusListResult

Risposta per elencare la chiamata al servizio API per lo stato del peer BGP.

Nome Tipo Descrizione
value

BgpPeerStatus[]

Elenco dei peer BGP.

Common.CloudError

Risposta di errore dal servizio.

Nome Tipo Descrizione
error

Common.CloudErrorBody

Corpo dell'errore cloud.

Common.CloudErrorBody

Risposta di errore dal servizio.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.

details

Common.CloudErrorBody[]

Un elenco di dettagli aggiuntivi sull'errore.

message

string

Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

target

string

Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.