uip codedapp deploy

「uip codedapp deploy」の構文とオプション - パブリッシュ済みのコード化された Web アプリを UiPath にデプロイまたはアップグレードします。

uip codedapp deploy deploys or upgrades a published app in UiPath. When the app is already deployed, the command upgrades it in place; otherwise it checks that the path name is free and deploys the app. It targets the latest published version by default; pass --version to pin a specific build. Use --folder-key to pick the destination folder.

概要

uip codedapp deploy [options]

オプション

フラグ	説明
-n, --name <name>	App name. Converted to the package ID the same way as in pack. When omitted, the name saved in the local app configuration is used; in an interactive terminal without a saved name, the command prompts for it.
--display-name <name>	Human-readable app title shown in UiPath. When omitted, the title remembered from an earlier deploy is used, then --name as typed. On an upgrade, only an explicit --display-name renames the deployed app.
--path-name <name>	App pathname in the URL (https://<org>.uipath.host/<path-name>). Defaults to the app name. On an upgrade, the path name changes only when you pass this option. To check whether a path name is free, run uip codedapp validate --path-name.
--client-id <id>	OAuth クライアント ID の上書き (非機密/パブリック クライアント)。
-v, --version <version>	特定のパブリッシュ済みバージョンを対象にします。既定では、最新のパブリッシュ済みバージョンが使用されます。
--tags <tags>	デプロイ済みのアプリのコンマ区切りの分類ラベル。例:governance,insightsです。
--base-url <url>	UiPath ベース URL (認証の上書き)。
--org-id <id>	組織 ID (認証の上書き)。
--org-name <name>	組織名 (認証の上書き)。
--tenant-id <id>	テナント ID (認証の上書き)。
--folder-key <key>	Folder key to deploy into. Refer to Folder selection.
--access-token <token>	アクセス トークン (認証の上書き)。

Folder selection

The destination folder is resolved in this order:

1. --folder-key, when passed. If the app was published into your Personal Workspace, a shared folder key is refused; if it was published into the tenant feed, a Personal Workspace folder key is refused.
2. The UIPATH_FOLDER_KEY environment variable.
3. The folders available to your account, filtered to Personal Workspace or shared folders to match how the app was published. When exactly one folder matches, it is selected automatically. When several match, an interactive terminal shows a picker; a non-interactive run fails and asks for --folder-key. Run uip or folders list --output json to find a folder key.

例

# Deploy / upgrade to the latest published version
uip codedapp deploy --name "MyApp"

# Pin a specific version
uip codedapp deploy --name "MyApp" --version "1.0.0"

# Deploy into a folder
uip codedapp deploy --name "MyApp" \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

# Separate display title, a custom OAuth client, and system tags
uip codedapp deploy --name "my-app" --display-name "My App" \
    --client-id "my-oauth-client-id" --tags governance

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

{
  "Code": "DeployCompleted",
  "Data": { "message": "App deployed successfully." }
}

A failed deploy returns Result: "Failure" with Message: "Deploy failed" and the cause in Instructions.

故障モード

• External application token without Apps scopes. When you sign in with an external application (client credentials) whose token carries no Apps scope, the UiPath Apps service rejects the request. The command fails with ErrorCode: "permission_denied" and a message naming the Apps.Read and Apps.Write scopes. Grant both scopes to the external application, add them to uip login --scope, and sign in again.
• Path name already taken. A fresh deploy fails when the path name is in use in the organization. Pass a different --path-name.
• Folder key required. A non-interactive run with several candidate folders and no --folder-key or UIPATH_FOLDER_KEY fails.
• App not published. The command fails when no published version of the app (or of the --version you passed) is found. Run uip codedapp publish first.

関連

• uip codedapp publish — deploy アクティブ化するパッケージを公開します。
• uip codedapp pack — publishによって消費される.nupkgを生成します。

参照

• Coded Apps ツール概要
• グローバル オプション
• 終了コード