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

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

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

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

Set-AzureRmTrafficManagerProfile コマンドレット

名前

Set-AzureRmTrafficManagerProfile

概要

Traffic Manager プロファイルを更新します。

構文

Set-AzureRmTrafficManagerProfile
[-DefaultProfile <IAzureContextContainer>]
-TrafficManagerProfile <TrafficManagerProfile>
[<CommonParameters>]

説明

Set-AzureRmTrafficManagerProfile コマンドレットは、Azure Traffic Manager プロファイルを更新します。このコマンドレットは、ローカルプロファイルオブジェクトからプロファイル設定を更新します。TrafficManagerProfile パラメーターを用いるか、パイプラインを用いてプロファイルオブジェクトを指定します。

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

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-TrafficManagerProfile <TrafficManagerProfile>

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

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

<CommonParameters>

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

入力

Microsoft.Azure.Commands.Network.TrafficManagerProfile

このコマンドレットは、TrafficManagerProfile オブジェクトを受け入れます。

出力

Microsoft.Azure.Commands.Network.TrafficManagerProfile

このコマンドレットは、TrafficManagerProfile オブジェクトを返します。

メモ

なし

例

例 1 : プロファイルを更新する

コマンド

$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
$TrafficManagerProfile.ProfileStatus = Disabled
Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile