Add-AzureRmRouteConfig

ルート テーブルにルートを追加します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Add-AzureRmRouteConfig
   -RouteTable <PSRouteTable>
   [-Name <String>]
   [-AddressPrefix <String>]
   [-NextHopType <String>]
   [-NextHopIpAddress <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Add-AzureRmRouteConfig コマンドレットは、Azure ルート テーブルにルートを追加します。

例 1: ルート テーブルにルートを追加する

PS C:\>$RouteTable = Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01"
PS C:\> Add-AzureRmRouteConfig -Name "Route13" -AddressPrefix 10.3.0.0/16 -NextHopType "VnetLocal" -RouteTable $RouteTable

最初のコマンドは、Get-AzureRmRouteTable コマンドレットを使用して RouteTable01 という名前のルート テーブルを取得します。 このコマンドは、テーブルを $RouteTable 変数に格納します。 2 番目のコマンドは、$RouteTableに格納されているルート テーブルに Route13 という名前のルートを追加します。 このルートは、パケットをローカル仮想ネットワークに転送します。

例 2: パイプラインを使用してルート テーブルにルートを追加する

PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzureRmRouteConfig -Name "Route02" -AddressPrefix 10.2.0.0/16 -NextHopType VnetLocal | Set-AzureRmRouteTable
Name              : routetable01
ResourceGroupName : ResourceGroup11
Location          : eastus
Id                : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ
                    k/routeTables/routetable01
Etag              : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59"
ProvisioningState : Succeeded
Tags              : 
Routes            : [
                      {
                        "Name": "route07",
                        "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"",
                        "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro
                    soft.Network/routeTables/routetable01/routes/route07",
                        "AddressPrefix": "10.1.0.0/16",
                        "NextHopType": "VnetLocal",
                        "NextHopIpAddress": null, 
                        "ProvisioningState": "Succeeded"
                      },
                      {
                        "Name": "route02",
                        "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"",
                        "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro
                    soft.Network/routeTables/routetable01/routes/route02",
                        "AddressPrefix": "10.2.0.0/16",
                        "NextHopType": "VnetLocal",
                        "NextHopIpAddress": null, 
                        "ProvisioningState": "Succeeded"
                      },
                      {
                        "Name": "route13",
                        "Etag": null, 
                        "Id": null, 
                        "AddressPrefix": "10.3.0.0/16",
                        "NextHopType": "VnetLocal",
                        "NextHopIpAddress": null, 
                        "ProvisioningState": null
                      }
                    ] 
Subnets           : []

このコマンドは、Get-AzureRmRouteTable を使用 して RouteTable01 という名前のルート テーブルを取得します。 このコマンドは、パイプライン演算子を使用して、そのテーブルを現在のコマンドレットに渡します。 現在のコマンドレットは、Route02 という名前のルートを追加し、結果を Set-AzureRmRouteTable コマンドレットに渡します。これにより、変更を反映するようにテーブルが更新されます。

パラメーター

-AddressPrefix

ルートが適用される宛先を クラスレス ドメイン間ルーティング (CIDR) 形式で指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

ルート テーブルに追加するルートの名前を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NextHopIpAddress

Azure 仮想ネットワークに追加する仮想アプライアンスの IP アドレスを指定します。 このルートは、そのアドレスにパケットを転送します。 このパラメーターは、NextHopType パラメーターに VirtualAppliance の値を指定する 場合にのみ指定 します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-NextHopType

このルートがパケットを転送する方法を指定します。 このパラメーターの有効値は、次のとおりです。

  • インターネット。 Azure によって提供される既定のインターネット ゲートウェイ。
  • なし。 この値を指定した場合、ルートはパケットを転送しません。
  • VirtualAppliance。 Azure 仮想ネットワークに追加する仮想アプライアンス。
  • VirtualNetworkGateway。 Azure サーバー間仮想プライベート ネットワーク ゲートウェイ。
  • VnetLocal。 ローカル仮想ネットワーク。 同じ仮想ネットワークに 10.1.0.0/16 と 10.2.0.0/16 の 2 つのサブネットがある場合は、他のサブネットに転送するサブネットごとに VnetLocal の値を選択します。
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RouteTable

このコマンドレットがルートを追加するルート テーブルを指定します。

Type:PSRouteTable
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSRouteTable

String

出力

PSRouteTable