DSC例示

重大度レベル: 情報

デフォルト状態:常に有効

Description

このルールは、特定のリソースに対してDesired State Configuration(DSC)例が存在するかどうかを検出します。

このルール違反を修正するには、 Examples ディレクトリが以下の目的で存在していることを確認しなければなりません:

• クラス以外のリソースは、 DSCResources フォルダと同じフォルダレベルにあるべきです。
• クラスベースのリソースは、リソースの .psm1 ファイルと同じフォルダレベルにあるべきです。

Examplesフォルダにはリソースのサンプル構成が含まれていなければなりません。 ファイル名にはリソース名を含めるべきです。

例

非クラスベースのリソース

以下のファイル構造を持つ非クラスベースのリソースがあると仮定します。

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

この場合、この警告を修正するために、以下の例を追加してください。

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

クラスベースのリソース

次のファイル構造を持つクラスベースのリソースがあると仮定します:

• MyDscリソース
  • MyDscResource.psm1
  • MyDscResource.psd1

この場合、この警告を修正するために、以下の例を追加してください。

• MyDscリソース
  • MyDscResource.psm1
  • MyDscResource.psd1
  • 例
    • MyDscResource_Example1.ps1
    • MyDscResource_Example2.ps1

ルールの設定

このルールは常に有効で、設定はできません。 このルールを避けるために、以下のいずれかの方法を用いてください。

• 欲しいルールだけを含めるか、不要なルールを除外するカスタムルール設定ファイルを作成しましょう。
• 特定のコードブロックに対してルール抑制を抑制するために、適切なルール抑制属性をコードに追加してください。 詳細については、PSScriptAnalyzerの使用に関する「抑制ルール」セクションをご覧ください。