Правила именования командлетов

В следующем списке приведены рекомендации, которые следует учитывать при выборе глагола для имени командлета:

  • Когда вы указываете глагол, мы рекомендуем использовать одно из предопределенных имен глаголов, предоставленное PowerShell (псевдонимы для этих предопределенных глаголов включены в следующие таблицы). Когда вы используете предопределенный глагол, вы обеспечиваете согласованность между создаваемыми командлетами, командлетами, предоставляемыми PowerShell, и командлетами, которые разрабатываются другими.
  • Используйте предопределенные глаголы для описания общей области действия и используйте параметры для дальнейшего уточнения действия командлета.
  • Чтобы обеспечить согласованность между командлетами, не используйте синоним одобренного глагола.
  • Используйте только форму каждого глагола, который указан в этом разделе. Например, используйте «Get», но не используйте «Getting» или «Gets».
  • Используйте Pascal для глаголов. В Pascal начальная буква каждого слова заглавная, например, «ForEach».
  • Не используйте следующие зарезервированные глаголы или псевдонимы. Эти глаголы используются языком PowerShell или специальными командлетами, предоставленными PowerShell.
    • ForEach (foreach)
    • Format (f)
    • Group (gp)
    • Sort (sr)
    • Tee (te)
    • Where (wh)

Подобные глаголы для разных действий

New vs. Set

The New verb is used to create a new resource. The Set verb is used to modify an existing resource, optionally creating the resource if it does not exist, such as the Set-Variable cmdlet.

The Find verb is used to look for an object. The Search verb is used to create a reference to a resource in a container.

Get vs. Read

The Get verb is used to retrieve a resource, such as a file. The Read verb is used to get information from a source, such as a file.

Invoke vs. Start

The Invoke verb is used to perform an operation that is generally a synchronous operation, such as running a command. The Start verb is used to begin an operation that is generally an asynchronous operation, such as starting a process.

Ping vs. Test

Use the Test verb.

Verb        Group
----        -----
Add         Common
Clear       Common
Close       Common
Copy        Common
Enter       Common
Exit        Common
Find        Common
Format      Common
Get         Common
Hide        Common
Join        Common
Lock        Common
Move        Common
New         Common
Open        Common
Optimize    Common
Pop         Common
Push        Common
Redo        Common
Remove      Common
Rename      Common
Reset       Common
Resize      Common
Search      Common
Select      Common
Set         Common
Show        Common
Skip        Common
Split       Common
Step        Common
Switch      Common
Undo        Common
Unlock      Common
Watch       Common
Backup      Data
Checkpoint  Data
Compare     Data
Compress    Data
Convert     Data
ConvertFrom Data
ConvertTo   Data
Dismount    Data
Edit        Data
Expand      Data
Export      Data
Group       Data
Import      Data
Initialize  Data
Limit       Data
Merge       Data
Mount       Data
Out         Data
Publish     Data
Restore     Data
Save        Data
Sync        Data
Unpublish   Data
Update      Data
Approve     Lifecycle
Assert      Lifecycle
Complete    Lifecycle
Confirm     Lifecycle
Deny        Lifecycle
Disable     Lifecycle
Enable      Lifecycle
Install     Lifecycle
Invoke      Lifecycle
Register    Lifecycle
Request     Lifecycle
Restart     Lifecycle
Resume      Lifecycle
Start       Lifecycle
Stop        Lifecycle
Submit      Lifecycle
Suspend     Lifecycle
Uninstall   Lifecycle
Unregister  Lifecycle
Wait        Lifecycle
Debug       Diagnostic
Measure     Diagnostic
Ping        Diagnostic
Repair      Diagnostic
Resolve     Diagnostic
Test        Diagnostic
Trace       Diagnostic
Connect     Communications
Disconnect  Communications
Read        Communications
Receive     Communications
Send        Communications
Write       Communications
Block       Security
Grant       Security
Protect     Security
Revoke      Security
Unblock     Security
Unprotect   Security
Use         Other

Ссылки