UseVerboseMessageInDSCResource

重大度レベル: 情報

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

Description

このルールは、関数やスクリプトに Write-Verbose メッセージが含まれていないDSCリソースを検出します。 Write-Verboseを使ってコマンド、関数、スクリプトに追加のユーザー情報を提供するのがベストプラクティスです。 これにより、ユーザーは実行中に何が起きているのか理解できます。 コードをより情報豊かでデバッグしやすくするために、メッセージ Write-Verbose を含めるべきです。

例

非準拠

Function Test-Function
{
    [CmdletBinding()]
    Param()
    ...
}

対応

Function Test-Function
{
    [CmdletBinding()]
    Param()
    Write-Verbose 'Verbose output'
    ...
}

ルールの設定

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

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