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

スポンサーリンク

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

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

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

Add-AzureRmTrafficManagerEndpointConfig コマンドレット

名前

Add-AzureRmTrafficManagerEndpointConfig

概要

ローカル Traffic Manager プロファイル オブジェクトにエンドポイントを追加します。

構文

Add-AzureRmTrafficManagerEndpointConfig
   [-DefaultProfile <IAzureContextContainer>]
   [-EndpointLocation <String>]
   -EndpointName <String>
   -EndpointStatus {Enabled | Disabled}
   [-GeoMapping <System.Collections.Generic.List`1[System.String]>]
   [-MinChildEndpoints <UInt32>]
   [-Priority <UInt32>]
   [-Target <String>]
   [-TargetResourceId <String>]
   -TrafficManagerProfile <TrafficManagerProfile>
   -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints}
   [-Weight <UInt32>]
   [<CommonParameters>]

説明

Add-AzureRmTrafficManagerEndpointConfig コマンドレットは、ローカル Traffic Manager プロファイル オブジェクトにエンドポイントを追加します。New-AzureRmTrafficManagerProfile コマンドレット、もしくは Get-AzureRmTrafficManagerProfile コマンドレットを用いることでプロファイルの取得が可能です。

このコマンドレットは、ローカル プロファイル オブジェクトを操作します。Set-AzureRmTrafficManagerProfile コマンドレットを用いて Traffic Manager プロファイルの変更を反映する必要があります。1回の操作でエンドポイントを作成、変更を反映するには、New-AzureRmTrafficManagerEndpoint コマンドレットを使用します。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-EndpointLocation <String>

Performance トラフィック ルーティング方式内で使用するためにエンドポイントの場所を指定します。このパラメーターは、ExternalEndpoints および NestedEndpoints の型のみ適用されます。Performance トラフィック ルーティング方式が使用されている場合、このパラメーターを指定する必要があります。

Azure リージョン名を指定します。Azure リージョンの完全な一覧については、Azure Regions を参照してください。

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

-EndpointName <String>

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

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

-EndpointStatus <String>

エンドポイントの状態を指定します。有効な値は、次のとおり :

  • Enabled
  • Disabled

状態が Enabled の場合、エンドポイントは、エンドポイント正常性をプローブし、トラフィック ルーティング方式内に含まれます。

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

-GeoMapping <System.Collections.Generic.List`1[System.String]>

‘Geographic’ トラフィック ルーティング方式を用いる場合、このエンドポイントにマッピングされるリージョンの一覧を指定します。受け入れることができる値の完全な一覧については、Traffic Manager のマニュアルを参照してください。

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

-MinChildEndpoints <UInt32>

Azure リージョン名を指定します。Azure リージョンの完全な一覧については、Azure Regions を参照してください。

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

-Priority <UInt32>

Traffic Manager にエンドポイントを割り当てる優先順位の値を指定します。このパラメーターは、Traffic Manager プロファイルが Priority トラフィック ルーティング方式で構成されている場合のみ使用します。有効な値は、1 から 1000 までの整数です。低い値が、高い優先順位を示します。

優先順位を指定した場合、プロファイル内のすべてのエンドポイントで優先順位を指定する必要があり、同じ優先順位の値を 2つのエンドポイントで共有することはできません。優先順位を指定しない場合、Traffic Manager がエンドポイントに割り当てる既定の優先順位の値は、プロファイルがエンドポイントをリストしている順に 1 から開始されます。

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

-Target <String>

エンドポイントの完全修飾 DNS 名を指定します。このエンドポイントにトラフィックを直接向ける場合、Traffic Manager は DNS 応答としてこの値を返します。このパラメーターは、ExternalEndpoints エンドポイントの型に対してのみ指定します。他のエンドポイントの型の場合、代わりに TargetResourceId パラメーターを指定します。

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

-TargetResourceId <String>

対象のリソース ID を指定します。このパラメーターは、AzureEndpoints および NestedEndpoints エンドポイントの型に対してのみ指定します。ExternalEndpoints エンドポイントの型の場合、代わりに Target パラメーターを指定します。

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

-TrafficManagerProfile <TrafficManagerProfile>

ローカル TrafficManagerProfile オブジェクトを指定します。このコマンドレットは、このローカル オブジェクトを修正します。TrafficManagerProfile オブジェクトを取得するには、Get-AzureRmTrafficManagerProfile コマンドレットを用います。

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

-Type <String>

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

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

-Weight <UInt32>

Traffic Manager がエンドポイントに割り当てる重み付けの値を指定します。有効な値は、1 から 1000 までの整数です。既定の値は 1 です。このパラメーターは、Traffic Manager プロファイルが Weighted トラフィック ルーティング方式で設定されている場合にのみ使用されます。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可する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"
Add-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -EndpointStatus Enabled -Target "www.contoso.com" -TrafficManagerProfile $TrafficManagerProfile -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Weight 10
Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile
コマンドの説明

最初のコマンドは、Get-AzureRmTrafficManagerProfile コマンドレットを用いて Azure Traffic Manager プロファイルを取得、変数 $TrafficManagerProfile にローカル プロファイルを格納します。

2番目のコマンドは、$TrafficManagerProfile に格納されたプロファイルにエンドポイント consoto を追加します。このコマンドは、エンドポイントの構成データを含んでおり、ローカル オブジェクトのみを変更します。

最後のコマンドは、$TrafficManagerProfile 内のローカルの値に合致した Azure Traffic Manager プロファイルを更新します。

関連するリンク

  • Get-AzureRmTrafficManagerProfile
  • New-AzureRmTrafficManagerEndpoint
  • Remove-AzureRmTrafficManagerEndpointConfig
  • Set-AzureRmTrafficManagerProfile

参考