Virtual Hubs - Create Or Update

參考

服務:: Virtual WAN

API 版本:: 2024-05-01

如果不存在，請建立 VirtualHub 資源，否則會更新現有的 VirtualHub。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	VirtualHub 的資源組名。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
virtualHubName	path	True	string	VirtualHub 的名稱。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源位置。
id		string	資源標識碼。
properties.addressPrefix		string	此 VirtualHub 的位址前置詞。
properties.allowBranchToBranchTraffic		boolean	旗標以控制 VirtualRouter 中樞的傳輸。
properties.azureFirewall		SubResource	與此 VirtualHub 相關聯的 azureFirewall。
properties.expressRouteGateway		SubResource	與此 VirtualHub 相關聯的 expressRouteGateway。
properties.hubRoutingPreference		HubRoutingPreference	此 VirtualHub 的 hubRoutingPreference。
properties.p2SVpnGateway		SubResource	與此 VirtualHub 相關聯的 P2SVpnGateway。
properties.preferredRoutingGateway		PreferredRoutingGateway	路由內部部署流量的慣用閘道
properties.routeTable		VirtualHubRouteTable	與此虛擬中樞相關聯的 routeTable。
properties.securityPartnerProvider		SubResource	與此 VirtualHub 相關聯的 securityPartnerProvider。
properties.securityProviderName		string	安全性提供者名稱。
properties.sku		string	此 VirtualHub 的 SKU。
properties.virtualHubRouteTableV2s		VirtualHubRouteTableV2[]	與此 VirtualHub 相關聯的所有虛擬中樞路由表 v2 清單。
properties.virtualRouterAsn		integer	VirtualRouter ASN。
properties.virtualRouterAutoScaleConfiguration		VirtualRouterAutoScaleConfiguration	VirtualHub Router 自動調整設定。
properties.virtualRouterIps		string[]	VirtualRouter IP。
properties.virtualWan		SubResource	VirtualHub 所屬的 VirtualWAN。
properties.vpnGateway		SubResource	與此 VirtualHub 相關聯的 VpnGateway。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	VirtualHub	要求成功。傳回 VirtualHub 建立或更新的詳細數據。
201 Created	VirtualHub	已成功收到要求。傳回 VirtualHub 建立或更新的詳細數據。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

VirtualHubPut

範例要求

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

範例回覆

狀態碼:: 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
    }
  }
}

狀態碼:: 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
    }
  }
}

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
HubRoutingPreference	中樞路由喜好設定閘道類型
PreferredRoutingGateway	慣用路由網關類型
ProvisioningState	目前的布建狀態。
RoutingState	VirtualHub 目前的路由狀態。
SubResource	另一個子資源的參考。
VirtualHub	VirtualHub 資源。
VirtualHubRoute	VirtualHub 路由。
VirtualHubRouteTable	VirtualHub 路由表。
VirtualHubRouteTableV2	VirtualHubRouteTableV2 資源。
VirtualHubRouteV2	VirtualHubRouteTableV2 路由。
VirtualRouterAutoScaleConfiguration	VirtualHub Router 自動調整設定。

CloudError

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

HubRoutingPreference

中樞路由喜好設定閘道類型

名稱	類型	Description
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

慣用路由網關類型

名稱	類型	Description
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

目前的布建狀態。

名稱	類型	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

VirtualHub 目前的路由狀態。

名稱	類型	Description
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

另一個子資源的參考。

名稱	類型	Description
id	string	資源標識碼。

VirtualHub

VirtualHub 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
kind	string	服務虛擬中樞的種類。這是路由伺服器的 Azure 入口網站體驗所使用的元數據。
location	string	資源位置。
name	string	資源名稱。
properties.addressPrefix	string	此 VirtualHub 的位址前置詞。
properties.allowBranchToBranchTraffic	boolean	旗標以控制 VirtualRouter 中樞的傳輸。
properties.azureFirewall	SubResource	與此 VirtualHub 相關聯的 azureFirewall。
properties.bgpConnections	SubResource[]	Bgp 連線的參考清單。
properties.expressRouteGateway	SubResource	與此 VirtualHub 相關聯的 expressRouteGateway。
properties.hubRoutingPreference	HubRoutingPreference	此 VirtualHub 的 hubRoutingPreference。
properties.ipConfigurations	SubResource[]	IpConfigurations 的參考清單。
properties.p2SVpnGateway	SubResource	與此 VirtualHub 相關聯的 P2SVpnGateway。
properties.preferredRoutingGateway	PreferredRoutingGateway	路由內部部署流量的慣用閘道
properties.provisioningState	ProvisioningState	虛擬中樞資源的布建狀態。
properties.routeMaps	SubResource[]	RouteMaps 的參考清單。
properties.routeTable	VirtualHubRouteTable	與此虛擬中樞相關聯的 routeTable。
properties.routingState	RoutingState	路由狀態。
properties.securityPartnerProvider	SubResource	與此 VirtualHub 相關聯的 securityPartnerProvider。
properties.securityProviderName	string	安全性提供者名稱。
properties.sku	string	此 VirtualHub 的 SKU。
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	與此 VirtualHub 相關聯的所有虛擬中樞路由表 v2 清單。
properties.virtualRouterAsn	integer	VirtualRouter ASN。
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	VirtualHub Router 自動調整設定。
properties.virtualRouterIps	string[]	VirtualRouter IP。
properties.virtualWan	SubResource	VirtualHub 所屬的 VirtualWAN。
properties.vpnGateway	SubResource	與此 VirtualHub 相關聯的 VpnGateway。
tags	object	資源標籤。
type	string	資源類型。

VirtualHubRoute

VirtualHub 路由。

名稱	類型	Description
addressPrefixes	string[]	所有 addressPrefixes 的清單。
nextHopIpAddress	string	NextHop ip 位址。

VirtualHubRouteTable

VirtualHub 路由表。

名稱	類型	Description
routes	VirtualHubRoute[]	所有路由的清單。

VirtualHubRouteTableV2

VirtualHubRouteTableV2 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
name	string	資源群組內唯一的資源名稱。此名稱可用來存取資源。
properties.attachedConnections	string[]	附加至此路由表 v2 的所有連線清單。
properties.provisioningState	ProvisioningState	虛擬中樞路由表 v2 資源的布建狀態。
properties.routes	VirtualHubRouteV2[]	所有路由的清單。

VirtualHubRouteV2

VirtualHubRouteTableV2 路由。

名稱	類型	Description
destinationType	string	目的地的類型。
destinations	string[]	所有目的地的清單。
nextHopType	string	下一個躍點的類型。
nextHops	string[]	NextHops ip 位址。

VirtualRouterAutoScaleConfiguration

VirtualHub Router 自動調整設定。

名稱	類型	Description
minCapacity	integer	VirtualHub Router 的縮放單位數目下限。

共用方式為

Virtual Hubs - Create Or Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

VirtualHubPut

範例要求

範例回覆

定義

CloudError

CloudErrorBody

HubRoutingPreference

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

其他資源