Como usar a documentação do PowerShell

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

• PowerShell 7.5 (versão prévia)
• PowerShell 7.4 (LTS-current)
• PowerShell 7.2 (LTS – atual)
• PowerShell 5.1

Navegar na documentação

A página da Web contém vários elementos que ajudam você 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. Ela contém links para outros conteúdos na plataforma do Microsoft Learn.
• Navegação de conteúdo relacionado – a barra de conteúdo relacionado está imediatamente abaixo da navegação no nível do site. Ela contém links para conteúdos relacionados 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 e controla qual versão da referência de cmdlet aparece nele.
• Sumário – o sumário à esquerda da página é dividido em duas seções: conceitual e referência. Observe a linha entre o nó Referência do sumário. Os documentos conceituais aparecem acima dessa linha. O conteúdo de referência está listado no nó Referência, abaixo da linha.
• Botões de ação – por meio dos botões de ação, é possível adicionar conteúdos a uma coleção, fornecer comentários, editar conteúdos ou compartilhá-los com outras pessoas.

Selecionar a versão do PowerShell

Use o seletor de versão acima do sumário para selecionar a versão desejada do PowerShell. 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 de cmdlet aparece no sumário no nó Referência. Alguns cmdlets funcionam de maneira diferente de acordo com a versão do PowerShell que está sendo usada. Verifique se você está lendo a documentação da 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 de uma versão, a documentação trará observações a respeito.

Para verificar a versão do PowerShell que você está usando, inspecione o valor $PSversionTable.PSVersion. O exemplo a seguir mostra a saída do Windows PowerShell 5.1.

$PSVersionTable.PSVersion

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

Localizar artigos

Há duas maneiras de pesquisar conteúdo nos docs.

• A caixa de pesquisa na barra de navegação no nível do site pesquisa o site inteiro. Ela retorna uma lista de artigos correspondentes de todos os conjuntos de documentações.
• A caixa de filtro TOC sob o seletor de versão permite a filtragem 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 TOC mostra uma lista de artigos que contêm a palavra invoke no título. A inserção da palavra idempotent no filtro TOC não mostra nenhum artigo. Ao clicar no link de pesquisa, pesquise idempotent na documentação do PowerShell. Essa pesquisa retorna apenas 9 resultados.

Baixar a documentação como PDF

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

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

Localizar artigos de versões anteriores

A documentação de versões mais antigas do PowerShell foi arquivada no site Versões anteriores. É possível escolher Versões anteriores no seletor de versão.

Ele contém a documentação dos seguintes tópicos:

• PowerShell 3.0
• PowerShell 4.0
• PowerShell 5.0
• PowerShell 6
• PowerShell 7.0
• PowerShell 7.1
• PowerShell 7.3
• Fluxo de Trabalho do PowerShell
• Windows PowerShell Web Access