UIP ソリューションのリソース

「uip solution resources」の構文とオプション。ローカル ソリューションが依存する Orchestrator と Data Service のリソースを管理します。

uip solution resources は、 ローカル ソリューション が依存するリソース (キュー、アセット、バケット、プロセス、コネクション、エンティティ、チョイス セット、その他の Orchestrator と Data Service オブジェクト) を管理します。すべてのプロジェクトのリソース バインドは、ソリューション独自のリソース リストに集約されます。このコマンド グループを使用して、プロジェクトのバインディングを編集した後に、検査、追加、編集、または再同期を行います。

注:

uip or と混同しないようにしてください。

uip or は、ライブ テナント上の Orchestrator のサーバー側のキュー、アセット、バケットなどに対する CRUD を提供します。uip solution resources は、 ローカル ソリューションで宣言された これらのリソースのリストを調べて編集します。これは、ライブ テナントではなくディスク上の独自のファイルです。list --source remote と add --source remote は Orchestrator を呼び出して検索しますが、結果は常にローカル ソリューションに書き込まれます。

概要

uip solution resources list      [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>] [--include-version] [--login-validity <minutes>]
uip solution resources get       <resource-key> [--solution-folder <path>] [--include-dependencies] [--login-validity <minutes>]
uip solution resources add       --source <local|remote> --kind <kind> --name <name> [--type <type>] [--folder-path <path>] [--cloud-key <guid>] [--solution-folder <path>] [--login-validity <minutes>]
uip solution resources remove    <resource-key> [--solution-folder <path>]
uip solution resources edit      <resource-key> --patch <json> [--solution-folder <path>]
uip solution resources refresh   [--solution-folder <path>] [--login-validity <minutes>]

6 つの動詞はすべて --solution-folder <path> (デフォルトは現在のディレクトリ) を取ります — どの動詞も位置パス引数を取りません。

リスト (List)

ソリューション内のリソースや Orchestrator で利用可能なリソースのリストを取得します。既定では (--source all)、ローカルで宣言されたリソースと、関連付けられたリモート テナントについて Orchestrator がレポートするリソースの両方を返します。両方が一覧表示されている場合、ローカル エントリと Kind:Name 一致するリモート エントリ (大文字と小文字は区別されません) は、ローカル エントリを優先して重複排除されます。

オプション

長押し	値 (Value)	既定 (Default)	説明
--solution-folder	パス	現在のディレクトリ	ソリューションのルート フォルダーへのパスです。
--kind	text	—	リソースの種類でフィルター処理します (例: Queue、 Asset、 Bucket、 Process、 Connection、 App、 Index、 Trigger、 Entity、 ChoiceSet)。SDK のインデックスは任意の種類で受け入れられます。これは固定の列挙型ではありません。
--search	text	—	Contains-match on resource name です。
--source	all | local | remote	all	どちらをリストするか。
--include-version	フラグ	無効	また、1 つ (app、 appVersion、 package、 process) を持つ種類の各リソースのデプロイされたバージョンも報告します。リソースごとに 1 回の追加呼び出しがかかるため、既定ではオフになっています。
--login-validity	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例

# All resources the current solution knows about
uip solution resources list

# Only queues declared locally
uip solution resources list --kind Queue --source local

# Deployed version per folder for classic Apps
uip solution resources list --kind app --source remote --include-version

データシェイプ(--output json)

{
  "Code": "ResourceList",
  "Data": [
    {
      "Source": "Remote",
      "Key": "0c2b7f04-1d3e-4a55-9f77-2b1a6d9e4c81",
      "Name": "InvoiceQueue",
      "Kind": "queue",
      "Folder": "Shared"
    },
    {
      "Source": "Remote",
      "Key": "a9c9d05f-6d85-41cd-8a54-a479d494bedc",
      "Name": "Validation App",
      "Kind": "app",
      "Folder": "Shared/Validation",
      "FolderKey": "0932a1f4-5cd1-44d4-9f02-cdc92244a6d2",
      "Version": "12.0.0"
    }
  ]
}

注:

--source remote (および all) には、ソリューションのターゲット Orchestrator にアクセスできる認証済みセッションが必要です。

get

ソリューション リソースの構成をキー (SDK によって公開される仕様、ロック、メタデータ) で取得します。キーがローカル ソリューションにない場合、 は Orchestrator/resource-catalog でのライブ検索にフォールバックするため、ソリューションにまだバインドされていないリソースに対してもこのコマンドは役に立ちます。

引数

