DscExamplesPresent

Tingkat Keparahan : Informasi

Status default: Selalu diaktifkan

Description

Aturan ini mendeteksi apakah ada contoh Desired State Configuration (DSC) untuk sumber daya tertentu.

Untuk memperbaiki pelanggaran aturan ini, Anda harus memastikan bahwa Examples direktori ada untuk:

• Sumber daya berbasis non-kelas, harus berada di tingkat folder yang sama dengan DSCResources folder.
• Sumber daya berbasis kelas, harus berada di tingkat folder yang sama dengan file sumber daya .psm1 .

Examples Folder harus berisi konfigurasi sampel untuk sumber daya. Nama file harus menyertakan nama sumber daya.

Example

Sumber daya berbasis non-kelas

Mari kita asumsikan kita memiliki sumber daya berbasis non-kelas dengan struktur file berikut:

• xAzure
  • Sumber DSCRe-sumber
    • MSFT_xAzureSubscription
      • MSFT_xAzureSubscription.psm1
      • MSFT_xAzureSubscription.skema.mof

Dalam hal ini, untuk memperbaiki peringatan ini, tambahkan contoh dengan cara berikut:

• xAzure
  • Sumber DSCRe-sumber
    • MSFT_xAzureSubscription
      • MSFT_xAzureSubscription.psm1
      • MSFT_xAzureSubscription.skema.mof
  • Contoh
    • MSFT_xAzureSubscription_AddSubscriptionExample.ps1
    • MSFT_xAzureSubscription_RemoveSubscriptionExample.ps1

Sumber daya berbasis kelas

Mari kita asumsikan kita memiliki sumber daya berbasis kelas dengan struktur file berikut:

• Sumber Daya MyDsc
  • MyDscResource.psm1
  • MyDscResource.psd1

Dalam hal ini, untuk memperbaiki peringatan ini, tambahkan contoh dengan cara berikut:

• Sumber Daya MyDsc
  • MyDscResource.psm1
  • MyDscResource.psd1
  • Contoh
    • MyDscResource_Example1.ps1
    • MyDscResource_Example2.ps1

Mengonfigurasi aturan

Aturan ini selalu diaktifkan dan tidak dapat dikonfigurasi. Gunakan salah satu metode berikut untuk menghindari penggunaan aturan ini:

• Buat file konfigurasi aturan kustom untuk hanya menyertakan aturan yang Anda inginkan atau kecualikan aturan yang tidak Anda inginkan.
• Tambahkan atribut penekanan aturan yang sesuai ke kode Anda untuk menekan aturan untuk blok kode tertentu. Untuk informasi selengkapnya, lihat bagian Menekan aturanMenggunakan PSScriptAnalyzer.