UIP 或文件夹

"uip 或 folders" 的语法和选项，用于管理限定 Orchestrator 资源和权限的分层文件夹容器。

uip or folders管理 Orchestrator 文件夹，即确定流程、作业、资产、队列和用户权限范围的分层容器。Verbs 涵盖列出、创建、移动、编辑和删除文件夹，以及用于报告文件夹内计算机 Runtime 分配的runtimes命令。

大纲

uip or folders <verb> [options]

动词

动词	用途
list	列出文件夹。默认：当前用户可以访问的文件夹；使用--all ，租户中的每个文件夹。
create	创建一个文件夹，将该文件夹嵌套在父文件夹下。
get	通过密钥或路径获取一个文件夹。
delete	按密钥或路径删除文件夹。
move	重新设置文件夹的父级，或将其移动至根目录。
update （别名 edit）	更新显示名称和/或说明。
runtimes	显示文件夹每个 runtime 类型的 runtime 分配情况（总计/已连接/可用）。

UIP 或文件夹列表

列出文件夹。默认视图使用调用者有权访问的GetAllForCurrentUser文件夹。使用--all时，动词会切换到完整的Folders端点（租户中的标准文件夹和解决方案文件夹）；设置为--type personal ，则会切换到PersonalWorkspaces端点。筛选和排序标志（ --name 、 --path 、 --type 、 --top-level 、 --sort-by ）需要--all 。

选项

短	长	值	默认	描述
-a	--all	标记	关闭	列出租户中的所有文件夹；需要启用下方的筛选器和排序标志。
-n	--name	text	—	显示名称包含匹配项。需要--all 。
—	--path	路径前缀	—	按文件夹路径前缀筛选（例如， Shared与Shared及以下所有内容匹配）。需要--all 。
—	--type	枚举	—	standard、 solution或personal 。需要--all 。personal切换至个人工作区端点。
—	--top-level	标记	关闭	仅根文件夹（无父文件夹）。需要--all 。不支持--type personal 。
-l	--limit	数字	50	页面大小。
—	--offset	数字	0	跳过计数。
—	--sort-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" --sort-by "Name asc"

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

数据形状（--输出 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 ）。

参数

名称	必填	用途
<name>	是	文件夹显示名称。

选项

短	长	值	默认	描述
-d	--description	text	—	文件夹说明。
-p	--parent	密钥或路径	—	按 GUID 或路径排列的父文件夹。若为根文件夹，则可省略。
—	--feed-type	枚举	Processes	Processes、 Libraries 、 FolderHierarchy 、
—	--permission-model	枚举	FineGrained	FineGrained 或 InheritFromTenant。
—	--provision-type	枚举	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

数据形状（--输出 json）

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

UIP 或 Folders 获取

通过密钥或路径获取一个文件夹。位置参数会自动检测：UUID 输入视为键，其他任何内容视为路径。

参数

名称	必填	用途
<folder-key-or-path>	是	文件夹 GUID 或路径。

选项

短	长	值	默认	描述

示例

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

数据形状（--输出 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 或 Folders Delete

按密钥或路径删除文件夹。如果文件夹包含实体或用户关联，则会失败 — 请先删除或移动内容。

参数

名称	必填	用途
<folder-key-or-path>	是	文件夹 GUID 或路径。

选项

短	长	值	默认	描述
-y	--yes	标记	—	必需。确认此不可撤销的操作 — CLI 从不提示。

示例

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

数据形状（--输出 json）

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

uip 或文件夹移动

将文件夹移动到新的父文件夹，或移动到根目录。您必须提供--parent或--root之一。

参数

名称	必填	用途
<folder-key-or-path>	是	要移动的文件夹 GUID 或路径。

选项

短	长	值	默认	描述
-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'

数据形状（--输出 json）

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

--root将TargetParentPath设置为(root) 。

uip 或文件夹更新

更新显示名称和/或说明。必须至少提供--name或--description其中一个。

edit 是此动词的已注册别名，uip or folders edit 的作用与 uip or folders update 相同。

参数

名称	必填	用途
<folder-key-or-path>	是	文件夹 GUID 或路径。

选项

短	长	值	默认	描述
-n	--name	text	—	新显示名称。
-d	--description	text	—	新说明。

示例

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

数据形状（--输出 json）

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

uip 或文件夹 runtime

列出文件夹的运行时分配 — 对于每种运行时类型，显示插槽的总数、已连接和可用数量。用于在开始作业之前检查容量。

参数

名称	必填	用途
<folder-key-or-path>	是	文件夹 GUID 或路径。

选项

短	长	值	默认	描述

示例

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]"

数据形状（--输出 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 — 文件夹级别角色分配。

另请参阅

• 全局选项。
• 会话— 租户和文件夹上下文解析。