Virtual Hubs - Get

Reference

Service:: Virtual WAN

API Version:: 2024-03-01

Retrieves the details of a VirtualHub.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The resource group name of the VirtualHub.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
virtualHubName	path	True	string	The name of the VirtualHub.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	VirtualHub	Request successful. Returns the details of the VirtualHub retrieved.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

VirtualHubGet

Sample request

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


/**
 * Samples for VirtualHubs GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/VirtualHubGet.json
     */
    /**
     * Sample code: VirtualHubGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualHubGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().getByResourceGroupWithResponse("rg1", "virtualHub1",
            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_get.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.get(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/VirtualHubGet.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/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/VirtualHubGet.json
func ExampleVirtualHubsClient_Get() {
	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)
	}
	res, err := clientFactory.NewVirtualHubsClient().Get(ctx, "rg1", "virtualHub1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.VirtualHub = 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{
	// 		},
	// 		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 Retrieves the details of a VirtualHub.
 *
 * @summary Retrieves the details of a VirtualHub.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/VirtualHubGet.json
 */
async function virtualHubGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.get(resourceGroupName, virtualHubName);
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/VirtualHubGet.json
// this example is just showing the usage of "VirtualHubs_Get" 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://video2.skills-academy.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 = "virtualHub1";
ResourceIdentifier virtualHubResourceId = VirtualHubResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualHubName);
VirtualHubResource virtualHub = client.GetVirtualHubResource(virtualHubResourceId);

// invoke the operation
VirtualHubResource result = await virtualHub.GetAsync();

// the variable result 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
VirtualHubData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Status code:: 200

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

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
HubRoutingPreference	The hub routing preference gateway types
PreferredRoutingGateway	The preferred routing gateway types
ProvisioningState	The current provisioning state.
RoutingState	The current routing state of the VirtualHub.
SubResource	Reference to another subresource.
VirtualHub	VirtualHub Resource.
VirtualHubRoute	VirtualHub route.
VirtualHubRouteTable	VirtualHub route table.
VirtualHubRouteTableV2	VirtualHubRouteTableV2 Resource.
VirtualHubRouteV2	VirtualHubRouteTableV2 route.
VirtualRouterAutoScaleConfiguration	The VirtualHub Router autoscale configuration.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

HubRoutingPreference

The hub routing preference gateway types

Name	Type	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

The preferred routing gateway types

Name	Type	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

The current routing state of the VirtualHub.

Name	Type	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

VirtualHub

VirtualHub Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
kind	string	Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
location	string	Resource location.
name	string	Resource name.
properties.addressPrefix	string	Address-prefix for this VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Flag to control transit for VirtualRouter hub.
properties.azureFirewall	SubResource	The azureFirewall associated with this VirtualHub.
properties.bgpConnections	SubResource[]	List of references to Bgp Connections.
properties.expressRouteGateway	SubResource	The expressRouteGateway associated with this VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	The hubRoutingPreference of this VirtualHub.
properties.ipConfigurations	SubResource[]	List of references to IpConfigurations.
properties.p2SVpnGateway	SubResource	The P2SVpnGateway associated with this VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	The preferred gateway to route on-prem traffic
properties.provisioningState	ProvisioningState	The provisioning state of the virtual hub resource.
properties.routeMaps	SubResource[]	List of references to RouteMaps.
properties.routeTable	VirtualHubRouteTable	The routeTable associated with this virtual hub.
properties.routingState	RoutingState	The routing state.
properties.securityPartnerProvider	SubResource	The securityPartnerProvider associated with this VirtualHub.
properties.securityProviderName	string	The Security Provider name.
properties.sku	string	The sku of this VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	List of all virtual hub route table v2s associated with this VirtualHub.
properties.virtualRouterAsn	integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	The VirtualHub Router autoscale configuration.
properties.virtualRouterIps	string[]	VirtualRouter IPs.
properties.virtualWan	SubResource	The VirtualWAN to which the VirtualHub belongs.
properties.vpnGateway	SubResource	The VpnGateway associated with this VirtualHub.
tags	object	Resource tags.
type	string	Resource type.

VirtualHubRoute

VirtualHub route.

Name	Type	Description
addressPrefixes	string[]	List of all addressPrefixes.
nextHopIpAddress	string	NextHop ip address.

VirtualHubRouteTable

VirtualHub route table.

Name	Type	Description
routes	VirtualHubRoute[]	List of all routes.

VirtualHubRouteTableV2

VirtualHubRouteTableV2 Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.attachedConnections	string[]	List of all connections attached to this route table v2.
properties.provisioningState	ProvisioningState	The provisioning state of the virtual hub route table v2 resource.
properties.routes	VirtualHubRouteV2[]	List of all routes.

VirtualHubRouteV2

VirtualHubRouteTableV2 route.

Name	Type	Description
destinationType	string	The type of destinations.
destinations	string[]	List of all destinations.
nextHopType	string	The type of next hops.
nextHops	string[]	NextHops ip address.

VirtualRouterAutoScaleConfiguration

The VirtualHub Router autoscale configuration.

Name	Type	Description
minCapacity	integer	The minimum number of scale units for VirtualHub Router.