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

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

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

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

Disable-AzureRmTrafficManagerEndpoint コマンドレット

名前

Disable-AzureRmTrafficManagerEndpoint

概要

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

構文

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

Disable-AzureRmTrafficManagerEndpoint
  [-DefaultProfile <IAzureContextContainer>]
  [-Force]
  -TrafficManagerEndpoint <TrafficManagerEndpoint>
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

説明

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

パイプライン演算子を用いて、このコマンドレットに TrafficManagerEndpoint オブジェクトを渡すことも、TrafficManagerEndpoint パラメーターを用いて TrafficManagerEndpoint オブジェクトを渡すことも可能です。

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

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-Force [<SwitchParameter>]

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

必須false
位置named
既定値False
パイプライン入力を許可する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

-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 を参照してください。

入力

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

出力

  • System.Boolean

メモ

  • なし

例 1 : 指定したエンドポイントを無効にする

コマンド

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

コマンドの説明

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

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

コマンド

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

コマンドの説明

このコマンドは、リソース グループ ResouceGroup11 内のプロファイル ContosoProfile から外部エンドポイント consoto 情報を取得します。またこのコマンドは、パイプライン演算子を用いて Disable-AzureRmTrafficManagerEndpoint コマンドレットにエンドポイント情報を渡して、エンドポイントを無効にしています。このコマンドには、Force パラメーターが指定されています。そのため、確認のプロンプトは表示されません。

関連するリンク

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

参考

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