UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

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:

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] [-l, --limit <number>] [--next-page <cursor>] [--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 edit      <resource-key> --source remote [--force] [--solution-folder <path>] [--login-validity <minutes>]
uip solution resources refresh   [--solution-folder <path>] [--login-validity <minutes>]
uip solution resources list      [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>] [--include-version] [-l, --limit <number>] [--next-page <cursor>] [--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 edit      <resource-key> --source remote [--force] [--solution-folder <path>] [--login-validity <minutes>]
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.

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. As linhas locais vêm primeiro. Uma entrada remota que corresponde a uma local por Kind:Name (sem diferenciação entre maiúsculas e minúsculas) é descartada, e a entrada local é mantida.

Os resultados são paginados por cursor. Quando existem mais linhas, a Pagination da resposta carrega HasMore: true e um cursor NextPage ; passe esse valor inalterado para --next-page para obter a próxima página.

Opções​

LongValorPadrãoDescription
--solution-folderPathdiretório atualCaminho para a pasta raiz da solução.
--kindtext—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.
--searchtext—Contém correspondência no nome do recurso.
--sourceall | local | remoteallQual lado listar.
--include-versionBandeiradesativadaRelate também a versão de cada recurso, para tipos que carregam uma (app, appVersion, package, process). Linhas remotas relatam a versão ao vivo na pasta; as linhas locais relatam a versão que a solução fixada. Custa uma chamada extra por recurso e, por isso, está desativado por padrão.
-l, --limit <number>Número50Número de recursos a serem retornados.
--next-page <cursor>text—Cursor de Pagination.NextPage de uma resposta anterior. Um cursor inválido é recusado.
--offset <number>Número—Apenas 0 é aceito, porque o catálogo de recursos páginas por cursor. Use --next-page em vez disso.
--login-validityminutos10Mí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

# Next page of a long listing
uip solution resources list --limit 20 --next-page <cursor>
# 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

# Next page of a long listing
uip solution resources list --limit 20 --next-page <cursor>

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"
    }
  ]
}
{
  "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:

list requer uma sessão autenticada. --source remote e all também precisam de acesso ao Orchestrator de destino da solução.

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​

NameRequiredFinalidade
<resource-key>simChave de recurso da solução — um GUID ou uma chave composta como TestRPA.process.TestRPA:1.0.0 para pacotes.

Opções​

LongValorPadrãoDescription
--solution-folderPathdiretório atualCaminho para a pasta raiz da solução.
--include-dependenciesBandeiradesativadaRetorne também configurações para cada dependência a que o recurso faz referência.
--login-validityminutos10Mí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
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
  }
}
{
  "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 }
  }
}
{
  "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​

LongValorPadrãoDescription
--sourcelocal | remote—Obrigatório. local cria um recibo virtual; remote importado do Orchestrator.
--kindtext—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.
--nametext—Obrigatório. Nome do recurso (máximo de 256 caracteres; não pode conter caracteres / \ : * ? " < > | ou de controle).
--typetext—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-pathPath—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-keyGUID—Ignore a pesquisa de nome remoto e importe esta chave de recurso exata. Válido apenas com --source remote.
--solution-folderPathdiretório atualCaminho para a pasta raiz da solução.
--login-validityminutos10Mí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
# 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"
  }
}
{
  "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​

NameRequiredFinalidade
<resource-key>simChave de recurso da solução (GUID). Use resources list ou resources get para descobri-lo.

Opções​

LongValorPadrãoDescription
--solution-folderPathdiretório atualCaminho para a pasta raiz da solução.

Exemplos​

uip solution resources remove 8f3a1b2c-1234-4abc-9def-0123456789ab
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"
  }
}
{
  "Code": "ResourceRemoved",
  "Data": {
    "Key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "Kind": "queue",
    "Name": "InvoiceQueue",
    "Folder": "solution_folder"
  }
}

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 de nuvem da qual o recurso foi importado, ao invés de --patch. É a maneira de selecionar uma alteração feita no Orchestrator ou no Data Fabric após a importação, porque refresh nunca substitui um recurso importado.

Argumentos​

NameRequiredFinalidade
<resource-key>simChave de recurso da solução (GUID).

Opções​

