about_Functions_CmdletBindingAttribute

[アーティクル]
06/21/2023

簡単な説明

関数をコンパイル済みコマンドレットのように動作させる属性について説明します。

長い説明

この CmdletBinding 属性は、C# で記述されたコンパイル済みコマンドレットのように動作させる関数の属性です。コマンドレットの機能にアクセスできます。

PowerShell は、コンパイル済みコマンドレットのパラメーターを CmdletBinding バインドするのと同じ方法で、属性を持つ関数のパラメーターをバインドします。 $PSCmdlet属性を持つ関数では自動変数をCmdletBinding使用できますが$Args、変数は使用できません。

属性を CmdletBinding 持つ関数では、不明なパラメーターと位置指定パラメーターが一致しない位置引数により、パラメーターバインドが失敗します。

注意

コンパイルされたコマンドレットでは、このトピックで説明されている属性にCmdletBinding似た必須Cmdletの属性を使用します。

構文

次の例は、属性のすべての省略可能な引数を指定する関数の形式を CmdletBinding 示しています。各引数の簡単な説明は、この例に従います。

{
    [CmdletBinding(ConfirmImpact=<String>,
    DefaultParameterSetName=<String>,
    HelpURI=<URI>,
    SupportsPaging=<Boolean>,
    SupportsShouldProcess=<Boolean>,
    PositionalBinding=<Boolean>)]

    Param ($Parameter1)
    Begin{}
    Process{}
    End{}
}

コマンドレットバインド属性から省略した場合、コマンドレットバインド属性のブール型は既定でFalse になります。引数の値を $true 名前で設定するか、単に引数を一覧表示します。たとえば、次の コマンドレットバインド 属性は同等です。

{
    [CmdletBinding(SupportsPaging=$true)]

    Param ($Parameter1)
    Begin{}
    Process{}
    End{}
}

# Boolean arguments can be defined using this shorthand syntax

{
    [CmdletBinding(SupportsPaging)]

    Param ($Parameter1)
    Begin{}
    Process{}
    End{}
}

ConfirmImpact

ConfirmImpact 引数は、ShouldProcess メソッドの呼び出しによって関数のアクションを確認するタイミングを指定します。 ShouldProcess メソッドの呼び出しは、ConfirmImpact 引数が基本設定変数の値以上の場合にのみ、確認プロンプトを$ConfirmPreference表示します。 (引数の既定値は Medium です)。この引数は、 SupportsShouldProcess 引数も指定されている場合にのみ指定します。

確認要求の詳細については、「確認の要求」を参照してください。

DefaultParameterSetName

DefaultParameterSetName 引数は、使用するパラメーターセットを決定できないときに PowerShell が使用するパラメーターセットの名前を指定します。この問題を回避するには、各パラメーターの一意のパラメーターを必須パラメーターに設定します。

HelpURI

HelpURI 引数は、関数を記述するオンラインバージョンのヘルプトピックのインターネットアドレスを指定します。 HelpURI 引数の値は、"http" または "https" で始まる必要があります。

HelpURI 引数の値は、関数に対して返される CommandInfo オブジェクトGet-Commandの HelpURI プロパティの値に使用されます。

ただし、ヘルプファイルがコンピューターにインストールされていて、ヘルプファイルの RelatedLinks セクションの最初のリンクの値が URI であるか、コメントベースのヘルプの最初 .Link のディレクティブの値が URI の場合、ヘルプファイル内の URI が関数の HelpUri プロパティの値として使用されます。

このコマンドレットはGet-Help、コマンドで Online パラメーターが指定されている場合に、HelpURI プロパティの値を使用して、関数ヘルプトピックのGet-Helpオンライン バージョンを検索します。

SupportsPaging

SupportsPaging 引数は、First、Skip、IncludeTotalCount の各パラメーターを関数に追加します。これらのパラメーターを使用すると、ユーザーは非常に大きな結果セットから出力を選択できます。この引数は、SQL データベースなどのデータの選択をサポートする大規模なデータストアからデータを返すコマンドレットと関数用に設計されています。

この引数は、Windows PowerShell 3.0 で導入されました。

最初: 最初の 'n' オブジェクトのみを取得します。
スキップ: 最初の 'n' オブジェクトを無視し、残りのオブジェクトを取得します。
IncludeTotalCount: データセット内のオブジェクトの数 (整数) とそれに続くオブジェクトを報告します。コマンドレットで合計カウントを特定できない場合は、"不明な合計カウント" が返されます。

PowerShell には、返される合計カウント値を取得し、合計カウント値の精度の見積もりを含むヘルパーメソッド である NewTotalCount が含まれています。

次のサンプル関数は、ページングパラメーターのサポートを高度な関数に追加する方法を示しています。

function Get-Numbers {
    [CmdletBinding(SupportsPaging)]
    param()

    $FirstNumber = [Math]::Min($PSCmdlet.PagingParameters.Skip, 100)
    $LastNumber = [Math]::Min($PSCmdlet.PagingParameters.First +
      $FirstNumber - 1, 100)

    if ($PSCmdlet.PagingParameters.IncludeTotalCount) {
        $TotalCountAccuracy = 1.0
        $TotalCount = $PSCmdlet.PagingParameters.NewTotalCount(100,
          $TotalCountAccuracy)
        Write-Output $TotalCount
    }
    $FirstNumber .. $LastNumber | Write-Output
}

SupportsShouldProcess

SupportsShouldProcess 引数は、Confirm パラメーターと WhatIf パラメーターを関数に追加します。 Confirm パラメーターは、パイプライン内の各オブジェクトでコマンドを実行する前にユーザーにプロンプトを表示します。 WhatIf パラメーターは、コマンドを実行する代わりに、コマンドが行う変更を一覧表示します。

PositionalBinding

引数 PositionalBinding は、関数内のパラメーターが既定で位置指定されているかどうかを決定します。既定値は $True です。 位置バインディングを無効にするには、値が $False 1 の位置バインド引数を使用できます。

位置バインディング引数は、Windows PowerShell 3.0 で導入されています。

パラメーターが位置指定されている場合、パラメーター名は省略可能です。 PowerShell は、関数コマンド内の名前のないパラメーター値の順序または位置に従って、名前のないパラメーター値を関数パラメーターに関連付けます。

パラメーターが位置指定 ("名前付き") でない場合は、コマンドにパラメーター名 (または名前の省略形または別名) が必要です。

位置指定バインドの場合、$True関数パラメーターは既定で位置指定されます。 PowerShell は、関数で宣言されている順序でパラメーターに位置番号を割り当てます。

位置指定バインドの場合、$False関数パラメーターは既定では位置指定されません。 パラメーターに対して Parameter 属性の Position 引数が宣言されていない限り、パラメーターを関数で使用する場合は、パラメーター名 (または別名または省略形) を含む必要があります。

Parameter 属性の Position 引数は、PositionBinding の既定値よりも優先されます。 引数 Position を使用して、パラメーターの位置の値を指定できます。 Position 引数の詳細については、about_Functions_Advanced_Parametersを参照してください。

メモ

SupportsTransactions 引数は、高度な関数ではサポートされていません。

Keywords

about_Functions_CmdletBinding_Attribute