Disable-AzTrafficManagerEndpoint
Traffic Manager プロファイルのエンドポイントを無効にします。
構文
Fields
Disable-AzTrafficManagerEndpoint
-Name <String>
-Type <String>
-ProfileName <String>
-ResourceGroupName <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Object
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
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
このコマンドレットで無効にする Traffic Manager エンドポイントの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Fields
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ProfileName
このコマンドレットがエンドポイントを無効にする Traffic Manager プロファイルの名前を指定します。
プロファイルを取得するには、Get-AzTrafficManagerProfile コマンドレットを使用します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Fields
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前を指定します。
このコマンドレットは、このパラメーターが指定するグループ内の Traffic Manager エンドポイントを無効にします。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Fields
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TrafficManagerEndpoint
このコマンドレットが無効にする Traffic Manager エンドポイントを指定します。
TrafficManagerEndpoint オブジェクトを取得するには、Get-AzTrafficManagerEndpoint コマンドレットを使用します。
パラメーターのプロパティ
パラメーター セット
Object
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Type
このコマンドレットが Traffic Manager プロファイルに追加するエンドポイントの種類を指定します。
有効な値は次のとおりです。
- AzureEndpoints
- ExternalEndpoints
- NestedEndpoints
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| 指定可能な値: | AzureEndpoints, ExternalEndpoints, NestedEndpoints |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Fields
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力