uip ou pastas

Sintaxe e opções para "uip or folders", que gerencia os contêineres de pasta hierárquicas que delimitam recursos e permissões do Orchestrator.

uip or folders gerencia pastas do Orchestrator — os contêineres hierárquicos que delimitam processos, trabalhos, ativos, filas e permissões de usuário. Os verbos cobrem listagem, criação, movimentação, edição e exclusão de pastas, além de um comando runtimes que relata a alocação de runtime da máquina dentro de uma pasta.

Resumo

uip or folders <verb> [options]

Verbo

Texto	Finalidade
list	Listar pastas. Padrão: pastas que o usuário atual pode acessar; --all, cada pasta no tenant.
create	Crie uma pasta, aninhada opcionalmente sob um pai.
get	Busca uma pasta por chave ou caminho.
delete	Exclui uma pasta por chave ou caminho.
move	Crie novamente o pai de uma pasta ou mova-a para a raiz.
update (alias edit)	Atualize o nome de exibição e/ou a descrição.
runtimes	Mostra a alocação de runtime (total / conectado / disponível) por tipo de runtime para uma pasta.

uip ou lista de pastas

Listar pastas. A visualização padrão usa GetAllForCurrentUser — pastas às quais o chamador tem acesso. Com --all, o verbo muda para o endpoint Folders completo (pastas Padrão e Solução no tenant); com --type personal, ele muda para o endpoint PersonalWorkspaces . A filtragem e classificação de sinalizadores (--name, --path, --type, --top-level, --sort-by) exigem --all.

Opções

Short	Long	Valor	Padrão	Description
-a	--all	Bandeira	desativada	Listar todas as pastas no tenant; necessário para habilitar o filtro e classificar sinalizadores abaixo.
-n	--name	text	—	Contém correspondência no nome de exibição. Requer --all.
—	--path	Prefixo do Caminho	—	Filtra por prefixo de caminho de pasta (por exemplo, Shared corresponde Shared e tudo abaixo). Requer --all.
—	--type	ENUM	—	standard, solution ou personal. Requer --all. personal alterna para o endpoint de espaços de trabalho pessoais.
—	--top-level	Bandeira	desativada	Apenas pastas raiz (sem pai). Requer --all. Não é compatível com --type personal.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	—	Classificação OData (por exemplo, Name asc). Requer --all.
—	--login-validity	minutos	10	Minutos mínimos antes da expiração do token que dispara uma atualização pré-solicitação.

Exemplos

# 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

Formato dos dados (--output json)

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

Com --all, os itens também incluem FeedType e PermissionModel. Com --type personal, a carga útil é { Key, Name, OwnerName, OwnerKey, LastLogin }.

uip ou pastas criar

Crie uma pasta, aninhada opcionalmente sob um pai. aceita um GUID Shared --parent Production/EU).

Argumentos

Name	Required	Finalidade
<name>	sim	Nome de exibição da pasta.

Opções

Short	Long	Valor	Padrão	Description
-d	--description	text	—	Descrição da pasta.
-p	--parent	Chave ou caminho	—	Pasta pai por GUID ou caminho. Omita para uma pasta raiz.
—	--feed-type	ENUM	Processes	Processes, Libraries, FolderHierarchy.
—	--permission-model	ENUM	FineGrained	FineGrained ou InheritFromTenant.
—	--provision-type	ENUM	Automatic	Automatic ou Manual.

Exemplos

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

Formato dos dados (--output json)

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

uip ou pastas get

Busca uma pasta por chave ou caminho. O argumento posicional detecta automaticamente: a entrada UUID é tratada como uma chave e qualquer outra coisa como um caminho.

Argumentos

Name	Required	Finalidade
<folder-key-or-path>	sim	GUID ou caminho da pasta.

Opções

Short	Long	Valor	Padrão	Description

Exemplos

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

Formato dos dados (--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 ou pastas excluir

Exclui uma pasta por chave ou caminho. A falha se a pasta contiver entidades ou associações de usuário — remova ou mova o conteúdo primeiro.

Argumentos

Name	Required	Finalidade
<folder-key-or-path>	sim	GUID ou caminho da pasta.

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Obrigatório. Confirma esta operação irreversível — a CLI nunca solicita.

Exemplos

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'

Formato dos dados (--output json)

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

migração de uip ou pastas

Mova uma pasta para um novo pai ou até a raiz. Você deve fornecer exatamente um dos --parent ou --root.

Argumentos

Name	Required	Finalidade
<folder-key-or-path>	sim	GUID da pasta ou caminho a mover.

Opções

Short	Long	Valor	Padrão	Description
-p	--parent	Chave ou caminho	—	Nova pasta pai. Obrigatório, a menos que --root esteja definido.
—	--root	Bandeira	desativada	Mover para o nível superior (sem pai).

Exemplos

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'

Formato dos dados (--output json)

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

define --root (root) TargetParentPath

atualização de uip ou pastas

Atualize o nome de exibição e/ou a descrição. Pelo menos um dos --name ou --description deve ser fornecido.

edit é um alias registrado para esse verbo — uip or folders edit funciona de forma idêntica a uip or folders update.

Argumentos

Name	Required	Finalidade
<folder-key-or-path>	sim	GUID ou caminho da pasta.

Opções

Short	Long	Valor	Padrão	Description
-n	--name	text	—	Novo nome de exibição.
-d	--description	text	—	Nova descrição.

Exemplos

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'

Formato dos dados (--output json)

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

runtimes de uip ou de pastas

Listar alocação de runtime para uma pasta — para cada tipo de runtime, quantos slots são no total, conectados e disponíveis. Útil para verificar a capacidade antes de iniciar trabalhos.

Argumentos

Name	Required	Finalidade
<folder-key-or-path>	sim	GUID ou caminho da pasta.

Opções

Short	Long	Valor	Padrão	Description

Exemplos

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

Formato dos dados (--output json)

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

Códigos de saída

Consulte Códigos de saída. Nenhuma substituição específica do verbo.

Comandos relacionados

• uip or processes — associações de processos com escopo de pasta.
• uip or machines — especialmente machines assign / unassign para associação a pastas.
• uip or users — users list-in-folder, users assign, users unassign.
• uip or roles — atribuições de função no nível da pasta.

Veja também

• Opções globais.
• Sessões — Resolução de contexto do tenant e da pasta.