Microsoft.Network expressRouteGateways

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.Network/expressRouteGateways@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    allowNonVirtualWanTraffic: bool
    autoScaleConfiguration: {
      bounds: {
        max: int
        min: int
      }
    }
    expressRouteConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          authorizationKey: 'string'
          enableInternetSecurity: bool
          enablePrivateLinkFastPath: bool
          expressRouteCircuitPeering: {
            id: 'string'
          }
          expressRouteGatewayBypass: bool
          routingConfiguration: {
            associatedRouteTable: {
              id: 'string'
            }
            inboundRouteMap: {
              id: 'string'
            }
            outboundRouteMap: {
              id: 'string'
            }
            propagatedRouteTables: {
              ids: [
                {
                  id: 'string'
                }
              ]
              labels: [
                'string'
              ]
            }
            vnetRoutes: {
              staticRoutes: [
                {
                  addressPrefixes: [
                    'string'
                  ]
                  name: 'string'
                  nextHopIpAddress: 'string'
                }
              ]
              staticRoutesConfig: {
                vnetLocalRouteOverrideCriteria: 'string'
              }
            }
          }
          routingWeight: int
        }
      }
    ]
    virtualHub: {
      id: 'string'
    }
  }
}

プロパティ値

expressRouteGateways

名前 説明 値
name リソース名 string (必須)
location リソースの場所。 string
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties Express Route ゲートウェイのプロパティ。 ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

名前 説明 値
allowNonVirtualWanTraffic Virtual WAN以外のネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 [bool]
autoScaleConfiguration 自動スケーリングの構成。 ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections ExpressRoute ゲートウェイへの ExpressRoute 接続の一覧。 ExpressRouteConnection[]
virtualHub ExpressRoute ゲートウェイがデプロイされる仮想ハブ。またはデプロイされる仮想ハブ。 VirtualHubId (必須)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

名前 説明 値
bounds デプロイするスケール ユニットの最小数と最大数。 ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

名前 説明 値
max ExpressRoute ゲートウェイにデプロイされるスケール ユニットの最大数。 INT
分 ExpressRoute ゲートウェイにデプロイされるスケール ユニットの最小数。 INT

ExpressRouteConnection

名前 説明 値
id リソースの ID string
name リソースの名前。 string (必須)
properties 高速ルート接続のプロパティ。 ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

名前 説明 値
authorizationKey 接続を確立するための承認キー。 string
enableInternetSecurity インターネット セキュリティを有効にします。 [bool]
enablePrivateLinkFastPath プライベート リンクにアクセスするときは、ExpressRoute ゲートウェイをバイパスします。 ExpressRoute FastPath (expressRouteGatewayBypass) を有効にする必要があります。 [bool]
expressRouteCircuitPeering ExpressRoute 回線ピアリング。 ExpressRouteCircuitPeeringId (必須)
expressRouteGatewayBypass FastPath から vWan Firewall ハブを有効にします。 [bool]
routingConfiguration この接続に関連付けられた、伝達されたルート テーブルを示すルーティング構成。 RoutingConfiguration
routingWeight 接続に関連付けられているルーティングの重み。 INT

ExpressRouteCircuitPeeringId

名前 説明 値
id ExpressRoute 回線ピアリングの ID。 string

RoutingConfiguration

名前 説明 値
associatedRouteTable この RoutingConfiguration に関連付けられているリソース ID RouteTable。 サブリソース
inboundRouteMap 受信学習ルートのこの RoutingConfiguration に関連付けられている RouteMap のリソース ID。 サブリソース
outboundRouteMap 送信アドバタイズされたルートのこの RoutingConfiguration に関連付けられているRouteMap のリソース ID。 サブリソース
propagatedRouteTables ルートをアドバタイズする RouteTable の一覧。 PropagatedRouteTable
vnetRoutes VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。 VnetRoute

サブリソース

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

PropagatedRouteTable

名前 説明 値
ids すべての RouteTable のリソース ID の一覧。 SubResource[]
labels ラベルの一覧。 string[]

VnetRoute

