uip またはフォルダー

uip or folders は Orchestrator フォルダー (プロセス、ジョブ、アセット、キュー、ユーザー権限のスコープを設定する階層型コンテナー) を管理します。動詞では、フォルダーのリスト表示、作成、移動、編集、削除のほか、フォルダー内のマシン ランタイムの割り当てを報告する runtimes コマンドが含まれます。

概要

uip or folders <verb> [options]

動詞

動詞	目的
list	フォルダーのリストを取得します。既定: 現在のユーザーがアクセスできるフォルダー[ --all] では、テナント内のすべてのフォルダーが含まれます。
create	フォルダーを作成します。必要に応じて、親の下に入れ子にします。
get	キーまたはパスで 1 つのフォルダーを取得します。
delete	キーまたはパスでフォルダーを削除します。
move	フォルダーの親子関係を変更するか、フォルダーをルートに移動します。
edit	表示名や説明を更新します。
runtimes	フォルダーのランタイムの種類ごとのランタイム割り当て (合計/接続済み/利用可能) を表示します。

uip またはフォルダーのリスト

フォルダーのリストを取得します。既定のビューでは、呼び出し元がアクセスできる GetAllForCurrentUser フォルダーが使用されます。--allでは、動詞は完全なFoldersエンドポイント (テナント内の Standard フォルダーと Solution フォルダー) に切り替わります。--type personalでは、PersonalWorkspaces エンドポイントに切り替わります。フラグ (--name、 --path、 --type、 --top-level、 --order-by) をフィルター処理および並べ替えるには、 --allが必要です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-a	--all	フラグ	無効	テナント内のすべてのフォルダーのリストを取得します。以下のフィルターフラグと並べ替えフラグを有効化するために必要です。
-n	--name	text	—	表示名に contains-match が含まれます。--allが必要です。
—	--path	パスのプレフィックス	—	フォルダー パスのプレフィックスでフィルター処理します (たとえば、 Shared は Shared 以下のすべてに一致します)。--allが必要です。
—	--type	ENUM	—	standard、 solution、または personalのいずれかです。--allが必要です。personal 、個人用ワークスペース エンドポイントに切り替わります。
—	--top-level	フラグ	無効	ルート フォルダーのみ (親フォルダーなし)。--allが必要です。非 --type personalではサポートされていません。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	—	OData の並べ替え ( Name ascなど)。--allが必要です。
—	--login-validity	分	10	トークンの有効期限の最小時間 (分) で、要求前の更新がトリガーされます。

例

# Folders the authenticated user can access
uip or folders list

# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --order-by "Name asc"

# Personal workspaces only
uip or folders list --all --type personal

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

{
  "Code": "FolderList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Shared",
      "Path": "Shared",
      "Description": "",
      "Type": "Standard",
      "ParentKey": ""
    }
  ]
}

--allでは、項目にFeedTypeとPermissionModelも含まれます。--type personalでは、ペイロードは { Key, Name, OwnerName, OwnerKey, LastLogin }です。

uip またはフォルダーの作成

フォルダーを作成します。必要に応じて、親の下に入れ子にします。--parent には、フォルダーの GUID またはパス (Shared、 Production/EUを指定できます。

引数

名前	Required	目的
<name>	○	フォルダーの表示名。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-d	--description	text	—	フォルダーの説明。
-p	--parent	キーまたはパス	—	GUID またはパスによる親フォルダールート フォルダーを省略します。
—	--feed-type	ENUM	Processes	Processes、 Libraries、 FolderHierarchyです。
—	--permission-model	ENUM	FineGrained	FineGrained または InheritFromTenant。
—	--provision-type	ENUM	Automatic	Automatic または Manual。

例

uip or folders create "Staging"

uip or folders create "EU" --parent "Production" \
    --description "European workloads"

uip or folders create "Libraries" --feed-type Libraries \
    --permission-model InheritFromTenant

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

{
  "Code": "FolderCreated",
  "Data": {
    "Name": "Staging",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Created successfully"
  }
}

uip または folders get

キーまたはパスで 1 つのフォルダーを取得します。位置引数は自動検出します:UUID入力はキーとして扱われ、それ以外はパスとして扱われます。

引数

名前	Required	目的
<folder-key-or-path>	○	フォルダー GUID またはパス。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'

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

{
  "Code": "FolderGet",
  "Data": {
    "Name": "Shared",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Description": "No description",
    "Path": "Shared",
    "ParentID": "Root",
    "FolderType": "Standard",
    "IsPersonal": "No",
    "ProvisionType": "Automatic",
    "PermissionModel": "FineGrained",
    "FeedType": "Processes"
  }
}

uip またはフォルダーの削除

キーまたはパスでフォルダーを削除します。フォルダにエンティティまたはユーザの関連付けが含まれている場合は失敗します。最初に内容を削除または移動します。

引数

名前	Required	目的
<folder-key-or-path>	○	フォルダー GUID またはパス。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or folders delete "Shared/Staging"
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010
uip or folders delete "Shared/Staging" --output-filter 'Data.Status'

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

{
  "Code": "FolderDelete",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Deleted successfully"
  }
}

uip またはフォルダーの移動

フォルダーを新しい親またはルートの上に移動します。--parent または --rootの 1 つだけを指定する必要があります。

引数

名前	Required	目的
<folder-key-or-path>	○	フォルダー GUID または移動するパス。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-p	--parent	キーまたはパス	—	新しい親フォルダー。--rootが設定されていない限りは必須です。
—	--root	フラグ	無効	最上位レベルに移動します (親なし)。

例

uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
    --output-filter 'Data.TargetParentPath'

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

{
  "Code": "FolderMove",
  "Data": {
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "FolderPath": "Shared/Staging",
    "TargetParentPath": "Production",
    "Status": "Moved successfully"
  }
}

--root は TargetParentPath を (root)に設定します。

uip またはフォルダーの編集

表示名や説明を更新します。--nameまたは--descriptionのうち、少なくとも 1 つを指定する必要があります。

引数

名前	Required	目的
<folder-key-or-path>	○	フォルダー GUID またはパス。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-n	--name	text	—	新しい表示名。
-d	--description	text	—	新しい説明。

例

uip or folders edit a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders edit "Shared/Staging" --description "Pre-prod runs"
uip or folders edit "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'

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

{
  "Code": "FolderUpdate",
  "Data": { "Status": "Updated successfully" }
}

UIP またはフォルダー ランタイム

フォルダーのランタイム割り当てのリスト — ランタイムの種類ごとに、合計スロット数、接続済みスロット数、使用可能なスロット数。ジョブを開始する前に容量を確認するのに便利です。

引数

名前	Required	目的
<folder-key-or-path>	○	フォルダー GUID またはパス。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
    --output-filter "Data[?Type=='Unattended'].Available | [0]"

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

{
  "Code": "FolderRuntimes",
  "Data": [
    { "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
    { "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
  ]
}

終了コード

「終了コード」を参照してください。動詞固有の上書きはありません。

関連コマンド

• uip or processes — フォルダー範囲のプロセスのバインド。
• uip or machines — 特にフォルダー メンバーシップのmachines assign/unassign。
• uip or users — users list-in-folder、 users assign、 users unassign。
• uip or roles — フォルダー レベルのロールの割り当て。

参照

• グローバル オプション。
• セッション — テナントとフォルダーのコンテキストの解決。