Azure Traffic Manager で使用できる Azure PowerShell コマンドレット (Set-AzureRmTrafficManagerEndpoint) について

Azure を含むデータセンターのサービス エンドポイントへのユーザー トラフィックの分散が制御可能な Azure Traffic の管理について、Azure ポータルだけではなく、Azure PowerShell や Azure CLI でも操作が可能になっています。

Azure PowerShell における Azure Traffic Manager の管理は、ドキュメントにも公開されていますが、使用するパラメーターに関しては現状、英語の情報のみとなっているため、日本語訳 (意訳) してみました。

ここでは、Set-AzureRmTrafficManagerEndpoint コマンドレットのヘルプ情報について、「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※Azure Traffic Manager で使用できる Azure PowerShell コマンドレット一覧については、「Azure Traffic Manager で使用できる Azure PowerShell コマンドレット一覧について」を参照。

Set-AzureRmTrafficManagerEndpoint コマンドレット


名前


Set-AzureRmTrafficManagerEndpoint

概要

Traffic Manager エンドポイントを更新します。

構文

Set-AzureRmTrafficManagerEndpoint
  [-DefaultProfile <IAzureContextContainer>]
  -TrafficManagerEndpoint <TrafficManagerEndpoint>
  [<CommonParameters>]

説明


Set-AzureRmTrafficManagerEndpoint コマンドレットは、Azure Traffic Manager 内のエンドポイントを更新します。このコマンドレットは、ローカル エンドポイント オブジェクトから設定を更新します。TrafficManagerEndpoint パラメーターを用いる、もしくはパイプラインを用いてエンドポイント オブジェクトを指定することが可能です。

Get-AzureRmTrafficManagerEndpoint コマンドレットを用いることでエンドポイントを示すローカル オブジェクトの取得が可能です。ローカル上でオブジェクトを変更し、Set-AzureRmTrafficManagerEndpoint コマンドレットを用いて変更を反映します。

パラメーター

-DefaultProfile <IAzureContextContainer>

Azure と通信するために使用される資格情報、アカウント、テナント、およびサブスクリプション情報を指定します。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-TrafficManagerEndpoint <TrafficManagerEndpoint>

ローカル TrafficManagerEndpoint オブジェクトを指定します。このコマンドレットは、このローカル オブジェクトに合致する Traffic Manager を更新します。

必須true
位置named
既定値None
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。

入力

  • Microsoft.Azure.Commands.Network.TrafficManagerEndpoint
    • このコマンドレットは、TrafficManagerEndpoint オブジェクトを受け入れます。

出力

  • Microsoft.Azure.Commands.Network.TrafficManagerEndpoint
    • このコマンドレットは、TrafficManagerEndpoint オブジェクトを返します。

メモ

  • なし

例 1 : エンドポイントを更新する

コマンド
$TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "endpoint1" -Type AzureEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11"
$TrafficManagerEndpoint.Weight = 20
Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint
コマンドの説明

最初のコマンドは、Get-AzureRmTrafficManagerEndpoint コマンドレットを用いて Azure Traffic Manager エンドポイントの情報を取得、変数 $TrafficManagerEndpoint にローカル上のエンドポイントを格納します。

2番目のコマンドは、ローカル上のエンドポイントを更新します。このコマンドは エンドポイントの重み付けを 20 に変更します。

最後のコマンドは、$TrafficManagerEndpoint 内のローカルの値に合致する Traffic Manager のエンドポイントを更新します。

関連するリンク

  • なし

参考

Azure PowerShell Azure Traffic Manager Microsoft Azure
タイトルとURLをコピーしました