about_command_syntax

トピック
    about_Command_Syntax

簡易説明
    ヘルプの Windows PowerShell の構文で使用される表記法について説明します。


詳細説明
    Get-Help コマンドレットを実行すると、コマンドレットのパラメーターの使用方法が表示されま
    す。Get-Help コマンドレットでは、次の特殊な記号が使用されます。

        山かっこ (<>) はプレースホルダー テキストを示します。
        角かっこ ([]) はオプションの項目を示します。
        波かっこ ({}) は値の選択肢を示します。


    コマンドレットには、複数のパラメーター セットが指定される場合があります。異なるパラメーター 
    セットでも、一部のパラメーターは同じものであることがあります。Get-Help コマンドレットを実
    行すると、コマンドレットのすべてのパラメーター セットが表示されます。


    パラメーターに関する追加情報は、パラメーターの説明およびパラメーター属性テーブルにあります。
    パラメーターの詳細な情報を表示するには、Get-Help の Full パラメーターまたは Parameter 
    パラメーターを使用します。


  構文
      Windows PowerShell のコマンドレット ヘルプ、ヘルプ トピック、およびその他のドキュメン
      トでは、構文の説明において、コマンドレットで次の表記法が使用されます。

          <cmdlet name> -<Required Parameter name> <Required parameter Value>
                       [-<Optional Parameter name> <Optional Parameter Value>] 
                       [-<Optional Switch Parameter>] 
                       [-<Optional Parameter Name>] <Required parameter Value> 

      New-Alias コマンドレットの構文を次に示します。

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


      この構文では、読みやすさのために大文字が使用されていますが、Windows Powershell では大
      文字と小文字は区別されません。


      パラメーターは順に表示されます。パラメーターの順序は、そのパラメーター名がオプションで
      ある場合にのみ重要となります。コマンドレットの使用時にパラメーター名を指定しない場合、
      Windows PowerShell では位置および型に基づいてパラメーターに値が割り当てられます。


      パラメーター名の前にはハイフン (-) が付きます。スイッチ パラメーターは、値の型を伴わずに
      表示されます。その他のパラメーターは、必須引数の Microsoft .NET Framework 型または使
      用可能な値の列挙と共に表示されます。.NET Framework 型の詳細については、
      https://msdn.microsoft.com/ja-jp/library/ms229335(VS.80).aspx を参照してください。


      山かっこ (<>) はプレースホルダー テキストを示します。このテキストでは、項目の種類 (文字
      列やプロセス オブジェクトなど) を記述することができます。
      このテキストは 1 つまたは複数の共通パラメーターのプレースホルダーである場合もあります。


      角かっこ ([]) はオプションの項目を示します。パラメーターが省略可能であるか、必須パラメー
      ターの名前が省略可能であることを示します。スイッチ パラメーターは、常に省略可能です。


      波かっこ ({}) は、列挙型の値の前後に表示されます。New-Alias コマンドレットの例では、
      Option パラメーターには一覧表示されているいずれの値を指定することもできます。


  オプションの項目
      オプションの項目は、角かっこ ([]) で囲まれています。たとえば、New-Alias コマンドレット
      の構文の説明では、Scope パラメーターはオプションです。これはパラメーター名と型を角かっこが
      囲む構文で示されます。

          [-Scope <string>]


      次の例は共に、New-Alias コマンドレットの正しい使用方法を示しています。

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


      パラメーターの値が必須であっても、パラメーター名は省略可能の場合があります。これは、New-
      Alias コマンドレットの次の例のように、パラメーター名を角かっこで囲み、パラメーターの型
      は角かっこで囲まない構文で示します。

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


      次のコマンドでは、New-Alias コマンドレットが正しく使用されています。コマンドの結果は同
      じになります。

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


      入力時にパラメーター名がステートメントに含まれていない場合、Windows PowerShell は、その
      引数の位置を使用して値をパラメーターに割り当てようとします。


      次の例は不完全です。

          New-Alias utd


      このコマンドレットでは、Name および Value パラメーターの両方に値を指定する必要があります。


      構文の例では、角かっこは .NET Framework 型に対する名前付けおよびキャストにも使用されてい
      ます。このような場合、角かっこは要素が省略可能であることを示すわけではありません。


  配列引数
      構文の説明では、角かっこは配列を表すためにも使用されています。次の例は、Restart-
      Service コマンドレットの構文を示しています。

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


      Name パラメーターには、引数が必要です。具体的には、再起動するサービスの名前が必要です。
      次の例のように、サービスのコンマ区切り一覧を指定することができます。

          Restart-Service RasAuto, RasMan, RemoteAccess


関連項目
    Get-Help