Microsoft.Network virtualHubs 2023-06-01

[アーティクル]
05/08/2024

Bicep リソース定義

virtualHubs リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.Network/virtualHubs リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Network/virtualHubs@2023-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    addressPrefix: 'string'
    allowBranchToBranchTraffic: bool
    azureFirewall: {
      id: 'string'
    }
    expressRouteGateway: {
      id: 'string'
    }
    hubRoutingPreference: 'string'
    p2SVpnGateway: {
      id: 'string'
    }
    preferredRoutingGateway: 'string'
    routeTable: {
      routes: [
        {
          addressPrefixes: [
            'string'
          ]
          nextHopIpAddress: 'string'
        }
      ]
    }
    securityPartnerProvider: {
      id: 'string'
    }
    securityProviderName: 'string'
    sku: 'string'
    virtualHubRouteTableV2s: [
      {
        id: 'string'
        name: 'string'
        properties: {
          attachedConnections: [
            'string'
          ]
          routes: [
            {
              destinations: [
                'string'
              ]
              destinationType: 'string'
              nextHops: [
                'string'
              ]
              nextHopType: 'string'
            }
          ]
        }
      }
    ]
    virtualRouterAsn: int
    virtualRouterAutoScaleConfiguration: {
      minCapacity: int
    }
    virtualRouterIps: [
      'string'
    ]
    virtualWan: {
      id: 'string'
    }
    vpnGateway: {
      id: 'string'
    }
  }
}

プロパティ値

virtualHubs

名前	説明	値
name	リソース名	string (必須)
location	リソースの場所。	string
tags	リソースタグ。	タグの名前と値のディクショナリ。「テンプレート内のタグ」を参照してください
properties	仮想ハブのプロパティ。	VirtualHubProperties

VirtualHubProperties

名前	説明	値
addressPrefix	この VirtualHub のアドレスプレフィックス。	string
allowBranchToBranchTraffic	VirtualRouter ハブの転送を制御するためのフラグ。	[bool]
azureFirewall	この VirtualHub に関連付けられている azureFirewall。	サブリソース
expressRouteGateway	この VirtualHub に関連付けられている expressRouteGateway。	サブリソース
hubRoutingPreference	この VirtualHub の hubRoutingPreference。	'ASPath' 'ExpressRoute' 'VpnGateway'
p2SVpnGateway	この VirtualHub に関連付けられている P2SVpnGateway。	サブリソース
preferredRoutingGateway	オンプレミストラフィックをルーティングするための優先ゲートウェイ	'ExpressRoute' 'None' 'VpnGateway'
routeTable	この仮想ハブに関連付けられている routeTable。	VirtualHubRouteTable
securityPartnerProvider	この VirtualHub に関連付けられている securityPartnerProvider。	サブリソース
securityProviderName	セキュリティプロバイダー名。	string
sku	この VirtualHub の SKU。	string
virtualHubRouteTableV2s	この VirtualHub に関連付けられているすべての仮想ハブルートテーブル v2 の一覧。	VirtualHubRouteTableV2[]
virtualRouterAsn	VirtualRouter ASN。	INT 制約: 最小値 = 0 最大値 = 4294967295
virtualRouterAutoScaleConfiguration	VirtualHub ルーターの自動スケーリング構成。	VirtualRouterAutoScaleConfiguration
virtualRouterIps	VirtualRouter IP。	string[]
virtualWan	VirtualHub が属する VirtualWAN。	サブリソース
vpnGateway	この VirtualHub に関連付けられている VpnGateway。	サブリソース

サブリソース

名前	説明	値
id	リソースの ID	string

VirtualHubRouteTable

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

VirtualHubRoute

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

VirtualHubRouteTableV2

名前	説明	値
id	リソースの ID	string
name	リソースグループ内で一意のリソースの名前。この名前は、リソースへのアクセスに使用できます。	string
properties	仮想ハブルートテーブル v2 のプロパティ。	VirtualHubRouteTableV2Properties

VirtualHubRouteTableV2Properties

名前	説明	値
attachedConnections	このルートテーブル v2 にアタッチされているすべての接続の一覧。	string[]
ルート	すべてのルートの一覧。	VirtualHubRouteV2[]

VirtualHubRouteV2

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

VirtualRouterAutoScaleConfiguration