名前	Required	目的
<resource-key>	○	ソリューション リソース キー — GUID、またはパッケージの場合は TestRPA.process.TestRPA:1.0.0 などの複合キーです。

オプション

長押し	値 (Value)	既定 (Default)	説明
--solution-folder	パス	現在のディレクトリ	ソリューションのルート フォルダーへのパスです。
--include-dependencies	フラグ	無効	また、リソースが参照するすべての依存関係の設定を返します。
--login-validity	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f \
  --solution-folder ./my-solution --include-dependencies

データシェイプ(--output json)

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "fb39bc38-255e-4fea-93c6-7c7eb44d766f",
    "spec": { "name": "RPA Workflow", "type": "Process" },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1",
    "isOverridable": true
  }
}

リンクされたライブリソースがローカル宣言からドリフトした場合、応答は古いspecと共にliveSpec (現在のライブ仕様) を追加し、次のようにresourceOverwrite.matchingOverwriteConfiguration: falseします。

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "0f8a1c9e-2b47-4d0a-9c31-5e2f6d8a7b10",
    "spec": { "name": "Approval App", "version": "7.0.0" },
    "liveSpec": { "name": "Approval App", "version": "12.0.0" },
    "resourceOverwrite": { "matchingOverwriteConfiguration": false }
  }
}

--include-dependencies は、代わりにresources配列を含むCode: "ResourceConfigurations"を返し、各エントリに name、kind、dependenciesが追加されます。

追加

ソリューションにリソースを追加します。--source local は、リモート ルックアップなしで仮想スタブを作成します。 --source remote 既存の Orchestrator リソースをインポートします。べき等: 同じ (kind, name, folder) に一致するリソース、またはリモート パスでは同じ解決されたクラウド キーに一致するリソースが、重複されずに変更されずに返されます。

オプション

