UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Ressources de solution uip

Syntaxe et options pour `uip solution resource`, qui gère les ressources d'Orchestrator et de Data Service dont dépend une solution locale.

uip solution resources gère les ressources - files d'attente, ressources, compartiments, processus, connexions, entités, ensembles de choix et autres objets Orchestrator et Data Service - dont dépend une solution locale . Les liaisons de ressources de chaque projet sont agrégées dans la propre liste de ressources de la solution; Utilisez ce groupe de commandes pour l'inspecter, l'ajouter, le modifier ou le synchroniser à nouveau après avoir modifié les liaisons du projet.

Remarque :

uip or fournit un CRUD sur les files d'attente, les ressources, les compartiments, etc. du serveur d'Orchestrator sur un locataire actif. uip solution resources inspecte et modifie la liste déclarée de ces ressources de la solution locale — son propre fichier sur le disque, et non le locataire actif. list --source remote et add --source remote appellent Orchestrator pour rechercher, mais le résultat est toujours écrit dans la solution locale.

Synthèse​

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

Les six verbes prennent --solution-folder <path> (par défaut vers le répertoire actuel) — aucun ne prend un argument de chemin positionnel.

Répertoriez les ressources dans la solution et/ou disponibles dans Orchestrator. Par défaut (--source all), renvoie à la fois les ressources déclarées localement et les ressources signalées par Orchestrator pour le locataire distant associé. Les lignes locales ont le premier plan. Une entrée distante qui correspond à une entrée locale par Kind:Name (insensible à la casse) est supprimée, et l'entrée locale est conservée.

Les résultats sont paginés par curseur. Lorsque davantage de lignes existent, le Pagination de la réponse comporte HasMore: true et un curseur NextPage ; transmettez cette valeur inchangée par --next-page pour obtenir la page suivante.

Options​

LongValeur (Value)DefaultDescription
--solution-folderChemin d'accèsRépertoire actuelChemin d’accès au dossier racine de la solution.
--kindtext—Filtrez par type de ressource (par exemple Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Tout type d'index du SDK est accepté, il ne s'agit pas d'une énumération fixe.
--searchtext—Contient une correspondance sur le nom de la ressource.
--sourceall | local | remoteallQuel côté lister.
--include-versionDrapeaudésactivéIndiquez également la version de chaque ressource pour les types qui en comportent une (app, appVersion, package, process). Les lignes distantes signalent la version en ligne dans le dossier; les lignes locales signalent la version des épingles de solution. Coûte un appel supplémentaire par ressource, il est donc désactivé par défaut.
-l, --limit <number>Numérique50Nombre de ressources à renvoyer.
--next-page <cursor>text—Curseur du Pagination.NextPage d'une réponse précédente. Un curseur non valide est refusé.
--offset <number>Numérique—Seul 0 est accepté, car les pages du catalogue de ressources par curseur. Utilisez --next-page à la place.
--login-validityminutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples​

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

Format des données (--sortie 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"
    }
  ]
}
Remarque :

list nécessite une session authentifiée. --source remote et all ont également besoin d'accéder à l'instance Orchestrator cible de la solution.

Obtenez la configuration d’une ressource de solution par clé — les spécifications, les verrous et les métadonnées tels que le SDK les expose. Si la clé ne se trouve pas dans la solution locale, elle revient à une recherche active d'Orchestrator/de catalogue de ressources afin que la commande soit toujours utile pour les ressources qui ne sont pas encore liées à la solution.

Arguments​

NomRequisObjectif
<resource-key>ouiClé de ressource de solution — un GUID ou une clé composite comme TestRPA.process.TestRPA:1.0.0 pour les packages.

Options​

LongValeur (Value)DefaultDescription
--solution-folderChemin d'accèsRépertoire actuelChemin d’accès au dossier racine de la solution.
--include-dependenciesDrapeaudésactivéRenvoyez également les configurations pour chaque dépendance référencée par la ressource.
--login-validityminutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples​

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

