recursos de la solución uip

Sintaxis y opciones para "recursos de solución de UIP", que gestiona los recursos de Orchestrator y Data Service de los que depende una solución local.

uip solution resources los recursos (colas, activos, depósitos, procesos, conexiones, entidades, conjuntos de opciones y otros objetos de Orchestrator y Data Service) de los que depende una solución local . Las vinculaciones de recursos de cada proyecto se agregan a la propia lista de recursos de la solución; utiliza este grupo de comandos para inspeccionarlo, añadirlo, editarlo o volver a sincronizarlo después de editar las vinculaciones del proyecto.

Nota:

No debe confundirse con uip or

uip or proporciona CRUD sobre las colas, activos, depósitos, etc. del lado del servidor de Orchestrator en un tenant activo. uip solution resources inspecciona y edita la lista declarada de esos recursos de la solución local : su propio archivo en el disco, no el tenant activo. list --source remote y add --source remote llaman a Orchestrator para buscar cosas, pero el resultado siempre se escribe en la solución local.

Sinopsis

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

Los seis verbos toman --solution-folder <path> (el directorio actual es el predeterminado); ninguno toma un argumento de ruta posicional.

Lista

Enumera los recursos en la solución y/o disponibles en Orchestrator. De forma predeterminada (--source all), devuelve tanto los recursos declarados localmente como los recursos que informa Orchestrator para el tenant remoto asociado; cuando se enumeran ambos, se deduplica una entrada remota que coincida con una local por Kind:Name (insensible a mayúsculas y minúsculas) en favor de la entrada local.

Opciones

Largo	Valor	Predeterminado	Descripción
--solution-folder	Ruta	directorio actual	Ruta a la carpeta raíz de la solución.
--kind	text	—	Filtrar por tipo de recurso (por ejemplo, Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Se acepta cualquier tipo de índice del SDK: no se trata de una enumeración fija.
--search	text	—	Contiene coincidencia en el nombre del recurso.
--source	all | local | remote	all	De qué lado enumerar.
--include-version	Marca	Desactivado	Informa también de la versión implementada de cada recurso, para los tipos que llevan una (app, appVersion, package, process). Cuesta una llamada adicional por recurso, por lo que está desactivada de forma predeterminada.
--login-validity	minutos	10	Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Ejemplos

# 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

Forma de datos (--json de salida)

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

Nota:

--source remote (y all) requiere una sesión autenticada con acceso al Orchestrator de destino de la solución.

get

Obtén la configuración de un recurso de solución por clave: la especificación, los bloqueos y los metadatos tal y como los expone el SDK. Si la clave no está en la solución local, recurre a una búsqueda en vivo de Orchestrator/catálogo de recursos para que el comando siga siendo útil para los recursos que aún no están vinculados a la solución.

Argumentos

Nombre	Obligatorio	Propósito
<resource-key>	Sí	Clave de recurso de la solución: un GUID o una clave compuesta como TestRPA.process.TestRPA:1.0.0 para paquetes.

Opciones

Largo	Valor	Predeterminado	Descripción
--solution-folder	Ruta	directorio actual	Ruta a la carpeta raíz de la solución.
--include-dependencies	Marca	Desactivado	También devuelve configuraciones para cada dependencia a la que hace referencia el recurso.
--login-validity	minutos	10	Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Ejemplos

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

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

Forma de datos (--json de salida)

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

Si el recurso activo vinculado se ha desviado de la declaración local, la respuesta añade liveSpec (la especificación activa actual) junto con spec obsoleto y 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 }
  }
}

--include-dependencies devuelve Code: "ResourceConfigurations" con una matriz resources en su lugar, cada entrada añade name, kind y dependencies.

Añadir

Añade un recurso a la solución. --source local crea un código auxiliar virtual sin búsqueda remota; --source remote importa un recurso de Orchestrator existente. Idempotente: un recurso que coincida con el mismo (kind, name, folder), o, en la ruta remota, la misma clave de nube resuelta, se devuelve sin cambios en lugar de duplicado.

Opciones

