Hub Virtual Network Connections - Create Or Update

Service:: Virtual WAN

Version d'API:: 2025-05-01

Crée une connexion au réseau virtuel hub si elle n’existe pas, sinon met à jour la connexion existante.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
connectionName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
virtualHubName	path	True	string	Le nom du Virtual Hub.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
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.allowHubToRemoteVnetTransit	boolean	Déconseillé : VirtualHub vers remoteVnet transit to enabled or not.
properties.allowRemoteVnetToUseHubVnetGateways	boolean	Déconseillé : autoriser RemoteVnet à utiliser les passerelles du hub virtuel.
properties.enableInternetSecurity	boolean	Activer la sécurité Internet.
properties.remoteVirtualNetwork	Common.SubResource	Référence au réseau virtuel distant.
properties.routingConfiguration	RoutingConfiguration	Configuration du routage indiquant les tables de routage associées et propagées sur cette connexion.

Réponses

Nom	Type	Description
200 OK	HubVirtualNetworkConnection	Opération Azure terminée avec succès.
201 Created	HubVirtualNetworkConnection	Ressource 'HubVirtualNetworkConnection' créer l’opération réussie En-têtes Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	Common.CloudError	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

HubVirtualNetworkConnection

Opération Azure terminée avec succès.

201 Created

HubVirtualNetworkConnection

Ressource 'HubVirtualNetworkConnection' créer l’opération réussie

En-têtes

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

Common.CloudError

Réponse d’erreur inattendue.

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

HubVirtualNetworkConnectionPut

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

{
  "properties": {
    "enableInternetSecurity": false,
    "remoteVirtualNetwork": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
    },
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
      },
      "inboundRouteMap": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
      },
      "outboundRouteMap": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
      },
      "propagatedRouteTables": {
        "ids": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
          }
        ],
        "labels": [
          "label1",
          "label2"
        ]
      },
      "vnetRoutes": {
        "staticRoutes": [
          {
            "name": "route1",
            "addressPrefixes": [
              "10.1.0.0/16",
              "10.2.0.0/16"
            ],
            "nextHopIpAddress": "10.0.0.68"
          },
          {
            "name": "route2",
            "addressPrefixes": [
              "10.3.0.0/16",
              "10.4.0.0/16"
            ],
            "nextHopIpAddress": "10.0.0.65"
          }
        ],
        "staticRoutesConfig": {
          "vnetLocalRouteOverrideCriteria": "Equal"
        }
      }
    }
  }
}

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

/**
 * This sample demonstrates how to Creates a hub virtual network connection if it doesn't exist else updates the existing one.
 *
 * @summary Creates a hub virtual network connection if it doesn't exist else updates the existing one.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/HubVirtualNetworkConnectionPut.json
 */
async function hubVirtualNetworkConnectionPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const connectionName = "connection1";
  const hubVirtualNetworkConnectionParameters = {
    enableInternetSecurity: false,
    remoteVirtualNetwork: {
      id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1",
    },
    routingConfiguration: {
      associatedRouteTable: {
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1",
      },
      inboundRouteMap: {
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1",
      },
      outboundRouteMap: {
        id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2",
      },
      propagatedRouteTables: {
        ids: [
          {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1",
          },
        ],
        labels: ["label1", "label2"],
      },
      vnetRoutes: {
        staticRoutes: [
          {
            name: "route1",
            addressPrefixes: ["10.1.0.0/16", "10.2.0.0/16"],
            nextHopIpAddress: "10.0.0.68",
          },
          {
            name: "route2",
            addressPrefixes: ["10.3.0.0/16", "10.4.0.0/16"],
            nextHopIpAddress: "10.0.0.65",
          },
        ],
        staticRoutesConfig: { vnetLocalRouteOverrideCriteria: "Equal" },
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.hubVirtualNetworkConnections.beginCreateOrUpdateAndWait(
    resourceGroupName,
    virtualHubName,
    connectionName,
    hubVirtualNetworkConnectionParameters,
  );
  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

{
  "name": "connection1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1",
  "properties": {
    "enableInternetSecurity": false,
    "provisioningState": "Updating",
    "remoteVirtualNetwork": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
    },
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
      },
      "inboundRouteMap": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
      },
      "outboundRouteMap": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
      },
      "propagatedRouteTables": {
        "ids": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
          }
        ],
        "labels": [
          "label1",
          "label2"
        ]
      },
      "vnetRoutes": {
        "bgpConnections": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1"
          }
        ],
        "staticRoutes": [
          {
            "name": "route1",
            "addressPrefixes": [
              "10.1.0.0/16",
              "10.2.0.0/16"
            ],
            "nextHopIpAddress": "10.0.0.68"
          },
          {
            "name": "route2",
            "addressPrefixes": [
              "10.3.0.0/16",
              "10.4.0.0/16"
            ],
            "nextHopIpAddress": "10.0.0.65"
          }
        ],
        "staticRoutesConfig": {
          "propagateStaticRoutes": true,
          "vnetLocalRouteOverrideCriteria": "Equal"
        }
      }
    }
  }
}

Code d’état:: 201

{
  "name": "connection1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1",
  "properties": {
    "enableInternetSecurity": false,
    "provisioningState": "Updating",
    "remoteVirtualNetwork": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
    },
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
      },
      "inboundRouteMap": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
      },
      "outboundRouteMap": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
      },
      "propagatedRouteTables": {
        "ids": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
          }
        ],
        "labels": [
          "label1",
          "label2"
        ]
      },
      "vnetRoutes": {
        "bgpConnections": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1"
          }
        ],
        "staticRoutes": [
          {
            "name": "route1",
            "addressPrefixes": [
              "10.1.0.0/16",
              "10.2.0.0/16"
            ],
            "nextHopIpAddress": "10.0.0.68"
          },
          {
            "name": "route2",
            "addressPrefixes": [
              "10.3.0.0/16",
              "10.4.0.0/16"
            ],
            "nextHopIpAddress": "10.0.0.65"
          }
        ],
        "staticRoutesConfig": {
          "propagateStaticRoutes": true,
          "vnetLocalRouteOverrideCriteria": "Equal"
        }
      }
    }
  }
}

Définitions

Nom	Description
Common.CloudError	Une réponse d’erreur du service.
Common.CloudErrorBody	Une réponse d’erreur du service.
Common.SubResource	Référence à une autre sous-ressource.
HubVirtualNetworkConnection	Ressource HubVirtualNetworkConnection.
PropagatedRouteTable	Liste des RoutesTables pour publier les itinéraires vers.
ProvisioningState	État d’approvisionnement de la ressource.
RoutingConfiguration	Configuration de routage indiquant les tables de routage associées et propagées pour cette connexion.
StaticRoute	Liste de tous les itinéraires statiques.
StaticRoutesConfig	Configuration des itinéraires statiques sur ce HubVnetConnectionConfiguration pour les itinéraires statiques sur ce HubVnetConnection.
VnetLocalRouteOverrideCriteria	Paramètre déterminant si l’appliance virtuelle réseau dans le réseau virtuel spoke est ignorée pour le trafic avec destination dans le réseau virtuel spoke.
VnetRoute	Liste des itinéraires qui contrôlent le routage à partir de VirtualHub vers une connexion de réseau virtuel.

Common.CloudError

Objet

Une réponse d’erreur du service.

Nom	Type	Description
error	Common.CloudErrorBody	Corps de l’erreur Cloud.

Common.CloudErrorBody

Objet

Une 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	Common.CloudErrorBody[]	Une liste de 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.

Common.SubResource

Objet

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

Nom	Type	Description
id	string	ID de ressource.