長押し	値 (Value)	既定 (Default)	説明
--source	local | remote	—	必須。 local 仮想スタブを作成します。 remote Orchestrator からインポートします。
--kind	text	—	必須。リソースの種類 (例: Queue、 Asset、 Bucket、 Process、 Connection、 App、 Index、 Trigger、 Entity、 ChoiceSet)。大文字と小文字を区別しません。
--name	text	—	必須。リソース名です (最大 256 文字、 / \ : * ? " < > | 文字またはコントロール文字を含めることはできません)。
--type	text	—	リソースのサブタイプ (例: Assetの場合は Text/Bool/Integer、Connectionの場合はコネクタの種類)。(kind, type)による SDK インデックスの種類に必要で、リモート一致から解決できない場合を除きます。
--folder-path	パス	—	リモート検索用の Orchestrator フォルダー パス。複数のリモート一致が存在する場合にあいまいさを取り除きます。--source localでは無効です。
--cloud-key	GUID	—	リモート名の検索をスキップして、この正確なリソース キーをインポートします。--source remoteでのみ有効です。
--solution-folder	パス	現在のディレクトリ	ソリューションのルート フォルダーへのパスです。
--login-validity	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

リモート名検索が複数のリソースと一致する場合、コマンドは失敗し、各候補のフォルダー、種類、キーが一覧表示されるため、 --cloud-keyであいまいさを解消できます。

例

# Create a local virtual stub (no remote lookup)
uip solution resources add --source local --kind Queue --name InvoiceQueue

# Import an existing remote queue, disambiguated by folder path
uip solution resources add --source remote --kind Queue --name InvoiceQueue \
  --folder-path Sales/CRM

データシェイプ(--output json)

{
  "Code": "ResourceAdded",
  "Data": {
    "Key": "8f3a1b2c-0000-0000-0000-000000000001",
    "Kind": "queue",
    "Type": null,
    "Name": "InvoiceQueue",
    "Folder": "solution_folder",
    "FolderKey": "5c2d61f4-0000-0000-0000-000000000001",
    "Source": "local",
    "Status": "Added"
  }
}

Status 、 Added、 Updated、または Unchanged のいずれかです (べき等 no-op ケース)。

削除

キーによってソリューションからリソースを削除します。純粋にローカルです。認証は不要で、プロジェクトの bindings_v2.jsonにも影響しません。

引数

名前	Required	目的
<resource-key>	○	ソリューション リソース キー (GUID)。resources list や resources get を使用して検出します。

オプション

長押し	値 (Value)	既定 (Default)	説明
--solution-folder	パス	現在のディレクトリ	ソリューションのルート フォルダーへのパスです。

例

uip solution resources remove 8f3a1b2c-1234-4abc-9def-0123456789ab

データシェイプ(--output json)

{
  "Code": "ResourceRemoved",
  "Data": {
    "Key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "Kind": "queue",
    "Name": "InvoiceQueue",
    "Folder": "solution_folder"
  }
}

編集

リソースの仕様プロパティをキーで編集します。--patch 、プロパティ→値の JSON オブジェクトを取り、既存の仕様にマージします。SDK が参照/読み取り専用/不明としてマークしたプロパティは、通知なしに無視されます。getとeditのデータ図形は一致するため、取得→変更→編集の往復は簡単です。--source remote ではなく、リソースのインポート --patch元のクラウド定義から値を取得します。

引数

名前	Required	目的
<resource-key>	○	ソリューション リソース キー (GUID)。

オプション

長押し	値 (Value)	既定 (Default)	説明
--patch	JSON または -	—	spec プロパティの JSON オブジェクト→値です。代わりに、 - を渡して stdin から JSON を読み取るようにします。
--source	local | remote	local	新しい値の取得元です。 --patch (local) またはクラウド定義 (remoteです)。
--force	フラグ	無効	--source remoteでは、クラウド定義をローカル定義の上に書き込みます。
--solution-folder	パス	現在のディレクトリ	ソリューションのルート フォルダーへのパスです。
--login-validity	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。--source remoteによってのみ使用されます。

例

uip solution resources edit 8f3a1b2c-1234-4abc-9def-0123456789ab \
  --patch '{"maxNumberOfRetries":5}'

# Pipeline-friendly: patch from stdin
echo '{"slaInHours":"4"}' | uip solution resources edit 8f3a1b2c-... --patch -

# Pull the cloud definition: report the differences, then overwrite
uip solution resources edit 8f3a1b2c-... --source remote
uip solution resources edit 8f3a1b2c-... --source remote --force

データシェイプ(--output json)

{
  "Code": "ResourceEdited",
  "Data": {
    "key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "spec": { "name": "InvoiceQueue", "maxNumberOfRetries": 5 },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1"
  }
}

--source remote で --forceを使用しない場合、コマンドは何も書き込みません。1を終了し、異なるプロパティに名前を付けます。違いがない場合は、 Code: "ResourceRemoteDrift" と Applied: falseで成功します。--force では、応答は ResourceEdited、 Changed、Skipped (リソースの種類によって SDK の書き込みを許可しないプロパティ)、および Applied: trueになります。

更新

ソリューション内のすべてのプロジェクトを再スキャンし、 bindings_v2.json ファイルからリソース宣言を同期します。ソリューションのリソース リストにまだないバインドが作成されます。既存の Orchestrator リソースに一致するバインドがインポートされます。以前の実行でデプロイされたフォルダーからインポートされた、ソリューション自体のプロジェクトの重複コピーはプルーニングされます。プロジェクトのバインドを編集した後にこのコマンドを実行して、ソリューションのリソース インベントリを元に戻します。

オプション

長押し	値 (Value)	既定 (Default)	説明
--solution-folder	パス	現在のディレクトリ	ソリューションのルート フォルダーへのパスです。
--login-validity	分	10	更新をトリガーするまでの最小分単位: トークンの有効期限が切れるまでの最小分単位です。

例

uip solution resources refresh

データシェイプ(--output json)

{
  "Code": "ResourceRefresh",
  "Data": {
    "Created": 2,
    "Imported": 1,
    "Skipped": 5,
    "Pruned": 0,
    "Warnings": [],
    "Status": "Synced 3 resources (5 already in solution)"
  }
}

Created は、新しいソリューション リソースの数です。 Imported は Orchestrator と照合されたカウントです。 Skipped 、一致するソリューション エントリが既にあるバインディングをカウントします。 Pruned は、削除された重複したプロジェクト コピーをカウントします (ゼロでない場合は Status での名前のみが付けられます)。Warnings 同期時の人間が判読できるメモのリストです (クリーン実行の場合は空)。

終了コード

共有コントラクト の終了コード を参照してください。

関連コマンド

• uip solution pack — パッケージ化は、ソリューションのリソースリストを読み取ります。
• uip solution deploy — ターゲット テナントにプロビジョニング リソースをデプロイします。
• uip or — Orchestrator のライブ リソース用のサーバー側の CRUD ツールです。

参照

• グローバルオプション — --output、 --output-filter、 --log-level、 --log-file。
• 終了コード — 標準の終了コード限月。