Largo	Valor	Predeterminado	Descripción
--source	local | remote	—	Requerido. local crea un código auxiliar virtual; remote importaciones desde Orchestrator.
--kind	text	—	Obligatorio. Tipo de recurso (por ejemplo, Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). No distingue entre mayúsculas y minúsculas.
--name	text	—	Obligatorio. Nombre del recurso (256 caracteres como máximo; no puede contener / \ : * ? " < > | ni caracteres de control).
--type	text	—	Subtipo de recurso (por ejemplo Text/Bool/Integer para Asset, un tipo de conector para Connection). Obligatorio para los tipos que el SDK indexa por (kind, type), a menos que se pueda resolver desde una coincidencia remota.
--folder-path	Ruta	—	Ruta de la carpeta de Orchestrator para búsqueda remota; elimina la ambigüedad cuando existe más de una coincidencia remota. No es válido con --source local.
--cloud-key	GUID	—	Omita la búsqueda de nombre remoto e importe esta clave de recurso exacta. Solo es válido con --source remote.
--solution-folder	Ruta	directorio actual	Ruta a la carpeta raíz de la solución.
--login-validity	minutos	10	Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Si una búsqueda remota de nombres coincide con más de un recurso, el comando falla y enumera la carpeta, el tipo y la clave de cada candidato para que puedas eliminar la ambigüedad con --cloud-key.

Ejemplos

# 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

Forma de datos (--json de salida)

{
  "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 es uno de Added, Updated o Unchanged (el caso idempotente no-op).

remove

Eliminar un recurso de la solución por su clave. Puramente local: no requiere autenticación y no afecta a bindings_v2.json de ningún proyecto.

Argumentos

Nombre	Obligatorio	Propósito
<resource-key>	Sí	Clave de recurso de solución (GUID). Utiliza resources list o resources get para descubrirlo.

Opciones

Largo	Valor	Predeterminado	Descripción
--solution-folder	Ruta	directorio actual	Ruta a la carpeta raíz de la solución.

Ejemplos

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

Forma de datos (--json de salida)

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

edit

Editar las propiedades de especificación de un recurso por clave. --patch toma un objeto JSON de propiedad → valor, fusionado en la especificación existente; las propiedades que el SDK marca como referencia/solo lectura/desconocida se ignoran silenciosamente. Las formas de datos get y edit coinciden, por lo que obtener → modificar → editar ida y vuelta es sencillo. --source remote toma los valores de la definición de la nube desde la que se importó el recurso en lugar de --patch.

Argumentos

Nombre	Obligatorio	Propósito
<resource-key>	Sí	Clave de recurso de solución (GUID).

Opciones

Largo	Valor	Predeterminado	Descripción
--patch	JSON o -	—	Objeto JSON de la propiedad de especificación → valor. Pasa - para leer el JSON de la entrada estándar en su lugar.
--source	local | remote	local	De dónde provienen los nuevos valores: --patch (local), o la definición de la nube (remote).
--force	Marca	Desactivado	Con --source remote, escribe la definición de la nube sobre la local.
--solution-folder	Ruta	directorio actual	Ruta a la carpeta raíz de la solución.
--login-validity	minutos	10	Minutos mínimos antes de la caducidad del token para desencadenar una actualización. Usado solo por --source remote.

Ejemplos

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

Forma de datos (--json de salida)

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

Con --source remote y sin --force, el comando no escribe nada: sale de 1 y nombra las propiedades que difieren. Si nada difiere, tiene éxito con Code: "ResourceRemoteDrift" y Applied: false. Con --force, la respuesta es ResourceEdited, que lleva Changed, Skipped (propiedades que el tipo de recurso no permite escribir al SDK) y Applied: true.

refresh

Vuelve a escanear cada proyecto de la solución y sincroniza las declaraciones de recursos de sus archivos bindings_v2.json. Se crean las vinculaciones que aún no están en la lista de recursos de la solución; se importan las vinculaciones que coinciden con un recurso de Orchestrator existente; se eliminan las copias duplicadas de los propios proyectos de la solución que una ejecución anterior importada desde una carpeta implementada. Ejecute esto después de editar las vinculaciones del proyecto para que el inventario de recursos de la solución vuelva al paso.

Opciones

Largo	Valor	Predeterminado	Descripción
--solution-folder	Ruta	directorio actual	Ruta a la carpeta raíz de la solución.
--login-validity	minutos	10	Minutos mínimos antes de la caducidad del token para desencadenar una actualización.

Ejemplos

uip solution resources refresh

Forma de datos (--json de salida)

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

Created es el recuento de recursos de solución nuevos; Imported es el recuento coincidente con Orchestrator; Skipped cuenta las vinculaciones que ya tenían una entrada de solución coincidente; Pruned cuenta las copias de proyecto duplicadas eliminadas (solo se nombran en Status cuando no es cero). Warnings es una lista de notas legibles por humanos de la sincronización (vacía en una ejecución limpia).

Códigos de salida

Consulta Códigos de salida para el contrato compartido.

Comandos relacionados

• uip solution pack — el empaquetado lee la lista de recursos de la solución.
• uip solution deploy : implementa recursos de aprovisionamiento en el tenant de destino.
• uip or : la herramienta CRUD del lado del servidor para recursos activos de Orchestrator.

Ver también

• Opciones globales : --output, --output-filter, --log-level, --log-file.
• Códigos de salida : contrato de código de salida estándar.