Format des données (--sortie 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
  }
}

Si la ressource dynamique liée a dérivé de la déclaration locale, la réponse ajoute liveSpec (la spécification dynamique actuelle) à côté de l'obsolescence spec, et 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 }
  }
}

--include-dependencies renvoie Code: "ResourceConfigurations" avec un tableau resources à la place, chaque entrée ajoutant name, kind et dependencies.

Ajouter (Add)​

Ajoutez une ressource à la solution. --source local crée un sbut virtuel sans recherche à distance; --source remote importe une ressource Orchestrator existante. Idmpotent: une ressource correspondant au même (kind, name, folder) — ou, sur le chemin distant, à la même clé cloud résolue — est renvoyée inchangée plutôt que dupliquée.

Options​

LongValeur (Value)DefaultDescription
--sourcelocal | remote—Requis. local crée un s Robot virtuel; remote importations depuis Orchestrator.
--kindtext—Requis. Type de ressource (par exemple Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Insensible à la casse.
--nametext—Requis. Nom de la ressource (256 caractères maximum; ne peut pas contenir de / \ : * ? " < > | caractères de contrôle).
--typetext—Sous-type de ressource (par exemple Text/Bool/Integer pour Asset, un type de connecteur pour Connection). Obligatoire pour saisir les index SDK par (kind, type), sauf si résolvable à partir d'une correspondance à distance.
--folder-pathChemin d'accès—Chemin du dossier Orchestrator pour la recherche à distance; dissipe l'ambiguïté lorsqu'il existe plusieurs correspondances à distance. Non valide avec --source local.
--cloud-keyGUID—Ignorez la recherche de nom à distance et importez cette clé de ressource exacte. Uniquement valide avec --source remote.
--solution-folderChemin d'accèsRépertoire actuelChemin d’accès au dossier racine de la solution.
--login-validityminutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Si une recherche de nom à distance correspond à plus d'une ressource, la commande échoue et répertorie le dossier, le type et la clé de chaque candidat afin que vous puissiez désambiguer avec --cloud-key.

Exemples​

# 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

Format des données (--sortie 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 est l’un des éléments Added, Updated ou Unchanged (le cas idempotent sans opération).

remove​

Supprimer une ressource de la solution par sa clé. Purement local — aucune authentification requise et il ne affecte pas le bindings_v2.json d'un projet.

Arguments​

NomRequisObjectif
<resource-key>ouiClé de ressource de solution. Utilisez resources list ou resources get pour le découvrir.

Options​

LongValeur (Value)DefaultDescription
--solution-folderChemin d'accèsRépertoire actuelChemin d’accès au dossier racine de la solution.

Exemples​

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

Format des données (--sortie 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"
  }
}

Modifier (Edit)​

Modifiez les propriétés spécifiques d'une ressource par clé. --patch prend un objet JSON de propriété → valeur, fusionné dans la spécification existante; que le SDK marque comme référence/lecture seule/inconnu sont ignorés en mode silencieux. Les formes de données get et edit correspondent, de sorte qu’un aller-retour → modifier → modifier est simple. --source remote prend les valeurs de la définition Cloud à partir de laquelle la ressource a été importée, au lieu de --patch. C'est le moyen de récupérer une modification apportée dans Orchestrator ou Data Fabric après l'importation, car refresh n'écrase jamais une ressource importée.

Arguments​

NomRequisObjectif
<resource-key>ouiClé de ressource de solution.

Options​

LongValeur (Value)DefaultDescription
--patchJSON ou -—Objet JSON de la propriété spécifiée → valeur. Transmettez - pour lire plutôt le fichier JSON de stbin. Requis avec --source local; refusé avec --source remote
--sourcelocal | remotelocalD'où proviennent les nouvelles valeurs: --patch (local) ou la définition du cloud (remote).
--forceDrapeaudésactivéAvec --source remote, écrivez la définition du cloud au-dessus de la définition locale. Sans cela, la commande ne signale que ce qui doit être modifié et n’écrit rien. Refusé avec --source local.
--solution-folderChemin d'accèsRépertoire actuelChemin d’accès au dossier racine de la solution.
--login-validityminutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation. Utilisé uniquement par --source remote.

Exemples​

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

Format des données (--sortie 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"
  }
}

Avec --source remote et sans --force, la commande n’écrit rien: elle quitte 1 et nomme les propriétés qui diffèrent. Si rien ne diffère, il réussit avec Code: "ResourceRemoteDrift" et Applied: false. Avec --force la réponse est ResourceEdited, qui porte Changed, Skipped (propriétés, le type de ressource ne permet pas à la CLI d’écrire, qui diffèrent toujours de la définition du cloud), Applied: true, et le Spec obtenu :

{
  "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​

Analysez à nouveau chaque projet dans la solution et synchronisez les fichiers de chaque projet dans la liste des ressources de la solution. Exécutez cette option après avoir modifié les liaisons d’un projet ou tout fichier de projet auquel son outil contribue en ressources.

  • Liaisons. Les entrées dans le fichier bindings_v2.json d'un projet qui ne sont pas encore dans la solution sont créées. Les entrées qui correspondent à une ressource Orchestrator existante sont importées. Les copies en double des propres projets de la solution dans lesquels une exécution antérieure a été importée à partir d'un dossier déployé sont supprimées.
  • Contributions au projet. L’outil de chaque projet indique ce que ses fichiers ajoutent aux ressources de la solution, et refresh écrit cela dans la ressource correspondante. Les propres ressources d'artefacts d'un projet sont réécrites à partir des fichiers du projet à chaque exécution.
  • Ressources cloud importées. refresh n'écrase jamais une ressource importée, de sorte que les modifications locales restent valides. Pour extraire une définition de cloud qui a changé après l'importation, exécutez resources edit <resource-key> --source remote.

Erreurs que les rapports d'outils d'un projet sont renvoyés sous forme d'avertissements et refresh n'échoue pas sur ces erreurs. uip solution pack et uip solution upload les appliquent.

Options​

LongValeur (Value)DefaultDescription
--solution-folderChemin d'accèsRépertoire actuelChemin d’accès au dossier racine de la solution.
--login-validityminutes10Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples​

uip solution resources refresh
uip solution resources refresh

Format des données (--sortie 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'."
  }
}
ChampDescription
CreatedRessources de solution créées à partir de liaisons.
ImportedLes liaisons ont été mises en correspondance avec une ressource Orchestrator existante et importée.
SkippedDes liaisons qui avaient déjà une ressource de solution correspondante et qui sont restées inchangées. Lorsqu'il n'est pas nul, Status nomme resources edit --source remote comme moyen d'extraire une définition de cloud modifiée.
PrunedCopies de projet en double supprimées. Nommé dans Status uniquement lorsqu'il est non nul.
ReconciledSpecsRessources mises à jour avec ce que leur projet contribue.
WarningsNotes de la synchronisation, y compris les erreurs signalées par les projets. Vide lors d'une exécution propre.

Si la synchronisation des liaisons réussit mais que les contributions au projet ne peuvent pas être écrites, la commande échoue. Corrigez le problème signalé, puis réexécutez refresh .

Codes de sortie​

Voir Codes de sortie pour le contrat partagé.

  • uip solution pack — l'empaquetage lit la liste des ressources de la solution.
  • uip solution deploy — déployer des ressources d'enregistrement sur le locataire cible.
  • uip or — l'outil CRUD côté serveur pour les ressources Orchestrator actives.

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance(opens in new window)

Vous souhaitez apprendre ? UiPath Academy(opens in new window)

Vous avez des questions ? UiPath Forum(opens in new window)

Rester à jour