PowerShell 使用谓词名对作为 cmdlet 的名称及其派生的 .NET 类。
名称的谓词部分标识 cmdlet 执行的作。 名称的名词部分标识执行作的实体。 例如,Get-Command cmdlet 检索 PowerShell 中注册的所有命令。
注释
PowerShell 使用术语 谓词 来描述一个单词,即使该单词不是英语中的标准谓词,该词也意味着作。 例如,该术语 New 是有效的 PowerShell 谓词名称,因为它表示作,即使它不是英语中的谓词。
每个批准的谓词都有一个相应的 别名前缀, 定义。 对于使用该谓词的命令,我们在别名中使用此别名前缀。 例如,Import 的别名前缀 ip,因此,Import-Module 的别名 ipmo。 这是建议,但不是规则;具体而言,不需要遵循命令别名来模拟来自其他环境的已知命令。
谓词命名建议
以下建议可帮助你为 cmdlet 选择适当的谓词,以确保创建的 cmdlet、PowerShell 提供的 cmdlet 和由其他人设计的 cmdlet 之间的一致性。
- 使用 PowerShell 提供的预定义谓词名称之一
- 使用谓词描述作的一般范围,并使用参数进一步优化 cmdlet 的作。
- 请勿使用已批准的谓词的同义词。 例如,始终使用 Remove,切勿使用Delete或Eliminate。
- 仅使用本主题中列出的每个谓词的形式。 例如,使用 Get,但不使用Getting或Gets。
- 请勿使用以下保留谓词或别名。 PowerShell 语言和极少数 cmdlet 在特殊情况下使用这些谓词。
- 
              ForEach(foreach)
- 
              Ping(pi)
- 
              Sort(sr)
- 
              Tee(te)
- 
              Where(wh)
 
- 
              
可以使用 Get-Verb cmdlet 获取谓词的完整列表。
不同作的类似谓词
以下类似的谓词表示不同的作。
              New 与 Add
使用 New 谓词创建新资源。 使用 Add 向现有容器或资源添加内容。 例如,Add-Content 向现有文件添加输出。
              New 与 Set
使用 New 谓词创建新资源。 
              Set使用谓词修改现有资源,可以选择创建它(如果不存在),例如 Set-Variable cmdlet。
              Find 与 Search
使用 Find 谓词查找对象。 使用 Search 谓词创建对容器中的资源的引用。
              Get 与 Read
使用 Get 谓词获取有关资源(如文件)的信息,或获取一个对象,以便将来访问该资源。 使用 Read 谓词打开资源并提取包含的信息。
              Invoke 与 Start
使用 Invoke 谓词执行同步作,例如运行命令并等待命令结束。 使用 Start 谓词开始异步作,例如启动自治进程。
              Ping 与 Test