名前 説明 値
staticRoutes すべての静的ルートの一覧。 StaticRoute[]
staticRoutesConfig この HubVnetConnection 上の静的ルートの構成。 StaticRoutesConfig

StaticRoute

名前 説明 値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
name VnetRoute 内で一意である StaticRoute の名前。 string
nextHopIpAddress 次ホップの IP アドレス。 string

StaticRoutesConfig

名前 説明 値
vnetLocalRouteOverrideCriteria スポーク vnet 内の NVA が、スポーク内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。 'Contains'
'Equal'

VirtualHubId

名前 説明 値
id ExpressRoute ゲートウェイがデプロイされる仮想ハブのリソース URI。 仮想ハブ リソースと ExpressRoute ゲートウェイ リソースは、同じサブスクリプションに存在します。 string

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

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

Template 説明
Azure Virtual WAN ルーティングの意図とポリシー

Azure にデプロイする		 このテンプレートでは、ルーティングインテントとポリシー機能が有効になっている 2 つのハブを使用して Azure Virtual WANをプロビジョニングします。
Azure Virtual WAN (vWAN) マルチハブデプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成できます。
カスタム ルーティング テーブルを使用した Azure vWAN マルチハブデプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成し、カスタム ルーティングのルート テーブルの使用方法を示すことができます。

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

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

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

リソース形式

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

{
  "type": "Microsoft.Network/expressRouteGateways",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "allowNonVirtualWanTraffic": "bool",
    "autoScaleConfiguration": {
      "bounds": {
        "max": "int",
        "min": "int"
      }
    },
    "expressRouteConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "authorizationKey": "string",
          "enableInternetSecurity": "bool",
          "enablePrivateLinkFastPath": "bool",
          "expressRouteCircuitPeering": {
            "id": "string"
          },
          "expressRouteGatewayBypass": "bool",
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "inboundRouteMap": {
              "id": "string"
            },
            "outboundRouteMap": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "ids": [
                {
                  "id": "string"
                }
              ],
              "labels": [ "string" ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "addressPrefixes": [ "string" ],
                  "name": "string",
                  "nextHopIpAddress": "string"
                }
              ],
              "staticRoutesConfig": {
                "vnetLocalRouteOverrideCriteria": "string"
              }
            }
          },
          "routingWeight": "int"
        }
      }
    ],
    "virtualHub": {
      "id": "string"
    }
  }
}

プロパティ値

expressRouteGateways

名前 説明 値
type リソースの種類 'Microsoft.Network/expressRouteGateways'
apiVersion リソース API のバージョン '2023-11-01'
name リソース名 string (必須)
location リソースの場所。 string
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties Express Route ゲートウェイのプロパティ。 ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

名前 説明 値
allowNonVirtualWanTraffic Virtual WAN以外のネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 [bool]
autoScaleConfiguration 自動スケーリングの構成。 ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections ExpressRoute ゲートウェイへの ExpressRoute 接続の一覧。 ExpressRouteConnection[]
virtualHub ExpressRoute ゲートウェイがデプロイされる仮想ハブ。またはデプロイされる仮想ハブ。 VirtualHubId (必須)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

名前 説明 値
bounds デプロイするスケール ユニットの最小数と最大数。 ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

名前 説明 値
max ExpressRoute ゲートウェイにデプロイされるスケール ユニットの最大数。 INT
分 ExpressRoute ゲートウェイにデプロイされるスケール ユニットの最小数。 INT

ExpressRouteConnection

名前 説明 値
id リソースの ID string
name リソースの名前。 string (必須)
properties 高速ルート接続のプロパティ。 ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

名前 説明 値
authorizationKey 接続を確立するための承認キー。 string
enableInternetSecurity インターネット セキュリティを有効にします。 [bool]
enablePrivateLinkFastPath プライベート リンクにアクセスするときは、ExpressRoute ゲートウェイをバイパスします。 ExpressRoute FastPath (expressRouteGatewayBypass) を有効にする必要があります。 [bool]
expressRouteCircuitPeering ExpressRoute 回線ピアリング。 ExpressRouteCircuitPeeringId (必須)
expressRouteGatewayBypass FastPath から vWan Firewall ハブを有効にします。 [bool]
routingConfiguration この接続に関連付けられているルート テーブルと伝達されたルート テーブルを示すルーティング構成。 RoutingConfiguration
routingWeight 接続に関連付けられているルーティングの重み。 INT

