recursos da solução uip

Sintaxe e opções para "recursos de solução uip", que gerencia os recursos do Orchestrator e do Data Service dos quais uma solução local depende.

uip solution resources gerencia os recursos — filas, ativos, buckets, processos, conexões, entidades, conjuntos de escolhas e outros objetos do Orchestrator e Data Service — dos quais uma solução local depende. As associações de recursos de cada projeto são agregadas na própria lista de recursos da solução; use esse grupo de comando para inspecioná-lo, adicioná-lo, editá-lo ou sincronizá-lo novamente após editar as associações do projeto.

Observação:

Não deve ser confundido com uip or

uip or fornece CRUD sobre filas, ativos, buckets, etc. do lado do servidor do Orchestrator em um tenant ativo. uip solution resources inspeciona e edita a lista declarada da solução local desses recursos — seu próprio arquivo no disco, não o tenant ativo. list --source remote e add --source remote chamam o Orchestrator para pesquisar as coisas, mas o resultado é sempre gravado na solução local.

Resumo

uip solution resources list      [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>] [--include-version] [--login-validity <minutes>]
uip solution resources get       <resource-key> [--solution-folder <path>] [--include-dependencies] [--login-validity <minutes>]
uip solution resources add       --source <local|remote> --kind <kind> --name <name> [--type <type>] [--folder-path <path>] [--cloud-key <guid>] [--solution-folder <path>] [--login-validity <minutes>]
uip solution resources remove    <resource-key> [--solution-folder <path>]
uip solution resources edit      <resource-key> --patch <json> [--solution-folder <path>]
uip solution resources refresh   [--solution-folder <path>] [--login-validity <minutes>]

Todos os seis verbos levam --solution-folder <path> (o padrão para o diretório atual) — nenhum leva um argumento de caminho posicional.

List

Liste recursos na solução e/ou disponíveis no Orchestrator. Por padrão (--source all), retorna os recursos declarados localmente e os recursos que o Orchestrator relata para o tenant remoto associado; quando ambas estão listadas, uma entrada remota que corresponde a uma local por Kind:Name (sem diferenciação entre maiúsculas e minúsculas) é desduplicada em favor da entrada local.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Caminho para a pasta raiz da solução.
--kind	text	—	Filtra por tipo de recurso (por exemplo, Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Qualquer tipo de índice do SDK é aceito — esse não é um enum fixo.
--search	text	—	Contém correspondência no nome do recurso.
--source	all | local | remote	all	Qual lado listar.
--include-version	Bandeira	desativada	Relate também a versão implantada de cada recurso, para tipos que carregam uma (app, appVersion, package, process). Custa uma chamada extra por recurso e, por isso, está desativado por padrão.
--login-validity	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos

# All resources the current solution knows about
uip solution resources list

# Only queues declared locally
uip solution resources list --kind Queue --source local

# Deployed version per folder for classic Apps
uip solution resources list --kind app --source remote --include-version

Formato dos dados (--output json)

{
  "Code": "ResourceList",
  "Data": [
    {
      "Source": "Remote",
      "Key": "0c2b7f04-1d3e-4a55-9f77-2b1a6d9e4c81",
      "Name": "InvoiceQueue",
      "Kind": "queue",
      "Folder": "Shared"
    },
    {
      "Source": "Remote",
      "Key": "a9c9d05f-6d85-41cd-8a54-a479d494bedc",
      "Name": "Validation App",
      "Kind": "app",
      "Folder": "Shared/Validation",
      "FolderKey": "0932a1f4-5cd1-44d4-9f02-cdc92244a6d2",
      "Version": "12.0.0"
    }
  ]
}

Observação:

--source remote (e all) requer uma sessão autenticada com acesso ao Orchestrator de destino da solução.

get

Obtenha a configuração de um recurso da solução por chave — as especificações, bloqueios e metadados à medida que o SDK os expõe. Se a chave não estiver na solução local, ele retorna para uma pesquisa ao vivo do Orchestrator/catálogo de recursos para que o comando ainda seja útil para recursos ainda não associados à solução.

Argumentos

Name	Required	Finalidade
<resource-key>	sim	Chave de recurso da solução — um GUID ou uma chave composta como TestRPA.process.TestRPA:1.0.0 para pacotes.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Caminho para a pasta raiz da solução.
--include-dependencies	Bandeira	desativada	Retorne também configurações para cada dependência a que o recurso faz referência.
--login-validity	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f \
  --solution-folder ./my-solution --include-dependencies

Formato dos dados (--output json)

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "fb39bc38-255e-4fea-93c6-7c7eb44d766f",
    "spec": { "name": "RPA Workflow", "type": "Process" },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1",
    "isOverridable": true
  }
}

