Glosario: DSC

PowerShell Desired State Configuration (DSC) usa varios términos que pueden tener definiciones diferentes en otro lugar. En este documento se enumeran los términos, sus significados y se muestra cómo se les da formato en la documentación.

Términos de configuración

Palabra clave Configuration

Palabra clave de PowerShell para definir una configuración de DSC.

Directrices

1. Dar formato a este término como código.
2. Use mayúsculas y minúsculas de título para este término.

Ejemplos

Para definir una configuración de DSC, use la palabra clave Configurationde PowerShell .

Bloque Configuration

El bloque de scripts de PowerShell que define una configuración de DSC.

Directrices

1. Dé formato a la palabra Configuration en este término como código.
2. Use mayúsculas y minúsculas para la palabra "block" en este término.

Ejemplos

Al usar este recurso de DSC en un Configuration bloque, puede especificar MSFT_UserResource o User.

Configuración de DSC

Conjunto con nombre de bloques de recursos de DSC definidos en un Configuration bloque.

Para usar una configuración de DSC, se ejecuta por nombre, que compila la configuración de DSC en un .mof archivo. El archivo resultante .mof representa el estado deseado para un sistema.

Directrices

1. Ponga en mayúscula la palabra "Configuration" en este término.
2. No agregue ningún formato a este término.

Ejemplos

Aquí es donde la configuración de DSC define la configuración del componente que está configurando.

Import-DscResource

Palabra clave dinámica que solo es válida en un Configuration bloque. Hace que los recursos de DSC estén disponibles para la configuración de DSC. Para usar un recurso de DSC, debe importarse con esta palabra clave.

Directrices

1. Dar formato a este término como código.
2. Use mayúsculas y minúsculas Pascal para este término.

Ejemplos

Import-DscResource es una palabra clave dinámica que solo se puede reconocer dentro de un Configuration bloque.

Términos de recursos

Recurso de DSC

La interfaz de DSC para administrar la configuración de un componente. Incluye una o varias propiedades y los métodos Get, Set y Test .

Directrices

1. Use mayúsculas y minúsculas de título para este término.
2. Dar formato a los nombres de recursos de DSC específicos como código.

Ejemplos

Ambos usan el Environment recurso de DSC.

Puede inspeccionar un recurso de DSC con el Get-DscResource cmdlet para ver las propiedades que administra.

Recurso de DSC basado en clases

Un recurso de DSC definido como una clase de PowerShell en un módulo.

El esquema del recurso de DSC basado en clases se define mediante los miembros de la clase . Un recurso de DSC basado en clases debe definir los Get()métodos , Set()y Test() .

Directrices

1. Use mayúsculas y minúsculas para la palabra class en este término.
2. No agregue ningún formato a este término.

Ejemplos

El recurso de DSC basado en clases no tiene requisitos especiales para dónde se define.

Los recursos de DSC basados en clases definen su esquema en la definición de clase.

Recurso de DSC compuesto

Un recurso de DSC definido con un archivo de módulo de script (.psm1) y un archivo de manifiesto de módulo opcional (.psd1).

El archivo del módulo de script define el esquema y la implementación del recurso de DSC como una configuración de DSC.

Directrices

1. Use mayúsculas y minúsculas para la palabra composite en este término.
2. No agregue ningún formato a este término.

Ejemplos

Un recurso de DSC compuesto es una configuración de DSC que toma parámetros.

Los recursos de DSC compuestos no funcionan con Invoke-DscResource.

Recurso de DSC basado en MOF

Un recurso de DSC definido con un archivo MOF (.mof), un archivo de módulo de script (.psm1) y un archivo de manifiesto de módulo opcional (.psd1).

El archivo MOF es el esquema del recurso de DSC y define las propiedades del recurso de DSC. El archivo de módulo de script define las funciones del recurso de DSC: Get-TargetResource, Set-TargetResourcey Test-TargetResource. Estas funciones se asignan a los métodos Get, Set y Test que tienen todos los recursos de DSC.

Directrices

1. Especifique siempre este término como "recurso de DSC basado en MOF".
2. No agregue ningún formato a este término.

Ejemplos

Los recursos de DSC basados en MOF definen su esquema en un schema.mof archivo mediante el formato de objeto administrado.

Bloque de recursos

Definición del estado deseado para un recurso de DSC específico en un Configuration bloque.

Directrices

1. Use el uso de mayúsculas y minúsculas para este término.
2. No agregue ningún formato a este término.
3. Al escribir sobre un bloque de recursos específico en una configuración de DSC, escriba el nombre con formato correcto del recurso de DSC seguido de "bloque de recursos".

Ejemplos

En el ejemplo siguiente se agrega un bloque de parámetros con un -ServiceName parámetro y se usa para definir dinámicamente el Service bloque de recursos.

Métodos

Las operaciones que puede tomar un recurso de DSC para el componente que administra.

• Get: recupera el estado actual de una instancia del recurso de DSC.
• Establecer : aplica el estado deseado de una instancia del recurso de DSC.
• Prueba : compara el estado deseado de una instancia del recurso de DSC con su estado actual. Devuelve $true si la instancia está en el estado deseado y $false si no es así.

Directrices

1. Ponga en mayúsculas los métodos.
2. Al hacer referencia al método en el contexto de llamar a Invoke-DscResource, dé formato al método como negrita.
3. Al hacer referencia al método como implementado en una clase de PowerShell, dé formato al método como code con un conjunto vacío de paréntesis (()) después del nombre.

Ejemplos

La implementación del Set() método no puede usar ninguna return instrucción .

DSC se construye en torno a un proceso Get, Test y Set .

Propiedad

Configuración que un recurso de DSC puede administrar para un componente. Los recursos de DSC siempre tienen al menos una propiedad.

Directrices

1. Dar formato a los nombres de propiedad de recursos de DSC como negrita.
2. Use el uso de mayúsculas y minúsculas de Pascal para los nombres de propiedad de recursos de DSC.
3. Dar formato a los valores de propiedad de recurso de DSC como código.

Ejemplos

El valor de la propiedad Format de este ejemplo es JSON.