Virtual Hubs - List

Referens

Tjänst:: Virtual WAN

API-version:: 2024-05-01

Visar en lista över alla VirtualHubs i en prenumeration.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	ListVirtualHubsResult	Begäran lyckades. Returnerar information om alla VirtualHubs i prenumerationen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VirtualHubList

Exempelbegäran

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


/**
 * Samples for VirtualHubs List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualHubList.json
     */
    /**
     * Sample code: VirtualHubList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualHubList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().list(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_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_hubs.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualHubList.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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualHubList.json
func ExampleVirtualHubsClient_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.NewVirtualHubsClient().NewListPager(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.ListVirtualHubsResult = armnetwork.ListVirtualHubsResult{
		// 	Value: []*armnetwork.VirtualHub{
		// 		{
		// 			Name: to.Ptr("virtualHub1"),
		// 			Type: to.Ptr("Microsoft.Network/virtualHubs"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
		// 			Location: to.Ptr("West US"),
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.VirtualHubProperties{
		// 				AddressPrefix: to.Ptr("10.10.1.0/24"),
		// 				AllowBranchToBranchTraffic: to.Ptr(false),
		// 				HubRoutingPreference: to.Ptr(armnetwork.HubRoutingPreferenceExpressRoute),
		// 				PreferredRoutingGateway: to.Ptr(armnetwork.PreferredRoutingGatewayExpressRoute),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				RoutingState: to.Ptr(armnetwork.RoutingStateProvisioned),
		// 				SKU: to.Ptr("Basic"),
		// 				VirtualHubRouteTableV2S: []*armnetwork.VirtualHubRouteTableV2{
		// 					{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1"),
		// 						Name: to.Ptr("rt2a"),
		// 						Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 						Properties: &armnetwork.VirtualHubRouteTableV2Properties{
		// 							AttachedConnections: []*string{
		// 								to.Ptr("All_Vnets")},
		// 								ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 								Routes: []*armnetwork.VirtualHubRouteV2{
		// 									{
		// 										DestinationType: to.Ptr("CIDR"),
		// 										Destinations: []*string{
		// 											to.Ptr("20.10.0.0/16"),
		// 											to.Ptr("20.20.0.0/16")},
		// 											NextHopType: to.Ptr("IPAddress"),
		// 											NextHops: []*string{
		// 												to.Ptr("10.0.0.68")},
		// 											},
		// 											{
		// 												DestinationType: to.Ptr("CIDR"),
		// 												Destinations: []*string{
		// 													to.Ptr("0.0.0.0/0")},
		// 													NextHopType: to.Ptr("IPAddress"),
		// 													NextHops: []*string{
		// 														to.Ptr("10.0.0.68")},
		// 												}},
		// 											},
		// 									}},
		// 									VirtualRouterAsn: to.Ptr[int64](65515),
		// 									VirtualRouterAutoScaleConfiguration: &armnetwork.VirtualRouterAutoScaleConfiguration{
		// 										MinCapacity: to.Ptr[int32](2),
		// 									},
		// 									VirtualRouterIPs: []*string{
		// 										to.Ptr("10.10.1.12"),
		// 										to.Ptr("10.10.1.13")},
		// 										VirtualWan: &armnetwork.SubResource{
		// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
		// 										},
		// 									},
		// 								},
		// 								{
		// 									Name: to.Ptr("virtualHub2"),
		// 									Type: to.Ptr("Microsoft.Network/virtualHubs"),
		// 									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2"),
		// 									Location: to.Ptr("East US"),
		// 									Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 									Properties: &armnetwork.VirtualHubProperties{
		// 										AddressPrefix: to.Ptr("210.10.1.0/24"),
		// 										AllowBranchToBranchTraffic: to.Ptr(false),
		// 										HubRoutingPreference: to.Ptr(armnetwork.HubRoutingPreferenceExpressRoute),
		// 										PreferredRoutingGateway: to.Ptr(armnetwork.PreferredRoutingGatewayExpressRoute),
		// 										ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 										RoutingState: to.Ptr(armnetwork.RoutingStateProvisioned),
		// 										SKU: to.Ptr("Basic"),
		// 										VirtualHubRouteTableV2S: []*armnetwork.VirtualHubRouteTableV2{
		// 											{
		// 												ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2"),
		// 												Name: to.Ptr("rt2a"),
		// 												Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 												Properties: &armnetwork.VirtualHubRouteTableV2Properties{
		// 													AttachedConnections: []*string{
		// 														to.Ptr("All_Vnets")},
		// 														ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 														Routes: []*armnetwork.VirtualHubRouteV2{
		// 															{
		// 																DestinationType: to.Ptr("CIDR"),
		// 																Destinations: []*string{
		// 																	to.Ptr("20.10.0.0/16"),
		// 																	to.Ptr("20.20.0.0/16")},
		// 																	NextHopType: to.Ptr("IPAddress"),
		// 																	NextHops: []*string{
		// 																		to.Ptr("10.0.0.68")},
		// 																	},
		// 																	{
		// 																		DestinationType: to.Ptr("CIDR"),
		// 																		Destinations: []*string{
		// 																			to.Ptr("0.0.0.0/0")},
		// 																			NextHopType: to.Ptr("IPAddress"),
		// 																			NextHops: []*string{
		// 																				to.Ptr("10.0.0.68")},
		// 																		}},
		// 																	},
		// 															}},
		// 															VirtualRouterAsn: to.Ptr[int64](65515),
		// 															VirtualRouterAutoScaleConfiguration: &armnetwork.VirtualRouterAutoScaleConfiguration{
		// 																MinCapacity: to.Ptr[int32](2),
		// 															},
		// 															VirtualRouterIPs: []*string{
		// 																to.Ptr("10.10.1.12"),
		// 																to.Ptr("10.10.1.13")},
		// 																VirtualWan: &armnetwork.SubResource{
		// 																	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
		// 																},
		// 															},
		// 													}},
		// 												}
	}
}

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 Lists all the VirtualHubs in a subscription.
 *
 * @summary Lists all the VirtualHubs in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualHubList.json
 */
