Freigeben über


Virtual Hubs - List

Listet alle VirtualHubs in einem Abonnement auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs?api-version=2024-05-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
path True

string

Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

ListVirtualHubsResult

Anforderung erfolgreich. Gibt die Details aller VirtualHubs im Abonnement zurück.

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

VirtualHubList

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/virtualHubs?api-version=2024-05-01

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "virtualHub1",
      "type": "Microsoft.Network/virtualHubs",
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        },
        "virtualHubRouteTableV2s": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "name": "rt2a",
            "properties": {
              "provisioningState": "Succeeded",
              "routes": [
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "20.10.0.0/16",
                    "20.20.0.0/16"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                },
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "0.0.0.0/0"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                }
              ],
              "attachedConnections": [
                "All_Vnets"
              ]
            }
          }
        ],
        "addressPrefix": "10.10.1.0/24",
        "sku": "Basic",
        "routingState": "Provisioned",
        "virtualRouterAsn": 65515,
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "allowBranchToBranchTraffic": false,
        "preferredRoutingGateway": "ExpressRoute",
        "hubRoutingPreference": "ExpressRoute",
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "East US",
      "name": "virtualHub2",
      "type": "Microsoft.Network/virtualHubs",
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        },
        "virtualHubRouteTableV2s": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "name": "rt2a",
            "properties": {
              "provisioningState": "Succeeded",
              "routes": [
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "20.10.0.0/16",
                    "20.20.0.0/16"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                },
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "0.0.0.0/0"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                }
              ],
              "attachedConnections": [
                "All_Vnets"
              ]
            }
          }
        ],
        "addressPrefix": "210.10.1.0/24",
        "sku": "Basic",
        "routingState": "Provisioned",
        "virtualRouterAsn": 65515,
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "allowBranchToBranchTraffic": false,
        "preferredRoutingGateway": "ExpressRoute",
        "hubRoutingPreference": "ExpressRoute",
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        }
      }
    }
  ]
}

Definitionen

Name Beschreibung
CloudError

Eine Fehlerantwort des Diensts.

CloudErrorBody

Eine Fehlerantwort des Diensts.

HubRoutingPreference

Die Gatewaytypen für Hubroutingeinstellungen

ListVirtualHubsResult

Ergebnis der Anforderung zum Auflisten von VirtualHubs. Es enthält eine Liste von VirtualHubs und eine URL nextLink, um den nächsten Satz von Ergebnissen abzurufen.

PreferredRoutingGateway

Die bevorzugten Routinggatewaytypen

ProvisioningState

Der aktuelle Bereitstellungsstatus.

RoutingState

Der aktuelle Routingstatus von VirtualHub.

SubResource

Verweisen auf eine andere Unterressource.

VirtualHub

VirtualHub-Ressource.

VirtualHubRoute

VirtualHub-Route.

VirtualHubRouteTable

VirtualHub-Routentabelle.

VirtualHubRouteTableV2

VirtualHubRouteTableV2-Ressource.

VirtualHubRouteV2

VirtualHubRouteTableV2-Route.

VirtualRouterAutoScaleConfiguration

Die Konfiguration des VirtualHub-Routers für die automatische Skalierung.

CloudError

Eine Fehlerantwort des Diensts.

Name Typ Beschreibung
error

CloudErrorBody

Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort des Diensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt 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 ist.

target

string

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

HubRoutingPreference

Die Gatewaytypen für Hubroutingeinstellungen

Wert Beschreibung
ASPath
ExpressRoute
VpnGateway

ListVirtualHubsResult

Ergebnis der Anforderung zum Auflisten von VirtualHubs. Es enthält eine Liste von VirtualHubs und eine URL nextLink, um den nächsten Satz von Ergebnissen abzurufen.

Name Typ Beschreibung
nextLink

string

URL zum Abrufen des nächsten Vorgangslistenergebnisses, falls vorhanden.

value

VirtualHub[]

Liste der VirtualHubs.

PreferredRoutingGateway

Die bevorzugten Routinggatewaytypen

Wert Beschreibung
ExpressRoute
None
VpnGateway

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Wert Beschreibung
Deleting
Failed
Succeeded
Updating

RoutingState

Der aktuelle Routingstatus von VirtualHub.

Wert Beschreibung
Failed
None
Provisioned
Provisioning

