Hub Virtual Network Connections - Create Or Update

Service:: Virtual WAN

API-versie:: 2025-05-01

Hiermee maakt u een virtuele hubnetwerkverbinding als deze niet bestaat, anders wordt de bestaande verbinding bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
connectionName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
virtualHubName	path	True	string	De naam van de Virtual Hub.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.allowHubToRemoteVnetTransit	boolean	Afgeschaft: Doorvoer van VirtualHub naar RemoteVnet naar ingeschakeld of niet.
properties.allowRemoteVnetToUseHubVnetGateways	boolean	Afgeschaft: ExternVnet toestaan om gateways van virtuele hubs te gebruiken.
properties.enableInternetSecurity	boolean	Internetbeveiliging inschakelen.
properties.remoteVirtualNetwork	Common.SubResource	Verwijzing naar het externe virtuele netwerk.
properties.routingConfiguration	RoutingConfiguration	De routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen op deze verbinding aangeeft.

Antwoorden

Name	Type	Description
200 OK	HubVirtualNetworkConnection	Azure-operatie succesvol voltooid.
201 Created	HubVirtualNetworkConnection	Resource 'HubVirtualNetworkConnection' aanmaakoperatie is geslaagd Kopteksten Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	Common.CloudError	Een onverwachte foutreactie.

Name

Type

Description

200 OK

HubVirtualNetworkConnection

Azure-operatie succesvol voltooid.

201 Created

HubVirtualNetworkConnection

Resource 'HubVirtualNetworkConnection' aanmaakoperatie is geslaagd

Kopteksten

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

Common.CloudError

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldrespons

Statuscode:: 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"
        }
      }
    }
  }
}

Statuscode:: 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"
        }
      }
    }
  }
}

Definities

Name	Description
Common.CloudError	Een foutreactie van de service.
Common.CloudErrorBody	Een foutreactie van de service.
Common.SubResource	Verwijzing naar een andere subresource.
HubVirtualNetworkConnection	HubVirtualNetworkConnection-resource.
PropagatedRouteTable	De lijst met RouteTables om de routes naar te adverteren.
ProvisioningState	De inrichtingsstatus van de resource.
RoutingConfiguration	Routeringsconfiguratie die de gekoppelde en doorgegeven routetabellen voor deze verbinding aangeeft.
StaticRoute	Lijst met alle statische routes.
StaticRoutesConfig	Configuratie voor statische routes op deze HubVnetConnectionConfiguration voor statische routes op deze HubVnetConnection.
VnetLocalRouteOverrideCriteria	Parameter die bepaalt of NVA in spoke vnet wordt omzeild voor verkeer met bestemming in spoke vnet.
VnetRoute	Lijst met routes die routering van VirtualHub naar een virtuele netwerkverbinding beheren.

Common.CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	Common.CloudErrorBody	Wolk fout lichaam.

Common.CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	Common.CloudErrorBody[]	Een lijst met aanvullende details over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

Common.SubResource

Object

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.