使用 Test 谓词。
常见谓词
PowerShell 使用 System.Management.Automation.VerbsCommon 枚举类来定义可应用于几乎所有 cmdlet 的泛型作。 下表列出了大多数已定义的谓词。
| 谓词(别名) | 行动 | 要避免的同义词 | 
|---|---|---|
| Add(a) | 将资源添加到容器,或将项附加到另一项。 例如, Add-Contentcmdlet 会将内容添加到文件中。 此谓词与Remove配对。 | Append、Attach、Concatenate、Insert | 
| Clear(cl) | 从容器中删除所有资源,但不删除容器。 例如, Clear-Contentcmdlet 会删除文件的内容,但不会删除该文件。 | Flush、Erase、Release、Unmark、Unset、Nullify | 
| Close(cs) | 更改资源的状态,使其不可访问、不可用或不可用。 此谓词与 Open.配对 | |
| Copy(cp) | 将资源复制到另一个名称或另一个容器。 例如, Copy-Itemcmdlet 将项(如文件)从数据存储中的一个位置复制到另一个位置。 | 复制、克隆、复制、同步 | 
| Enter(et) | 指定允许用户移动到资源的作。 例如, Enter-PSSessioncmdlet 将用户置于交互式会话中。 此谓词与Exit配对。 | 推送、推送到 | 
| Exit(ex) | 将当前环境或上下文设置为最近使用的上下文。 例如, Exit-PSSessioncmdlet 将用户置于用于启动交互式会话的会话中。 此谓词与Enter配对。 | 弹出、传出 | 
| Find(fd) | 在未知、隐含、可选或指定的容器中查找对象。 | 搜索 | 
| Format(f) | 排列指定窗体或布局中的对象 | |
| Get(g) | 指定检索资源的作。 此谓词与 Set配对。 | 读取, 打开, Cat, 类型, Dir, 获取, 转储, 获取, 检查, 查找, 搜索 | 
| Hide(h) | 使资源无法检测到。 例如,名称包含 Hide 谓词的 cmdlet 可能会向用户隐藏服务。 此谓词与 Show配对。 | 块 | 
| Join(j) | 将资源合并为一个资源。 例如, Join-Pathcmdlet 将路径与其子路径之一组合在一起,以创建单个路径。 此谓词与Split配对。 | Combine、Unite、Connect、Associate | 
| Lock(lk) | 保护资源。 此谓词与 Unlock配对。 | 限制、保护 | 
| Move(m) | 将资源从一个位置移到另一个位置。 例如, Move-Itemcmdlet 将项从数据存储中的一个位置移动到另一个位置。 | 传输、名称、迁移 | 
| New(n) | 创建资源。 (创建包含数据的资源(如 Setcmdlet)时也可以使用Set-Variable谓词。 | 创建、生成、生成、生成、分配 | 
| Open(op) | 更改资源的状态,使其可访问、可用或可用。 此谓词与 Close配对。 | |
| Optimize(om) | 提高资源的有效性。 | |
| Pop(pop) | 从堆栈顶部删除项。 例如, Pop-Locationcmdlet 将当前位置更改为最近推送到堆栈的位置。 | |
| Push(pu) | 将项添加到堆栈的顶部。 例如, Push-Locationcmdlet 将当前位置推送到堆栈。 | |
| Redo(re) | 将资源重置为已撤消的状态。 | |
| Remove(r) | 从容器中删除资源。 例如, Remove-Variablecmdlet 删除变量及其值。 此谓词与Add配对。 | 清除、剪切、释放、放弃、擦除 | 
| Rename(rn) | 更改资源的名称。 例如,用于访问存储数据的 Rename-Itemcmdlet 会更改数据存储中项的名称。 | 改变 | 
| Reset(rs) | 将资源设置回其原始状态。 | |
| Resize(rz) | 更改资源的大小。 | |
| Search(sr) | 创建对容器中的资源的引用。 | 查找、查找 | 
| Select(sc) | 在容器中找到资源。 例如, Select-Stringcmdlet 在字符串和文件中查找文本。 | 查找、查找 | 
| Set(s) | 替换现有资源上的数据或创建包含某些数据的资源。 例如, Set-Datecmdlet 更改本地计算机上的系统时间。 (New谓词还可用于创建资源。此谓词与Get配对。 | 写入、重置、分配、配置、更新 | 
| Show(sh) | 使资源对用户可见。 此谓词与 Hide配对。 | 显示、生成 | 
| Skip(sk) | 绕过序列中的一个或多个资源或点。 | 绕过、跳跃 | 
| Split(sl) | 分隔资源的各个部分。 例如, Split-Pathcmdlet 返回路径的不同部分。 此谓词与Join配对。 | 分开 | 
| Step(st) | 移动到序列中的下一个点或资源。 | |
| Switch(sw) | 指定在两个资源之间交替的作,例如在两个位置、职责或状态之间更改。 | |
| Undo(un) | 将资源设置为其以前的状态。 | |
| Unlock(uk) | 释放已锁定的资源。 此谓词与 Lock配对。 | Release、Unrestrict、Unsecure | 
| Watch(wc) | 持续检查或监视资源是否有更改。 | 
通信谓词
PowerShell 使用 System.Management.Automation.VerbsCommunications 类来定义应用于通信的作。 下表列出了大多数已定义的谓词。
| 谓词(别名) | 行动 | 要避免的同义词 | 
|---|---|---|
| Connect(cc) | 在源和目标之间创建链接。 此谓词与 Disconnect配对。 | Join、Telnet、Login | 
| Disconnect(dc) | 中断源和目标之间的链接。 此谓词与 Connect配对。 | 中断、注销 | 
| Read(rd) | 从源获取信息。 此谓词与 Write配对。 | 获取、提示、获取 | 
| Receive(rc) | 接受从源发送的信息。 此谓词与 Send配对。 | 读取、接受、速览 | 
| Send(sd) | 将信息传送到目标。 此谓词与 Receive配对。 | Put、Broadcast、Mail、Fax | 
| Write(wr) | 将信息添加到目标。 此谓词与 Read配对。 | Put、Print | 
数据谓词
PowerShell 使用 System.Management.Automation.VerbsData 类定义应用于数据处理的作。 下表列出了大多数已定义的谓词。
| 谓词名称(别名) | 行动 | 要避免的同义词 | 
|---|---|---|
| Backup(ba) | 通过复制数据来存储数据。 | 保存、燃烧、复制、同步 | 
| Checkpoint(ch) | 创建数据或其配置的当前状态的快照。 | 差异 | 
| Compare(cr) | 根据另一个资源中的数据评估一个资源中的数据。 | 差异 | 
| Compress(cm) | 压缩资源的数据。 与 Expand配对。 | 紧凑的 | 
| Convert(cv) | 当 cmdlet 支持双向转换或 cmdlet 支持在多个数据类型之间进行转换时,将数据从一个表示形式更改为另一种表示形式。 | 更改、调整大小、重新采样 | 
| ConvertFrom(cf) | 将一种主要类型的输入(cmdlet 名词指示输入)转换为一个或多个受支持的输出类型。 | 导出、输出、输出 | 
| ConvertTo(ct) | 从一个或多个输入类型转换为主输出类型(cmdlet 名词指示输出类型)。 | 导入、输入、输入、输入 | 
| Dismount(dm) | 从位置分离命名实体。 此谓词与 Mount配对。 | 卸载、取消链接 | 
| Edit(ed) | 通过添加或删除内容来修改现有数据。 | 更改、更新、修改 | 
| Expand(en) | 还原已压缩到其原始状态的资源的数据。 此谓词与 Compress配对。 | 分解,取消压缩 | 
| Export(ep) | 将主输入封装到持久性数据存储(如文件)或交换格式中。 此谓词与 Import配对。 | 提取、备份 | 
| Group(gp) | 排列或关联一个或多个资源 | |
| Import(ip) | 根据存储在持久性数据存储(如文件)或交换格式中的数据创建资源。 例如, Import-Csv该 cmdlet 将数据从逗号分隔值 (CSV) 文件导入到其他 cmdlet 可以使用的对象。 此谓词与Export配对。 | BulkLoad、Load | 
| Initialize(in) | 准备要使用的资源,并将其设置为默认状态。 | Erase, Init, Renew, Rebuild, Reinitialize, Setup | 
| Limit(l) | 将约束应用于资源。 | 配额 | 
| Merge(mg) | 从多个资源创建单个资源。 | 合并、联接 | 
| Mount(mt) | 将命名实体附加到某个位置。 此谓词与 Dismount配对。 | 连接 | 
| Out(o) | 将数据从环境中发送出来。 例如, Out-Printercmdlet 将数据发送到打印机。 | |
| Publish(pb) | 使资源可供其他人使用。 此谓词与 Unpublish配对。 | 部署、发布、安装 | 
| Restore(rr) | 将资源设置为预定义状态,例如由 Checkpoint设置的状态。 例如,Restore-Computercmdlet 在本地计算机上启动系统还原。 | 修复、返回、撤消、修复 | 
| Save(sv) | 保留数据以避免丢失。 | |
| Sync(sy) | 确保两个或多个资源处于同一状态。 | 复制、强制、匹配 | 
| Unpublish(ub) | 使资源对其他人不可用。 此谓词与 Publish配对。 | 卸载、还原、隐藏 | 
| Update(ud) | 使资源 up-to日期保持其状态、准确性、符合性或符合性。 例如, Update-FormatDatacmdlet 更新并将格式化文件添加到当前 PowerShell 控制台。 | 刷新、续订、重新计算、重新索引 | 
诊断谓词
PowerShell 使用 System.Management.Automation.VerbsDiagnostic 类来定义适用于诊断的作。 下表列出了大多数已定义的谓词。
| 谓词(别名) | 行动 | 要避免的同义词 | 
|---|---|---|
| Debug(db) | 检查资源以诊断作问题。 | 诊断 | 
| Measure(ms) | 标识由指定作使用的资源,或检索有关资源的统计信息。 | 计算、确定、分析 | 
| Ping(pi) | 已弃用 - 改用测试谓词。 | |
| Repair(rp) | 将资源还原到可用条件 | 修复,还原 | 
| Resolve(rv) | 将资源的速记表示形式映射到更完整的表示形式。 | 展开,确定 | 
| Test(t) | 验证资源的作或一致性。 | 诊断、分析、打捞、验证 | 
| Trace(tr) | 跟踪资源的活动。 | 跟踪、跟踪、检查、挖掘 | 
生命周期谓词
PowerShell 使用 System.Management.Automation.VerbsLifecycle 类来定义应用于资源生命周期的作。 下表列出了大多数已定义的谓词。
| 谓词(别名) | 行动 | 要避免的同义词 | 
|---|---|---|
| Approve(ap) | 确认或同意资源或进程的状态。 | |
| Assert(as) | 确认资源的状态。 | 证明 | 
| Build(bd) | 从一组输入文件(通常是源代码或声明性文档)中创建项目(通常是二进制文件或文档)。此谓词已在 PowerShell 6 中添加。 | |
| Complete(cp) | 结束作。 | |
| Confirm(cn) | 确认、验证或验证资源或进程的状态。 | 确认、同意、认证、验证、验证 | 
| Deny(dn) | 拒绝、对象、块或反对资源或进程的状态。 | Block、Object、Reject、Reject | 
| Deploy(dp) | 将应用程序、网站或解决方案发送到远程目标[s],使该解决方案的使用者可以在部署完成后访问它。 此谓词已在 PowerShell 6 中添加。 | |
| Disable(d) | 将资源配置为不可用或非活动状态。 例如, Disable-PSBreakpointcmdlet 使断点处于非活动状态。 此谓词与Enable配对。 | 停止、隐藏 | 
| Enable(e) | 将资源配置为可用或活动状态。 例如, Enable-PSBreakpointcmdlet 使断点处于活动状态。 此谓词与Disable配对。 | 开始,开始 | 
| Install(is) | 将资源置于某个位置,并选择性地初始化它。 此谓词与 Uninstall配对。 | 安装 | 
| Invoke(i) | 执行作,例如运行命令或方法。 | 运行、启动 | 
| Register(rg) | 为存储库(如数据库)中的资源创建条目。 此谓词与 Unregister配对。 | |
| Request(rq) | 请求资源或请求权限。 | |
| Restart(rt) | 停止作,然后再次启动它。 例如, Restart-Servicecmdlet 停止,然后启动服务。 | 回收 | 
| Resume(ru) | 启动已挂起的作。 例如, Resume-Servicecmdlet 启动已挂起的服务。 此谓词与Suspend配对。 | |
| Start(sa) | 启动作。 例如, Start-Servicecmdlet 启动服务。 此谓词与Stop配对。 | 启动、启动、启动 | 
| Stop(sp) | 停止活动。 此谓词与 Start配对。 | End、Kill、Terminate、Cancel | 
| Submit(sb) | 提供要审批的资源。 | 发布 | 
| Suspend(ss) | 暂停活动。 例如, Suspend-Servicecmdlet 暂停服务。 此谓词与Resume配对。 | 暂停 | 
| Uninstall(us) | 从指示的位置中删除资源。 此谓词与 Install配对。 | |
| Unregister(ur) | 从存储库中删除资源条目。 此谓词与 Register配对。 | 删除 | 
| Wait(w) | 暂停作,直到发生指定的事件。 例如, Wait-Jobcmdlet 将暂停作,直到完成一个或多个后台作业。 | 睡眠、暂停 | 
安全谓词
PowerShell 使用 System.Management.Automation.VerbsSecurity 类来定义应用于安全性的作。 下表列出了大多数已定义的谓词。
| 谓词(别名) | 行动 | 要避免的同义词 | 
|---|---|---|
| Block(bl) | 限制对资源的访问。 此谓词与 Unblock配对。 | 阻止、限制、拒绝 | 
| Grant(gr) | 允许访问资源。 此谓词与 Revoke配对。 | 允许、启用 | 
| Protect(pt) | 保护资源免受攻击或损失。 此谓词与 Unprotect配对。 | 加密、保护、密封 | 
| Revoke(rk) | 指定不允许访问资源的作。 此谓词与 Grant配对。 | 删除、禁用 | 
| Unblock(ul) | 删除对资源的限制。 此谓词与 Block配对。 | 清除、允许 | 
| Unprotect(up) | 从添加的资源中删除安全措施,以防止其受到攻击或丢失。 此谓词与 Protect配对。 | 解密、取消密封 | 
其他谓词
PowerShell 使用 System.Management.Automation.VerbsOther 类定义不适合特定谓词名称类别的规范谓词名称,例如常见、通信、数据、生命周期或安全谓词名称谓词。
| 谓词(别名) | 行动 | 要避免的同义词 | 
|---|---|---|
| Use(u) | 使用或包括资源来执行某些作。 | 
另请参阅
- System.Management.Automation.VerbsCommon
- System.Management.Automation.VerbsCommunications
- System.Management.Automation.VerbsData
- System.Management.Automation.VerbsDiagnostic
- System.Management.Automation.Verbs生命周期
- System.Management.Automation.VerbsSecurity
- System.Management.Automation.VerbsOther
- Cmdlet 声明
- Windows PowerShell 程序员指南
- Windows PowerShell Shell SDK