SubResource

Verweisen auf eine andere Unterressource.

Name Typ Beschreibung
id

string

Ressourcen-ID.

VirtualHub

VirtualHub-Ressource.

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID.

kind

string

Art des virtuellen Diensthubs. Dies sind Metadaten, die für die Azure-Portaloberfläche für Route Server verwendet werden.

location

string

Ressourcenspeicherort.

name

string

Ressourcenname.

properties.addressPrefix

string

Adresspräfix für diesen VirtualHub.

properties.allowBranchToBranchTraffic

boolean

Flag zum Steuern der Übertragung für VirtualRouter-Hub.

properties.azureFirewall

SubResource

Die azureFirewall, die diesem VirtualHub zugeordnet ist.

properties.bgpConnections

SubResource[]

Liste der Verweise auf Bgp Connections.

properties.expressRouteGateway

SubResource

Das expressRouteGateway, das diesem VirtualHub zugeordnet ist.

properties.hubRoutingPreference

HubRoutingPreference

HubRoutingPreference dieses VirtualHub.

properties.ipConfigurations

SubResource[]

Liste der Verweise auf IpConfigurations.

properties.p2SVpnGateway

SubResource

Das P2SVpnGateway, das diesem VirtualHub zugeordnet ist.

properties.preferredRoutingGateway

PreferredRoutingGateway

Das bevorzugte Gateway zum Weiterleiten von lokalem Datenverkehr

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der virtuellen Hubressource.

properties.routeMaps

SubResource[]

Liste der Verweise auf RouteMaps.

properties.routeTable

VirtualHubRouteTable

Die routeTable, die diesem virtuellen Hub zugeordnet ist.

properties.routingState

RoutingState

Der Routingstatus.

properties.securityPartnerProvider

SubResource

Der securityPartnerProvider, der diesem VirtualHub zugeordnet ist.

properties.securityProviderName

string

Der Name des Sicherheitsanbieters.

properties.sku

string

Die Sku dieses VirtualHub.

properties.virtualHubRouteTableV2s

VirtualHubRouteTableV2[]

Liste aller virtuellen Hubroutentabellen v2s, die diesem VirtualHub zugeordnet sind.

properties.virtualRouterAsn

integer (int64)

minimum: 0
maximum: 4294967295

VirtualRouter ASN.

properties.virtualRouterAutoScaleConfiguration

VirtualRouterAutoScaleConfiguration

Die Konfiguration des VirtualHub-Routers für die automatische Skalierung.

properties.virtualRouterIps

string[]

VirtualRouter-IPs.

properties.virtualWan

SubResource

Der VirtualWAN, zu dem virtualHub gehört.

properties.vpnGateway

SubResource

Das vpnGateway, das diesem VirtualHub zugeordnet ist.

tags

object

Ressourcentags.

type

string

Ressourcentyp.

VirtualHubRoute

VirtualHub-Route.

Name Typ Beschreibung
addressPrefixes

string[]

Liste aller addressPrefixes.

nextHopIpAddress

string

NextHop-IP-Adresse.

VirtualHubRouteTable

VirtualHub-Routentabelle.

Name Typ Beschreibung
routes

VirtualHubRoute[]

Liste aller Routen.

VirtualHubRouteTableV2

VirtualHubRouteTableV2-Ressource.

Name Typ Beschreibung
etag

string

Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.

id

string

Ressourcen-ID.

name

string

Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.

properties.attachedConnections

string[]

Liste aller Verbindungen, die an diese Routentabelle v2 angefügt sind.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der Vm Hub Route Table v2-Ressource.

properties.routes

VirtualHubRouteV2[]

Liste aller Routen.

VirtualHubRouteV2

VirtualHubRouteTableV2-Route.

Name Typ Beschreibung
destinationType

string

Der Typ der Ziele.

destinations

string[]

Liste aller Ziele.

nextHopType

string

Der Typ der nächsten Hops.

nextHops

string[]

NextHops IP-Adresse.

VirtualRouterAutoScaleConfiguration

Die Konfiguration des VirtualHub-Routers für die automatische Skalierung.

Name Typ Beschreibung
minCapacity

integer (int32)

minimum: 0

Die Mindestanzahl der Skalierungseinheiten für VirtualHub-Router.