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

スポンサーリンク
Rise of the Tomb Raider

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

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

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

New-AzureRmTrafficManagerProfile コマンドレット


名前


New-AzureRmTrafficManagerProfile

概要

Traffic Manager プロファイルを作成します。

構文

New-AzureRmTrafficManagerProfile
  [-DefaultProfile <IAzureContextContainer>]
  [-MonitorIntervalInSeconds <Int32>]
  [-MonitorPath <String>]
  -MonitorPort <UInt32>
  -MonitorProtocol {HTTP | HTTPS | TCP}
  [-MonitorTimeoutInSeconds <Int32>]
  [-MonitorToleratedNumberOfFailures <Int32>]
  -Name <String>
  [-ProfileStatus {Enabled | Disabled}]
  -RelativeDnsName <String>
  -ResourceGroupName <String>
  [-Tag <Hashtable>]
  -TrafficRoutingMethod {Performance | Weighted | Priority | Geographic}
  -Ttl <UInt32>
  [<CommonParameters>]

説明


New-AzureRmTrafficManagerProfile コマンドレットは、Azure Traffic Manager プロファイルを作成します。Name パラメーターおよび要求された設定を指定します。このコマンドレットは新しいプロファイルを示すローカル オブジェクトを返します。

このコマンドレットは、Traffic Manager エンドポイントを構成しません。Add-AzureRmTrafficManagerEndpointConfig コマンドレットを用いてローカル プロファイル オブジェクトを更新することができます。その際、Set-AzureRmTrafficManagerProfile コマンドレットを用いて Traffic Manager に変更をアップロードします。または、New-AzureRmTrafficManagerEndpoint コマンドレットを用いてエンドポイントを追加します。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-MonitorIntervalInSeconds <Int32>

Traffic Manager がこのプロファイル内の各エンドポイントの正常性をチェックする間隔 (秒単位) を指定します。既定の値は、30 です。

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

-MonitorPath <String>

エンドポイント正常性の監視で使用されるパスを指定します。エンドポイント ドメイン名に関連した値を指定します。この値は、スラッシュ (/) から始まる必要があります。

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

-MonitorPort <UInt32>

エンドポイント正常性の監視で使用される TCP ポートを指定します。有効な値は、1 から 65535 までの整数です。

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

-MonitorProtocol <String>

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

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

-MonitorTimeoutInSeconds <Int32>

Traffic Manager がこのプロファイルのエンドポイントで正常性に応答する時間 (秒単位) を指定します。既定の値は、10 です。

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

-MonitorToleratedNumberOfFailures <Int32>

このプロファイル内でエンドポイントが Degraded と宣言する前に Traffic Manager が許容する連続した正常性チェックの失敗回数を指定します。既定の値は、3 です。

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

-Name <String>

このコマンドレットが作成する、Traffic Manager プロファイル名を指定します。

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

-ProfileStatus <String>

プロファイルの状態を指定します。有効な値は、次のとおり :

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

-RelativeDnsName <String>

この Traffic Manager が提供する相対 DNS 名を指定します。Traffic Manager は、この値と Azure Traffic Manager が使用する DNS ドメイン名を結合して、プロファイルの完全修飾ドメイン名 (FQDN) を形成します。

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

-ResourceGroupName <String>

リソース グループ名を指定します。このコマンドレットは、このパラメーターを指定したグループ内に Traffic Manager プロファイルを作成します。

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

-Tag <Hashtable>

サーバー上のタグとして設定されたハッシュ テーブル形式のキーと値の組 (Key-value pair) を指定します。例については、次のとおり :

@{key0=”value0″;key1=$null;key2=”value2″}

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

-TrafficRoutingMethod <String>

トラフィック ルーティング方式を指定します。この方式は、受信 DNS クエリに応答してどのエンドポイント Traffic Manager が返すかを決定します。有効な値は、次のとおり :

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

-Ttl <UInt32>

DNS 有効時間 (TTL) の値を指定します。

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

<CommonParameters>

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

入力

  • なし

出力

  • Microsoft.Azure.Commands.Network.TrafficManagerProfile
    • このコマンドレットは、新しい TrafficManagerProfile コマンドレットを返します。

メモ

  • なし

例 1 : プロファイルを作成する

コマンド

 New-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -ProfileStatus Enabled -TrafficRoutingMethod Performance -RelativeDnsName "contosoapp" -TTL 30 -MonitorProtocol HTTP -MonitorPort 80 -MonitorPath "/default.aspx" 

コマンドの説明

このコマンドは、リソース グループ ResourceGroup11 内の Azure Traffic Manager プロファイル ContosoProfile を作成します。DPN の FQDN は、”contosoapp.trafficmanager.net” です。

関連するリンク

  • Add-AzureRmTrafficManagerEndpointConfig
  • Disable-AzureRmTrafficManagerProfile
  • Enable-AzureRmTrafficManagerProfile
  • Get-AzureRmTrafficManagerProfile
  • Remove-AzureRmTrafficManagerProfile
  • Set-AzureRmTrafficManagerProfile

参考