名前	説明	値
minCapacity	VirtualHub Router のスケールユニットの最小数。	INT 制約: 最小値 = 0

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
セキュリティ保護付き仮想ハブ	このテンプレートでは、Azure Firewallを使用してセキュリティで保護された仮想ハブを作成し、インターネット宛てのクラウドネットワークトラフィックをセキュリティで保護します。
新しいサブネットでルートサーバーをCreateする	このテンプレートは、RouteServerSubnet という名前のサブネットにルートサーバーをデプロイします。
Quagga を使用した BGP ピアリングでの Azure Route Server	このテンプレートでは、Quagga を使用してルーターサーバーと Ubuntu VM をデプロイします。ルーターサーバーと Quagga の間に 2 つの外部 BGP セッションが確立されます。 Quagga のインストールと構成は、Linux 用の Azure カスタムスクリプト拡張機能によって実行されます
Virtual WAN リソースを作成します	このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。
Azure Virtual WAN ルーティングの意図とポリシー	このテンプレートは、ルーティングインテントとポリシー機能が有効になっている 2 つのハブを持つ Azure Virtual WANをプロビジョニングします。
Azure Virtual WAN (vWAN) マルチハブデプロイ	このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブデプロイを作成できます。
カスタムルーティングテーブルを使用した Azure vWAN マルチハブデプロイ	このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブデプロイを作成し、カスタムルーティング用のルートテーブルの使用方法を示すことができます。

ARM テンプレートリソース定義

virtualHubs リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.Network/virtualHubs リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Network/virtualHubs",
  "apiVersion": "2023-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "addressPrefix": "string",
    "allowBranchToBranchTraffic": "bool",
    "azureFirewall": {
      "id": "string"
    },
    "expressRouteGateway": {
      "id": "string"
    },
    "hubRoutingPreference": "string",
    "p2SVpnGateway": {
      "id": "string"
    },
    "preferredRoutingGateway": "string",
    "routeTable": {
      "routes": [
        {
          "addressPrefixes": [ "string" ],
          "nextHopIpAddress": "string"
        }
      ]
    },
    "securityPartnerProvider": {
      "id": "string"
    },
    "securityProviderName": "string",
    "sku": "string",
    "virtualHubRouteTableV2s": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "attachedConnections": [ "string" ],
          "routes": [
            {
              "destinations": [ "string" ],
              "destinationType": "string",
              "nextHops": [ "string" ],
              "nextHopType": "string"
            }
          ]
        }
      }
    ],
    "virtualRouterAsn": "int",
    "virtualRouterAutoScaleConfiguration": {
      "minCapacity": "int"
    },
    "virtualRouterIps": [ "string" ],
    "virtualWan": {
      "id": "string"
    },
    "vpnGateway": {
      "id": "string"
    }
  }
}

プロパティ値

virtualHubs

名前	説明	値
type	リソースの種類	'Microsoft.Network/virtualHubs'
apiVersion	リソース API のバージョン	'2023-06-01'
name	リソース名	string (必須)
location	リソースの場所。	string
tags	リソースタグ。	タグの名前と値のディクショナリ。「テンプレート内のタグ」を参照してください
properties	仮想ハブのプロパティ。	VirtualHubProperties

VirtualHubProperties

名前	説明	値
addressPrefix	この VirtualHub のアドレスプレフィックス。	string
allowBranchToBranchTraffic	VirtualRouter ハブの転送を制御するためのフラグ。	[bool]
azureFirewall	この VirtualHub に関連付けられている azureFirewall。	サブリソース
expressRouteGateway	この VirtualHub に関連付けられている expressRouteGateway。	サブリソース
hubRoutingPreference	この VirtualHub の hubRoutingPreference。	'ASPath' 'ExpressRoute' 'VpnGateway'
p2SVpnGateway	この VirtualHub に関連付けられている P2SVpnGateway。	サブリソース
preferredRoutingGateway	オンプレミストラフィックをルーティングするための優先ゲートウェイ	'ExpressRoute' 'None' 'VpnGateway'
routeTable	この仮想ハブに関連付けられている routeTable。	VirtualHubRouteTable
securityPartnerProvider	この VirtualHub に関連付けられている securityPartnerProvider。	サブリソース
securityProviderName	セキュリティプロバイダー名。	string
sku	この VirtualHub の SKU。	string
virtualHubRouteTableV2s	この VirtualHub に関連付けられているすべての仮想ハブルートテーブル v2 の一覧。	VirtualHubRouteTableV2[]
virtualRouterAsn	VirtualRouter ASN。	INT 制約: 最小値 = 0 最大値 = 4294967295
virtualRouterAutoScaleConfiguration	VirtualHub ルーターの自動スケーリング構成。	VirtualRouterAutoScaleConfiguration
virtualRouterIps	VirtualRouter IP。	string[]
virtualWan	VirtualHub が属する VirtualWAN。	サブリソース
vpnGateway	この VirtualHub に関連付けられている VpnGateway。	サブリソース

