Virtual Hubs - Create Or Update

Référence

Service:: Virtual WAN

Version d'API:: 2024-05-01

Crée une ressource VirtualHub s’il n’existe pas d’autre mise à jour de VirtualHub existante.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources du VirtualHub.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
virtualHubName	path	True	string	Nom du VirtualHub.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement des ressources.
id		string	ID de ressource.
properties.addressPrefix		string	Préfixe d’adresse pour ce VirtualHub.
properties.allowBranchToBranchTraffic		boolean	Indicateur pour contrôler le transit pour le hub VirtualRouter.
properties.azureFirewall		SubResource	AzureFirewall associé à ce VirtualHub.
properties.expressRouteGateway		SubResource	ExpressRouteGateway associé à ce VirtualHub.
properties.hubRoutingPreference		HubRoutingPreference	HubRoutingPreference de ce VirtualHub.
properties.p2SVpnGateway		SubResource	P2SVpnGateway associé à ce VirtualHub.
properties.preferredRoutingGateway		PreferredRoutingGateway	Passerelle préférée pour acheminer le trafic local
properties.routeTable		VirtualHubRouteTable	RouteTable associé à ce hub virtuel.
properties.securityPartnerProvider		SubResource	SecurityPartnerProvider associé à ce VirtualHub.
properties.securityProviderName		string	Nom du fournisseur de sécurité.
properties.sku		string	Référence SKU de ce VirtualHub.
properties.virtualHubRouteTableV2s		VirtualHubRouteTableV2[]	Liste de toutes les tables de routage de hub virtuel v2 associées à ce VirtualHub.
properties.virtualRouterAsn		integer	ASN VirtualRouter.
properties.virtualRouterAutoScaleConfiguration		VirtualRouterAutoScaleConfiguration	Configuration de la mise à l’échelle automatique du routeur VirtualHub.
properties.virtualRouterIps		string[]	Adresses IP VirtualRouter.
properties.virtualWan		SubResource	VirtualWAN auquel appartient VirtualHub.
properties.vpnGateway		SubResource	VpnGateway associé à ce VirtualHub.
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	VirtualHub	Demande réussie. Retourne les détails du VirtualHub créé ou mis à jour.
201 Created	VirtualHub	Demande reçue avec succès. Retourne les détails du VirtualHub créé ou mis à jour.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

VirtualHubPut

Exemple de requête

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2?api-version=2024-05-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"
  }
}


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/2024-05-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

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/2024-05-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

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/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/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

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/2024-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

Exemple de réponse

Code d’état:: 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
    }
  }
}

Code d’état:: 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
    }
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
HubRoutingPreference	Types de passerelle de préférence de routage hub
PreferredRoutingGateway	Types de passerelle de routage préférés
ProvisioningState	État d’approvisionnement actuel.
RoutingState	État de routage actuel du VirtualHub.
SubResource	Référence à une autre sous-ressource.
VirtualHub	Ressource VirtualHub.
VirtualHubRoute	Itinéraire VirtualHub.
VirtualHubRouteTable	Table de routage VirtualHub.
VirtualHubRouteTableV2	Ressource VirtualHubRouteTableV2.
VirtualHubRouteV2	Itinéraire VirtualHubRouteTableV2.
VirtualRouterAutoScaleConfiguration	Configuration de la mise à l’échelle automatique du routeur VirtualHub.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

HubRoutingPreference

Types de passerelle de préférence de routage hub

Nom	Type	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

Types de passerelle de routage préférés

Nom	Type	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

État de routage actuel du VirtualHub.

Nom	Type	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

Référence à une autre sous-ressource.

Nom	Type	Description
id	string	ID de ressource.

VirtualHub

Ressource VirtualHub.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
kind	string	Type de hub virtuel de service. Il s’agit des métadonnées utilisées pour l’expérience du portail Azure pour le serveur de routage.
location	string	Emplacement des ressources.
name	string	Nom de la ressource.
properties.addressPrefix	string	Préfixe d’adresse pour ce VirtualHub.
properties.allowBranchToBranchTraffic	boolean	Indicateur pour contrôler le transit pour le hub VirtualRouter.
properties.azureFirewall	SubResource	AzureFirewall associé à ce VirtualHub.
properties.bgpConnections	SubResource[]	Liste des références aux connexions Bgp.
properties.expressRouteGateway	SubResource	ExpressRouteGateway associé à ce VirtualHub.
properties.hubRoutingPreference	HubRoutingPreference	HubRoutingPreference de ce VirtualHub.
properties.ipConfigurations	SubResource[]	Liste des références à IpConfigurations.
properties.p2SVpnGateway	SubResource	P2SVpnGateway associé à ce VirtualHub.
properties.preferredRoutingGateway	PreferredRoutingGateway	Passerelle préférée pour acheminer le trafic local
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de hub virtuel.
properties.routeMaps	SubResource[]	Liste des références à RouteMaps.
properties.routeTable	VirtualHubRouteTable	RouteTable associé à ce hub virtuel.
properties.routingState	RoutingState	État de routage.
properties.securityPartnerProvider	SubResource	SecurityPartnerProvider associé à ce VirtualHub.
properties.securityProviderName	string	Nom du fournisseur de sécurité.
properties.sku	string	Référence SKU de ce VirtualHub.
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	Liste de toutes les tables de routage de hub virtuel v2 associées à ce VirtualHub.
properties.virtualRouterAsn	integer	ASN VirtualRouter.
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	Configuration de la mise à l’échelle automatique du routeur VirtualHub.
properties.virtualRouterIps	string[]	Adresses IP VirtualRouter.
properties.virtualWan	SubResource	VirtualWAN auquel appartient VirtualHub.
properties.vpnGateway	SubResource	VpnGateway associé à ce VirtualHub.
tags	object	Balises de ressource.
type	string	Type de ressource.

VirtualHubRoute

Itinéraire VirtualHub.

Nom	Type	Description
addressPrefixes	string[]	Liste de toutes les adressesPrefixes.
nextHopIpAddress	string	Adresse IP NextHop.

VirtualHubRouteTable

Table de routage VirtualHub.

Nom	Type	Description
routes	VirtualHubRoute[]	Liste de tous les itinéraires.

VirtualHubRouteTableV2

Ressource VirtualHubRouteTableV2.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.attachedConnections	string[]	Liste de toutes les connexions attachées à cette table de routage v2.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de la table de routage de hub virtuel v2.
properties.routes	VirtualHubRouteV2[]	Liste de tous les itinéraires.

VirtualHubRouteV2

Itinéraire VirtualHubRouteTableV2.

Nom	Type	Description
destinationType	string	Type de destinations.
destinations	string[]	Liste de toutes les destinations.
nextHopType	string	Type de tronçons suivants.
nextHops	string[]	Adresse IP NextHops.

VirtualRouterAutoScaleConfiguration

Configuration de la mise à l’échelle automatique du routeur VirtualHub.

Nom	Type	Description
minCapacity	integer	Nombre minimal d’unités d’échelle pour VirtualHub Router.

Partager via

Virtual Hubs - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

VirtualHubPut

Exemple de requête

Exemple de réponse

Définitions

CloudError

CloudErrorBody

HubRoutingPreference

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

Ressources supplémentaires