Hub Virtual Network Connections - Create Or Update

Tjänst:: Virtual WAN

API-version:: 2025-05-01

Skapar en virtuell hubbnätverksanslutning om den inte finns, annars uppdateras den befintliga.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
connectionName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
virtualHubName	path	True	string	Namnet på Virtual Hub.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.allowHubToRemoteVnetTransit	boolean	Inaktuell: VirtualHub till RemoteVnet-överföring till aktiverad eller inte.
properties.allowRemoteVnetToUseHubVnetGateways	boolean	Inaktuell: Tillåt att RemoteVnet använder Virtual Hubs gatewayer.
properties.enableInternetSecurity	boolean	Aktivera internetsäkerhet.
properties.remoteVirtualNetwork	Common.SubResource	Referens till det virtuella fjärrnätverket.
properties.routingConfiguration	RoutingConfiguration	Routningskonfigurationen som anger de associerade och spridade routningstabellerna i den här anslutningen.

Svar

Name	Typ	Description
200 OK	HubVirtualNetworkConnection	Azure-operationen slutfördes framgångsrikt.
201 Created	HubVirtualNetworkConnection	Resursen 'HubVirtualNetworkConnection' skapade operationen lyckades Sidhuvuden Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	Common.CloudError	Ett oväntat felsvar.

Name

Typ

Description

200 OK

HubVirtualNetworkConnection

Azure-operationen slutfördes framgångsrikt.

201 Created

HubVirtualNetworkConnection

Resursen 'HubVirtualNetworkConnection' skapade operationen lyckades

Sidhuvuden

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

Common.CloudError

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

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

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

Definitioner

Name	Description
Common.CloudError	Ett felsvar från tjänsten.
Common.CloudErrorBody	Ett felsvar från tjänsten.
Common.SubResource	Referens till en annan underresurs.
HubVirtualNetworkConnection	HubVirtualNetworkConnection-resurs.
PropagatedRouteTable	Listan med RouteTables som du vill annonsera vägarna till.
ProvisioningState	Resursens etableringstillstånd.
RoutingConfiguration	Routningskonfiguration som anger de associerade och distribuerade routningstabellerna för den här anslutningen.
StaticRoute	Lista över alla statiska vägar.
StaticRoutesConfig	Konfiguration för statiska vägar på detta HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.
VnetLocalRouteOverrideCriteria	Parameter som avgör om NVA i det virtuella ekernätverket kringgås för trafik med målet i det virtuella ekernätverket.
VnetRoute	Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.

Common.CloudError

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
error	Common.CloudErrorBody	Brödtext för molnfel.

Common.CloudErrorBody

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	Common.CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

Common.SubResource

Objekt

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.