サブリソース

名前	説明	値
id	リソースの ID	string

VirtualHubRouteTable

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

VirtualHubRoute

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

VirtualHubRouteTableV2

名前	説明	値
id	リソースの ID	string
name	リソースグループ内で一意のリソースの名前。この名前は、リソースへのアクセスに使用できます。	string
properties	仮想ハブルートテーブル v2 のプロパティ。	VirtualHubRouteTableV2Properties

VirtualHubRouteTableV2Properties

名前	説明	値
attachedConnections	このルートテーブル v2 にアタッチされているすべての接続の一覧。	string[]
ルート	すべてのルートの一覧。	VirtualHubRouteV2[]

VirtualHubRouteV2

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

VirtualRouterAutoScaleConfiguration

名前	説明	値
minCapacity	VirtualHub Router のスケールユニットの最小数。	INT 制約: 最小値 = 0

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
セキュリティ保護付き仮想ハブ	このテンプレートでは、Azure Firewallを使用してセキュリティで保護された仮想ハブを作成し、インターネット宛てのクラウドネットワークトラフィックをセキュリティで保護します。
新しいサブネットでルートサーバーをCreateする	このテンプレートは、RouteServerSubnet という名前のサブネットにルートサーバーをデプロイします。
Quagga を使用した BGP ピアリングでの Azure Route Server	このテンプレートでは、Quagga を使用してルーターサーバーと Ubuntu VM をデプロイします。ルーターサーバーと Quagga の間に 2 つの外部 BGP セッションが確立されます。 Quagga のインストールと構成は、Linux 用の Azure カスタムスクリプト拡張機能によって実行されます
Virtual WAN リソースを作成します	このテンプレートを使用すると、Virtual WAN、Virtual Hub、VPN Gateway、VPN サイト、VPN Connecton などの仮想 WAN リソースを作成できます。
Azure Virtual WAN ルーティングの意図とポリシー	このテンプレートでは、ルーティングインテントとポリシー機能が有効になっている 2 つのハブを使用して Azure Virtual WANをプロビジョニングします。
Azure Virtual WAN (vWAN) マルチハブデプロイ	このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブデプロイを作成できます。
カスタムルーティングテーブルを使用した Azure vWAN マルチハブデプロイ	このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブデプロイを作成し、カスタムルーティングのルートテーブルの使用方法を示すことができます。

Terraform (AzAPI プロバイダー) リソース定義

virtualHubs リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.Network/virtualHubs リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs@2023-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      addressPrefix = "string"
      allowBranchToBranchTraffic = bool
      azureFirewall = {
        id = "string"
      }
      expressRouteGateway = {
        id = "string"
      }
      hubRoutingPreference = "string"
      p2SVpnGateway = {
        id = "string"
      }
      preferredRoutingGateway = "string"
      routeTable = {
        routes = [
          {
            addressPrefixes = [
              "string"
            ]
            nextHopIpAddress = "string"
          }
        ]
      }
      securityPartnerProvider = {
        id = "string"
      }
      securityProviderName = "string"
      sku = "string"
      virtualHubRouteTableV2s = [
        {
          id = "string"
          name = "string"
          properties = {
            attachedConnections = [
              "string"
            ]
            routes = [
              {
                destinations = [
                  "string"
                ]
                destinationType = "string"
                nextHops = [
                  "string"
                ]
                nextHopType = "string"
              }
            ]
          }
        }
      ]
      virtualRouterAsn = int
      virtualRouterAutoScaleConfiguration = {
        minCapacity = int
      }
      virtualRouterIps = [
        "string"
      ]
      virtualWan = {
        id = "string"
      }
      vpnGateway = {
        id = "string"
      }
    }
  })
}

