Disable-AzTrafficManagerEndpoint

  • リファレンス
モジュール:
Az.TrafficManager

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

構文

Disable-AzTrafficManagerEndpoint
       -Name <String>
       -Type <String>
       -ProfileName <String>
       -ResourceGroupName <String>
       [-Force]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-AzTrafficManagerEndpoint
       -TrafficManagerEndpoint <TrafficManagerEndpoint>
       [-Force]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

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

パイプライン演算子を使用して TrafficManagerEndpoint オブジェクトをこのコマンドレットに渡すか、TrafficManagerEndpoint パラメーターを使用して TrafficManagerEndpoint オブジェクトを渡すことができます。

または、Name パラメーターと Type パラメーターを ProfileName パラメーターと ResourceGroupName パラメーターと共に使用して、エンドポイントの名前と種類を指定することもできます。

例

例 1: 名前でエンドポイントを無効にする

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

このコマンドは、リソース グループ ResourceGroup11 の ContosoProfile という名前のプロファイルで contoso という名前の外部エンドポイントを無効にします。 コマンドを実行すると、確認を求められます。

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

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

このコマンドは、ResourceGroup11 の ContosoProfile という名前のプロファイルから Contoso という名前の外部エンドポイントを取得します。 次に、パイプライン 演算子を使用して、そのエンドポイントを Disable-AzTrafficManagerEndpoint コマンドレットに渡します。 そのコマンドレットは、そのエンドポイントを無効にします。 このコマンドは Force パラメーターを指定します。 そのため、確認を求めるメッセージは表示されません。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProfileName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TrafficManagerEndpoint

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

Type:TrafficManagerEndpoint
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Type

このコマンドレットが Traffic Manager プロファイルに追加するエンドポイントの種類を指定します。 有効な値は次の通りです。

  • AzureEndpoints
  • ExternalEndpoints
  • NestedEndpoints
Type:String
Accepted values:AzureEndpoints, ExternalEndpoints, NestedEndpoints
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

TrafficManagerEndpoint

出力

Boolean