async function virtualHubList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualHubs.list()) {
    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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
HubRoutingPreference	Gatewaytyper för hubbdirigeringsinställning
ListVirtualHubsResult	Resultatet av begäran om att lista VirtualHubs. Den innehåller en lista över VirtualHubs och en URL nextLink för att få nästa uppsättning resultat.
PreferredRoutingGateway	De vanligaste typerna av routningsgatewayer
ProvisioningState	Det aktuella etableringstillståndet.
RoutingState	Det aktuella routningstillståndet för VirtualHub.
SubResource	Referens till en annan underresurs.
VirtualHub	VirtualHub-resurs.
VirtualHubRoute	VirtualHub-väg.
VirtualHubRouteTable	VirtualHub-routningstabell.
VirtualHubRouteTableV2	VirtualHubRouteTableV2-resurs.
VirtualHubRouteV2	VirtualHubRouteTableV2-väg.
VirtualRouterAutoScaleConfiguration	Autoskalningskonfigurationen för VirtualHub Router.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

HubRoutingPreference

Gatewaytyper för hubbdirigeringsinställning

Name	Typ	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

ListVirtualHubsResult

Resultatet av begäran om att lista VirtualHubs. Den innehåller en lista över VirtualHubs och en URL nextLink för att få nästa uppsättning resultat.

Name	Typ	Description
nextLink	string	URL för att hämta nästa uppsättning resultat i åtgärdslistan om det finns några.
value	VirtualHub[]	Lista över VirtualHubs.

PreferredRoutingGateway

De vanligaste typerna av routningsgatewayer

Name	Typ	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

Det aktuella routningstillståndet för VirtualHub.

Name	Typ	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

VirtualHub

VirtualHub-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
kind	string	Typ av virtuell tjänsthubb. Det här är metadata som används för Azure Portal-upplevelsen för Route Server.
location	string	Resursplats.
name	string	Resursnamn.
properties.addressPrefix	string	Adressprefix för denna VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Flagga för att styra överföring för VirtualRouter Hub.
properties.azureFirewall	SubResource	AzureFirewall som är associerad med denna VirtualHub.
properties.bgpConnections	SubResource[]	Lista över referenser till Bgp-anslutningar.
properties.expressRouteGateway	SubResource	ExpressRouteGateway som är associerad med denna VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	HubRoutingPreference för denna VirtualHub.
properties.ipConfigurations	SubResource[]	Lista över referenser till IpConfigurations.
properties.p2SVpnGateway	SubResource	P2SVpnGateway som är associerad med denna VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	Den föredragna gatewayen för att dirigera lokal trafik
properties.provisioningState	ProvisioningState	Etableringstillståndet för den virtuella hubbresursen.
properties.routeMaps	SubResource[]	Lista över referenser till RouteMaps.
properties.routeTable	VirtualHubRouteTable	RouteTable som är associerad med den här virtuella hubben.
properties.routingState	RoutingState	Routningstillståndet.
properties.securityPartnerProvider	SubResource	SecurityPartnerProvider som är associerad med denna VirtualHub.
properties.securityProviderName	string	Namnet på säkerhetsprovidern.
properties.sku	string	SKU:n för denna VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Lista över alla v2:er för routningstabeller för virtuell hubb som är associerade med den här VirtualHub.
properties.virtualRouterAsn	integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	Autoskalningskonfigurationen för VirtualHub Router.
properties.virtualRouterIps	string[]	VirtualRouter IP-adresser.
properties.virtualWan	SubResource	VirtualWAN som VirtualHub tillhör.
properties.vpnGateway	SubResource	VpnGateway som är associerad med denna VirtualHub.
tags	object	Resurstaggar.
type	string	Resurstyp.

VirtualHubRoute

VirtualHub-väg.

Name	Typ	Description
addressPrefixes	string[]	Lista över alla addressPrefixes.
nextHopIpAddress	string	NextHop ip-adress.

VirtualHubRouteTable

VirtualHub-routningstabell.

Name	Typ	Description
routes	VirtualHubRoute[]	Lista över alla vägar.

VirtualHubRouteTableV2

VirtualHubRouteTableV2-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.attachedConnections	string[]	Lista över alla anslutningar som är kopplade till den här routningstabellen v2.
properties.provisioningState	ProvisioningState	Etableringstillståndet för den virtuella hubbens routningstabell v2-resurs.
properties.routes	VirtualHubRouteV2[]	Lista över alla vägar.

VirtualHubRouteV2

VirtualHubRouteTableV2-väg.

Name	Typ	Description
destinationType	string	Typ av mål.
destinations	string[]	Lista över alla mål.
nextHopType	string	Typ av nästa hopp.
nextHops	string[]	NextHops ip-adress.

VirtualRouterAutoScaleConfiguration

Autoskalningskonfigurationen för VirtualHub Router.

Name	Typ	Description
minCapacity	integer	Det minsta antalet skalningsenheter för VirtualHub Router.

Dela via

Virtual Hubs - List

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

VirtualHubList

Exempelbegäran

Exempelsvar

Definitioner

CloudError

CloudErrorBody

HubRoutingPreference

ListVirtualHubsResult

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Ytterligare resurser