Verbos aprobados por PowerShell

Los verbos aprobados en PowerShell siguen una estructura específica [Verbo]-[Sustantivo] para garantizar coherencia y claridad en la sintaxis de los comandos de PowerShell.

En PowerShell, los verbos aprobados son un formato de estilo verbo-sustantivo para usar nombres para cmdlets y funciones en PowerShell. El verbo especifica una acción que realiza el comando y la parte sustantiva especifica la identidad sobre la cual se realizará la acción.

El elemento verbal de un verbo aprobado debe estar en forma infinitiva (como Get, Set, New), mientras que la parte sustantiva debe ser descriptiva y singular (como User, Computer, AdUser).

Por ejemplo, el cmdlet Get-AdUser (Get - es el verbo, AdUser - Noun) en PowerShell obtiene información de los usuarios del directorio activo.

En Windows PowerShell, hay aprox. 98 verbos aprobados, puede obtener una lista de verbos aprobados de PowerShell usando el cmdlet Get-Verb en PowerShell como se muestra a continuación

Get-Verb

El cmdlet Get-Verb en PowerShell obtiene los verbos aprobados como se muestra a continuación

Nota: Puedes obtener el recuento de verbos aprobados usando Get-Verb | Measure-Object, en el momento de escribir la publicación, el recuento de verbos aprobados es 98

Entendamos los verbos aprobados en PowerShell.

Mejores prácticas de verbos aprobados por PowerShell

Microsoft ha creado un conjunto de pautas para el uso de verbos aprobados en cmdlets o funciones en PowerShell. Garantiza la coherencia entre cmdlets o funciones creadas en PowerShell, el propósito de los cmdlets.

Siga las recomendaciones de verbos aprobados por PowerShell mientras los crea como se indica a continuación

1. Use verbos aprobados en PowerShell, puede obtener una lista de verbos aprobados usando Get-Verb
2. Utilice el verbo predefinido de PowerShell para la acción y el sustantivo para identificar qué acción se realizará.
3. No utilice sinónimos de verbos aprobados, por ejemplo, utilice el verbo Escribir para escribir información y evite el uso de sinónimos de verbos aprobados (como poner o imprimir).
4. Utilice el mismo verbo aprobado para tipos similares de tareas para mantener la coherencia.
5. Utilice un elemento sustantivo descriptivo que describa el objeto sobre el que se actúa.
6. Evite el uso de verbos no aprobados

El uso del par Verbo-Sustantivo de la convención de nomenclatura garantiza que los comandos sean fáciles de entender y el propósito del cmdlet. Por ejemplo,

• Obtener: este verbo se utiliza para recuperar información de un recurso. Por ejemplo, Get-ComputerInfo recupera información sobre las propiedades del sistema operativo.
• Establecer: este verbo se utiliza para establecer información o configuración de un recurso. Por ejemplo, Set-Location establece la ubicación de trabajo actual en una ubicación específica.
• Eliminar: este verbo se utiliza para eliminar o eliminar el recurso. Por ejemplo, Remove-Event elimina el evento de la cola de eventos.
• Nuevo: este verbo se utiliza para crear un nuevo recurso. Por ejemplo, New-LocalUser crea una cuenta de usuario local.

Grupo de verbos aprobados por PowerShell

PowerShell ha aprobado verbos para diferentes grupos y especifica acciones que se aplican al grupo. El grupo de verbos permitidos de PowerShell contiene verbos predefinidos para realizar acciones.

Verbos comunes

Los verbos comunes aprobados contienen verbos predefinidos para realizar acciones genéricas que se pueden aplicar a cualquier cmdlet. Por ejemplo, agregar, borrar, cerrar, obtener

Para obtener verbos comunes aprobados en PowerShell, ejecute el siguiente comando

Get-Verb | Where Group -eq "Common" 

El resultado de los verbos comunes anteriores es:

PS C:\> Get-Verb | Where Group -eq "Common"                                                                             
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

Verbos de comunicación

Los verbos de comunicación contienen verbos predefinidos para realizar acciones que se aplican a la comunicación. Por ejemplo, Conectar, Desconectar, Enviar, Recibir, etc.

Para obtener verbos de comunicación en PowerShell, ejecute el siguiente comando

Get-Verb | Where Group -eq "Communications" 

El resultado de los verbos aprobados de comunicación anteriores es:

PS C:\> Get-Verb | Where Group -eq "Communications"                                                                     
Verb       Group
----       -----
Connect    Communications
Disconnect Communications
Read       Communications
Receive    Communications
Send       Communications
Write      Communications


PS C:\>    

Consejo interesante: ¡Cómo cambiar el nombre de una computadora en PowerShell!

