Compartilhar via


about_Command_Syntax

TÓPICO
    about_Command_Syntax

DESCRIÇÃO RESUMIDA
    Descreve a notação usada para a sintaxe do Windows PowerShell na 
    Ajuda.


DESCRIÇÃO LONGA
    O cmdlet Get-Help exibe o uso do parâmetro para um cmdlet. O 
    cmdlet Get-Help usa os seguintes símbolos especiais:

        Colchetes angulares (<>) indicam o texto do espaço reservado. 
        Colchetes ([]) indicam itens opcionais. Chaves ({}) indicam 
        uma escolha entre valores.


    Alguns cmdlets têm mais de um conjunto de parâmetros. Conjuntos de 
    parâmetros distintos podem compartilhar alguns parâmetros. O cmdlet 
    Get-Help exibe todos os conjuntos de parâmetros de um cmdlet.


    Você pode localizar informações adicionais sobre um parâmetro na 
    descrição do parâmetro e na tabela de atributos do parâmetro. 
    Para exibir informações completas sobre um parâmetro, use os 
    parâmetros Full ou Parameter de Get-Help.


  Sintaxe
      A Ajuda, os tópicos da Ajuda e outras documentações de cmdlet 
      do Windows PowerShell usam a seguinte notação para cmdlets em 
      descrições de sintaxe. 

          <nome do cmdlet> -<nome de parâmetro necessário> <valor de parâmetro necessário>
                       [-<nome de parâmetro opcional> <valor de parâmetro opcional>]
                       [-<parâmetro de opção opcional>]
                       [-<nome de parâmetro opcional>] <valor de parâmetro necessário>

      A seguir, é apresentada a sintaxe do cmdlet New-Alias.

          New-Alias [-Force] [-PassThru] [-Scope <string>] 
              [-Option {None | ReadOnly | Constant | Private | AllScope}] 
              [-Description <string>] [-Name] <string> [-Value] <string> 
              [-confirm] [-whatif] [<CommonParameters>]


      A sintaxe é mostrada com a primeira letra em maiúsculas para 
      melhorar a legibilidade, mas o Windows PowerShell não diferencia 
      maiúsculas de minúsculas. 


      Os parâmetros aparecem em ordem. A ordem dos parâmetros só é 
      importante quando os nomes de parâmetros são opcionais. Se você não 
      especificar nomes de parâmetro quando usar um cmdlet, o Windows PowerShell 
      atribuirá valores a parâmetros por posição e por tipo. 


      Nomes de parâmetro são precedidos por um hífen (-). Os 
      parâmetros de opção aparecem sem um tipo de valor. Outros parâmetros 
      aparecem com o tipo do Microsoft .NET Framework do argumento 
      necessário ou com uma enumeração de valores possíveis. 
      Para obter mais informações sobre os tipos do .NET Framework, 
      consulte https://go.microsoft.com/fwlink/?LinkId=143682.


      Colchetes angulares (<>) indicam o texto do espaço reservado. 
      Esse texto pode descrever o 
      tipo de um item (como uma cadeia de caracteres ou um objeto 
      Process). Também pode ser um espaço reservado para um ou mais 
      parâmetros comuns.


      Colchetes ([]) indicam itens opcionais. Um parâmetro pode ser 
      opcional ou o nome de um parâmetro necessário pode ser opcional. 
      Parâmetros de opção são sempre opcionais. 


      Chaves ({}) aparecem ao redor dos valores de uma enumeração. No 
      exemplo do cmdlet New-Alias, o parâmetro Option pode ter 
      qualquer um dos valores listados.


  Itens opcionais
      Colchetes ([]) envolvem itens opcionais. Por exemplo, na 
      descrição da sintaxe do cmdlet New-Alias, o parâmetro Scope é 
      opcional. Isso é indicado na sintaxe pelos colchetes em volta 
      do nome de parâmetro e do tipo:

          [-Scope <string>]


      Os dois exemplos a seguir são usos corretos do cmdlet New-Alias:

          New-Alias -Name utd -Value Update-TypeData 
          New-Alias -Name utd -Value Update-TypeData -Scope global


      Um nome de parâmetro pode ser opcional mesmo quando o valor desse 
      parâmetro é necessário. Isso é indicado na sintaxe pelos colchetes ao 
      redor do nome de parâmetro, mas não do tipo do parâmetro, como no 
      exemplo do cmdlet New-Alias:

          [-Name] <string> [-Value] <string>


      Os seguintes comandos usam o cmdlet New-Alias corretamente. Os 
      comandos geram o mesmo resultado:

          New-Alias -Name utd -Value Update-TypeData 
          New-Alias -Name utd Update-TypeData
          New-Alias utd -Value Update-TypeData
          New-Alias utd Update-TypeData


      Se o nome de parâmetro não for incluído na instrução conforme 
      digitado, o Windows PowerShell tentará usar a posição dos 
      argumentos para atribuir os valores a parâmetros.


      O exemplo a seguir não está completo:

          New-Alias utd


      Esse cmdlet requer valores para os parâmetros Name e Value.


      Em exemplos de sintaxe, também são usados colchetes na 
      nomenclatura e na conversão para tipos do .NET Framework. Nesse 
      contexto, colchetes não indicam que um elemento é opcional.


  Argumentos da matriz 
      Também são usados colchetes em descrições de sintaxe para 
      representar uma matriz. O exemplo a seguir mostra a sintaxe do 
      cmdlet Restart-Service:

          Restart-Service [-Name] <string[]> [-Include <string[]>] 
              [-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf] 
              [<CommonParameters>]


      O parâmetro Name requer um argumento. Especificamente, ele 
      requer o nome do serviço a ser reiniciado. Ele pode conter uma 
      lista de serviços separados por vírgula, como mostrado no 
      seguinte exemplo:

          Restart-Service RasAuto, RasMan, RemoteAccess


CONSULTE TAMBÉM
    Get-Help