すべてのツール

recipe_run

スキルとレシピ · macOS · Windows

効果: 実行. 状態: 条件付き提供.

「条件付き提供」は、バージョン、プラットフォーム、権限、アカウント、設定に依存する可能性を示し、すべての環境で有効という意味ではありません。

macOS

目的

レシピを最初から最後まで実行します。params を割り当て、各ステップのツールをレジストリ経由で順番に実行し、実行履歴(recipe_runs を参照)を保存して、各ステップの結果と markers_path があればそれも返します。状態を変更するステップ(write/send/delete)があるレシピは最初に PREVIEW を返し、実行には confirm:true でもう一度呼び出します。読み取り専用レシピは直ちに実行されます。エラーになったステップで実行を停止し、その内容を報告します。

必須入力

入力名はツールが要求する正確な形式のままです。英語の正規技術定義は下の展開可能なスキーマにあります。

権限と確認

スキーマには明示的な確認パラメータがあります。プレビューを確認し、プラットフォーム契約に従って実操作を承認してください。

英語の正規技術スキーマmacOS
{
  "properties": {
    "confirm": {
      "description": "Set true to execute a recipe that has state-changing steps; read-only recipes ignore it.",
      "type": "boolean"
    },
    "name": {
      "type": "string"
    },
    "params": {
      "description": "Param overrides (merged over the recipe defaults).",
      "type": "object"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

ドキュメント例

recipe_run のドキュメント例です。この例は実行しないでください。表示される引数は架空のデータセットに属します。実際に呼び出す前に実在する識別子を確認し、承認を得てください。

{
  "confirm": false,
  "name": "Demo morning brief"
}

Windows

目的

保存済みレシピを最初から最後まで実行します。params を割り当て、各ステップのツールを順番に実行し、実行履歴(recipe_runs を参照)を記録して各結果を返します。確認ゲートとして、confirm:true がなければ割り当て済み引数を含む順序付きステップの DRY-RUN PREVIEW を返し、実行には confirm:true でもう一度呼び出します。エラーになったステップで停止し、その内容を報告します。

必須入力

入力名はツールが要求する正確な形式のままです。英語の正規技術定義は下の展開可能なスキーマにあります。

権限と確認

スキーマには明示的な確認パラメータがあります。プレビューを確認し、プラットフォーム契約に従って実操作を承認してください。

英語の正規技術スキーマWindows
{
  "properties": {
    "confirm": {
      "description": "Set true to execute; without it a dry-run preview is returned.",
      "type": "boolean"
    },
    "name": {
      "description": "Recipe name (from recipe_list).",
      "type": "string"
    },
    "params": {
      "description": "Param overrides (merged over the recipe defaults).",
      "type": "object"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

ドキュメント例

recipe_run のドキュメント例です。この例は実行しないでください。表示される引数は架空のデータセットに属します。実際に呼び出す前に実在する識別子を確認し、承認を得てください。

{
  "confirm": false,
  "name": "Demo morning brief"
}