UIP ソリューションのデプロイ

uip solution deploy パブリッシュ済みのソリューション パッケージ (uip solution publishを参照) を Orchestrator にインストールします。フォルダーの作成、リソース (キュー、アセット、プロセス、バケット、コネクション) のプロビジョニング、デプロイのアクティブ化を行います。

このページでは、deployのすべてのサブコマンドに加えて、(デプロイではなく) Studio Web ソリューションを管理する最上位のuip solution deleteについて説明します。

サブコマンド	目的
run	パブリッシュしたパッケージを Orchestrator にデプロイします。
status	パイプラインのデプロイのステータスを確認します。
list	既存のデプロイを一覧表示します。
activate	自動アクティブ化せずにインストールされたデプロイをアクティブ化します。
uninstall	デプロイとそのプロビジョニングされたリソースを削除します。
config get	パッケージの既定のデプロイ設定を取得します。
config set	デプロイ構成ファイルでリソース プロパティを設定します。
config link	ソリューション リソースを既存の Orchestrator リソースにリンクします。
config unlink	デプロイ構成ファイルからリソース リンクを削除します。

このページにも記載されています。

• uip solution delete — Studio Web から ID でソリューションを削除する最上位の動詞。これは deploy サブコマンド ではありません 。グループ化の理由から、これらのコマンドと一緒に文書化されています。

すべてのサブコマンドが認証されます。最初に uip login を実行するか、--tenantを渡して特定のテナントを対象にします。

一般的なワークフロー

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       └─→ deploy uninstall  (tear down)

---

uip solution deploy run

パブリッシュ済みのソリューション パッケージを Orchestrator にデプロイします。新しいフォルダーを ( --folder-path または --folder-keyの下に) 作成し、パッケージ (または --config-file) に記述されているすべてのリソースをプロビジョニングし、デプロイが最終状態になるまでポーリングを行います。

概要

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--folder-path <path> | --folder-key <guid>] \
  [--config-file <path>] \
  [--tenant <tenant-name>] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

オプション

