DscExamplesPresent

Nivel de gravedad: información

Descripción

Comprueba que hay ejemplos de DSC para un recurso determinado.

Cómo

Para corregir una infracción de esta regla, asegúrese de que Examples el directorio está presente:

• En el caso de los recursos no basados en clases, debe existir en el mismo nivel de carpeta que DSCResources la carpeta.
• Para los recursos basados en clases, debe estar presente en el mismo nivel de carpeta que el archivo de recursos .psm1 .

La Examples carpeta debe contener una configuración de ejemplo para un recurso determinado. El nombre del archivo debe contener el nombre del recurso.

Ejemplo

Recurso no basado en clases

Supongamos que tenemos un recurso no basado en clases con una estructura de archivos siguiente:

• xAzure
  • DSCResources
    • MSFT_xAzureSubscription
      • MSFT_xAzureSubscription.psm1
      • MSFT_xAzureSubscription.schema.mof

En este caso, para corregir esta advertencia, deberíamos agregar ejemplos de la siguiente manera:

• xAzure
  • DSCResources
    • MSFT_xAzureSubscription
      • MSFT_xAzureSubscription.psm1
      • MSFT_xAzureSubscription.schema.mof
  • Ejemplos
    • MSFT_xAzureSubscription_AddSubscriptionExample.ps1
    • MSFT_xAzureSubscription_RemoveSubscriptionExample.ps1

Recurso basado en clases

Supongamos que tenemos un recurso basado en clases con una estructura de archivos siguiente:

• MyDscResource
  • MyDscResource.psm1
  • MyDscResource.psd1

En este caso, para corregir esta advertencia, deberíamos agregar ejemplos de la siguiente manera:

• MyDscResource
  • MyDscResource.psm1
  • MyDscResource.psd1
  • Ejemplos
    • MyDscResource_Example1.ps1
    • MyDscResource_Example2.ps1