プロパティ値

virtualHubs

名前	説明	値
type	リソースの種類	"Microsoft.Network/virtualHubs@2023-06-01"
name	リソース名	string (必須)
location	リソースの場所。	string
parent_id	リソースグループにデプロイするには、そのリソースグループの ID を使用します。	string (必須)
tags	リソースタグ。	タグ名と値のディクショナリ。
properties	仮想ハブのプロパティ。	VirtualHubProperties

VirtualHubProperties

名前	説明	値
addressPrefix	この VirtualHub のアドレスプレフィックス。	string
allowBranchToBranchTraffic	VirtualRouter ハブの転送を制御するためのフラグ。	[bool]
azureFirewall	この VirtualHub に関連付けられている azureFirewall。	サブリソース
expressRouteGateway	この VirtualHub に関連付けられている expressRouteGateway。	サブリソース
hubRoutingPreference	この VirtualHub の hubRoutingPreference。	"ASPath" "ExpressRoute" "VpnGateway"
p2SVpnGateway	この VirtualHub に関連付けられている P2SVpnGateway。	サブリソース
preferredRoutingGateway	オンプレミストラフィックをルーティングするための優先ゲートウェイ	"ExpressRoute" "None" "VpnGateway"
routeTable	この仮想ハブに関連付けられている routeTable。	VirtualHubRouteTable
securityPartnerProvider	この VirtualHub に関連付けられている securityPartnerProvider。	サブリソース
securityProviderName	セキュリティプロバイダー名。	string
sku	この VirtualHub の SKU。	string
virtualHubRouteTableV2s	この VirtualHub に関連付けられているすべての仮想ハブルートテーブル v2 の一覧。	VirtualHubRouteTableV2[]
virtualRouterAsn	VirtualRouter ASN。	INT 制約: 最小値 = 0 最大値 = 4294967295
virtualRouterAutoScaleConfiguration	VirtualHub ルーターの自動スケーリング構成。	VirtualRouterAutoScaleConfiguration
virtualRouterIps	VirtualRouter IP。	string[]
virtualWan	VirtualHub が属する VirtualWAN。	サブリソース
vpnGateway	この VirtualHub に関連付けられている VpnGateway。	サブリソース

サブリソース

名前	説明	値
id	リソースの ID	string

VirtualHubRouteTable

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

VirtualHubRoute

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

VirtualHubRouteTableV2

名前	説明	値
id	リソースの ID	string
name	リソースグループ内で一意のリソースの名前。この名前は、リソースへのアクセスに使用できます。	string
properties	仮想ハブルートテーブル v2 のプロパティ。	VirtualHubRouteTableV2Properties

VirtualHubRouteTableV2Properties

名前	説明	値
attachedConnections	このルートテーブル v2 に接続されているすべての接続の一覧。	string[]
ルート	すべてのルートの一覧。	VirtualHubRouteV2[]

VirtualHubRouteV2

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

VirtualRouterAutoScaleConfiguration

名前	説明	値
minCapacity	VirtualHub ルーターのスケールユニットの最小数。	INT 制約: 最小値 = 0

次の方法で共有

Microsoft.Network virtualHubs 2023-06-01

Bicep リソース定義

リソース形式

プロパティ値

virtualHubs

VirtualHubProperties

サブリソース

VirtualHubRouteTable

VirtualHubRoute

VirtualHubRouteTableV2

VirtualHubRouteTableV2Properties

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

クイック スタート テンプレート

ARM テンプレート リソース定義

リソース形式

プロパティ値

virtualHubs

VirtualHubProperties

サブリソース

VirtualHubRouteTable

VirtualHubRoute

VirtualHubRouteTableV2

VirtualHubRouteTableV2Properties

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

virtualHubs

VirtualHubProperties

サブリソース

VirtualHubRouteTable

VirtualHubRoute

VirtualHubRouteTableV2

VirtualHubRouteTableV2Properties

VirtualHubRouteV2

VirtualRouterAutoScaleConfiguration

フィードバック

その他のリソース

クイックスタートテンプレート

ARM テンプレートリソース定義

クイックスタートテンプレート