ExpressRouteCircuitPeeringId

名前 説明 値
id ExpressRoute 回線ピアリングの ID。 string

RoutingConfiguration

名前 説明 値
associatedRouteTable この RoutingConfiguration に関連付けられているリソース ID RouteTable。 サブリソース
inboundRouteMap 受信学習ルートのこの RoutingConfiguration に関連付けられている RouteMap のリソース ID。 サブリソース
outboundRouteMap 送信アドバタイズされたルートのこの RoutingConfiguration に関連付けられているRouteMap のリソース ID。 サブリソース
propagatedRouteTables ルートをアドバタイズする RouteTable の一覧。 伝達されたRouteTable
vnetRoutes VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。 VnetRoute

サブリソース

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

伝達されたRouteTable

名前 説明 値
ids すべての RouteTable のリソース ID の一覧。 SubResource[]
labels ラベルの一覧。 string[]

VnetRoute

名前 説明 値
staticRoutes すべての静的ルートの一覧。 StaticRoute[]
staticRoutesConfig この HubVnetConnection 上の静的ルートの構成。 StaticRoutesConfig

StaticRoute

名前 説明 値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
name VnetRoute 内で一意の StaticRoute の名前。 string
nextHopIpAddress 次ホップの IP アドレス。 string

StaticRoutesConfig

名前 説明 値
vnetLocalRouteOverrideCriteria スポーク vnet 内の NVA がスポーク内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。 'Contains'
'Equal'

VirtualHubId

名前 説明 値
id ExpressRoute ゲートウェイがデプロイされる仮想ハブのリソース URI。 Virtual Hub リソースと ExpressRoute ゲートウェイ リソースは、同じサブスクリプションに存在します。 string

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

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

Template 説明
Azure Virtual WAN ルーティングの意図とポリシー

Azure にデプロイする		 このテンプレートでは、ルーティングインテントとポリシー機能が有効になっている 2 つのハブを使用して Azure Virtual WANをプロビジョニングします。
Azure Virtual WAN (vWAN) マルチハブデプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成できます。
カスタム ルーティング テーブルを使用した Azure vWAN マルチハブデプロイ

Azure にデプロイする		 このテンプレートを使用すると、すべてのゲートウェイと VNET 接続を含む Azure Virtual WAN (vWAN) マルチハブ デプロイを作成し、カスタム ルーティングのルート テーブルの使用方法を示すことができます。

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/expressRouteGateways@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allowNonVirtualWanTraffic = bool
      autoScaleConfiguration = {
        bounds = {
          max = int
          min = int
        }
      }
      expressRouteConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            authorizationKey = "string"
            enableInternetSecurity = bool
            enablePrivateLinkFastPath = bool
            expressRouteCircuitPeering = {
              id = "string"
            }
            expressRouteGatewayBypass = bool
            routingConfiguration = {
              associatedRouteTable = {
                id = "string"
              }
              inboundRouteMap = {
                id = "string"
              }
              outboundRouteMap = {
                id = "string"
              }
              propagatedRouteTables = {
                ids = [
                  {
                    id = "string"
                  }
                ]
                labels = [
                  "string"
                ]
              }
              vnetRoutes = {
                staticRoutes = [
                  {
                    addressPrefixes = [
                      "string"
                    ]
                    name = "string"
                    nextHopIpAddress = "string"
                  }
                ]
                staticRoutesConfig = {
                  vnetLocalRouteOverrideCriteria = "string"
                }
              }
            }
            routingWeight = int
          }
        }
      ]
      virtualHub = {
        id = "string"
      }
    }
  })
}

プロパティ値

expressRouteGateways

名前 説明 値
type リソースの種類 "Microsoft.Network/expressRouteGateways@2023-11-01"
name リソース名 string (必須)
location リソースの場所。 string
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。
properties Express Route ゲートウェイのプロパティ。 ExpressRouteGatewayProperties

