PowerShell コマンドに承認されている動詞
PowerShell では、コマンドレットの名前とその派生 .NET クラスに動詞と名詞のペアが使用されます。
名前の動詞部分は、コマンドレットが実行するアクションを識別します。 名前の名詞部分は、アクションが実行されるエンティティを識別します。 たとえば、Get-Command コマンドレットは、PowerShell に登録されているすべてのコマンドを取得します。
注意
PowerShell では、動詞 という用語を使用して、その単語が英語の標準動詞でない場合でもアクションを意味する単語を記述します。 たとえば、新しい という用語は、英語の動詞ではない場合でもアクションを意味するため、有効な PowerShell 動詞名です。
承認された各動詞には、対応する エイリアス プレフィックス 定義されています。 このエイリアス プレフィックスは、その動詞を使用するコマンドのエイリアスで使用します。 たとえば、Import のエイリアス プレフィックスは ip され、それに応じて、Import-Module のエイリアスが ipmoされます。 これは推奨事項ですが、ルールではありません。特に、他の環境からよく知られているコマンドを模倣するコマンド エイリアスには考慮する必要はありません。
次の推奨事項は、作成するコマンドレット、PowerShell によって提供されるコマンドレット、および他のユーザーによって設計されたコマンドレットの間の一貫性を確保するために、コマンドレットに適した動詞を選択するのに役立ちます。
- PowerShell で提供されている定義済みの動詞名のいずれかを使用する
- 動詞を使用してアクションの一般的なスコープを記述し、パラメーターを使用してコマンドレットのアクションをさらに絞り込みます。
- 承認された動詞のシノニムを使用しないでください。 たとえば、常に
Removeを使用し、DeleteやEliminateは使用しないでください。 - このトピックに記載されている各動詞の形式のみを使用します。 たとえば、
Getを使用しますが、GettingやGetsは使用しないでください。 - 次の予約済み動詞またはエイリアスは使用しないでください。 PowerShell 言語とまれなコマンドレットは、例外的な状況でこれらの動詞を使用します。
- ForEach (foreach)
- Ping (pi)
- 並べ替え (sr)
- Tee (te)
- Where (wh)
Get-Verb コマンドレットを使用して、動詞の完全な一覧を取得できます。
次の同様の動詞は、さまざまなアクションを表します。
New 動詞を使用して、新しいリソースを作成します。
Add を使用して、既存のコンテナーまたはリソースに何かを追加します。 たとえば、Add-Content は既存のファイルに出力を追加します。
New 動詞を使用して、新しいリソースを作成します。
Set 動詞を使用して既存のリソースを変更します。必要に応じて、Set-Variable コマンドレットなど、存在しない場合は作成します。
オブジェクトを検索するには、Find 動詞を使用します。
Search 動詞を使用して、コンテナー内のリソースへの参照を作成します。
Get 動詞を使用して、リソース (ファイルなど) に関する情報を取得したり、将来リソースにアクセスできるオブジェクトを取得したりします。
Read 動詞を使用してリソースを開き、その中に含まれる情報を抽出します。
Invoke 動詞を使用して、コマンドの実行や終了の待機などの同期操作を実行します。 自律プロセスの開始など、非同期操作を開始するには、Start 動詞を使用します。
Test 動詞を使用します。
PowerShell では、System.Management.Automation.VerbsCommon 列挙クラスを使用して、ほぼすべてのコマンドレットに適用できる汎用アクションを定義します。 次の表に、定義されている動詞の大部分を示します。
| 動詞 (エイリアス) | アクション | 回避するシノニム |
|---|---|---|
| の追加 (a) | コンテナーにリソースを追加するか、項目を別の項目にアタッチします。 たとえば、Add-Content コマンドレットは、ファイルにコンテンツを追加します。 この動詞は、Removeとペアになっています。 |
Append、Attach、Concatenate、Insert |
| クリア (cl) | コンテナーからすべてのリソースを削除しますが、コンテナーは削除しません。 たとえば、Clear-Content コマンドレットはファイルの内容を削除しますが、ファイルは削除しません。 |
Flush、Erase、Release、Unmark、Unset、Nullify |
| を閉じる (cs) | リソースの状態を変更して、アクセス不可、使用不可、または使用できないようにします。 この動詞は、Open. とペアになっています |
|
| コピー (cp) | リソースを別の名前または別のコンテナーにコピーします。 たとえば、Copy-Item コマンドレットは、データ ストア内のある場所から別の場所にアイテム (ファイルなど) をコピーします。 |
複製、複製、レプリケート、同期 |
| を入力します (et) | ユーザーがリソースに移動できるようにするアクションを指定します。 たとえば、Enter-PSSession コマンドレットは、ユーザーを対話型セッションに配置します。 この動詞は、Exitとペアになっています。 |
押し込む |
| Exit (例) | 現在の環境またはコンテキストを、最近使用したコンテキストに設定します。 たとえば、Exit-PSSession コマンドレットは、対話型セッションの開始に使用されたセッションにユーザーを配置します。 この動詞は、Enterとペアになっています。 |
ポップ、アウト |
| find (fd) | 不明、暗黙的、省略可能、または指定されたコンテナー内のオブジェクトを探します。 | 検索する |
| 書式 (f) | 指定したフォームまたはレイアウトでオブジェクトを配置します。 | |
| Get (g) | リソースを取得するアクションを指定します。 この動詞は、Setとペアになっています。 |
Read、Open、Cat、Type、Dir、Obtain、Dump、Acquire、Examine、Find、Search |
| を非表示にする (h) | リソースを検出不能にします。 たとえば、名前に Hide 動詞が含まれるコマンドレットは、ユーザーからサービスを隠す可能性があります。 この動詞は、Showとペアになっています。 |
ブロック |
| Join (j) | リソースを 1 つのリソースに結合します。 たとえば、Join-Path コマンドレットは、パスとその子パスの 1 つを組み合わせて、1 つのパスを作成します。 この動詞は、Splitとペアになっています。 |
結合、結合、接続、関連付け |
| ロック (lk) | リソースをセキュリティで保護します。 この動詞は、Unlockとペアになっています。 |
制限、セキュリティ保護 |
| の移動 (m) | リソースをある場所から別の場所に移動します。 たとえば、Move-Item コマンドレットは、データ ストア内のある場所から別の場所に項目を移動します。 |
転送、名前、移行 |
| New (n) | リソースを作成します。 (Set 動詞は、Set-Variable コマンドレットなどのデータを含むリソースを作成するときにも使用できます)。 |
作成、生成、ビルド、作成、割り当て |
| オープン (op) | リソースの状態を変更して、アクセス可能、使用可能、または使用可能にします。 この動詞は、Closeとペアになっています。 |
|
| の最適化 (om) | リソースの有効性を向上させます。 | |
| ポップ (ポップ) | スタックの上部から項目を削除します。 たとえば、Pop-Location コマンドレットは、現在の場所を、最近スタックにプッシュされた場所に変更します。 |
|
| プッシュ (pu) | スタックの先頭に項目を追加します。 たとえば、Push-Location コマンドレットは、現在の場所をスタックにプッシュします。 |
|
| Redo (re) | 元に戻された状態にリソースをリセットします。 | |
| の削除 (r) | コンテナーからリソースを削除します。 たとえば、Remove-Variable コマンドレットは変数とその値を削除します。 この動詞は、Addとペアになっています。 |
クリア、カット、破棄、破棄、消去 |
| の名前変更 (rn) | リソースの名前を変更します。 たとえば、Rename-Item コマンドレットは、格納されているデータにアクセスするために使用され、データ ストア内の項目の名前を変更します。 |
変更 |
| リセット (rs) | リソースを元の状態に戻します。 | |
| のサイズ変更 (rz) | リソースのサイズを変更します。 | |
| Search (sr) | コンテナー内のリソースへの参照を作成します。 | 検索、検索 |
| の選択 (sc) | コンテナー内のリソースを検索します。 たとえば、Select-String コマンドレットは文字列とファイル内のテキストを検索します。 |
検索、検索 |
| set (s) | 既存のリソースのデータを置き換えるか、データを含むリソースを作成します。 たとえば、Set-Date コマンドレットは、ローカル コンピューターのシステム時刻を変更します。 (New 動詞を使用してリソースを作成することもできます)。この動詞は、Getとペアになっています。 |
書き込み、リセット、割り当て、構成、更新 |
| の表示 (sh) | リソースをユーザーに表示します。 この動詞は、Hideとペアになっています。 |
表示、生成 |
| スキップ (sk) | シーケンス内の 1 つ以上のリソースまたはポイントをバイパスします。 | バイパス、ジャンプ |
| 分割 (sl) | リソースの一部を分離します。 たとえば、Split-Path コマンドレットはパスのさまざまな部分を返します。 この動詞は、Joinとペアになっています。 |
分ける |
| ステップ (st) | シーケンス内の次のポイントまたはリソースに移動します。 | |
| スイッチ (sw) | 2 つの場所、責任、状態の間で変更するなど、2 つのリソース間で代替するアクションを指定します。 | |
| 元に戻す (解除) | リソースを以前の状態に設定します。 | |
| ロック解除 (英国) | ロックされたリソースを解放します。 この動詞は、Lockとペアになっています。 |
Release、Unrestrict、Unsecure |
| ウォッチ (wc) | リソースの変更を継続的に検査または監視します。 |
PowerShell では、System.Management.Automation.VerbsCommunications クラスを使用して、通信に適用されるアクションを定義します。 次の表に、定義されている動詞の大部分を示します。
| 動詞 (エイリアス) | アクション | 回避するシノニム |
|---|---|---|
| 接続 (cc) | ソースと宛先の間のリンクを作成します。 この動詞は、Disconnectとペアになっています。 |
参加、Telnet、ログイン |
| (dc) の切断 | ソースと宛先の間のリンクを解除します。 この動詞は、Connectとペアになっています。 |
中断、ログオフ |
| 読み取り (rd) | ソースから情報を取得します。 この動詞は、Writeとペアになっています。 |
取得、プロンプト、取得 |
| Receive (rc) | ソースから送信された情報を受け入れます。 この動詞は、Sendとペアになっています。 |
読み取り、承諾、ピーク |
| send (sd) | 宛先に情報を配信します。 この動詞は、Receiveとペアになっています。 |
Put、Broadcast、Mail、FAX |
| 書き込み (wr) | ターゲットに情報を追加します。 この動詞は、Readとペアになっています。 |
Put、Print |
PowerShell では、System.Management.Automation.VerbsData クラスを使用して、データ処理に適用されるアクションを定義します。 次の表に、定義されている動詞の大部分を示します。
| 動詞名 (エイリアス) | アクション | 回避するシノニム |
|---|---|---|
| バックアップ (ba) | データをレプリケートして格納します。 | 保存、書き込み、レプリケート、同期 |
| チェックポイント (ch) | データまたはその構成の現在の状態のスナップショットを作成します。 | 差分 |
| 比較 (cr) | あるリソースのデータを、別のリソースのデータと比較して評価します。 | 差分 |
| 圧縮 (cm) | リソースのデータを圧縮します。
Expandとのペア。 |
コンパクト |
| 変換 (cv) | コマンドレットが双方向変換をサポートしている場合、またはコマンドレットが複数のデータ型間の変換をサポートしている場合に、データを 1 つの表現から別の表現に変更します。 | 変更、サイズ変更、再サンプル |
| ConvertFrom (cf) | 1 つのプライマリ型の入力 (コマンドレットの名詞が入力を示します) を、サポートされている 1 つ以上の出力の種類に変換します。 | エクスポート、出力、出力 |
| ConvertTo (ct) | 1 つ以上の種類の入力からプライマリ出力の種類に変換します (コマンドレットの名詞は出力の種類を示します)。 | インポート、入力、入力 |
| マウント解除 (dm) | 名前付きエンティティを場所からデタッチします。 この動詞は、Mountとペアになっています。 |
マウント解除、リンク解除 |
| 編集 (ed) | コンテンツを追加または削除して、既存のデータを変更します。 | 変更、更新、変更 |
| 展開 (en) | 圧縮されたリソースのデータを元の状態に復元します。 この動詞は、Compressとペアになっています。 |
分解、圧縮解除 |
| エクスポート (ep) | プライマリ入力をファイルなどの永続的なデータ ストアまたはインターチェンジ形式にカプセル化します。 この動詞は、Importとペアになっています。 |
抽出、バックアップ |
| グループ (gp) | 1 つ以上のリソースを配置または関連付ける | |
| インポート (ip) | 永続的なデータ ストア (ファイルなど) またはインターチェンジ形式で格納されているデータからリソースを作成します。 たとえば、Import-Csv コマンドレットは、コンマ区切り値 (CSV) ファイルから他のコマンドレットで使用できるオブジェクトにデータをインポートします。 この動詞は、Exportとペアになっています。 |
BulkLoad、Load |
| 初期化 (in) | 使用するリソースを準備し、既定の状態に設定します。 | Erase、Init、Renew、Rebuild、Reinitialize、Setup |
| 制限 (l) | リソースに制約を適用します。 | クォータ |
| マージ (mg) | 複数のリソースから 1 つのリソースを作成します。 | 結合、結合 |
| マウント (mt) | 名前付きエンティティを場所にアタッチします。 この動詞は、Dismountとペアになっています。 |
接続する |
| アウト (o) | 環境からデータを送信します。 たとえば、Out-Printer コマンドレットはプリンターにデータを送信します。 |
|
| Publish (pb) | リソースを他のユーザーが使用できるようにします。 この動詞は、Unpublishとペアになっています。 |
展開、リリース、インストール |
| 復元 (rr) |
Checkpointによって設定された状態など、リソースを定義済みの状態に設定します。 たとえば、Restore-Computer コマンドレットは、ローカル コンピューターでシステムの復元を開始します。 |
修復、返却、元に戻す、修正 |
| (sv) を保存する | 損失を避けるためにデータを保持します。 | |
| 同期 (sy) | 2 つ以上のリソースが同じ状態であることを保証します。 | レプリケート、強制、一致 |
| 発行解除 (ub) | リソースを他のユーザーが使用できないようにします。 この動詞は、Publishとペアになっています。 |
アンインストール、元に戻す、非表示にする |
| Update (ud) | 状態、精度、準拠、またはコンプライアンスを維持するために、リソース up-to-date を提供します。 たとえば、Update-FormatData コマンドレットは、現在の PowerShell コンソールに書式設定ファイルを更新して追加します。 |
更新、更新、再計算、インデックスの再作成 |
PowerShell では、System.Management.Automation.VerbsDiagnostic クラスを使用して、診断に適用されるアクションを定義します。 次の表に、定義されている動詞の大部分を示します。
| 動詞 (エイリアス) | アクション | 回避するシノニム |
|---|---|---|
| デバッグ (db) | リソースを調べて、運用上の問題を診断します。 | 診断する |
| Measure (ms) | 指定した操作によって使用されるリソースを識別するか、リソースに関する統計情報を取得します。 | 計算、決定、分析 |
| Ping (pi) | 非推奨 - 代わりに Test 動詞を使用してください。 | |
| 修復 (rp) | 使用可能な条件にリソースを復元します。 | 修正、復元 |
| 解決 (rv) | リソースの短縮形表現をより完全な表現にマップします。 | 展開、決定 |
| テスト (t) | リソースの操作または一貫性を検証します。 | 診断、分析、サルベージ、検証 |
| トレース (tr) | リソースのアクティビティを追跡します。 | 追跡、フォロー、検査、掘り下げ |
PowerShell では、System.Management.Automation.VerbsLifecycle クラスを使用して、リソースのライフサイクルに適用されるアクションを定義します。 次の表に、定義されている動詞の大部分を示します。
| 動詞 (エイリアス) | アクション | 回避するシノニム |
|---|---|---|
| 承認 (ap) | リソースまたはプロセスの状態を確認または同意します。 | |
| Assert (as) | リソースの状態を確認します。 | Certify |
| ビルド (bd) | 一部の入力ファイル (通常はソース コードまたは宣言型ドキュメント) から成果物 (通常はバイナリまたはドキュメント) を作成します。この動詞は PowerShell 6 で追加されました。 | |
| Complete (cp) | 操作を終了します。 | |
| 確認 (cn) | リソースまたはプロセスの状態を確認、検証、または検証します。 | 確認、同意、認定、検証、検証 |
| Deny (dn) | リソースまたはプロセスの状態を拒否、オブジェクト、ブロック、または反対します。 | ブロック、オブジェクト、拒否、拒否 |
| Deploy (dp) | デプロイが完了した後、そのソリューションのコンシューマーがアクセスできるように、アプリケーション、Web サイト、またはソリューションをリモート ターゲットに送信します。 この動詞は PowerShell 6 で追加されました。 | |
| を無効にする (d) | リソースを使用できない状態または非アクティブな状態に構成します。 たとえば、Disable-PSBreakpoint コマンドレットはブレークポイントを非アクティブにします。 この動詞は、Enableとペアになっています。 |
停止、非表示 |
| を有効にする (e) | 使用可能な状態またはアクティブな状態にリソースを構成します。 たとえば、Enable-PSBreakpoint コマンドレットはブレークポイントをアクティブにします。 この動詞は、Disableとペアになっています。 |
開始、開始 |
| のインストール (is) | リソースを場所に配置し、必要に応じて初期化します。 この動詞は、Uninstallとペアになっています。 |
セットアップ |
| 呼び出し (i) | コマンドやメソッドの実行などのアクションを実行します。 | 実行、開始 |
| register (rg) | データベースなどのリポジトリ内のリソースのエントリを作成します。 この動詞は、Unregisterとペアになっています。 |
|
| 要求 (rq) | リソースを要求するか、アクセス許可を要求します。 | |
| 再起動 (rt) | 操作を停止してから、もう一度開始します。 たとえば、Restart-Service コマンドレットはサービスを停止してから開始します。 |
リサイクル |
| Resume (ru) | 中断された操作を開始します。 たとえば、Resume-Service コマンドレットは、中断されたサービスを開始します。 この動詞は、Suspendとペアになっています。 |
|
| Start (sa) | 操作を開始します。 たとえば、Start-Service コマンドレットはサービスを開始します。 この動詞は、Stopとペアになっています。 |
起動、開始、起動 |
| Stop (sp) | アクティビティを中止します。 この動詞は、Startとペアになっています。 |
End、Kill、Terminate、Cancel |
| Submit (sb) | 承認用のリソースを表示します。 | 投稿 |
| 一時停止 (秒) | アクティビティを一時停止します。 たとえば、Suspend-Service コマンドレットはサービスを一時停止します。 この動詞は、Resumeとペアになっています。 |
一時停止 |
| アンインストール (us) | 指定された場所からリソースを削除します。 この動詞は、Installとペアになっています。 |
|
| の登録解除 (自分) | リポジトリからリソースのエントリを削除します。 この動詞は、Registerとペアになっています。 |
削除 |
| wait (w) | 指定したイベントが発生するまで操作を一時停止します。 たとえば、Wait-Job コマンドレットは、1 つ以上のバックグラウンド ジョブが完了するまで操作を一時停止します。 |
スリープ、一時停止 |
PowerShell では、System.Management.Automation.VerbsSecurity クラスを使用して、セキュリティに適用されるアクションを定義します。 次の表に、定義されている動詞の大部分を示します。
| 動詞 (エイリアス) | アクション | 回避するシノニム |
|---|---|---|
| ブロック (bl) | リソースへのアクセスを制限します。 この動詞は、Unblockとペアになっています。 |
禁止、制限、拒否 |
| Grant (gr) | リソースへのアクセスを許可します。 この動詞は、Revokeとペアになっています。 |
許可、有効 |
| Protect (pt) | リソースを攻撃や損失から保護します。 この動詞は、Unprotectとペアになっています。 |
暗号化、保護、シール |
| 取り消し (rk) | リソースへのアクセスを許可しないアクションを指定します。 この動詞は、Grantとペアになっています。 |
削除、無効化 |
| のブロック解除 (ul) | リソースに対する制限を削除します。 この動詞は、Blockとペアになっています。 |
クリア、許可 |
| の保護を解除する (アップ) | 攻撃や損失を防ぐために追加されたリソースからセーフガードを削除します。 この動詞は、Protectとペアになっています。 |
Decrypt、Unseal |
PowerShell では、System.Management.Automation.VerbsOther クラスを使用して、共通、通信、データ、ライフサイクル、セキュリティ動詞名の動詞などの特定の動詞名カテゴリに適合しない正規動詞名を定義します。
- System.Management.Automation.VerbsCommon
- System.Management.Automation.VerbsCommunications
- System.Management.Automation.VerbsData
- System.Management.Automation.VerbsDiagnostic
- System.Management.Automation.VerbsLifecycle
- System.Management.Automation.VerbsSecurity
- System.Management.Automation.VerbsOther
- コマンドレット宣言の
- Windows PowerShell プログラマ ガイド
- Windows PowerShell シェル SDK の
PowerShell に関するフィードバック
PowerShell はオープンソース プロジェクトです。 フィードバックを提供するにはリンクを選択します。