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

スポンサーリンク

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

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

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

Get-AzureRmTrafficManagerEndpoint コマンドレット


名前


Get-AzureRmTrafficManagerEndpoint

概要

Traffic Manager プロファイルのエンドポイント情報を取得します。

構文

Get-AzureRmTrafficManagerEndpoint
  [-DefaultProfile <IAzureContextContainer>]
  -Name <String>
  -ProfileName <String>
  -ResourceGroupName <String>
  -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints}
  [<CommonParameters>]

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

説明


Get-AzureRmTrafficManagerEndpoint コマンドレットは、Azure Traffic Manager プロファイルのエンドポイント情報を取得します。

このオブジェクトをローカル上で修正することが可能、および Set-AzureRmTrafficManagerEndpoint コマンドレットを用いてプロファイルの変更を適用することができます。Name および Type パラメーターを用いてエンドポイントを指定します。ProfileName および ResourceGroupName パラメーターを用いる、もしくは TrafficManagerProfile オブジェクトを指定することのどちらかによって Traffic Manager プロファイルを指定することが可能です。または、パイプラインを用いて値を渡すことも可能です。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-Name <String>

このコマンドレットが取得する Traffic Manager エンドポイント名を指定します。

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

-ProfileName <String>

このコマンドレットが取得する、Traffic Manager エンドポイント名を指定します。

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

-ResourceGroupName <String>

リソース グループ名を指定します。このコマンドレットは、このパラメーターを指定したグループ内の Traffic Manager エンドポイントを取得します。

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

-TrafficManagerEndpoint <TrafficManagerEndpoint>

このコマンドレットが取得する、Traffic Manager エンドポイントを指定します。

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

-Type <String>

このコマンドレットが Traffic Manager プロファイルに追加する、エンドポイントの型を指定します。有効な値は、次のとおり :

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

<CommonParameters>

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

入力

  • TrafficManagerEndpoint
    • パラメーター ‘TrafficManagerEndpoint’ は、パイプラインから型 ‘TrafficManagerEndpoint’ の値を受け入れます。

出力

  • Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint

メモ

  • なし

例 1 : エンドポイント情報を取得する

コマンド

 $TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints 

コマンドの説明

このコマンドは、リソース グループ ResourceGroup11 内のプロファイル ContosoProfile から Azure エンドポイント contoso の情報を取得、変数 $TrafficManagerEndpoint にオブジェクトを格納します。

関連するリンク

  • Disable-AzureRmTrafficManagerEndpoint
  • Enable-AzureRmTrafficManagerEndpoint
  • New-AzureRmTrafficManagerEndpoint
  • Remove-AzureRmTrafficManagerEndpoint
  • Set-AzureRmTrafficManagerEndpoint

参考