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

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

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

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

Enable-AzureRmTrafficManagerEndpoint コマンドレット


名前


Enable-AzureRmTrafficManagerEndpoint

概要

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

構文

Enable-AzureRmTrafficManagerEndpoint
  [-DefaultProfile <IAzureContextContainer>]
  -Name <String>
  -ProfileName <String>
  -ResourceGroupName <String>
  -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints}
  [<CommonParameters>]

Enable-AzureRmTrafficManagerEndpoint
  [-DefaultProfile <IAzureContextContainer>]
  -TrafficManagerEndpoint <TrafficManagerEndpoint>
  [<CommonParameters>]

説明


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

このコマンドレットに TrafficManagerEndpoint オブジェクトを渡すためにパイプライン操作を用いることも、TrafficManagerEndpoint パラメーターを用いて TrafficManagerEndpoint オブジェクトを指定することも可能です。

また、ProfileName および ResourceGroupName パラメーターと一緒に Name とType パラメーターを用いてエンドポイント名と型を指定することが可能です。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-Name <String>

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

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

-ProfileName <String>

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

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

-ResourceGroupName <String>

リソース グループ名を指定します。このコマンドレットは、このパラメーターが指定するグループ内の Traffic Manager エンドポイントを有効にします。

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

-TrafficManagerEndpoint <TrafficManagerEndpoint>

このコマンドレットが有効にする Traffic Manager エンドポイントを指定します。TrafficManagerEndpoint オブジェクトを取得するために、Get-AzureRmTrafficManagerEndpoint コマンドレットを用います。

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

-Type <String>

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

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

<CommonParameters>

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

入力

  • TrafficManagerEndpoint
    • パラメーター ‘TrafficManagerEndpoint’ は、パイプラインから型 ‘TrafficManagerEndpoint’ の値を受け入れます。

出力

  • System.Boolean

メモ

  • なし

例 1 : プロファイルからエンドポイントを有効にする

コマンド

 Enable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints

コマンドの説明

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

例 2 : パイプラインを用いてエンドポイントを有効にする

コマンド

 Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzureRmTrafficManagerEndpoint

コマンドの説明

このコマンドは、 ResourceGroup11 内のプロファイル ContosoProfile から 外部エンドポイント Contoso の情報を取得、パイプライン操作を用いて Enable-AzureRmTrafficManagerEndpoint コマンドレットにエンドポイント情報を渡します。このコマンドレットは、エンドポイントを有効にします。

関連するリンク

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

参考

Azure PowerShell Azure Traffic Manager Microsoft Azure
タイトルとURLをコピーしました