Virtual Hubs - Update Tags

サービス:: Virtual WAN

API バージョン:: 2025-05-01

VirtualHub タグを更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前の大文字と小文字は区別されません。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
virtualHubName	path	True	string	VirtualHubの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
tags	object	リソースタグ。

応答

名前	型	説明
200 OK	VirtualHub	Azureの運用は無事に完了しました。
Other Status Codes	Common.CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

VirtualHubUpdate

要求のサンプル

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

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

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_update_tags.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="SUBSCRIPTION_ID",
    )

    response = client.virtual_hubs.update_tags(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub2",
        virtual_hub_parameters={"tags": {"key1": "value1", "key2": "value2"}},
    )
    print(response)


# x-ms-original-file: 2025-05-01/VirtualHubUpdateTags.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

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

/**
 * This sample demonstrates how to Updates VirtualHub tags.
 *
 * @summary Updates VirtualHub tags.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/VirtualHubUpdateTags.json
 */
async function virtualHubUpdate() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub2";
  const virtualHubParameters = {
    tags: { key1: "value1", key2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualHubs.updateTags(
    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

{
  "name": "virtualHub2",
  "type": "Microsoft.Network/virtualHubs",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
  "location": "West US",
  "properties": {
    "addressPrefix": "10.168.0.0/24",
    "allowBranchToBranchTraffic": false,
    "hubRoutingPreference": "ExpressRoute",
    "provisioningState": "Succeeded",
    "sku": "Basic",
    "virtualHubRouteTableV2s": [],
    "virtualRouterAsn": 65515,
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": 2
    },
    "virtualRouterIps": [
      "10.10.1.12",
      "10.10.1.13"
    ],
    "virtualWan": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
    }
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

定義

名前	説明
Common.CloudError	サービスからのエラー応答。
Common.CloudErrorBody	サービスからのエラー応答。
Common.SubResource	別のサブリソースへの参照。
HubRoutingPreference	ハブルーティング設定ゲートウェイの種類
PreferredRoutingGateway	優先ルーティングゲートウェイの種類
ProvisioningState	リソースのプロビジョニング状態。
RoutingState	VirtualHub の現在のルーティング状態。
TagsObject	パッチ操作用のオブジェクトにタグを付けます。
VirtualHub	VirtualHub リソース。
VirtualHubRoute	VirtualHub ルート。
VirtualHubRouteTable	VirtualHub ルートテーブル。
VirtualHubRouteTableV2	VirtualHubRouteTableV2 リソース。
VirtualHubRouteV2	VirtualHubRouteTableV2 ルート。
VirtualRouterAutoScaleConfiguration	VirtualHub ルーターの自動スケール構成。

Common.CloudError

Object

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

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

Common.CloudErrorBody

Object

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

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

Common.SubResource

Object

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

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

HubRoutingPreference

列挙

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

値	説明
ExpressRoute	ExpressRoute
VpnGateway	VpnGateway
ASPath	ASPath

PreferredRoutingGateway

列挙

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

値	説明
ExpressRoute	ExpressRoute
VpnGateway	VpnGateway
None	なし

ProvisioningState

列挙

リソースのプロビジョニング状態。

値	説明
Failed	失敗
Succeeded	成功しました
Canceled	取り消し済み
Creating	作成
Updating	更新中
Deleting	削除中

RoutingState

列挙

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

値	説明
None	なし
Provisioned	プロビジョニング済み
Provisioning	プロビジョニング
Failed	失敗

TagsObject

Object

パッチ操作用のオブジェクトにタグを付けます。

名前	型	説明
tags	object	リソースタグ。

VirtualHub

Object

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	Common.SubResource	この VirtualHub に関連付けられている azureFirewall。
properties.bgpConnections	Common.SubResource[]	Bgp 接続への参照のリスト。
properties.expressRouteGateway	Common.SubResource	この VirtualHub に関連付けられている expressRouteGateway。
properties.hubRoutingPreference	HubRoutingPreference	この VirtualHub の hubRoutingPreference。
properties.ipConfigurations	Common.SubResource[]	IpConfigurations への参照のリスト。
properties.p2SVpnGateway	Common.SubResource	この VirtualHub に関連付けられている P2SVpnGateway。
properties.preferredRoutingGateway	PreferredRoutingGateway	オンプレミストラフィックをルーティングするための優先ゲートウェイ
properties.provisioningState	ProvisioningState	仮想ハブリソースのプロビジョニング状態。
properties.routeMaps	Common.SubResource[]	RouteMaps への参照のリスト。
properties.routeTable	VirtualHubRouteTable	この仮想ハブに関連付けられている routeTable。
properties.routingState	RoutingState	ルーティング状態。
properties.securityPartnerProvider	Common.SubResource	この VirtualHub に関連付けられている securityPartnerProvider。
properties.securityProviderName	string	セキュリティプロバイダー名。
properties.sku	string	この VirtualHub の SKU。
properties.virtualHubRouteTableV2s	VirtualHubRouteTableV2[]	この VirtualHub に関連付けられているすべての仮想ハブルートテーブル v2 の一覧。
properties.virtualRouterAsn	integer (int64) minimum: 0 maximum: 4294967295	VirtualRouter ASN。
properties.virtualRouterAutoScaleConfiguration	VirtualRouterAutoScaleConfiguration	VirtualHub ルーターの自動スケール構成。
properties.virtualRouterIps	string[]	VirtualRouter IP。
properties.virtualWan	Common.SubResource	VirtualHub が属する VirtualWAN。
properties.vpnGateway	Common.SubResource	この VirtualHub に関連付けられている VpnGateway。
tags	object	リソースタグ。
type	string	リソースの種類。

VirtualHubRoute

Object

VirtualHub ルート。

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

VirtualHubRouteTable

Object

VirtualHub ルートテーブル。

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

VirtualHubRouteTableV2

Object

VirtualHubRouteTableV2 リソース。

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

VirtualHubRouteV2

Object

VirtualHubRouteTableV2 ルート。

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

VirtualRouterAutoScaleConfiguration

Object

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

名前	型	説明
minCapacity	integer (int32) minimum: 0	VirtualHub ルーターのスケールユニットの最小数。