• -n, --name <deployment-name> (必須) — デプロイの名前。このインストールを識別するために deploy status、 activateおよび uninstall によって使用されます。
• --package-name <name> (必須) — ソリューション パッケージ名。利用可能な名前を検索するには、packages list を使用します。
• --package-version <version> (必須) — ソリューション パッケージのバージョンです。packages list を使用して、利用可能なバージョンを見つけます。
• --folder-name <name> (必須) — このデプロイ用に作成される新しい Orchestrator フォルダーの名前 ( --folder-pathの下)。
• --folder-path <path> — 親フォルダーのパス (例: Shared)。その下にデプロイ フォルダーが作成されます。
• --folder-key <key> — 親フォルダー キー (GUID)。--folder-pathの代替手段。
• --config-file <path> — JSON 構成ファイル。deploy config getで生成し、config set / config linkで編集して、ここで渡します。
• -t, --tenant <tenant-name> — デプロイ先のテナントです。
• --timeout <seconds> — デプロイのポーリング タイムアウト。既定値は [ 360です。
• --poll-interval <ms> — ステータスポーリング間のミリ秒。既定値は [ 5000です。
• --login-validity <minutes> — 更新をトリガーするトークンの有効期限の最小分前。既定値は [ 10です。

例

共通

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared"

カスタマイズされた構成

uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared" \
  --config-file ./deploy-config.json

スクリプティング — フォローアップ コールのデプロイ ID をキャプチャします。

PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

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

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution"
  }
}

ターミナルのデプロイのステータス: DeploymentSucceeded、DeploymentFailed、ValidationFailed、ConflictFixingError、DeploymentScheduleError非成功 ターミナル ステートは 1 で終了し、検証/競合/スケジュール/ワークフロー エラーを [ Instructions ] フィールドに集約します。

タイムアウト時の動作

--timeout が経過する前にデプロイが終了状態に達しない場合、コマンドは 0 以外の状態を終了し、deploy status <pipeline-deployment-id> へのポインターを付けて監視を続行できます。

---

UIP ソリューションのデプロイ ステータス

パイプラインのデプロイの現在のステータスを確認します。デプロイのステート、デプロイの名前/パッケージ/バージョンがある場合はそのバージョン、および連結されたエラーの概要を返します。

引数

• <pipeline-deployment-id> (必須) — deploy runによって返されるPipelineDeploymentIdです。

オプション

• -t, --tenant <tenant-name> — クエリを実行するテナントです。
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

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

{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}

---

UIP ソリューションのデプロイ一覧

ソリューションのデプロイのリストを取得デプロイの名前、ステータス、パッケージ バージョン、フォルダー パスが表示されます。

オプション

• -t, --tenant <tenant-name> — クエリを実行するテナントです。
• --folder-path <path> — 親フォルダーのパスでフィルター処理します。フィルター処理はフェッチ 後 に適用されます。このフィルターの使用時に結果が不完全であるように見える場合は --take を増やします。
• --folder-key <key> — 親フォルダー キー (GUID) でフィルター処理します。--folder-pathの代替手段。
• --take <number> — 取得するデプロイの最大数。既定値は [ 10です。
• --order-by <column> — 並べ替え条件の列。既定値は [ startTimeです。
• --order-direction <direction> — Ascending または Descendingです。既定値は [ Descendingです。
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy list --take 20 --folder-path "Shared/Production"

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

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "InstallDeploymentKey": "…",
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "OperationStatus": "Successful",
      "ActivationStatus": "Activated",
      "FolderPath": "Shared/Production",
      "FolderKey": "…",
      "CreatedAt": "2026-04-15T10:30:00Z"
    }
  ]
}

---

uip ソリューションのデプロイのアクティブ化

自動アクティブ化せずにインストールされたデプロイをアクティブ化します。アクティブ化すると、すべてのソリューション コンポーネントがプロビジョニングされます。activate は、最初に Orchestrator によって ( --log-level info経由で stderr に) 報告されたアクティブ化前のステップを出力し、次に activate を呼び出して、終了状態 (SuccessfulActivate または FailedActivate) になるまでポーリングします。

引数

• <deployment-name> (必須) — アクティブ化するデプロイの名前。deploy listを使用してデプロイ名を検索します。

オプション

• -t, --tenant <tenant-name> — ターゲットとするテナントです。
• --timeout <seconds> — アクティベーションポーリングタイムアウト。既定値は [ 360です。
• --poll-interval <ms> — ステータスポーリング間のミリ秒。既定値は [ 5000です。
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy activate my-deployment

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

{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Orchestrator で instanceId が報告されない (ポーリングするものがない) 場合、 Status は Activation completed (no instance to poll) され、コマンドは正常に返されます。

---

uip solution deploy uninstall

デプロイ済みのソリューションをアンインストールします。プロビジョニングされたすべてのリソースとソリューション フォルダーを削除します。

引数

• <deployment-name> (必須) — アンインストールするデプロイの名前。

オプション

• -t, --tenant <tenant-name> — ターゲットとするテナントです。
• --timeout <seconds> — ポーリングタイムアウトをアンインストールします。既定値は [ 360です。
• --poll-interval <ms> — ステータスポーリング間のミリ秒。既定値は [ 5000です。
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy uninstall my-deployment

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

{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

2つの短絡応答が考えられます。

• Uninstall completed immediately — Orchestrator が最初の呼び出しでcomplete: trueを報告したとき。ポーリングは行われません。
• Uninstall scheduled — Orchestrator がインスタンス ID を返さずに作業をスケジュールした場合。このデータには、API からの Scheduled フィールドが含まれます。

---

uip solution deploy config get

パブリッシュ済みのソリューション パッケージの既定のデプロイ設定を取得します。この構成には、ソリューションが作成するすべてのリソース (キュー、アセット、プロセス、バケット、コネクションなど) が既定の設定とともにリストされます。ファイルをファイル(-d)に保存し、config set / config linkでカスタマイズして、deploy run --config-fileに渡します。

引数

• <package-name> (必須) — ソリューション パッケージ名。packages listを使用します。

オプション

• --package-version <version> — パッケージ バージョン。省略した場合は latest が使用されます。
• -d, --destination <path> — stdout の代わりにこのファイルに設定を書き込みます。
• -t, --tenant <tenant-name> — クエリを実行するテナントです。
• --login-validity <minutes> — デフォルトは 10です。

例

uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json

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

-dが指定されている場合:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package"
  }
}

-d省略すると、構成が応答に埋め込まれます。

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "Configuration": { "resources": [ ... ] }
  }
}

---

uip solution deploy config set

デプロイ構成ファイルのリソース プロパティを編集します。ファイルは、deploy run --config-fileに渡すまでローカルのままです。

引数

• <file> (必須) — デプロイ構成ファイル JSON ファイル (config getによって生成) へのパス。
• <args...> (必須) — --allによって異なります。
  • --allなし : <resource> <property> <value> — 例:MyQueue maxNumberOfRetries 5。
  • With --all: <property> <value> — ファイル内のすべてのリソースに適用されます。最上位の conflictFixingAction プロパティに対してのみ有効です。

オプション

• --all - ファイル内のすべてのリソースにプロパティを適用します。conflictFixingAction (例:UseExisting)。

例

変更のリトライは 1 つのキューで行います

uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

すべてのリソースに競合修正ポリシーを設定する

uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

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

単一リソースの更新:

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}

一括更新 (--all):

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}

---

uip solution deploy config リンク

ソリューション リソースを 既存の Orchestrator リソースにリンクし、デプロイで新しいリソースを作成するのではなく再利用する。変更はローカルです — ファイルを deploy run --config-fileに渡して適用します。

引数

• <file> (必須) — デプロイ構成ファイルの JSON ファイルへのパスです。
• <resource> (必須) — 構成ファイルのリソース名または resourceKey 。

オプション

• -n, --name <name> (必須) — リンク先の既存の Orchestrator リソースの名前です。
• --folder-path <path> — 既存のリソースが存在する Orchestrator フォルダーのパスです。

例

uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"

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

{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

---

uip solution deploy config unlink

以前に config linkで設定したリンクを削除します。次の deploy run --config-fileでは、リソースは再利用されるのではなく、新たに作成されます。

引数

• <file> (必須) — デプロイ構成ファイルの JSON ファイルへのパスです。
• <resource> (必須) — リンクを解除するリソース名または resourceKey 。

例

uip solution deploy config unlink ./deploy-config.json MyQueue

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

{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}

故障モード

• リソースは現在リンクされていません。このコマンドはリンク解除を拒否し、config linkをポイントします。

---

uip solution delete

uip solution delete は最上位の動詞 ( deploy サブコマンドではない) で、 Studio Web からソリューション ID でソリューションを削除します。この ID は、uip solution upload およびflow debugによって出力されます。

この操作によってデプロイ済みのソリューションが Orchestrator からアンインストールされることはありません。アンインストールの代わりに [ソリューション]deploy uninstall を使用します。

概要

uip solution delete <solution-id>

引数

• <solution-id> (必須) — Studio Web のソリューション ID (UUID)。

例

uip solution delete a1b2c3d4-0000-0000-0000-000000000001

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

{
  "Code": "SolutionDelete",
  "Data": {
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

---

関連コマンド

• uip solution publish — deploy runの前に必要なステップ 。
• uip solution packages list — パッケージの名前とバージョンを検出します。
• uip resource — deploy config link参照する Orchestrator リソースを検査または作成します。

参照

• 最初のパイプライン — パック→パブリッシュ→デプロイの実行ウォークスルー。
• 認証 と 構成 — セッション設定とテナントごとの既定値。
• uip solutionの概要。