Write-Information
Especifica como o Windows PowerShell lida com dados de fluxo de informações para um comando.
Sintaxe
Default (Predefinição)
Write-Information
[-MessageData] <Object>
[[-Tags] <String[]>]
[<CommonParameters>]
Description
O cmdlet Write-Information especifica como o Windows PowerShell lida com dados de fluxo de informações para um comando.
O Windows PowerShell 5.0 apresenta um novo fluxo de informações estruturado (número 6 em fluxos do Windows PowerShell) que você pode usar para transmitir dados estruturados entre um script e seus chamadores (ou ambiente de hospedagem).
Write-Information permite adicionar uma mensagem informativa ao fluxo e especificar como o Windows PowerShell lida com dados de fluxo de informações para um comando. Os fluxos de informações também funcionam para PowerShell.Streams, trabalhos, trabalhos agendados e fluxos de trabalho.
Observação
O fluxo de informações não segue a convenção padrão de prefixar suas mensagens com "[Nome do fluxo]:". Isto foi concebido para brevidade e clareza visual.
O valor da variável de preferência $InformationPreference determina se a mensagem que você fornece a 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 não quiser alterar o valor de $InformationPreference, você pode substituir seu valor adicionando o parâmetro comum InformationAction ao comando.
Para obter mais informações, consulte about_Preference_Variables e about_CommonParameters.
Observação
A partir do Windows PowerShell 5.0, Write-Host é um encapsulador para Write-Information. Isto permite que tu uses Write-Host para emitir saída para o fluxo de informações.
Isso permite que o capture ou de supressão de dados gravados usando Write-Host preservando a compatibilidade com versões anteriores.
para obter mais informações, consulte Write-Host
Write-Information também é uma atividade de fluxo de trabalho suportada.
Exemplos
Exemplo 1: Escrever informações para Get- results
Get-WindowsFeature -Name p*; Write-Information -MessageData "Got your features!" -InformationAction Continue
Display Name Name Install State
------------ ---- -------------
[ ] Print and Document Services Print-Services Available
[ ] Print Server Print-Server Available
[ ] Distributed Scan Server Print-Scan-Server Available
[ ] Internet Printing Print-Internet Available
[ ] LPD Service Print-LPD-Service Available
[ ] Peer Name Resolution Protocol PNRP Available
[X] Windows PowerShell PowerShellRoot Installed
[X] Windows PowerShell 5.0 PowerShell Installed
[ ] Windows PowerShell 2.0 Engine PowerShell-V2 Removed
[X] Windows PowerShell ISE PowerShell-ISE Installed
Got your features!
Neste exemplo, você mostra uma mensagem informativa, "Tem seus recursos!", depois de executar o comando Get-WindowsFeature para localizar todos os recursos que têm um valor Name que começa com 'p'.
Como a variável $InformationPreference ainda está definida como padrão, SilentlyContinue, você adiciona o parâmetro InformationAction para substituir o valor $InformationPreference e mostrar a mensagem.
O valor InformationAction é Continue, o que significa que sua mensagem é mostrada, mas o script ou comando continua, se ainda não tiver sido concluído.
Exemplo 2: Escrever informações e marcá-las
Get-WindowsFeature -Name p*; Write-Information -MessageData "To filter your results for PowerShell, pipe your results to the Where-Object cmdlet." -Tags "Instructions" -InformationAction Continue
Display Name Name Install State
------------ ---- -------------
[ ] Print and Document Services Print-Services Available
[ ] Print Server Print-Server Available
[ ] Distributed Scan Server Print-Scan-Server Available
[ ] Internet Printing Print-Internet Available
[ ] LPD Service Print-LPD-Service Available
[ ] Peer Name Resolution Protocol PNRP Available
[X] Windows PowerShell PowerShellRoot Installed
[X] Windows PowerShell 5.0 PowerShell Installed
[ ] Windows PowerShell 2.0 Engine PowerShell-V2 Removed
[X] Windows PowerShell ISE PowerShell-ISE Installed
To filter your results for PowerShell, pipe your results to the Where-Object cmdlet.
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 tag Instructions à mensagem informativa.
Depois de executar esse comando, se você pesquisar no fluxo de informações por mensagens marcadas como Instruções, a mensagem especificada aqui estará entre os resultados.
Exemplo 3: Gravar informações em um arquivo
function Test-Info
{
Get-Process P*
Write-Information "Here you go"
}
Test-Info 6> Info.txt
Neste exemplo, você redireciona o fluxo de informações na função para um arquivo, Info.txt, usando o código 6>. Quando você abre o arquivo Info.txt, você vê o texto, "Aqui você vai".
Parâmetros
-MessageData
Especifica uma mensagem informativa que você deseja exibir aos usuários à medida que eles executam um script ou comando. Para obter melhores resultados, coloque a mensagem informativa entre aspas. Um exemplo é "Teste concluído".
Propriedades dos parâmetros
| Tipo: | Object |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Msg |
Conjuntos de parâmetros
(All)
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Tags
Especifica uma cadeia de caracteres simples que você pode usar para classificar e filtrar mensagens que você adicionou ao fluxo de informações com Write-Information.
Este parâmetro funciona de forma semelhante ao parâmetro Tags no New-ModuleManifest.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
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.
Entradas
None
Write-Information não aceita entrada canalizada.