Verbos de datos

Los verbos de datos contienen verbos predefinidos para realizar acciones que se aplican al manejo de datos. Por ejemplo, Convertir, Guardar, Editar, etc.

Para obtener verbos de datos en PowerShell, ejecute el siguiente comando

Get-Verb | Where Group -eq "Data" 

El resultado del script de PowerShell anterior para obtener verbos de datos es:

PS C:\> Get-Verb | Where Group -eq "Data"                                                                               
Verb        Group
----        -----
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

Verbos de diagnóstico

Los verbos de diagnóstico contienen verbos predefinidos para realizar una acción que se aplica al diagnóstico del recurso. Por ejemplo, depurar, probar, reparar, etc.

Para obtener verbos aprobados de diagnóstico en PowerShell, ejecute el siguiente comando

Get-Verb | Where Group -eq "Diagnostic" 

El resultado del script de PowerShell anterior para obtener verbos de diagnóstico es:

PS C:\> Get-Verb | Where Group -eq "Diagnostic"                                                                         
Verb    Group
----    -----
Debug   Diagnostic
Measure Diagnostic
Ping    Diagnostic
Repair  Diagnostic
Resolve Diagnostic
Test    Diagnostic
Trace   Diagnostic


PS C:\>        

Verbos del ciclo de vida

Los verbos del ciclo de vida contienen verbos predefinidos para realizar una acción que se aplica al ciclo de vida de un recurso. Por ejemplo, Aprobar, Deshabilitar, Habilitar, etc.

Para obtener verbos aprobados por el ciclo de vida en PowerShell, ejecute el siguiente comando

Get-Verb | Where Group -eq "LifeCycle" 

El resultado del comando anterior obtiene los verbos del ciclo de vida.

PS C:\> Get-Verb | Where Group -eq "LifeCycle"                                                                          
Verb       Group
----       -----
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


PS C:\>      

Verbos de seguridad

Los verbos de seguridad contienen verbos predefinidos para realizar acciones que se aplican a la seguridad de los recursos. Por ejemplo, Bloquear, Proteger, Desbloquear, etc.

Para obtener verbos aprobados por seguridad en PowerShell, ejecute el siguiente comando

Get-Verb | Where Group -eq "Security" 

El resultado del script de PowerShell anterior para recuperar el verbo de seguridad es:

PS C:\> Get-Verb | Where Group -eq "Security"                                                                           
Verb      Group
----      -----
Block     Security
Grant     Security
Protect   Security
Revoke    Security
Unblock   Security
Unprotect Security


PS C:\>         

Otros verbos

Otros verbos contienen verbos predefinidos que no cubren ninguna de las categorías mencionadas anteriormente. Por ejemplo, utilice

Get-Verb | Where Group -eq "Other" 

El resultado del comando anterior es:

PS C:\> Get-Verb | Where Group -eq "Other"                                                                              
Verb Group
---- -----
Use  Other


PS C:\>    

Consejo interesante: ¡Cómo obtener información de computadoras remotas en PowerShell!

Convención de nomenclatura de funciones de PowerShell

El nombre de la función de PowerShell debe ser descriptivo y proporcionar una idea clara de lo que hace la función. Al nombrar la función en PowerShell, siga las mejores prácticas de verbos aprobados.

Estas son algunas de las mejores prácticas a seguir para el nombre de la función PowerShell.

1. Utilice pares verbo-sustantivo: los comandos de PowerShell siguen un patrón de verbo-sustantivo donde el elemento verbal describe la acción que realiza el comando, mientras que el sustantivo describe la identidad sobre la cual se realizará la acción. Por ejemplo, Eliminar elemento, Obtener proceso, etc.
2. Utilice PascalCase: el nombre de la función en PowerShell debe seguir a PascalCase, lo que significa que la primera letra de cada palabra debe estar en mayúscula. Por ejemplo, Get-Process y Get-AdUser.
3. Evite abreviaturas: utilice palabras descriptivas para describir la parte sustantiva en el nombre de la función. El nombre de la función debe ser conciso y fácil de recordar.

Conclusión

Espero que el artículo anterior sobre los verbos aprobados por PowerShell le resulte útil para escribir su cmdlet o funcionar según el formato verbo-sustantivo.

Se recomienda utilizar verbos aprobados al escribir cmdlet y evitar el uso de sinónimos de verbos aprobados en PowerShell. El uso de verbos aprobados por PowerShell es una práctica recomendada importante para garantizar la coherencia y la sintaxis del código, y que el código sea fácil de entender y mantener.

Puede encontrar más temas sobre los comandos de PowerShell Active Directory y los conceptos básicos de PowerShell en la página de inicio de ShellGeek.