Recurso de uip

uip resource gerencia os recursos do Orchestrator dos quais as automações dependem no runtime — ativos, buckets e arquivos de bucket, bibliotecas, filas e itens de fila, gatilhos e webhooks. É a superfície CRUD de uso geral sobre essas entidades, separada de uip solution resource (que inspeciona as declarações de recursos de soluções locais) e de uip or (a ferramenta de automação do Orchestrator para trabalhos, processos, pastas e assim por diante).

Observação:

O alias da ferramenta é resource (singular), não resources. Cada exemplo usa uip resource <kind>.

é fornecido pelo plug- @uipath/resource-tool uip resource Se ainda não estiver instalado, uip tools install resource o adiciona. Consulte Ferramentas ( plugins ).

Recursos

Cada recurso tem sua própria página de referência. O verbo definido em cada página corresponde aos comandos registrados por uip resource — execute uip resource --help para confirmar a superfície completa em sua instalação.

Recurso	Finalidade
Ativos	Valores de configuração nomeados (Texto, Bool, Integer, Credential e Segredo) usados por automações no runtime. Com escopo de pasta.
Buckets	Contêineres de armazenamento para arquivos usados por automações. Com escopo de pasta.
arquivos do bucket	Arquivos individuais dentro de um bucket. Listar, carregar, baixar, excluir e buscar URLs pré-assinadas.
Bibliotecas	Pacotes .nupkg reutilizáveis (atividades compartilhadas e lógica). Com escopo de tenant.
Filas	Contêineres para itens de trabalho transacionais. Com escopo de pasta.
Itens da Fila	Transações individuais dentro de filas, com controles completos de máquina de estado. Com escopo de pasta.
Gatilhos	Gatilhos de tempo, fila e API que iniciam trabalhos. Os gatilhos de tempo/fila têm escopo de pasta; Os gatilhos de API têm o escopo de tenant.
Webhooks	Retornos de chamada HTTP disparados em eventos de plataforma (conclusão do trabalho, falha do item da fila,…). Com escopo de tenant.

Resumo

uip resource <resource> <verb> [options]

A saída padrão é JSON. Cada subcomando honra as opções globais (--output, --output-filter, --log-level, --log-file) e retorna os códigos de saída padrão.

Convenções

• Autenticação. Cada subcomando uip resource chama o Orchestrator. Execute uip login primeiro ou passe -t, --tenant <tenant-name> em qualquer subcomando para direcionar um tenant específico dentro de sua organização autenticada.
• Escopo de pastas. Ativos, buckets, filas, itens de fila e gatilhos (tempo / fila) têm escopo de pasta. Forneça --folder-path <path> ( exemplo "Shared") ou --folder-key <guid> em list, create e chamadas relacionadas. get, update e delete resolvem pastas cruzadas por chave quando viável — a descrição de cada verbo na página do recurso o chama explicitamente. Bibliotecas, gatilhos de API e webhooks têm o escopo de tenant e não aceitam --folder-*.
• Chaves. A maioria dos recursos é identificada por um GUID retornado na saída list (em key, identifier ou — para itens de fila — uniqueKey para uma única tentativa e key para a cadeia de repetições). Os campos numéricos id são internos e não devem ser passados para comandos.
• Paginação. Os verbos da lista aceitam -l, --limit <n>, --offset <n> e --order-by <field> (sintaxe do OData, por exemplo "Name asc"). O arquivo do bucket list é a exceção e usa um continuationToken.
• Filtrando. Quando compatível, -n, --name <name> é uma correspondência contém no nome do recurso; alguns recursos adicionam --enabled, --disabled, --status, etc.

Formato dos dados

A saída bem-sucedida sempre segue o envelope padrão:

{
  "Result": "Success",
  "Code": "<ResourceCode>",
  "Data": <resource-or-list>
}

O Code por verbo está documentado na página do recurso (AssetList, AssetCreated, BucketFile, QueueItemAdded, TriggerEnabled, WebhookPinged, etc.). Data é um único objeto (get, create, update) ou uma matriz (list, versions, event-types, history).

As listagens estão desencapsuladas no momento. Elas não incluem um campo count ou nextPage de nível superior. O arquivo do bucket list é a exceção; sua carga útil inclui um continuationToken usado para paginação.

Exemplos resolvidos

Listar filas em uma pasta

uip resource queues list --folder-path Shared

Crie um ativo e compartilhe-o em todas as pastas

uip resource assets create ApiToken "sk-live-xxxx" \
  --folder-path Shared --type Secret \
  --credential-store-key <store-guid>

uip resource assets share <asset-guid> --folder-path Production

Adicionar itens de fila em massa a partir de um arquivo JSON

ITEMS=$(jq -c . ./items.json)
uip resource queue-items bulk-add InvoiceQueue \
  --folder-path Shared \
  --queue-items "$ITEMS" \
  --commit-type StopOnFirstFailure \
  --output-filter "Data" --output json

Comandos relacionados

• uip solution deploy config link — associe o recurso declarado de uma solução a um dos ativos/filas/buckets criados por meio de uip resource.
• uip solution resource list — inspecione as declarações de recursos dentro de uma solução local.
• uip or — para pastas, processos, versões, trabalhos, máquinas, usuários e armazenamentos de credenciais nos quais você frequentemente precisará pesquisar chaves ao usar uip resource.

Veja também

• Autenticação — cada subcomando requer uma sessão ativa.
• Configuração — fixe valores padrão de tenant/pasta por projeto.
• Opções globais e códigos de saída — contratos compartilhados por cada verbo.