Runbook 输出和消息

在包含在 runbook 中的函数中写入输出流时，输出会传递回 runbook。 如果 runbook 将该输出分配给变量，则它不会写入输出流。 从函数中写入任何其他流会写入 runbook 的对应流。

请考虑下面的示例 runbook。

Workflow Test-Runbook
{
   Write-Verbose "Verbose outside of function"
   Write-Output "Output outside of function"
   $functionOutput = Test-Function

   Function Test-Function
   {
      Write-Verbose "Verbose inside of function"
      Write-Output "Output inside of function"
   }
}

Runbook 作业的输出流是：

Output outside of function

Runbook 作业的详细流是：

Verbose outside of function
Verbose inside of function

$functionOutput 变量会具有值：

Output inside of function

工作流可以使用 OutputType 特性指定其输出的数据类型。 此特性在运行时期间没有任何影响，但是它在设计时向 runbook 作者提供了 runbook 的预期输出的指示。 随着 runbook 的工具集继续发展，在设计时声明输出数据类型的重要性的也会提高。 因此，在创建的任何 runbook 中都包含此声明是最佳做法。

下面的示例 runbook 输出一个字符串对象，并包含其输出类型的声明。 如果 runbook 输出特定类型的数组，则应仍指定类型而不是该类型的数组。

Workflow Test-Runbook
{
   [OutputType([string])]

   $output = "This is some string output."
   Write-Output $output
}

警告和错误流旨在记录 runbook 中出现的问题。 它们会在执行 runbook 时写入作业历史记录，并且在测试 runbook 时包含在管理门户的测试输出窗格中。 默认情况下，runbook 会在出现警告或错误之后继续执行。 可以通过在创建消息之前在 runbook 中设置首选项变量，指定应在出现警告或错误时挂起 runbook。 例如，要使 runbook 如同异常一样在出现错误时挂起，请将 $ErrorActionPreference 设置为 Stop。

使用 Write-Warning 或 Write-Error cmdlet 创建警告或错误消息。 活动也可能会写入这些流。

#The following lines create a warning message and then an error message that will suspend the runbook.

$ErrorActionPreference = "Stop"
Write-Warning –Message "This is a warning message."
Write-Error –Message "This is an error message that will stop the runbook because of the preference variable."

详细消息流用于有关 runbook 操作的常规信息。 由于调试流在 runbook 中不可用，因此应将详细消息用于故障排除信息。 默认情况下，来自已发布 runbook 的详细消息不会存储在作业历史记录中。 要存储详细消息，请在管理门户中的 runbook 的“配置”选项卡上将已发布 runbook 配置为“记录详细记录”。 在大多数情况下，出于性能原因，应对 runbook 保留不记录详细记录的默认设置。 启用此选项仅仅是为了对 runbook 进行故障排除或调试。

$VerbosePreference 变量的默认值为 SilentlyContinue。 无需在已发布 runbook 中更改此变量来存储详细消息。 不过，如果此值在已发布 runbook 中显式设置为 SilentlyContinue，则不会存储详细消息（即使 runbook 配置为记录详细记录）。

测试 runbook 时，不会显示详细消息（即使 runbook 配置为记录详细记录）。 要在测试 runbook 时显示详细消息，必须将 $VerbosePreference 变量设置为 Continue。 设置该变量后，会在管理门户的测试输出窗格中显示详细消息。

可使用 Write-Verbose cmdlet 创建详细消息。

#The following line creates a verbose message.

Write-Verbose –Message "This is a verbose message."

调试流旨在用于交互用户，不应在 runbook 中使用。

可以从管理门户中的 runbook 的“作业”选项卡查看 runbook 作业的详细信息。 除了有关作业以及任何异常（如发生）的常规信息，作业的“摘要”还显示输入参数和 输出流。 如果将 Runbook 配置为记录详细记录和进度记录，则除了 详细流 和 进度记录，”历史记录”还将包括来自输出流和 警告和错误流 的消息。

在 Windows PowerShell 中，可以使用Get-SmaJobOutput cmdlet 从 runbook 检索输出和消息。 此 cmdlet 需要作业 ID，并具有一个名为“Stream”的参数（在其中指定要返回的流）。 可以指定“Any”以返回作业的所有流。

下面的示例启动一个示例 runbook，然后等待它完成。 完成之后，便从作业收集其输出流。

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$job = Start-SmaRunbook –WebServiceEndpoint $webServer –Port $port –Name $runbookName

$doLoop = $true
While ($doLoop) {
   $job = Get-SmaJob –WebServiceEndpoint $webServer –Port $port -Id $job.Id
   $status = $job.Status
   $doLoop = (($status -ne "Completed") -and ($status -ne "Failed") -and ($status -ne "Suspended") -and ($status -ne "Stopped") 
}

Get-SmaJobOutput –WebServiceEndpoint $webServer –Port $port -Id $job.Id –Stream Output