DSC示例现状

严重性级别：信息

默认状态：始终启用

Description

该规则检测给定资源是否存在Desired State Configuration（DSC）示例。

要纠正违反该规则，您必须确保 Examples 目录存在于以下状态：

• 非职业类资源，应该和文件夹在同一个文件夹层。DSCResources
• 基于类的资源，应该和资源 .psm1 文件在同一文件夹层。

文件夹必须 Examples 包含该资源的示例配置。 文件名应包含资源名称。

Example

非职业资源

假设我们有一个非类类资源，文件结构如下：

• 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资源
  • MyDsc资源.psm1
  • MyDsc资源.psd1

在这种情况下，为了修正该警告，请以以下方式添加示例：

• MyDsc资源
  • MyDsc资源.psm1
  • MyDsc资源.psd1
  • 示例
    • MyDscResource_Example1.ps1
    • MyDscResource_Example2.ps1

配置规则

这个规则始终是启用的，不能配置。 请采用以下方法之一以避免使用此规则：

• 创建一个自定义规则配置文件，只包含你想要的规则，或者排除你不想要的规则。
• 在代码中添加相应的规则抑制属性，以抑制特定代码块的规则。 更多信息请参见使用 PSScriptAnalyzer 中的“抑制规则”部分。