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

スポンサーリンク

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

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

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

Remove-AzureRmTrafficManagerProfile コマンドレット


名前


Remove-AzureRmTrafficManagerProfile

概要

Traffic Manager プロファイルを削除します。

構文

Remove-AzureRmTrafficManagerProfile
  [-DefaultProfile <IAzureContextContainer>]
  [-Force]
  -Name <String>
  -ResourceGroupName <String>
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

Remove-AzureRmTrafficManagerProfile
  [-DefaultProfile <IAzureContextContainer>]
  [-Force]
  -TrafficManagerProfile <TrafficManagerProfile>
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

説明


Remove-AzureRmTrafficManagerProfile コマンドレットは、Azure Traffic Manager プロファイルを削除します。Name および ResourceGroupName パラメーターを用いて削除するプロファイルを指定します。または、TrafficManagerProfile パラメーターを用いて TrafficManagerProfile オブジェクトを指定することも、パイプラインを用いることも可能です。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-Force [<SwitchParameter>]

ユーザーの確認を求めずにコマンドを実行します。

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

-Name <String>

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

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

-ResourceGroupName <String>

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

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

-TrafficManagerProfile <TrafficManagerProfile>

削除する TrafficManagerProfile オブジェクトを指定します。TrafficManagerProfile オブジェクトを取得するには、Get-AzureRmTrafficManagerProfile コマンドレットを用います。

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

-Confirm [<SwitchParameter>]

コマンドレットを実行する前に、確認のプロンプトを表示します。

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

-WhatIf [<SwitchParameter>]

コマンドレットを実行する際、どのように動作するか表示します。コマンドレットは、実際には実行されません。

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

<CommonParameters>

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

入力

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

出力

  • Boolean
    • このコマンドレットが成功した場合は $True の値を返し、削除が失敗した場合には $False の値を返します。

メモ

  • なし

例 1 : 指定したプロファイルを削除する

コマンド

 Remove-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" 

コマンドの説明

このコマンドは、ResourceGroup11 内の プロファイル ContosoProfile を削除します。このコマンドは、確認のプロンプトを表示します。

例 2 : パイプラインを用いてプロファイルを削除

コマンド

 Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Remove-AzureRmTrafficManagerProfile -Force 

コマンドの説明

このコマンドは、ResourceGroup11 内のプロファイル ContosoProfile の情報を取得し、パイプライン操作を用いて Remove-AzureRmTrafficManagerProfile コマンドレットにプロファイル情報を渡します。このコマンドレットは、プロファイルを削除します。このコマンドには、Force パラメーターが指定されています。そのため、確認のプロンプトは表示されません。

関連するリンク

  • Disable-AzureRmTrafficManagerProfile
  • Enable-AzureRmTrafficManagerProfile
  • Get-AzureRmTrafficManagerProfile
  • New-AzureRmTrafficManagerProfile
  • Set-AzureRmTrafficManagerProfile

参考