共有パラメーター名

このトピックで説明するパラメーターは、共通パラメーター と 呼ばれます。 これらはランタイムによってコマンドレットに追加Windows PowerShellコマンドレットで宣言することはできません。

注意

これらのパラメーターは、プロバイダー コマンドレットおよび 属性で装飾された関数にも追加 CmdletBinding されます。

一般的な共通パラメーター

次のパラメーターは、すべてのコマンドレットに追加され、コマンドレットが実行されるたびにアクセスできます。 これらのパラメーターは 、System.Management.Automation.Internal.Commonparameters クラスによって定義 されます。

確認 (エイリアス: cf)

データ型: SwitchParameter

このパラメーターは、ユーザーが続行するかどうかを確認するプロンプトをコマンドレットに表示するかどうかを指定します。

デバッグ (エイリアス: db)

データ型: SwitchParameter

このパラメーターは、コマンド ラインに表示できるプログラマレベルのデバッグ メッセージかどうかを指定します。 これらのメッセージはコマンドレットの操作のトラブルシューティングを目的とし 、System.Management.Automation.Cmdlet.WriteDebug メソッドの呼び出しによって生成されます。 デバッグ メッセージをローカライズする必要はない。

ErrorAction (エイリアス: ea)

データ型: 列挙型

このパラメーターは、エラーが発生した場合に実行するアクションを指定します。 このパラメーターに指定できる値は 、System.Management.Automation.Actionpreference 列挙体によって定義 されます。

ErrorVariable (エイリアス: ev)

データ型: 文字列

このパラメーターは、エラーが発生した場合にオブジェクトを配置する変数を指定します。 この変数に追加するには、変数をクリアして設定するのではなく、 +varname を使用します。

OutBuffer (エイリアス: ob)

データ型: Int32

このパラメーターでは、出力バッファーに格納するオブジェクトの数を定義してから、パイプラインに渡されるオブジェクトの数を指定します。 既定では、オブジェクトはすぐにパイプラインに渡されます。

OutVariable (エイリアス: ov)

データ型: 文字列

このパラメーターは、 コマンドレットによって生成された出力オブジェクトを配置する変数を指定します。 この変数に追加するには、変数をクリアして設定するのではなく、 +varname を使用します。

PipelineVariable (エイリアス: pv)

データ型: 文字列

このパラメーターは、現在のパイプライン要素の値を、パイプラインを通過する名前付きコマンドの変数として格納します。

Verbose (エイリアス: vb)

データ型: SwitchParameter

このパラメーターは、コマンド ラインに表示できる説明メッセージをコマンドレットが書き込むかどうかを指定します。 これらのメッセージは、ユーザーに追加のヘルプを提供することを目的とし 、System.Management.Automation.Cmdlet.WriteVerbose メソッドの呼び出しによって生成されます。

WarningAction (エイリアス: wa)

データ型: 列挙型

このパラメーターは、コマンドレットが警告メッセージを書き込むときに実行するアクションを指定します。 このパラメーターに指定できる値は 、System.Management.Automation.Actionpreference 列挙体によって定義 されます。

WarningVariable (エイリアス: wv)

データ型: 文字列

このパラメーターは、警告メッセージを保存できる変数を指定します。 この変数に追加するには、変数をクリアして設定するのではなく、 +varname を使用します。

Risk-Mitigationパラメーター

次のパラメーターは、アクションを実行する前に確認を要求するコマンドレットに追加されます。 確認要求の詳細については、「確認の要求 」を参照してください。 これらのパラメーターは 、System.Management.Automation.Internal.Shouldprocessparameters クラスによって定義 されます。

WhatIf (エイリアス: wi)

データ型: SwitchParameter

このパラメーターは、実際にアクションを実行せずにコマンドレットを実行した場合の影響を説明するメッセージをコマンドレットが書き込むかどうかを指定します。

トランザクション パラメーター

次のパラメーターは、トランザクションをサポートするコマンドレットに追加されます。 これらのパラメーターは 、System.Management.Automation.Internal.Transactionparameters クラスによって定義 されます。 トランザクションサポートは PowerShell 3.0 で導入され、PowerShell 6.0 で廃止されました。

UseTransaction (エイリアス: usetx)

データ型: SwitchParameter

このパラメーターは、コマンドレットが現在のトランザクションを使用してアクションを実行するかどうかを指定します。

参照

System.Management.Automation.Internal.Commonparameters

System.Management.Automation.Internal.Shouldprocessparameters

System.Management.Automation.Internal.Transactionparameters

Windows PowerShell コマンドレットの記述

Windows PowerShell SDK