Se o recurso ativo vinculado se desviou da declaração local, a resposta adiciona liveSpec (a especificação ativa atual) ao lado da obsoleta spec e resourceOverwrite.matchingOverwriteConfiguration: false:

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "0f8a1c9e-2b47-4d0a-9c31-5e2f6d8a7b10",
    "spec": { "name": "Approval App", "version": "7.0.0" },
    "liveSpec": { "name": "Approval App", "version": "12.0.0" },
    "resourceOverwrite": { "matchingOverwriteConfiguration": false }
  }
}

Em--include-dependencies vez disso, retorna Code: "ResourceConfigurations" com uma resources matriz, cada entrada name adicionando, kind e.dependencies

Adicionar

Adicione um recurso à solução. --source local cria um recibo virtual sem pesquisa remota; --source remote importa um recurso existente do Orchestrator. Idempotente: um recurso que corresponde ao mesmo (kind, name, folder) — ou, no caminho remoto, a mesma chave de nuvem resolvida — é retornado inalterado em vez de duplicado.

Opções

Long	Valor	Padrão	Description
--source	local | remote	—	Obrigatório. local cria um recibo virtual; remote importado do Orchestrator.
--kind	text	—	Obrigatório. Tipo de recurso (por exemplo, Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Sem distinção entre maiúsculas e minúsculas.
--name	text	—	Obrigatório. Nome do recurso (máximo de 256 caracteres; não pode conter caracteres / \ : * ? " < > | ou de controle).
--type	text	—	Subtipo de recurso (por exemplo, Text/Bool/Integer para Asset, um tipo de conector para Connection). Obrigatório para os tipos dos índices do SDK por (kind, type), a menos que possa ser resolvido a partir de uma correspondência remota.
--folder-path	Path	—	Caminho da pasta do Orchestrator para pesquisa remota; desambigua quando existe mais de uma correspondência remota. Não é válido com --source local.
--cloud-key	GUID	—	Ignore a pesquisa de nome remoto e importe esta chave de recurso exata. Válido apenas com --source remote.
--solution-folder	Path	diretório atual	Caminho para a pasta raiz da solução.
--login-validity	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Se uma pesquisa de nome remoto corresponder a mais de um recurso, o comando falhará e listará a pasta, o tipo e a chave de cada candidato para que você possa desambiguar --cloud-key com.

Exemplos

# Create a local virtual stub (no remote lookup)
uip solution resources add --source local --kind Queue --name InvoiceQueue

# Import an existing remote queue, disambiguated by folder path
uip solution resources add --source remote --kind Queue --name InvoiceQueue \
  --folder-path Sales/CRM

Formato dos dados (--output json)

{
  "Code": "ResourceAdded",
  "Data": {
    "Key": "8f3a1b2c-0000-0000-0000-000000000001",
    "Kind": "queue",
    "Type": null,
    "Name": "InvoiceQueue",
    "Folder": "solution_folder",
    "FolderKey": "5c2d61f4-0000-0000-0000-000000000001",
    "Source": "local",
    "Status": "Added"
  }
}

Status é um Added Updateddestes:,, ou Unchanged (o caso no-op idempotente).

remove

Remove um recurso da solução pela sua chave. puramente local — sem necessidade de autenticação e não afeta o bindings_v2.json de nenhum projeto.

Argumentos

Name	Required	Finalidade
<resource-key>	sim	Chave de recurso da solução (GUID). Use resources list ou resources get para descobri-lo.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Caminho para a pasta raiz da solução.

Exemplos

uip solution resources remove 8f3a1b2c-1234-4abc-9def-0123456789ab

Formato dos dados (--output json)

{
  "Code": "ResourceRemoved",
  "Data": {
    "Key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "Kind": "queue",
    "Name": "InvoiceQueue",
    "Folder": "solution_folder"
  }
}

edit

Edite as propriedades especificadas de um recurso por chave. --patch pega um objeto JSON de propriedade → valor, mesclado na especificação existente; as propriedades que o SDK marca como referência/somente leitura/desconhecida são ignoradas silenciosamente. As formas de dados get e edit correspondem; portanto, uma viagem de ida e volta obter → modificar → editar é direta. --source remote pega os valores da definição da nuvem da qual o recurso foi importado em vez de --patch.

Argumentos

Name	Required	Finalidade
<resource-key>	sim	Chave de recurso da solução (GUID).

Opções

Long	Valor	Padrão	Description
--patch	JSON ou -	—	Objeto JSON da propriedade especifica → valor. Passe - para ler o JSON do stdin.
--source	local | remote	local	De onde vêm os novos valores: --patch (local) ou a definição da nuvem (remote).
--force	Bandeira	desativada	Com --source remote, escreva a definição da nuvem sobre a local.
--solution-folder	Path	diretório atual	Caminho para a pasta raiz da solução.
--login-validity	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização. Usado apenas --source remote por.

Exemplos

uip solution resources edit 8f3a1b2c-1234-4abc-9def-0123456789ab \
  --patch '{"maxNumberOfRetries":5}'

# Pipeline-friendly: patch from stdin
echo '{"slaInHours":"4"}' | uip solution resources edit 8f3a1b2c-... --patch -

# Pull the cloud definition: report the differences, then overwrite
uip solution resources edit 8f3a1b2c-... --source remote
uip solution resources edit 8f3a1b2c-... --source remote --force

Formato dos dados (--output json)

{
  "Code": "ResourceEdited",
  "Data": {
    "key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "spec": { "name": "InvoiceQueue", "maxNumberOfRetries": 5 },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1"
  }
}

Com --source remote e sem --force, o comando não escreve nada: sai de 1 e nomeia as propriedades que diferem. Se nada diferir, ele é bem-sucedido com Code: "ResourceRemoteDrift" e Applied: false. Com --force a resposta é ResourceEdited, carregando Changed, Skipped (propriedades que o tipo de recurso não permite que o SDK escreva) e Applied: true.

refresh

Verifique novamente cada projeto na solução e sincronize as declarações de recursos de seus arquivos bindings_v2.json. As associações que ainda não estão na lista de recursos da solução são criadas; as associações que correspondem a um recurso existente do Orchestrator são importadas; cópias duplicadas dos próprios projetos da solução que uma execução anterior importada de uma pasta implantada são podadas. Execute isso depois de editar as associações do projeto para trazer o inventário de recursos da solução de volta ao passo.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Caminho para a pasta raiz da solução.
--login-validity	minutos	10	Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos

uip solution resources refresh

Formato dos dados (--output json)

{
  "Code": "ResourceRefresh",
  "Data": {
    "Created": 2,
    "Imported": 1,
    "Skipped": 5,
    "Pruned": 0,
    "Warnings": [],
    "Status": "Synced 3 resources (5 already in solution)"
  }
}

Created é a contagem de recursos de solução novos; Imported é a contagem correspondente ao Orchestrator; Skipped conta associações que já tiveram uma entrada de solução correspondente; Pruned conta cópias duplicadas do projeto removidas (nomeadas apenas em Status quando diferentes de zero). Warnings é uma lista de notas legíveis por humanos da sincronização (vazia em uma execução limpa).

Códigos de saída

Consulte Códigos de saída para o contrato compartilhado.

Comandos relacionados

• uip solution pack — o empacotamento lê a lista de recursos da solução.
• uip solution deploy — implantar recursos de provisionamento no tenant de destino.
• uip or — a ferramenta CRUD do lado do servidor para recursos ao vivo do Orchestrator.

Veja também

• Opções globais — --output, --output-filter, --log-level, --log-file.
• Códigos de saída — contrato de código de saída padrão.