about_InlineScript

[アーティクル]
11/06/2024

簡単な説明

ワークフローで PowerShell コマンドを実行する InlineScript アクティビティについて説明します。

詳細な説明

InlineScript アクティビティは、共有 PowerShell セッションのワークフローでコマンドを実行します。 InlineScript はワークフローでのみ有効です。

構文

InlineScript {<script block>} <ActivityCommonParameters>

詳しい説明

InlineScript アクティビティは、共有 PowerShell セッションでコマンドを実行します。これをワークフローに含め、ワークフローで有効でないデータとコマンドを共有するコマンドを実行できます。

InlineScript スクリプトブロックには、有効なすべての PowerShell コマンドと式を含めることができます。 InlineScript スクリプトブロック内のコマンドと式は同じセッションで実行されるため、インポートされたモジュールや変数の値など、すべての状態とデータを共有します。

ループまたは制御ステートメント、Parallel または Sequence スクリプトブロック内など、ワークフローまたは入れ子になったワークフロー内の任意の場所に、 InlineScript アクティビティを配置できます。

InlineScript アクティビティには、PSPersist を含むアクティビティ共通パラメーターがあります。ただし、 InlineScript スクリプトブロック内のコマンドと式には、チェックポイント処理、永続化、ワークフローまたはアクティビティの共通パラメーターなどのワークフロー機能はありません。詳細については、「 about_ActivityCommonParameters」を参照してください。

InlineScript 変数

既定では、ワークフローで定義されている変数は、 InlineScript スクリプトブロック内のコマンドには表示されません。ワークフロー変数を InlineScriptに表示するには、 $Using スコープ修飾子を使用します。 $Using スコープ修飾子は、InlineScript内の変数ごとに 1 回だけ必要です。

$Using スコープ修飾子の詳細については、「about_Remote_Variables」を参照してください。

次の例では、$Using スコープ修飾子を使用すると、InlineScript スクリプトブロック内のコマンドで$a最上位ワークフロー変数の値を使用できるようになります。

workflow Test-Workflow {
  $a = 3

  ## Without $Using, the $a workflow variable isn't visible
  ## in inline script.
  InlineScript {"Inline A0 = $a"}

  ## $Using imports the variable and its current value.
  InlineScript {"Inline A1 = $Using:a"}
}

Test-Workflow

Inline A0 =
Inline A1 = 3

InlineScript で変数を返す

InlineScript コマンドは、ワークフロースコープからインポートされた変数の値を変更できますが、変更はワークフロースコープに表示されません。表示されるようにするには、次の例に示すように、変更した値をワークフロースコープに返します。

workflow Test-Workflow {
  $a = 3

  ##  Changes to the InlineScript variable value don't
  ##  change the workflow variable.
  InlineScript {
    $a = $Using:a+1;
    "Inline A = $a"
  }
  "Workflow A = $a"

  ##  To change the variable in workflow scope, return the
  ##  new value.
  $a = InlineScript {$b = $Using:a+1; $b}
  "Workflow New A = $a"
}

Test-Workflow

Inline A = 4
Workflow A = 3
Workflow New A = 4

Note

$Using スコープ修飾子を持つステートメントは、InlineScript スクリプトブロックで変数を使用する前に指定する必要があります。

インプロセスの実行

信頼性を向上させるために、 InlineScript スクリプトブロック内のコマンドは、ワークフローが実行されるプロセスとは別の独自のプロセスで実行され、その出力がワークフロープロセスに返されます。

PowerShell でワークフロープロセスでInlineScript アクティビティを実行するように指示するには、New-PSWorkflowExecutionOption コマンドレットを使用するなどして、セッション構成の OutOfProcessActivity プロパティからInlineScript値を削除します。

例

次のワークフローの InlineScript には、PowerShell では有効ですが、ワークフローでは有効ではないコマンドが含まれています。たとえば、ComObject パラメーターを持つ New-Object コマンドレットです。

workflow Test-Workflow
{
  $ie = InlineScript {
    $ie = New-Object -ComObject InternetExplorer.Application -Property @{navigate2="www.microsoft.com"}

    $ie.Visible = $true
  }

  $ie
}

Test-Workflow

次の方法で共有