ExpressRouteGatewayProperties

名前 説明 値
allowNonVirtualWanTraffic Virtual WAN以外のネットワークからのトラフィックを受け入れるように、このゲートウェイを構成します。 [bool]
autoScaleConfiguration 自動スケーリングの構成。 ExpressRouteGatewayPropertiesAutoScaleConfiguration
expressRouteConnections ExpressRoute ゲートウェイへの ExpressRoute 接続の一覧。 ExpressRouteConnection[]
virtualHub ExpressRoute ゲートウェイがデプロイされる仮想ハブ。またはデプロイされる仮想ハブ。 VirtualHubId (必須)

ExpressRouteGatewayPropertiesAutoScaleConfiguration

名前 説明 値
bounds デプロイするスケール ユニットの最小数と最大数。 ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

ExpressRouteGatewayPropertiesAutoScaleConfigurationB...

名前 説明 値
max ExpressRoute ゲートウェイにデプロイされるスケール ユニットの最大数。 INT
分 ExpressRoute ゲートウェイにデプロイされるスケール ユニットの最小数。 INT

ExpressRouteConnection

名前 説明 値
id リソースの ID string
name リソースの名前。 string (必須)
properties 高速ルート接続のプロパティ。 ExpressRouteConnectionProperties

ExpressRouteConnectionProperties

名前 説明 値
authorizationKey 接続を確立するための承認キー。 string
enableInternetSecurity インターネット セキュリティを有効にします。 [bool]
enablePrivateLinkFastPath プライベート リンクにアクセスするときは、ExpressRoute ゲートウェイをバイパスします。 ExpressRoute FastPath (expressRouteGatewayBypass) を有効にする必要があります。 [bool]
expressRouteCircuitPeering ExpressRoute 回線ピアリング。 ExpressRouteCircuitPeeringId (必須)
expressRouteGatewayBypass FastPath から vWan Firewall ハブを有効にします。 [bool]
routingConfiguration この接続に関連付けられた、伝達されたルート テーブルを示すルーティング構成。 RoutingConfiguration
routingWeight 接続に関連付けられているルーティングの重み。 INT

ExpressRouteCircuitPeeringId

名前 説明 値
id ExpressRoute 回線ピアリングの ID。 string

RoutingConfiguration

名前 説明 値
associatedRouteTable この RoutingConfiguration に関連付けられているリソース ID RouteTable。 サブリソース
inboundRouteMap 受信学習ルートのこの RoutingConfiguration に関連付けられている RouteMap のリソース ID。 サブリソース
outboundRouteMap 送信アドバタイズされたルートのこの RoutingConfiguration に関連付けられているRouteMap のリソース ID。 サブリソース
propagatedRouteTables ルートをアドバタイズする RouteTable の一覧。 PropagatedRouteTable
vnetRoutes VirtualHub から仮想ネットワーク接続へのルーティングを制御するルートの一覧。 VnetRoute

サブリソース

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

PropagatedRouteTable

名前 説明 値
ids すべての RouteTable のリソース ID の一覧。 SubResource[]
labels ラベルの一覧。 string[]

VnetRoute

名前 説明 値
staticRoutes すべての静的ルートの一覧。 StaticRoute[]
staticRoutesConfig この HubVnetConnection 上の静的ルートの構成。 StaticRoutesConfig

StaticRoute

名前 説明 値
addressPrefixes すべてのアドレス プレフィックスの一覧。 string[]
name VnetRoute 内で一意である StaticRoute の名前。 string
nextHopIpAddress 次ホップの IP アドレス。 string

StaticRoutesConfig

名前 説明 値
vnetLocalRouteOverrideCriteria スポーク vnet 内の NVA が、スポーク内の宛先を持つトラフィックに対してバイパスされるかどうかを決定するパラメーター。 "Contains"
"等しい"

VirtualHubId

名前 説明 値
id ExpressRoute ゲートウェイがデプロイされる仮想ハブのリソース URI。 仮想ハブ リソースと ExpressRoute ゲートウェイ リソースは、同じサブスクリプションに存在します。 string