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

スポンサーリンク

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

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

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

Remove-AzureRmTrafficManagerEndpointConfig コマンドレット


名前


Remove-AzureRmTrafficManagerEndpointConfig

概要

ローカル Traffic Manager プロファイル オブジェクトからエンドポイントを削除します。

構文

Remove-AzureRmTrafficManagerEndpointConfig
  [-DefaultProfile <IAzureContextContainer>]
  -EndpointName <String>
  -TrafficManagerProfile <TrafficManagerProfile>
  [<CommonParameters>]

説明


Remove-AzureRmTrafficManagerEndpointConfig コマンドレットは、ローカル Azure Traffic Manager プロファイル オブジェクトからエンドポイントを削除します。Get-AzureRmTrafficManagerProfile コマンドレットを用いてプロファイル情報を取得することが可能です。

このコマンドレットはローカル プロファイル オブジェクト上で操作します。Set-AzureRmTrafficManagerProfile コマンドレットを用いて Traffic Manager プロファイルに変更を反映します。1回の操作でエンドポイントを削除、変更を反映するには、Remove-AzureRmTrafficManagerEndpoint コマンドレットを用います。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-EndpointName <String>

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

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

-TrafficManagerProfile <TrafficManagerProfile>

ローカル TrafficManagerProfile オブジェクトを指定します。このコマンドレットは、このローカル オブジェクトを修正します。TrafficManagerProfile オブジェクトを取得するには、Get-AzureRmTrafficManagerProfile コマンドレットを用います。

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

<CommonParameters>

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

入力

  • Microsoft.Azure.Commands.Network.TrafficManagerProfile
    • このコマンドレットは、このコマンドレットに TrafficManagerProfile オブジェクトを受け入れます。

出力

  • Microsoft.Azure.Commands.Network.TrafficManagerProfile
    • このコマンドレットは、修正された TrafficManagerProfile オブジェクトを返します。

メモ

  • なし

例 1 : エンドポイントを削除する

コマンド
$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
Remove-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -Type AzureEndpoints -TrafficManagerProfile $TrafficManagerProfile
Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile
コマンドの説明

最初のコマンドは、Get-AzureRmTrafficManagerProfile コマンドレットを用いて Azure Traffic Manager プロファイルを取得、変数 $TrafficManagerProfile にローカル プロファイルを格納します。

2番目のコマンドは、$TrafficManagerProfile に格納されたプロファイルのエンドポイント consoto を削除します。このコマンドは、ローカル オブジェクトのみを変更します。

最後のコマンドは、$TrafficManagerProfile のローカルの値に合致する Traffic Manager プロファイル ContosoProfile を更新します。

関連するリンク

  • Add-AzureRmTrafficManagerEndpointConfig
  • Get-AzureRmTrafficManagerProfile
  • Remove-AzureRmTrafficManagerEndpoint
  • Set-AzureRmTrafficManagerProfile

参考