Write-Information

Write-Information
    [-MessageData] <Object>
    [[-Tags] <String[]>]
    [<CommonParameters>]

O cmdlet Write-Information especifica como o PowerShell lida com dados de fluxo de informações para um comando.

O Windows PowerShell 5.0 apresenta um novo fluxo de informações estruturados. Você pode usar esse fluxo para transmitir dados estruturados entre um script e seus chamadores ou o aplicativo host. Write-Information permite adicionar uma mensagem informativa ao fluxo e especificar como o PowerShell lida com dados de fluxo de informações para um comando. Os fluxos de informações também funcionam para PowerShell.Streams, trabalhos e tarefas agendadas.

O valor da variável de preferência $InformationPreference determina se a mensagem que você fornece para Write-Information é exibida no ponto esperado na operação de um script. Como o valor padrão dessa variável é SilentlyContinue, por padrão, as mensagens informativas não são mostradas. Se você não quiser alterar o valor de $InformationPreference, poderá substituir seu valor adicionando o parâmetro InformationAction comum ao seu comando. Consulte about_Preference_Variables e about_CommonParameterspara obter mais informações.

Write-Information também é uma atividade de fluxo de trabalho com suporte no Windows PowerShell 5.1.

Neste exemplo, você mostra uma mensagem informativa, "Processos começando com 'P'", antes de executar o comando Get-Process para localizar todos os processos que têm um nome valor que começa com 'p'. Como a variável ainda está definida como padrão, SilentlyContinue, adicione o parâmetro InformationAction para substituir o valor e mostrar a mensagem. O valor InformationAction é Continue, o que significa que sua mensagem é mostrada, mas o script ou o comando continua, caso não tenha sido concluído ainda.

Write-Information -MessageData "Processes starting with 'P'" -InformationAction Continue
Get-Process -Name p*

Processes starting with 'P'

     18    19.76      15.16       0.00    6232   0 PFERemediation
     20     8.92      25.15       0.00   24944   0 policyHost
      9     1.77       7.64       0.00    1780   0 powercfg
     10    26.67      32.18       0.00    7028   0 powercfg
      8    26.55      31.59       0.00   13600   0 powercfg
      9     1.66       7.55       0.00   22620   0 powercfg
     21     6.17       4.54     202.20   12536   1 PowerMgr
     42    84.26      12.71   2,488.84   20588   1 powershell
     27    47.07      45.38       2.05   25988   1 powershell
     27    24.45       5.31       0.00   12364   0 PresentationFontCache
     92   112.04      13.36      82.30   13176   1 pwsh
    106   163.73      93.21     302.25   14620   1 pwsh
    227   764.01      92.16   1,757.22   25328   1 pwsh

Neste exemplo, você usa Write-Information para informar aos usuários que eles precisarão executar outro comando depois que terminarem de executar o comando atual. O exemplo adiciona a marca "Instructions" à mensagem informativa. Depois de executar esse comando, quando você pesquisa o fluxo de informações em busca de mensagens marcadas "Instructions", a mensagem está nos resultados.

$message = "To filter your results for PowerShell, pipe your results to the Where-Object cmdlet."
Get-Process -Name p*
Write-Information -MessageData $message -Tags "Instructions" -InformationAction Continue

 NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     18    19.76      15.16       0.00    6232   0 PFERemediation
     20     8.92      25.15       0.00   24944   0 policyHost
      9     1.77       7.64       0.00    1780   0 powercfg
     10    26.67      32.18       0.00    7028   0 powercfg
      8    26.55      31.59       0.00   13600   0 powercfg
      9     1.66       7.55       0.00   22620   0 powercfg
     21     6.17       4.54     202.20   12536   1 PowerMgr
     42    84.26      12.71   2,488.84   20588   1 powershell
     27    47.07      45.38       2.05   25988   1 powershell
     27    24.45       5.31       0.00   12364   0 PresentationFontCache
     92   112.04      13.36      82.30   13176   1 pwsh
    106   163.73      93.21     302.25   14620   1 pwsh
    227   764.01      92.16   1,757.22   25328   1 pwsh

To filter your results for PowerShell, pipe your results to the Where-Object cmdlet.

Neste exemplo, você redireciona o fluxo de informações na função para Info.txt usando o código 6>. Ao abrir o arquivo Info.txt, você verá o texto "Aqui está".

function Test-Info
{
    Get-Process P*
    Write-Information "Here you go"
}
Test-Info 6> Info.txt

Usando o parâmetro InformationVariable, você pode salvar registros de informações em uma variável. Isso permite que você inspecione as mensagens de fluxo de informações posteriormente no script.

$psproc = Get-Process -Id $PID | Select-Object ProcessName, CPU, Path
Write-Information -MessageData $psproc -Tags 'PowerShell' -InformationVariable 'InfoMsg'
$InfoMsg | Select-Object *

MessageData     : @{ProcessName=powershell; CPU=1.609375;
                  Path=C:\WINDOWS\System32\WindowsPowerShell\v1.0\powershell.exe}
Source          : Write-Information
TimeGenerated   : 10/19/2023 11:28:15
Tags            : {PowerShell}
User            : sdwheeler
Computer        : circumflex
ProcessId       : 237
NativeThreadId  : 261
ManagedThreadId : 10

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Não é possível transferir objetos para esse cmdlet.

Esse cmdlet não retorna nenhuma saída. Ele grava apenas no fluxo de mensagens informativas.