Ruft die Details aller VirtualHubBgpConnections ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections?api-version=2023-09-01
URI-Parameter
| Name |
In |
Erforderlich |
Typ |
Beschreibung |
|
resourceGroupName
|
path |
True
|
string
|
Der Ressourcengruppenname des VirtualHub.
|
|
subscriptionId
|
path |
True
|
string
|
Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
|
|
virtualHubName
|
path |
True
|
string
|
Der Name des VirtualHub.
|
|
api-version
|
query |
True
|
string
|
Client-API-Version.
|
Antworten
| Name |
Typ |
Beschreibung |
|
200 OK
|
ListVirtualHubBgpConnectionResults
|
Anforderung erfolgreich. Gibt die Details aller VirtualHubBgpConnections für den VirtualHub zurück.
|
|
Other Status Codes
|
CloudError
|
Fehlerantwort mit Beschreibung des Grunds für den Fehler.
|
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Beschreibung |
|
user_impersonation
|
Identitätswechsel Ihres Benutzerkontos
|
Beispiele
VirtualHubRouteTableV2List
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections?api-version=2023-09-01
/**
* Samples for VirtualHubBgpConnections List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubBgpConnectionList.
* json
*/
/**
* Sample code: VirtualHubRouteTableV2List.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void virtualHubRouteTableV2List(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getVirtualHubBgpConnections().list("rg1", "hub1",
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_hub_bgp_connection_list.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_hub_bgp_connections.list(
resource_group_name="rg1",
virtual_hub_name="hub1",
)
for item in response:
print(item)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubBgpConnectionList.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/VirtualHubBgpConnectionList.json
func ExampleVirtualHubBgpConnectionsClient_NewListPager() {
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)
}
pager := clientFactory.NewVirtualHubBgpConnectionsClient().NewListPager("rg1", "hub1", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.ListVirtualHubBgpConnectionResults = armnetwork.ListVirtualHubBgpConnectionResults{
// Value: []*armnetwork.BgpConnection{
// {
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1"),
// Name: to.Ptr("conn1"),
// Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
// Properties: &armnetwork.BgpConnectionProperties{
// ConnectionState: to.Ptr(armnetwork.HubBgpConnectionStatusConnected),
// HubVirtualNetworkConnection: &armnetwork.SubResource{
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1"),
// },
// PeerAsn: to.Ptr[int64](20000),
// PeerIP: to.Ptr("192.168.1.5"),
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// },
// }},
// }
}
}
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 Retrieves the details of all VirtualHubBgpConnections.
*
* @summary Retrieves the details of all VirtualHubBgpConnections.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubBgpConnectionList.json
*/
async function virtualHubRouteTableV2List() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const virtualHubName = "hub1";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.virtualHubBgpConnections.list(resourceGroupName, virtualHubName)) {
resArray.push(item);
}
console.log(resArray);
}
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;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubBgpConnectionList.json
// this example is just showing the usage of "VirtualHubBgpConnections_List" 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 VirtualHubResource created on azure
// for more information of creating VirtualHubResource, please refer to the document of VirtualHubResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualHubName = "hub1";
ResourceIdentifier virtualHubResourceId = VirtualHubResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualHubName);
VirtualHubResource virtualHub = client.GetVirtualHubResource(virtualHubResourceId);
// get the collection of this BgpConnectionResource
BgpConnectionCollection collection = virtualHub.GetBgpConnections();
// invoke the operation and iterate over the result
await foreach (BgpConnectionResource item in collection.GetAllAsync())
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BgpConnectionData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"name": "conn1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1",
"etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
"properties": {
"provisioningState": "Succeeded",
"peerIp": "192.168.1.5",
"peerAsn": 20000,
"connectionState": "Connected",
"hubVirtualNetworkConnection": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1"
}
}
}
]
}
Definitionen
BgpConnection
Standortressource der virtuellen Appliance.
| Name |
Typ |
Beschreibung |
|
etag
|
string
|
Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
|
|
id
|
string
|
Ressourcen-ID
|
|
name
|
string
|
Name der Verbindung
|
|
properties.connectionState
|
HubBgpConnectionStatus
|
Der aktuelle Status von VirtualHub to Peer.
|
|
properties.hubVirtualNetworkConnection
|
SubResource
|
Der Verweis auf die HubVirtualNetworkConnection-Ressource.
|
|
properties.peerAsn
|
integer
|
Peer-ASN:
|
|
properties.peerIp
|
string
|
Peer-IP.
|
|
properties.provisioningState
|
ProvisioningState
|
Der Bereitstellungsstatus der Ressource.
|
|
type
|
string
|
Verbindungstyp.
|
CloudError
Eine Fehlerantwort vom Dienst.
CloudErrorBody
Eine Fehlerantwort vom Dienst.
| Name |
Typ |
Beschreibung |
|
code
|
string
|
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
|
|
details
|
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 sein soll.
|
|
target
|
string
|
Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.
|
HubBgpConnectionStatus
Der aktuelle Status von VirtualHub to Peer.
| Name |
Typ |
Beschreibung |
|
Connected
|
string
|
|
|
Connecting
|
string
|
|
|
NotConnected
|
string
|
|
|
Unknown
|
string
|
|
ListVirtualHubBgpConnectionResults
VirtualHubBgpConnections-Liste.
| Name |
Typ |
Beschreibung |
|
nextLink
|
string
|
URL, um den nächsten Satz von Ergebnissen abzurufen.
|
|
value
|
BgpConnection[]
|
Die Liste der VirtualHubBgpConnections.
|
ProvisioningState
Der aktuelle Bereitstellungsstatus.
| Name |
Typ |
Beschreibung |
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Succeeded
|
string
|
|
|
Updating
|
string
|
|
SubResource
Verweis auf eine andere Unterquelle.
| Name |
Typ |
Beschreibung |
|
id
|
string
|
Ressourcen-ID
|