A GetBgpPeerStatus művelet lekéri az összes BGP-társ állapotát.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus?api-version=2023-09-01
With optional parameters:
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus?peer={peer}&api-version=2023-09-01
URI-paraméterek
| Name |
In |
Kötelező |
Típus |
Description |
|
resourceGroupName
|
path |
True
|
string
|
Az erőforráscsoport neve.
|
|
subscriptionId
|
path |
True
|
string
|
Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
|
|
virtualNetworkGatewayName
|
path |
True
|
string
|
A virtuális hálózati átjáró neve.
|
|
api-version
|
query |
True
|
string
|
Ügyfél API-verziója.
|
|
peer
|
query |
|
string
|
A társ IP-címe az állapot lekéréséhez.
|
Válaszok
| Name |
Típus |
Description |
|
200 OK
|
BgpPeerStatusListResult
|
A BGP-társállapotok listája.
|
|
202 Accepted
|
|
Elfogadva, és a művelet aszinkron módon fejeződik be.
|
|
Other Status Codes
|
CloudError
|
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.
|
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
felhasználói fiók megszemélyesítése
|
Példák
GetVirtualNetworkGatewayBGPPeerStatus
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/getBgpPeerStatus?api-version=2023-09-01
/**
* Samples for VirtualNetworkGateways GetBgpPeerStatus.
*/
public final class Main {
/*
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
* VirtualNetworkGatewayGetBGPPeerStatus.json
*/
/**
* Sample code: GetVirtualNetworkGatewayBGPPeerStatus.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getVirtualNetworkGatewayBGPPeerStatus(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getVirtualNetworkGateways().getBgpPeerStatus("rg1", "vpngw", null,
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python virtual_network_gateway_get_bgp_peer_status.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = NetworkManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.virtual_network_gateways.begin_get_bgp_peer_status(
resource_group_name="rg1",
virtual_network_gateway_name="vpngw",
).result()
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-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
const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to The GetBgpPeerStatus operation retrieves the status of all BGP peers.
*
* @summary The GetBgpPeerStatus operation retrieves the status of all BGP peers.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json
*/
async function getVirtualNetworkGatewayBgpPeerStatus() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const virtualNetworkGatewayName = "vpngw";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.virtualNetworkGateways.beginGetBgpPeerStatusAndWait(
resourceGroupName,
virtualNetworkGatewayName,
);
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
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json
// this example is just showing the usage of "VirtualNetworkGateways_GetBgpPeerStatus" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "vpngw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);
// invoke the operation
ArmOperation<BgpPeerStatusListResult> lro = await virtualNetworkGateway.GetBgpPeerStatusAsync(WaitUntil.Completed);
BgpPeerStatusListResult result = lro.Value;
Console.WriteLine($"Succeeded: {result}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-09-01
{}
Definíciók
BgpPeerState
A BGP-társ állapota.
| Name |
Típus |
Description |
|
Connected
|
string
|
|
|
Connecting
|
string
|
|
|
Idle
|
string
|
|
|
Stopped
|
string
|
|
|
Unknown
|
string
|
|
BgpPeerStatus
A BGP-társ állapotának részletei.
| Name |
Típus |
Description |
|
asn
|
integer
|
A távoli BGP-társ autonóm rendszerszáma.
|
|
connectedDuration
|
string
|
Mennyi ideig tartott a társviszony-létesítés.
|
|
localAddress
|
string
|
A virtuális hálózati átjáró helyi címe.
|
|
messagesReceived
|
integer
|
A fogadott BGP-üzenetek száma.
|
|
messagesSent
|
integer
|
Az elküldött BGP-üzenetek száma.
|
|
neighbor
|
string
|
A távoli BGP-társ.
|
|
routesReceived
|
integer
|
A társtól tanult útvonalak száma.
|
|
state
|
BgpPeerState
|
A BGP-társ állapota.
|
BgpPeerStatusListResult
Válasz a BGP-társállapot API-szolgáltatáshívására.
| Name |
Típus |
Description |
|
value
|
BgpPeerStatus[]
|
A BGP-társviszonyok listája.
|
CloudError
Hibaválasz a szolgáltatástól.
CloudErrorBody
Hibaválasz a szolgáltatástól.
| Name |
Típus |
Description |
|
code
|
string
|
A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
|
|
details
|
CloudErrorBody[]
|
A hibával kapcsolatos további részletek listája.
|
|
message
|
string
|
A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
|
|
target
|
string
|
Az adott hiba célja. Például a hibás tulajdonság neve.
|