Set-AzureTrafficManagerEndpoint

Traffic Manager プロファイル内のエンドポイントのプロパティを更新します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

Set-AzureTrafficManagerEndpoint
   -DomainName <String>
   [-Location <String>]
   [-Type <String>]
   [-Status <String>]
   [-Weight <Int32>]
   [-MinChildEndpoints <Int32>]
   -TrafficManagerProfile <IProfileWithDefinition>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

説明

Set-AzureTrafficManagerEndpoint コマンドレットは、Microsoft Azure Traffic Manager プロファイル内のエンドポイントのプロパティを更新します。 現在のプロファイルにエンドポイントが存在しない場合、このコマンドレットによって作成されます。 エンドポイントを追加した後、パイプライン 演算子を使用して Set-AzureTrafficManagerProfile コマンドレットに結果を渡します。 このコマンドレットは Azure に接続して変更を保存します。

例 1: プロファイルのエンドポイントを更新する

PS C:\>$TrafficManagerProfile = Get-AzureTrafficManagerProfile -Name "ContosoProfile"
PS C:\> Set-AzureTrafficManagerEndpoint -TrafficManagerProfile $TrafficManagerProfile -DomainName "ContosoApp02.cloudapp.net" -Status "Enabled" -Type "CloudService" -Weight 2 -Location myLocation | Set-AzureTrafficManagerProfile

最初のコマンドでは、 Get-AzureTrafficManagerProfile コマンドレットを使用して ContosoProfile という名前のプロファイルを取得し、$TrafficManagerProfile変数に格納します。

2 番目のコマンドは、$TrafficManagerProfileに格納されている Traffic Manager プロファイル内のエンドポイントを更新します。 エンドポイントにはドメイン名 ContosoApp02.cloudapp.net があります。 このコマンドでは、エンドポイントの状態、種類、重み、および場所も指定します。 このコマンドは、変更されたプロファイルを Set-AzureTrafficManagerProfile コマンドレットに渡して Azure に接続し、変更を保存します。

パラメーター

-DomainName

変更するエンドポイントのドメイン名を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Location

コマンドレットによって追加されるエンドポイントの場所を指定します。 これは Azure の場所である必要があります。

このパラメーターには、負荷分散方法が "Performance" に設定されているプロファイル内の "Any" 型または種類 "TrafficManager" のエンドポイントの値を含める必要があります。 使用可能な値は、次に示すように https://azure.microsoft.com/regions/https://azure.microsoft.com/regions/、Azure リージョン名です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-MinChildEndpoints

このエンドポイントをオンラインと見なすために、入れ子になったプロファイルがオンラインにする必要があるエンドポイントの最小数を指定します。

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

型:AzureSMProfile
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Status

監視エンドポイントの状態を指定します。 有効な値は次の通りです。

  • Enabled
  • 無効

[有効] の値を指定した場合、Traffic Manager はエンドポイントを監視し、負荷分散方法はトラフィックを管理するときにそれを考慮します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-TrafficManagerProfile

エンドポイントを変更する Traffic Manager プロファイル オブジェクトを指定します。

型:IProfileWithDefinition
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Type

エンドポイントの種類を指定します。 有効な値は次の通りです。

  • CloudService

  • AzureWebsite

  • TrafficManager

  • [任意]

複数の AzureWebsite エンドポイントがある場合、エンドポイントは異なるデータセンターに存在する必要があります。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Weight

コマンドレットによって追加されるエンドポイントの重みを指定します。 このパラメーターの有効な値の範囲は [1,1000] です。

このパラメーターは、RoundRobin 負荷分散ポリシーにのみ使用されます。

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

出力

Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition

このコマンドレットは、更新されたプロファイルに関する情報を含む Traffic Manager プロファイル オブジェクトを生成します。