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

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

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

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

Get-AzureRmTrafficManagerProfile コマンドレット


名前


Get-AzureRmTrafficManagerProfile

概要

Traffic Manager プロファイル情報を取得します。

構文

Get-AzureRmTrafficManagerProfile
  [-DefaultProfile <IAzureContextContainer>]
  [-Name <String>]
  [-ResourceGroupName <String>]
  [<CommonParameters>]

説明


Get-AzureRmTrafficManagerProfile コマンドレットは、Azure Traffic Manager プロファイル情報を取得、プロファイルを示すオブジェクトを返します。プロファイル名およびリソース グループ名を指定します。

このオブジェクトをローカル上で修正し、Set-AzureRmTrafficManagerProfile コマンドレットを用いてプロファイルの変更を適用することが可能です。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-Name <String>

このコマンドレットが取得する、Traffic Manager プロファイル名を指定します。

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

-ResourceGroupName <String>

このコマンドレットが取得する、Traffic Manager プロファイルが含まれるリソース グループ名を指定します。

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

<CommonParameters>

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

入力

  • なし

出力

  • Microsoft.Azure.Commands.Network.TrafficManagerProfile
    • このコマンドレットは、TrafficManagerProfile オブジェクトを返します。このオブジェクトを修正し、Set-AzureRmTrafficManagerProfile を用いて Traffic Manager に変更を適用することが可能です。

メモ

  • なし

例 1 : プロファイル情報を取得します

コマンド

 Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"

コマンドの説明

このコマンドは、ResourceGroup11 内のプロファイル ContosoProfile の情報を取得します。

関連するリンク

  • Disable-AzureRmTrafficManagerProfile
  • Enable-AzureRmTrafficManagerProfile
  • New-AzureRmTrafficManagerProfile
  • Remove-AzureRmTrafficManagerProfile
  • Set-AzureRmTrafficManagerProfile

参考

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