UIP リソース

uip resource は、オートメーションが実行時に依存する Orchestrator リソース (アセット、バケットとバケット ファイル、ライブラリ、キューとキュー アイテム、トリガー、Webhook) を管理します。これは、これらのエンティティに対する汎用の CRUD サーフェスであり、uip solution resource (ローカルのソリューション リソース宣言を検査する) や uip or (ジョブ、プロセス、フォルダーなどに対応する Orchestrator のオートメーション ツール) とは別のものです。

注:

ツールのエイリアスはresource (単数形)であり、resourcesではありません。すべての例で uip resource <kind>を使用します。

uip resource は @uipath/resource-tool プラグインによって提供されます。まだインストールされていない場合は、 uip tools install resource によって追加されます。ツール (プラグイン) を参照してください。

リソース

各リソースには、独自のリファレンス ページがあります。各ページに設定された動詞は、 uip resource によって登録されたコマンドと一致します— uip resource --help を実行して、インストールの完全な表面を確認します。

リソース	目的
アセット	オートメーションが実行時に使用する名前付き設定値 (Text、Bool、Integer、Credential、Secret) です。フォルダー範囲。
バケット	オートメーションで使用するファイルのストレージ コンテナーです。フォルダー範囲。
bucket-files	バケット内の個々のファイル署名済み URL のリストを取得、アップロード、ダウンロード、削除、取得します。
ライブラリ	再利用可能な .nupkg パッケージ (共有アクティビティとロジック)テナント範囲です。
キュー	トランザクション作業項目のコンテナー。フォルダー範囲。
queue-items	キュー内の個々のトランザクション (ステートマシンによる完全な制御)フォルダー範囲。
トリガー	ジョブを開始するタイム トリガー、キュー トリガー、および API トリガー。タイム トリガー/キュー トリガーはフォルダー範囲です。API トリガーはテナント範囲です。
Webhook	HTTP コールバックは、プラットフォーム イベント (ジョブの完了、キュー アイテムの失敗など) で発生します。テナント範囲です。

概要

uip resource <resource> <verb> [options]

既定の出力は JSON です。すべてのサブコマンドは、 グローバル・オプション (--output、 --output-filter、 --log-level、 --log-file) を優先し、 標準の終了コードを返します。

命名規則

• 認証。uip resource サブコマンドごとに Orchestrator を呼び出します。最初に uip login を実行するか、任意のサブコマンドに -t, --tenant <tenant-name> を渡して、認証された組織内の特定のテナントを対象とします。
• フォルダーの範囲。アセット、バケット、キュー、キュー アイテム、トリガー (タイム/キュー) はフォルダー範囲です。以下のいずれか--folder-path <path> (例:"Shared")、またはlist、create、および関連する呼び出しで--folder-key <guid>します。get、 update、 delete は、可能な場合はフォルダー間の解決をキーで行います — リソース ページの各動詞の説明では、その名前が明示的に示されています。ライブラリ、API トリガー、Webhook はテナントを対象範囲と し、 --folder-*を受け入れません。
• キー。ほとんどのリソースは list 出力で返される GUID によって識別されます ( key、 identifier、またはキュー アイテムの場合は 1 回の試行で uniqueKey 、再試行チェーンで key )。数値 id フィールドは内部であり、コマンドに渡さないでください。
• ページング。リスト動詞は、 -l, --limit <n>、 --offset <n>、および --order-by <field> を受け入れます (OData 構文、例:"Name asc")。バケット ファイル list は例外で、 continuationTokenを使用します。
• フィルター。サポートされている場合、 -n, --name <name> はリソース名のcontains-matchです。一部のリソースでは、 --enabled、 の --disabled、 --statusなどが追加されます。

データシェイプ

正常な出力は常に標準エンベロープに従います。

{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}

動詞ごとの Code については、リソース ページ (AssetList、 AssetCreated、 BucketFile、 QueueItemAdded、 TriggerEnabled、 WebhookPingedなど) に記載されています。Data は、単一のオブジェクト (get、 create、 update) または配列 (list、 versions、 event-types、 history) のいずれかです。

リストは現在 ラップされておらず 、トップレベルの count や nextPage フィールドは含まれません。バケット ファイル list は例外です。そのペイロードには、ページングに使用される continuationToken が含まれています。

作業例

フォルダー内のキューのリストを取得

uip resource queues list --folder-path Shared

アセットを作成し、フォルダー間で共有する

uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production

キュー アイテムを JSON ファイルから一括追加する

ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json

関連コマンド

• uip solution deploy config link — ソリューションの宣言されたリソースを、uip resourceで作成されたアセット/キュー/バケットのいずれかにバインドします。
• uip solution resource list — ローカル ソリューション内のリソース宣言を調べます。
• uip or — フォルダー、プロセス、リリース、ジョブ、マシン、ユーザー、資格情報ストアなど、使用時にキーの検索が必要になることが多い場合 uip resource

参照

• 認証 — すべてのサブコマンドにはアクティブなセッションが必要です。
• 設定 — プロジェクトごとのテナント/フォルダーの既定値をピン留めします。
• グローバルオプション と 終了コード — すべての動詞で共有されるコントラクト。