Virtual Hubs - Create Or Update

Service:: Virtual WAN

API Version:: 2025-05-01

Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHubName	path	True	string	The name of the VirtualHub.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
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.expressRouteGateway	SubResource	The expressRouteGateway associated with this VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	The hubRoutingPreference of this VirtualHub.
properties.p2SVpnGateway	SubResource	The P2SVpnGateway associated with this VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	The preferred gateway to route on-prem traffic
properties.routeTable	VirtualHubRouteTable	The routeTable associated with this virtual hub.
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 (int64) minimum: 0 maximum: 4294967295	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.

Responses

Name	Type	Description
200 OK	VirtualHub	Resource 'VirtualHub' update operation succeeded
201 Created	VirtualHub	Resource 'VirtualHub' create operation succeeded Headers Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	An unexpected error response.

Name

Type

Description

200 OK

VirtualHub

Resource 'VirtualHub' update operation succeeded

201 Created

VirtualHub

Resource 'VirtualHub' create operation succeeded

Headers

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

CloudError

An unexpected error response.

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

VirtualHubPut

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2?api-version=2025-05-01

{
  "location": "West US",
  "properties": {
    "addressPrefix": "10.168.0.0/24",
    "sku": "Basic",
    "virtualWan": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    }
  },
  "tags": {
    "key1": "value1"
  }
}

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
 *
 * @summary Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/VirtualHubPut.json
 */
async function virtualHubPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub2";
  const virtualHubParameters = {
    addressPrefix: "10.168.0.0/24",
    location: "West US",
    sku: "Basic",
    tags: { key1: "value1" },
    virtualWan: {
      id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.beginCreateOrUpdateAndWait(
    resourceGroupName,
    virtualHubName,
    virtualHubParameters,
  );
  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

Sample response

Status code:: 200

{
  "name": "virtualHub2",
  "type": "Microsoft.Network/virtualHubs",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
  "location": "West US",
  "properties": {
    "addressPrefix": "10.168.0.0/24",
    "allowBranchToBranchTraffic": false,
    "hubRoutingPreference": "ExpressRoute",
    "preferredRoutingGateway": "ExpressRoute",
    "provisioningState": "Succeeded",
    "routingState": "Provisioned",
    "sku": "Basic",
    "virtualHubRouteTableV2s": [],
    "virtualRouterAsn": 65515,
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": 2
    },
    "virtualRouterIps": [
      "10.10.1.12",
      "10.10.1.13"
    ],
    "virtualWan": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    }
  }
}

Status code:: 201

{
  "name": "virtualHub2",
  "type": "Microsoft.Network/virtualHubs",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
  "location": "West US",
  "properties": {
    "addressPrefix": "10.168.0.0/24",
    "allowBranchToBranchTraffic": false,
    "hubRoutingPreference": "ExpressRoute",
    "preferredRoutingGateway": "ExpressRoute",
    "provisioningState": "Succeeded",
    "routingState": "Provisioned",
    "sku": "Basic",
    "virtualHubRouteTableV2s": [],
    "virtualRouterAsn": 65515,
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": 2
    },
    "virtualRouterIps": [
      "10.10.1.12",
      "10.10.1.13"
    ],
    "virtualWan": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    }
  }
}

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	Provisioning states of a resource.
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

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

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

Enumeration

The hub routing preference gateway types

Value	Description
ExpressRoute	ExpressRoute
VpnGateway	VpnGateway
ASPath	ASPath

PreferredRoutingGateway

Enumeration

The preferred routing gateway types

Value	Description
ExpressRoute	ExpressRoute
VpnGateway	VpnGateway
None	None

ProvisioningState

Enumeration

Provisioning states of a resource.

Value	Description
Failed	Failed
Succeeded	Succeeded
Canceled	Canceled
Creating	Creating
Updating	Updating
Deleting	Deleting

RoutingState

Enumeration

The current routing state of the VirtualHub.

Value	Description
None	None
Provisioned	Provisioned
Provisioning	Provisioning
Failed	Failed

SubResource

Object

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

VirtualHub

Object

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 (int64) minimum: 0 maximum: 4294967295	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

Object

VirtualHub route.

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

VirtualHubRouteTable

Object

VirtualHub route table.

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

VirtualHubRouteTableV2

Object

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

Object

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

Object

The VirtualHub Router autoscale configuration.

Name	Type	Description
minCapacity	integer (int32) minimum: 0	The minimum number of scale units for VirtualHub Router.

Share via

Virtual Hubs - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

VirtualHubPut

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

HubRoutingPreference

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration