Set-AzureTrafficManagerProfile

Traffic Manager プロファイルのプロパティを更新します。

Note

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

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

構文

Set-AzureTrafficManagerProfile
   [-Name <String>]
   [-LoadBalancingMethod <String>]
   [-MonitorPort <Int32>]
   [-MonitorProtocol <String>]
   [-MonitorRelativePath <String>]
   [-Ttl <Int32>]
   -TrafficManagerProfile <IProfileWithDefinition>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

説明

Set-AzureTrafficManagerProfile コマンドレットは、Microsoft Azure Traffic Manager プロファイルのプロパティを更新します。

LoadBalancingMethod 値を "Failover" に設定したプロファイルの場合、Add-AzureTrafficManagerEndpoint コマンドレットを使用して、プロファイルに追加したエンドポイントのフェールオーバー順序を決定できます。 詳細については、以下の例 3 を参照してください。

例 1: Traffic Manager プロファイルの TTL を設定する

PS C:\>Set-AzureTrafficManagerProfile -TrafficManagerProfile $MyTrafficManagerProfile -Ttl 60

このコマンドは、Traffic Manager プロファイル オブジェクト MyTrafficManagerProfile の TTL を 60 秒に設定します。

例 2: プロファイルに複数の値を設定する

PS C:\>Get-AzureTrafficManagerProfile -Name "MyProfile" | Set-AzureTrafficManagerProfile -LoadBalancingMethod "RoundRobin" -Ttl 30 -MonitorProtocol "Http" -MonitorPort 80 -MonitorRelativePath "/"

このコマンドは、Get-AzureTrafficManagerProfile コマンドレットを使用 して、MyProfile という名前の Traffic Manager プロファイルを取得します。 このプロファイルでは、RoundRobin 負荷分散方法、30 秒の TTL、監視プロトコル HTTP、監視ポート、Traffic Manager プロファイルの相対パスが使用されます。

例 3: エンドポイントを目的のフェールオーバー順序に並べ替える

PS C:\>$Profile = Get-AzureTrafficManagerProfile -Name "MyProfile"
PS C:\> $Profile.Endpoints[0],$Profile.Endpoints[1] = $Profile.Endpoints[1],$Profile.Endpoints[0]
PS C:\> $Profile = Set-AzureTrafficManagerProfile

この例では、MyProfile に追加されたエンドポイントを目的のフェールオーバー順序に並べ替えます。

最初のコマンドは、MyProfile という名前の Traffic Manager プロファイル オブジェクトを取得し、そのオブジェクトを $Profile 変数に格納します。

2 番目のコマンドは、エンドポイント配列からフェールオーバーが発生する順序にエンドポイントを並べ替えます。

最後のコマンドは、$Profileに格納されている Traffic Manager プロファイルを新しいエンドポイントの順序で更新します。

パラメーター

-LoadBalancingMethod

接続の分散に使用する負荷分散方法を指定します。 有効な値は次の通りです。

  • パフォーマンス
  • [フェールオーバー]
  • RoundRobin
型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-MonitorPort

エンドポイントの正常性を監視するために使用するポートを指定します。 有効な値は、0 より大きく、65,535 以下の整数値です。

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

-MonitorProtocol

エンドポイントの正常性の監視に使用するプロトコルを指定します。 有効な値は次の通りです。

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

-MonitorRelativePath

正常性状態をプローブするエンドポイント ドメイン名に対する相対パスを指定します。 パスは次の制限を満たしている必要があります。

  • パスは 1 ~ 1000 文字にする必要があります。
  • スラッシュ /で始まる必要があります。
  • XML 要素 <>を含めてはなりません。
  • 二重スラッシュ // を含めてはなりません。
  • 無効な HTML エスケープ文字を含めてはなりません。 たとえば、%XY です。
型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Name

更新する Traffic Manager プロファイルの名前を指定します。

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

-Profile

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

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

-TrafficManagerProfile

プロファイルの設定に使用する Traffic Manager プロファイル オブジェクトを指定します。

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

-Ttl

DNS エントリをキャッシュする時間をローカル DNS リゾルバーに通知する DNS Time-to-Live (TTL) を指定します。 有効な値は、30 ~ 999,999 の整数です。

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

出力

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

このコマンドレットは、Traffic Manager プロファイル オブジェクトを生成します。