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

スポンサーリンク

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

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

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

New-AzureRmTrafficManagerEndpoint コマンドレット


名前


New-AzureRmTrafficManagerEndpoint

概要

Traffic Manager プロファイル内にエンドポイントを作成します。

構文

New-AzureRmTrafficManagerEndpoint
  [-DefaultProfile <IAzureContextContainer>]
  [-EndpointLocation <String>]
  -EndpointStatus {Enabled | Disabled}
  [-GeoMapping <System.Collections.Generic.List`1[System.String]>]
  [-MinChildEndpoints <UInt32>]
  -Name <String> [-Priority <UInt32>]
  -ProfileName <String>
  -ResourceGroupName <String>
  [-Target <String>]
  [-TargetResourceId <String>]
  -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints}
  [-Weight <UInt32>]
  [<CommonParameters>]

説明


New-AzureRmTrafficManagerEndpoint コマンドレットは、Azure Traffic Manager プロファイル内にエンドポイントを作成します。

このコマンドレットは、Traffic Manager サービスにそれぞれの新しいエンドポイントに反映します。ローカル Traffic Manager プロファイル オブジェクトに複数のエンドポイントを追加し、1回の操作で変更を反映するには、Add-AzureRmTrafficManagerEndpointConfig コマンドレットを用います。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-EndpointLocation <String>

Performance トラフィック ルーティング方式で使用するエンドポイントの場所を指定します。このパラメーターは、ExternalEndpoints もしくは NestedEndpoints の型のエンドポイントでのみ利用可能です。Performance トラフィック ルーティング方式が使用される場合、このパラメーターを指定する必要があります。

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

必須false
位置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

-Name <String>

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

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

-Priority <UInt32>

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

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

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

-ProfileName <String>

このコマンドレットがエンドポイントを追加する、Traffic Manager プロファイル名を指定します。プロファイルを取得するには、New-AzureRmTrafficManagerProfile、もしくは Get-AzureRmTrafficManagerProfile コマンドレットを用います。

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

-ResourceGroupName <String>

このコマンドレットは、このパラメーターが指定するグループに Traffic Manager エンドポイントを作成します。

必須true
位置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

-Type <String>

このコマンドレットが Traffic 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.TrafficManager.Models.TrafficManagerEndpoint

メモ

  • なし

例 1 : プロファイルの外部エンドポイントを作成する

コマンド

 New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Target "www.contoso.com" -Weight 10 

コマンドの説明

このコマンドは、リソース グループ ResourceGroup11 内のプロファイル ContosoProfile の外部エンドポイント consoto を作成します。

例 2 : プロファイルの Azure エンドポイントを作成する

コマンド

 New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10 

コマンドの説明

このコマンドは、リソース グループ ResouceGroup11 内のプロファイル ContosoProfile の Azure エンドポイント contoso を作成します。Azure エンドポイントは、Azure Resource Manager ID が TargetResourceId 内の URI パスによって与えられる Azure Web App を指します。このコマンドでは、Web App リソースが場所を提供するため、EndpointLocation パラメーターは指定していません。

関連するリンク

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

参考