LongValorPadrãoDescription
--patchJSON ou -—Objeto JSON da propriedade especifica → valor. Passe - para ler o JSON do stdin. Necessário com --source local; recusado com --source remote.
--sourcelocal | remotelocalDe onde vêm os novos valores: --patch (local) ou a definição da nuvem (remote).
--forceBandeiradesativadaCom --source remote, escreva a definição de nuvem sobre a local. Sem ele, o comando relata apenas o que mudaria e não escreve nada. Recusado com --source local.
--solution-folderPathdiretório atualCaminho para a pasta raiz da solução.
--login-validityminutos10Mí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
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"
  }
}
{
  "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 será 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 a CLI grave, que ainda diferem da definição da nuvem), Applied: true e o Spec resultante :

{
  "Code": "ResourceEdited",
  "Data": {
    "Key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "Changed": ["fields"],
    "Skipped": [],
    "Applied": true,
    "Status": "Overwrote 1 property with the cloud definition",
    "Spec": { "...": "..." }
  }
}
{
  "Code": "ResourceEdited",
  "Data": {
    "Key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "Changed": ["fields"],
    "Skipped": [],
    "Applied": true,
    "Status": "Overwrote 1 property with the cloud definition",
    "Spec": { "...": "..." }
  }
}

refresh​

Verifique novamente todos os projetos na solução e sincronize os arquivos de cada projeto com a lista de recursos da solução. Execute isso depois de editar as associações de um projeto ou qualquer arquivo do projeto do qual sua ferramenta contribui com recursos.

  • Associações. As entradas em bindings_v2.json de um projeto que ainda não estão na solução são criadas. As entradas que correspondem a um recurso do Orchestrator existente são importadas. As cópias duplicadas dos projetos próprios da solução que uma execução anterior importou de uma pasta implantada são removidas.
  • Contribuições do projeto. A ferramenta de cada projeto relata o que seus arquivos adicionam aos recursos da solução e refresh isso no recurso correspondente. Os recursos de artefato do próprio projeto são reescritos a partir dos arquivos do projeto em cada execução.
  • Recursos de nuvem importados. refresh substitui um recurso importado, portanto, as edições locais persistem. Para extrair uma definição de nuvem que foi alterada após a importação, execute resources edit <resource-key> --source remote.

Os erros que a ferramenta de um projeto relata são retornados como avisos, e refresh não falha neles. uip solution pack e uip solution upload os aplicam.

Opções​

LongValorPadrãoDescription
--solution-folderPathdiretório atualCaminho para a pasta raiz da solução.
--login-validityminutos10Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos​

uip solution resources refresh
uip solution resources refresh

Formato dos dados (--output json)​

{
  "Code": "ResourceRefresh",
  "Data": {
    "Created": 2,
    "Imported": 1,
    "Skipped": 5,
    "Pruned": 0,
    "ReconciledSpecs": 1,
    "Warnings": [],
    "Status": "Synced 3 resources (5 already in solution). Refresh never overwrites an imported resource — to pull a changed cloud definition, run 'uip solution resources edit <resource-key> --source remote'."
  }
}
{
  "Code": "ResourceRefresh",
  "Data": {
    "Created": 2,
    "Imported": 1,
    "Skipped": 5,
    "Pruned": 0,
    "ReconciledSpecs": 1,
    "Warnings": [],
    "Status": "Synced 3 resources (5 already in solution). Refresh never overwrites an imported resource — to pull a changed cloud definition, run 'uip solution resources edit <resource-key> --source remote'."
  }
}
CampoDescription
CreatedRecursos da solução criados a partir de associações.
ImportedAs associações foram correspondidas com um recurso do Orchestrator existente e importadas.
SkippedAs associações que já tinham um recurso de solução correspondente e foram deixadas inalteradas. Quando diferente de zero, Status nomeia resources edit --source remote como a maneira de extrair uma definição de nuvem alterada.
PrunedCópias duplicadas do projeto removidas. Nomeado em Status apenas quando for diferente de zero.
ReconciledSpecsRecursos atualizados com a contribuição do seu projeto.
WarningsObservações da sincronização, incluindo erros que os projetos reportaram. Esvaziar em uma execução limpa.

Se a sincronização de associações for bem-sucedida, mas as contribuições do projeto não puderem ser escritas, o comando falhará. Corrija o problema relatado e execute refresh novamente.

Códigos de saída​

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

  • 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​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades