Virtual Hubs - Create Or Update

Service:

Virtual WAN

API Version:

2023-09-01

Erstellt eine VirtualHub-Ressource, wenn sie nicht vorhanden ist, und aktualisiert den vorhandenen VirtualHub.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Ressourcengruppenname des VirtualHubs.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
virtualHubName	path	True	string	Der Name des VirtualHub.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Ressourcenspeicherort
id		string	Ressourcen-ID
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.expressRouteGateway		SubResource	Das expressRouteGateway, das diesem VirtualHub zugeordnet ist.
properties.hubRoutingPreference		HubRoutingPreference	Die hubRoutingPreference dieses VirtualHub.
properties.p2SVpnGateway		SubResource	Das P2SVpnGateway, das diesem VirtualHub zugeordnet ist.
properties.preferredRoutingGateway		PreferredRoutingGateway	Das bevorzugte Gateway zum Weiterleiten von lokalem Datenverkehr
properties.routeTable		VirtualHubRouteTable	Die diesem virtuellen Hub zugeordnete routeTable.
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 virtuellen Hub-Routingtabellen v2, die diesem VirtualHub zugeordnet sind.
properties.virtualRouterAsn		integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration		VirtualRouterAutoScaleConfiguration	Die Konfiguration der automatischen Skalierung des VirtualHub-Routers.
properties.virtualRouterIps		string[]	VirtualRouter-IP-Adressen.
properties.virtualWan		SubResource	Der VirtualWAN, zu dem virtualHub gehört.
properties.vpnGateway		SubResource	Das vpnGateway, das diesem VirtualHub zugeordnet ist.
tags		object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualHub	Anforderung erfolgreich. Gibt die Details des erstellten oder aktualisierten VirtualHub zurück.
201 Created	VirtualHub	Die Anforderung wurde erfolgreich empfangen. Gibt die Details des erstellten oder aktualisierten VirtualHub 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

VirtualHubPut

Sample Request

HTTP

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

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

Java

import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.fluent.models.VirtualHubInner;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for VirtualHubs CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubPut.json
     */
    /**
     * Sample code: VirtualHubPut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualHubPut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualHubs().createOrUpdate("rg1", "virtualHub2",
            new VirtualHubInner().withLocation("West US").withTags(mapOf("key1", "fakeTokenPlaceholder"))
                .withVirtualWan(new SubResource().withId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"))
                .withAddressPrefix("10.168.0.0/24").withSku("Basic"),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

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_put.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.begin_create_or_update(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub2",
        virtual_hub_parameters={
            "location": "West US",
            "properties": {
                "addressPrefix": "10.168.0.0/24",
                "sku": "Basic",
                "virtualWan": {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
                },
            },
            "tags": {"key1": "value1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubPut.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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubPut.json
func ExampleVirtualHubsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewVirtualHubsClient().BeginCreateOrUpdate(ctx, "rg1", "virtualHub2", armnetwork.VirtualHub{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
		Properties: &armnetwork.VirtualHubProperties{
			AddressPrefix: to.Ptr("10.168.0.0/24"),
			SKU:           to.Ptr("Basic"),
			VirtualWan: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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("virtualHub2"),
	// 	Type: to.Ptr("Microsoft.Network/virtualHubs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VirtualHubProperties{
	// 		AddressPrefix: to.Ptr("10.168.0.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

JavaScript

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

/**
 * 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/stable/2023-09-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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualHubPut.json
// this example is just showing the usage of "VirtualHubs_CreateOrUpdate" 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://learn.microsoft.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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualHubResource
VirtualHubCollection collection = resourceGroupResource.GetVirtualHubs();

// invoke the operation
string virtualHubName = "virtualHub2";
VirtualHubData data = new VirtualHubData()
{
    VirtualWanId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
    AddressPrefix = "10.168.0.0/24",
    Sku = "Basic",
    Location = new AzureLocation("West US"),
    Tags =
    {
    ["key1"] = "value1",
    },
};
ArmOperation<VirtualHubResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, virtualHubName, data);
VirtualHubResource result = lro.Value;

// 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/virtualHub2",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "virtualHub2",
  "type": "Microsoft.Network/virtualHubs",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    },
    "virtualHubRouteTableV2s": [],
    "addressPrefix": "10.168.0.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
    }
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "virtualHub2",
  "type": "Microsoft.Network/virtualHubs",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    },
    "virtualHubRouteTableV2s": [],
    "addressPrefix": "10.168.0.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
PreferredRoutingGateway	Die bevorzugten Routinggatewaytypen
ProvisioningState	Der aktuelle Bereitstellungsstatus.
RoutingState	Der aktuelle Routingstatus von VirtualHub.
SubResource	Verweis auf eine andere Unterressource.
VirtualHub	VirtualHub-Ressource.
VirtualHubRoute	VirtualHub-Route.
VirtualHubRouteTable	VirtualHub-Routingtabelle.
VirtualHubRouteTableV2	VirtualHubRouteTableV2-Ressource.
VirtualHubRouteV2	VirtualHubRouteTableV2-Route.
VirtualRouterAutoScaleConfiguration	Die Konfiguration der automatischen Skalierung des VirtualHub-Routers.

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, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

HubRoutingPreference

Gatewaytypen der Hubroutingpräferenz

Name	Typ	Beschreibung
ASPath	string
ExpressRoute	string
VpnGateway	string

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 von VirtualHub.

Name	Typ	Beschreibung
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Verweis 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-Portal Erfahrung 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	Das expressRouteGateway, das diesem VirtualHub zugeordnet ist.
properties.hubRoutingPreference	HubRoutingPreference	Die 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 diesem virtuellen Hub zugeordnete routeTable.
properties.routingState	RoutingState	Der Routingzustand.
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 virtuellen Hub-Routingtabellen v2, die diesem VirtualHub zugeordnet sind.
properties.virtualRouterAsn	integer	VirtualRouter ASN.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	Die Konfiguration der automatischen Skalierung des VirtualHub-Routers.
properties.virtualRouterIps	string[]	VirtualRouter-IP-Adressen.
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	Der Ressourcentyp.

VirtualHubRoute

VirtualHub-Route.

Name	Typ	Beschreibung
addressPrefixes	string[]	Liste aller AddressPrefixes.
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 Routingtabelle v2-Ressource 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 der automatischen Skalierung des VirtualHub-Routers.

Name	Typ	Beschreibung
minCapacity	integer	Die Mindestanzahl von Skalierungseinheiten für Den VirtualHub-Router.