Partilhar via

Como usar a documentação do PowerShell

  • Artigo

Bem-vindo à documentação online do PowerShell. Este site contém referência de cmdlet para as seguintes versões do PowerShell:

  • PowerShell 7.5 (visualização)
  • PowerShell 7.4 (LTS-atual)
  • PowerShell 7.2 (LTS-atual)
  • PowerShell 5.1

Captura de ecrã a mostrar os vários elementos da página Web.

A página Web contém vários elementos que o ajudam a navegar na documentação.

  • Navegação no nível do site - A navegação no nível do site aparece na parte superior da página. Ele contém links para outros conteúdos na plataforma Microsoft Learn.
  • Navegação de conteúdo relacionado - A barra de conteúdo relacionada está imediatamente abaixo da navegação no nível do site. Ele contém links para conteúdo relacionado ao conjunto de documentação atual, que é o PowerShell neste caso.
  • Seletor de versão - O seletor de versão aparece acima do sumário (TOC) e controla qual versão da referência do cmdlet aparece no sumário.
  • Índice - O sumário do lado esquerdo da página está dividido em duas seções: conceitual e de referência. Observe a linha entre o nó Referência do índice. Os documentos conceptuais aparecem acima da linha. O conteúdo de referência está listado no nó Referência abaixo da linha.
  • Botões de ação - Os botões de ação fornecem uma maneira de adicionar conteúdo a uma coleção, fornecer feedback, editar o conteúdo ou compartilhar o conteúdo com outras pessoas.

Selecionando a versão do PowerShell

Use o seletor de versão localizado acima do sumário para selecionar a versão do PowerShell desejada. Por padrão, a página é carregada com a versão estável mais atual selecionada. O seletor de versão controla qual versão da referência do cmdlet aparece no sumário sob o nó Referência . Alguns cmdlets funcionam de forma diferente em diferentes versões do PowerShell que você está usando. Certifique-se de que está a visualizar a documentação para a versão correta do PowerShell.

O seletor de versão não afeta a documentação conceitual. Os documentos conceituais aparecem acima do nó Referência no sumário. Os mesmos artigos conceituais aparecem para cada versão selecionada. Se houver diferenças específicas da versão, a documentação anota essas diferenças.

Animação mostrando como usar o seletor de versão.

Você pode verificar a versão do PowerShell que está usando inspecionando o $PSversionTable.PSVersion valor. O exemplo a seguir mostra a saída para o Windows PowerShell 5.1.

$PSVersionTable.PSVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
5      1      22621  963

Encontrar artigos

Há duas maneiras de pesquisar conteúdo no Documentos.

  • A caixa de pesquisa na barra de navegação no nível do site pesquisa todo o site. Ele retorna uma lista de artigos correspondentes de todos os conjuntos de documentação.
  • A caixa de filtro de sumário sob o seletor de versão permite filtrar por palavras que aparecem no título de um artigo. O filtro exibe uma lista de artigos correspondentes à medida que você digita. Você também pode selecionar a opção para pesquisar as palavras em um artigo. Quando você pesquisa a partir daqui, a pesquisa é limitada à documentação do PowerShell.

No exemplo a seguir, a pesquisa na barra de navegação no nível do site retorna 840 resultados para a palavra idempotent. Inserir a palavra invoke na caixa de filtro de sumário mostra uma lista de artigos que contêm a palavra invoke no título. Inserir a palavra idempotent no filtro TOC não mostra nenhum artigo. Clicar no link de pesquisa procura idempotent na documentação do PowerShell. Esta pesquisa devolve apenas 9 resultados.

Animação mostrando como usar os recursos de pesquisa.

Download da documentação em PDF

Para baixar a documentação como PDF, clique no botão Baixar PDF na parte inferior do sumário.

Captura de ecrã do botão Transferir PDF.

  • Se você estiver visualizando um artigo conceitual, a plataforma Learn criará um PDF contendo todo o conteúdo conceitual para a versão selecionada.
  • Se você estiver visualizando um artigo de referência, a plataforma Learn criará um PDF contendo todo o conteúdo de referência para a versão selecionada.

Encontrar artigos para versões anteriores

A documentação para versões mais antigas do PowerShell é arquivada em nosso site de Versões Anteriores . Você pode escolher Versões Anteriores no seletor de versão.

Captura de ecrã da opção Versões Anteriores.

Este site contém documentação para os seguintes tópicos:

  • PowerShell 3.0
  • PowerShell 4.0
  • Powershell 5.0
  • PowerShell 6
  • PowerShell 7.0
  • PowerShell 7.1
  • PowerShell 7.3
  • Fluxos de trabalho do PowerShell
  • Acesso Web ao PowerShell