Freigeben über


Virtual Hubs - List

Listen alle VirtualHubs in einem Abonnement.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs?api-version=2023-09-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 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

VirtualHubList

Sample Request

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

Sample Response

{
  "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 vom Dienst.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

HubRoutingPreference

Gatewaytypen der Hubroutingpräferenz

ListVirtualHubsResult

Ergebnis der Anforderung, VirtualHubs aufzulisten. 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 des VirtualHub.

SubResource

Verweis auf eine andere Unterquelle.

VirtualHub

VirtualHub-Ressource.

VirtualHubRoute

VirtualHub-Route.

VirtualHubRouteTable

VirtualHub-Routingtabelle.

VirtualHubRouteTableV2

VirtualHubRouteTableV2-Ressource.

VirtualHubRouteV2

VirtualHubRouteTableV2-Route.

VirtualRouterAutoScaleConfiguration

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

CloudError

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
error

CloudErrorBody

Cloudfehlertext.

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.

HubRoutingPreference

Gatewaytypen der Hubroutingpräferenz

Name Typ Beschreibung
ASPath

string

ExpressRoute

string

VpnGateway

string

ListVirtualHubsResult

Ergebnis der Anforderung, VirtualHubs aufzulisten. 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, um den nächsten Satz von Vorgangslistenergebnissen abzurufen, falls vorhanden.

value

VirtualHub[]

Liste der VirtualHubs.

PreferredRoutingGateway

Die bevorzugten Routinggatewaytypen

Name Typ Beschreibung
ExpressRoute

string

None

string

VpnGateway

string

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Deleting

string

Failed

string

Succeeded

string

Updating

string

RoutingState

Der aktuelle Routingstatus des VirtualHub.

Name Typ Beschreibung
Failed

string

None

string

Provisioned

string

Provisioning

string

SubResource

Verweis auf eine andere Unterquelle.

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-Portal Für Route Server verwendet werden.

location

string

Ressourcenspeicherort

name

string

Name der Ressource.

properties.addressPrefix

string

Adresspräfix für diesen VirtualHub.

properties.allowBranchToBranchTraffic

boolean

Flag zum Steuern des Transits für den VirtualRouter-Hub.

properties.azureFirewall

SubResource

Die azureFirewall, die diesem VirtualHub zugeordnet ist.

properties.bgpConnections

SubResource[]

Liste der Verweise auf Bgp Connections.

properties.expressRouteGateway

SubResource

Der expressRouteGateway, der diesem VirtualHub zugeordnet ist.

properties.hubRoutingPreference

HubRoutingPreference

HubRoutingPreference dieses VirtualHub.

properties.ipConfigurations

SubResource[]

Liste der Verweise auf IpConfigurations.

properties.p2SVpnGateway

SubResource

Der P2SVpnGateway, der 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 VirtualHubs.

properties.virtualHubRouteTableV2s

VirtualHubRouteTableV2[]

Liste aller V2-Routingtabellen für virtuelle Hubs, die diesem VirtualHub zugeordnet sind.

properties.virtualRouterAsn

integer

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 der VirtualHub gehört.

properties.vpnGateway

SubResource

Der VpnGateway, der diesem VirtualHub zugeordnet ist.

tags

object

Ressourcentags.

type

string

Der Ressourcentyp.

VirtualHubRoute

VirtualHub-Route.

Name Typ Beschreibung
addressPrefixes

string[]

Liste aller AdressenPrefixes.

nextHopIpAddress

string

NextHop-IP-Adresse.

VirtualHubRouteTable

VirtualHub-Routingtabelle.

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 Routingtabelle v2 angefügt sind.

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der V2-Ressource für die Routingtabelle des virtuellen Hubs.

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

Die Mindestanzahl von Skalierungseinheiten für VirtualHub Router.