- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- UiPath pour les agents de codage
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- UiPath Docsai
- add-test-data-entity
- ajouter une file d'attente de données de test
- add-test-data-variation
- Analyser
- Construire
- créer-projet
- Différence
- recherche-activités
- Obtenir les règles de l'analyse
- récupérer-activité-xaml par défaut
- Récupérer les erreurs
- obtenir des cas de test manuels
- Obtenir les étapes de test manuelles
- Obtenir les versions
- exemple de workflow
- indiquer l'application
- indiquer l'élément
- inspecter-package
- install-data-fabric-entities
- installer-ou-Update-packages
- list-data-fabric-entités
- listes-exemples-workflow
- Créer un package
- restore
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- UIA
- Traçages UIP
- Migration
- Référence et assistance
Guide de l'utilisateur de UiPath CLI
uip resource gère les ressources Orchestrator dont dépendent les automatisations au moment de l'exécution: ressources, compartiments et fichiers de compartiment, bibliothèques, files d'attente et éléments de file d'attente, déclencheurs et webhooks. Il s'agit de la surface CRUD à usage général sur ces entités, distincte de uip solution resource (qui inspecte les déclarations de ressources de solution locale) et de uip or (l'outil d'automatisation Orchestrator pour les tâches, les processus, les dossiers, etc.).
L'alias de l'outil est resource (singulaire), et non resources. Chaque exemple utilise uip resource <kind>.
uip resource est fourni par le plug-in @uipath/resource-tool . S’il n’est pas encore installé, uip tools install resource l’ajoute. Voir Outils.
Ressources
Chaque ressource a sa propre page de référence. Le verbe défini sur chaque page correspond aux commandes enregistrées par uip resource — exécutez uip resource --help pour confirmer la surface complète de votre installation.
| Ressource | Objectif |
|---|---|
| Actifs | Valeurs de configuration nommées (Texte, Booléen, Integer, Credential, Secret) utilisées par les automatisations au moment du runtime. Étendue du dossier. |
| Compartiments | Conteneurs de stockage pour les fichiers utilisés par les automatisations. Étendue du dossier. |
| Compartiment-fichiers | Fichiers individuels dans un compartiment. Répertorier, charger, télécharger, supprimer, récupérer des URL pré-signées. |
| Bibliothèques | Packages .nupkg réutilisables (activités et logique partagées). À l’échelle du locataire. |
| Files d'attente (Queues) | Conteneurs pour les éléments de travail transactionnels. Étendue du dossier. |
| éléments de la file d'attente | Transactions individuelles dans des files d'attente, avec des contrôles complets de la machine d'état. Étendue du dossier. |
| Déclencheurs (Triggers) | Déclencheurs de temps, de file d'attente et d'API qui démarrent les tâches. Les déclencheurs de temps/file d'attente sont à l'échelle du dossier; Les déclencheurs d'API sont à l'échelle du locataire. |
| Webhooks | Rappels HTTP déclenchés lors d'événements de la plateforme (achèvement de la tâche, échec de l'élément de la file d'attente, ...) . À l’échelle du locataire. |
Synthèse
uip resource <resource> <verb> [options]
uip resource <resource> <verb> [options]
La sortie par défaut est JSON. Chaque sous-commande respecte les options globales (--output, --output-filter, --log-level, --log-file) et renvoie les codes de sortie standard.
Conventions
- Authentification. Toutes les sous-commandes
uip resourceappellent Orchestrator. Exécutez d'aborduip loginou transmettez-t, --tenant <tenant-name>sur n'importe quelle sous-commande pour cibler un locataire spécifique au sein de votre organisation authentifiée. - Étendue des dossiers. Les ressources, les compartiments, les files d'attente, les éléments de file d'attente et les déclencheurs (heure/file d'attente) sont couverts par le dossier. Indiquez
--folder-path <path>(par ex"Shared") ou--folder-key <guid>surlist,createet les appels associés.get,update, etdeleterésolvent les dossiers croisés par clé lorsque cela est possible - la description de chaque verbe sur la page de ressource l'appelle explicitement. Les bibliothèques, les déclencheurs d'API et les webhooks sont à l'échelle du locataire et n'acceptent pas--folder-*. - Clés. La plupart des ressources sont identifiées par un GUID renvoyé dans la sortie
list(souskey,identifierou — pour les éléments de file d'attente —uniqueKeypour une tentative unique etkeypour la chaîne de réessai). Les champs numériquesidsont internes et ne doivent pas être transmis aux commandes. - Pagination. Les verbes de la liste acceptent
-l, --limit <n>,--offset <n>et--order-by <field>(synde OData, par exemple"Name asc"). Le fichier de compartimentlistest l'exception et utilise unecontinuationToken. - Filtrage. Lorsque cette option est prise en charge,
-n, --name <name>est une correspondance de « contient» au niveau du nom de la ressource; certaines ressources ajoutent--enabled,--disabled,--status, etc.
Format des données
La sortie réussie suit toujours l'enveloppe standard:
{
"Result": "Success",
"Code": "<ResourceCode>",
"Data": <resource-or-list>
}
{
"Result": "Success",
"Code": "<ResourceCode>",
"Data": <resource-or-list>
}
Le Code par verbe est documenté sur la page de ressource (AssetList, AssetCreated, BucketFile, QueueItemAdded, TriggerEnabled, WebhookPinged, etc.). Data est soit un objet unique (get, create, update), soit un tableau (list, versions, event-types, history).
Les listes ne sont actuellement pas encapsulées - elles n'incluent pas de champ count ou nextPage de niveau supérieur. Le fichier de compartiment list est l'exception; sa charge utile comprend une continuationToken utilisée pour la pagination.
Exemples développés
Répertorier les files d'attente dans un dossier
uip resource queues list --folder-path Shared
uip resource queues list --folder-path Shared
Créer une ressource, puis la partager entre plusieurs dossiers
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
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
Ajouter en bloc des éléments de file d’attente à partir d’un fichier 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
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
Commandes associées
uip solution deploy config link— lier la ressource déclarée d'une solution à l'une des ressources/files d'attente/compartiments créés viauip resource.uip solution resource list— inspecter les déclarations de ressources dans une solution locale.uip or— pour les dossiers, les processus, les versions, les tâches, les machines, les utilisateurs et les magasins d'informations d'identification auxquels vous devrez souvent rechercher des clés lorsque vous utilisezuip resource
Voir également
- Authentification — chaque sous-commande nécessite une session active.
- Configuration — épingler les valeurs de locataire/dossier par défaut par projet.
- Options globales et codes de sortie — contrats partagés par chaque verbe.