Snap-in do PowerShell: usando o sistema de ajuda do PowerShell

Artigo
03/12/2024

Neste passo a passo, você aprenderá como obter ajuda sobre como usar o Snap-in do PowerShell do IIS.

Introdução

O Snap-in do PowerShell do IIS usa dois tipos de cmdlets.

Os cmdlets internos, como New-Item, Get-ChildItems ou Set-ItemProperty, são implementados em todos os namespaces (o sistema de arquivos, por exemplo) e também funcionam com o Snap-in do PowerShell do IIS. Esses cmdlets internos se aplicam a contêineres expostos na hierarquia do IIS: Sites, Pools de Aplicativos, Aplicativos Web e Diretórios Virtuais.
Os cmdlets específicos do Snap-in do PowerShell do IIS, como Get-WebConfiguration, Set-WebConfigurationProperty ou Get-WebItemState, só são aplicáveis ao IIS. Estes cmdlets precisam ser usados para gerenciar a configuração de recursos ou o estado em tempo de execução. Exemplos de configuração de recursos são configuração de defaultDocument, configurações de compactação, módulos e configuração de manipuladores etc. Exemplos de estado em tempo de execução são o estado de Pools de Aplicativos e Sites.

Ajuda para cmdlets internos

Obter ajuda para estes dois tipos de cmdlets é diferente. Para obter ajuda sobre como os cmdlets internos podem ser usados no namespace IIS:\ use o comando a seguir:

get-help WebAdministration | more

A saída desse comando fornecerá uma visão geral detalhada sobre como os cmdlets internos podem ser usados no namespace do IIS. Ela mostra a sintaxe e quais parâmetros adicionais precisam ser especificados. Por fim, ela exibirá um grande conjunto de exemplos que ajudarão você a se familiarizar com estes cmdlets.

Ajuda para os cmdlets específicos do IIS

Caso queira obter ajuda para os cmdlets específicos do IIS, você precisará usar o comando a seguir:

Get-Help <cmdlet name>

Exemplos:

Get-Help Get-WebConfiguration
Get-Help Get-WebItemState
Get-Help Add-WebConfiguration

Execute o seguinte comando para recuperar uma lista dos cmdlets que o IIS fornece:

PS IIS:\> Get-Command -pssnapin IISProviderSnapIn
CommandType     Name                                      Definition
-----------     ----                                      ----------
Cmdlet          Add-WebConfiguration                      Add-WebConfiguration [-Filter] <String...
Cmdlet          Add-WebConfigurationProperty              Add-WebConfigurationProperty [-Filter]...
Cmdlet          Begin-Transaction                         Begin-Transaction [[-PSPath] <String[]...
Cmdlet          Clear-WebConfiguration                    Clear-WebConfiguration [-Filter] <Stri...
Cmdlet          End-Transaction                           End-Transaction [[-PSPath] <String[]>]...
Cmdlet          Get-section                               Get-section [-Section] <String> [-PSPa...
Cmdlet          Get-URL                                   Get-URL [-Url <String>] [-PSPath <Stri...
Cmdlet          Get-WebConfiguration                      Get-WebConfiguration [-Filter] <String...
Cmdlet          Get-WebConfigurationProperty              Get-WebConfigurationProperty [-Filter]...
Cmdlet          Get-WebItemState                          Get-WebItemState [[-PSPath] <String[]>...
Cmdlet          Remove-WebConfigurationProperty           Remove-WebConfigurationProperty [-Filt...
Cmdlet          Restart-WebItem                           Restart-WebItem [[-PSPath] <String[]>]...
Cmdlet          Set-WebConfiguration                      Set-WebConfiguration [-Filter] <String...
Cmdlet          Set-WebConfigurationProperty              Set-WebConfigurationProperty [-Filter]...
Cmdlet          Start-WebItem                             Start-WebItem [[-PSPath] <String[]>] [...
Cmdlet          Stop-WebItem                              Stop-WebItem [[-PSPath] <String[]>] [-...

Resumo

Neste passo a passo, você aprendeu a usar o sistema de ajuda do PowerShell para obter mais informações sobre como usar os cmdlets internos no namespace do IIS e também sobre como usar os cmdlets específicos do IIS.

Share via