13. コマンドレット

編集メモ

重要

Windows PowerShell 言語仕様 3.0 は、2012 年 12 月に公開され、Windows PowerShell 3.0 に基づいています。 この仕様では、PowerShell の現在の状態は反映されません。 現在の状態を反映するようにこのドキュメントを更新する予定はありません。 このドキュメントは、履歴参照のためにここに示されています。

仕様文書は、Microsoft ダウンロード センターから Microsoft Word 文書として入手できます。https://www.microsoft.com/download/details.aspx?id=36389 Word 文書は、Microsoft Learn でプレゼンテーション用に変換されています。 変換中に、Docs プラットフォームの書式設定に対応するために、いくつかの編集の変更が行われました。 一部の入力ミスと軽微なエラーが修正されました。

コマンドレットは、PowerShell でオブジェクトを操作する単一機能コマンドです。 コマンドレットは、名前の形式、-、Get-Help、Get-Processなど、ダッシュ (Start-Service) で区切られた動詞と名詞で認識できます。 動詞パターン は、W*のようにワイルドカードを使用して表現される動詞です。 名詞パターン は、イベント のように、ワイルドカードを使って表現される名詞です。

コマンドレットは単純で、他のコマンドレットと組み合わせて使用するように設計する必要があります。 たとえば、Get コマンドレット データのみを取得する必要がある 、Set コマンドレットはデータのみを確立または変更する必要があります。Format コマンドレットはデータの書式設定のみを行う必要があり、Out コマンドレットは出力を指定した宛先にのみ送信する必要があります。

コマンドレットごとに、次のように入力してアクセスできるヘルプ ファイルを指定します。

Get-Help *cmdlet-name* -Detailed

コマンドレット ヘルプ ファイルの詳細ビューには、コマンドレットの説明、コマンド構文、パラメーターの説明、およびそのコマンドレットの使用方法を示す例が含まれている必要があります。

コマンドレットは、オペレーティング システムのコマンドとユーティリティと同様に使用されます。 PowerShell コマンドでは、大文字と小文字が区別されません。

手記

エディターのメモ: 元のドキュメントには、説明、構文図、パラメーター定義、および例を含むコマンドレットの一覧が含まれています。 この情報は不完全であり、古い形式です。 コマンドレットの現在の情報については、PowerShell ドキュメントの「リファレンス」セクションを参照してください。

13.1 共通パラメーター

共通パラメーターは、任意のコマンドレットで使用できる一連のコマンドレット パラメーターです。 これらは、コマンドレット開発者ではなく PowerShell ランタイム環境自体によって実装され、Parameter 属性 (§12.3.7) または CmdletBinding 属性 (§12.3.5) を使用するコマンドレットまたは関数で自動的に使用できます。

共通パラメーターはどのコマンドレットでも受け入れられますが、そのコマンドレットのセマンティクスがない可能性があります。 たとえば、あるコマンドレットから詳細出力が生成されない場合、Verbose 共通パラメーターを使っても効果はありません。

いくつかの一般的なパラメーターは、基本設定変数 (§2.3.2.3) を使用して設定できるシステムの既定値または基本設定をオーバーライドします。 基本設定変数とは異なり、一般的なパラメーターは、それらが使用されているコマンドにのみ影響します。

手記

エディターのメモ: 元のドキュメントには、共通パラメーターの一覧が含まれています。 この情報は不完全であり、古い形式です。 現在の情報については、about_CommonParametersを参照してください。