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 パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	VirtualHub のリソースグループ名。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
virtualHubName	path	True	string	VirtualHub の名前。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースの場所。
id		string	リソース ID。
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 ルーターの自動スケール構成。
properties.virtualRouterIps		string[]	VirtualRouter IP。
properties.virtualWan		SubResource	VirtualHub が属する VirtualWAN。
properties.vpnGateway		SubResource	この VirtualHub に関連付けられている VpnGateway。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	VirtualHub	要求が成功しました。作成または更新された VirtualHub の詳細を返します。
201 Created	VirtualHub	要求が正常に受信されました。作成または更新された VirtualHub の詳細を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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
    }
  }
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
HubRoutingPreference	ハブルーティング優先ゲートウェイの種類
PreferredRoutingGateway	優先ルーティングゲートウェイの種類
ProvisioningState	現在のプロビジョニング状態。
RoutingState	VirtualHub の現在のルーティング状態。
SubResource	別のサブリソースへの参照。
VirtualHub	VirtualHub リソース。
VirtualHubRoute	VirtualHub ルート。
VirtualHubRouteTable	VirtualHub ルートテーブル。
VirtualHubRouteTableV2	VirtualHubRouteTableV2 リソース。
VirtualHubRouteV2	VirtualHubRouteTableV2 ルート。
VirtualRouterAutoScaleConfiguration	VirtualHub ルーターの自動スケール構成。

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

HubRoutingPreference

ハブルーティング優先ゲートウェイの種類

名前	型	説明
ASPath	string
ExpressRoute	string
VpnGateway	string

PreferredRoutingGateway

優先ルーティングゲートウェイの種類

名前	型	説明
ExpressRoute	string
None	string
VpnGateway	string

ProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingState

VirtualHub の現在のルーティング状態。

名前	型	説明
Failed	string
None	string
Provisioned	string
Provisioning	string

SubResource

別のサブリソースへの参照。

名前	型	説明
id	string	リソース ID。

VirtualHub

VirtualHub リソース。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
kind	string	サービス仮想ハブの種類。これは、Route Server の Azure portal エクスペリエンスに使用されるメタデータです。
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 ルーターの自動スケール構成。
properties.virtualRouterIps	string[]	VirtualRouter IP。
properties.virtualWan	SubResource	VirtualHub が属する VirtualWAN。
properties.vpnGateway	SubResource	この VirtualHub に関連付けられている VpnGateway。
tags	object	リソースタグ。
type	string	リソースの種類。

VirtualHubRoute

VirtualHub ルート。

名前	型	説明
addressPrefixes	string[]	すべての addressPrefixes の一覧。
nextHopIpAddress	string	NextHop IP アドレス。

VirtualHubRouteTable

VirtualHub ルートテーブル。

名前	型	説明
routes	VirtualHubRoute[]	すべてのルートの一覧。

VirtualHubRouteTableV2

VirtualHubRouteTableV2 リソース。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.attachedConnections	string[]	このルートテーブル v2 に接続されているすべての接続の一覧。
properties.provisioningState	ProvisioningState	仮想ハブルートテーブル v2 リソースのプロビジョニング状態。
properties.routes	VirtualHubRouteV2[]	すべてのルートの一覧。

VirtualHubRouteV2

VirtualHubRouteTableV2 ルート。

名前	型	説明
destinationType	string	変換先の種類。
destinations	string[]	すべての宛先の一覧。
nextHopType	string	次ホップの種類。
nextHops	string[]	NextHops IP アドレス。

VirtualRouterAutoScaleConfiguration

VirtualHub ルーターの自動スケール構成。

名前	型	説明
minCapacity	integer	VirtualHub ルーターのスケールユニットの最小数。

次の方法で共有

Virtual Hubs - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

VirtualHubPut

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

HubRoutingPreference

PreferredRoutingGateway

ProvisioningState

RoutingState

SubResource

VirtualHub

VirtualHubRoute

VirtualHubRouteTable

VirtualHubRouteTableV2

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

その他のリソース