- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- UiPath für Codierungs-Agents
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Dokumentation
- Add-Test-Data-Entität
- Add-Test-Data-Queue
- Add-Test-Data-Variation
- Analysieren
- Erstellen
- Ein Projekt erstellen
- Diff
- Suchaktivitäten
- Get-Analyse-Regeln
- get-standard-aktivität-xaml
- Fehler abrufen
- Manuelle-Testfälle erhalten
- Manuelle-Testschritte erhalten
- Get-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Beispiele für Listenworkflows
- Packen
- restore
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- UIA
- UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
uip resource verwaltet die Orchestrator-Ressourcen, von denen Automatisierungen zur Laufzeit abhängen – Assets, Buckets und Bucket-Dateien, Bibliotheken, Warteschlangen und Warteschlangenelemente, Trigger und Webhooks. Es ist die allgemeine CRUD-Oberfläche über diese Entitäten, getrennt von uip solution resource (die lokale Lösungsressourcendeklarationen überprüft) und von uip or (dem Orchestrator-Automatisierungstool für Aufträge, Prozesse, Ordner usw.).
Der Tool-Alias ist resource (Singular), nicht resources. Jedes Beispiel verwendet uip resource <kind>.
uip resource wird vom Plugin @uipath/resource-tool bereitgestellt. Wenn sie noch nicht installiert ist, wird uip tools install resource hinzugefügt. Siehe Tools (Plugins).
Ressourcen
Jede Ressource hat eine eigene Referenzseite. Das auf jeder Seite festgelegte Verb stimmt mit den von uip resource registrierten Befehlen überein – führen Sie uip resource --help aus, um die vollständige Oberfläche Ihrer Installation zu bestätigen.
| Ressource | Zweck |
|---|---|
| Assets | Benannte Konfigurationswerte (Text, Bool, Integer, Anmeldeinformationen, Geheimnis), die von Automatisierungen zur Runtime verwendet werden. Ordnerbezogenen. |
| Buckets | Speichercontainer für Dateien, die von Automatisierungen verwendet werden. Ordnerbezogenen. |
| Bucket-Dateien | Einzelne Dateien in einem Bucket. Auflisten, Hochladen, Herunterladen, Löschen und Abrufen von vorsignierten URLs. |
| Bibliotheken | Wiederverwendbare .nupkg -Pakete (gemeinsame Aktivitäten und Logik). Mandantenbezogenen. |
| Warteschlangen | Container für transaktionale Arbeitselemente. Ordnerbezogenen. |
| Warteschlangenelemente | Einzelne Transaktionen innerhalb von Warteschlangen mit vollständigen State-Machine-Steuerelementen. Ordnerbezogenen. |
| Auslöser | Zeit, Warteschlange und API-Trigger, die Aufträge starten. Zeit-/Warteschlangentrigger haben einen Ordner-Scope; API-Trigger haben einen Mandanten-Scope. |
| Webhooks | HTTP-Rückrufe, die bei Plattformereignissen ausgelöst werden (Auftragsabschluss, Fehler bei Warteschlangenelementen, …). Mandantenbezogenen. |
Zusammenfassung
uip resource <resource> <verb> [options]
uip resource <resource> <verb> [options]
Die Standardausgabe ist JSON. Jeder Unterbefehl berücksichtigt die globalen Optionen (--output, --output-filter, --log-level, --log-file) und gibt die Standardbeendigungscodes zurück.
Konventionen
- Authentifizierung. Jeder
uip resource-Unterbefehl ruft Orchestrator auf. Führen Sie zuerstuip loginaus oder übergeben Sie-t, --tenant <tenant-name>in einem beliebigen Unterbefehl, um einen bestimmten Mandanten innerhalb Ihrer authentifizierten Organisation anzuvisieren. - Ordner-Scoping. Assets, Buckets, Warteschlangen, Warteschlangenelemente und Trigger (Zeit/Warteschlange) sind ordnerbezogenen. Geben Sie entweder
--folder-path <path>(z. B"Shared") oder--folder-key <guid>fürlist,createund verwandte Aufrufe.get,updateunddeletelösen ordnerübergreifend nach Schlüssel auf, wenn möglich – die Beschreibung jedes Verbs auf der Ressourcenseite ruft es explizit auf. Bibliotheken, API-Trigger und Webhooks haben einen Mandanten-Scope und akzeptieren--folder-*nicht. - Schlüssel. Die meisten Ressourcen werden durch eine GUID identifiziert, die in der
list-Ausgabe zurückgegeben wird (unterkey,identifieroder – für Warteschlangenelemente –uniqueKeyfür einen einzelnen Versuch undkeyfür die Wiederholungskette). Numerischeid-Felder sind intern und sollten nicht an Befehle übergeben werden. - Paginieren. Listenverben akzeptieren
-l, --limit <n>,--offset <n>und--order-by <field>(OData-Syntax, z. B"Name asc"). Die Bucket-Dateilistist die Ausnahme und verwendet einecontinuationToken. - Filtern. Sofern unterstützt, ist
-n, --name <name>eine Enthält-Übereinstimmung für den Ressourcennamen; Einige Ressourcen fügen--enabled,--disabled,--statususw. hinzu.
Datenform
Eine erfolgreiche Ausgabe folgt immer dem Standardumschlag:
{
"Result": "Success",
"Code": "<ResourceCode>",
"Data": <resource-or-list>
}
{
"Result": "Success",
"Code": "<ResourceCode>",
"Data": <resource-or-list>
}
Der Code pro Verb wird auf der Ressourcenseite dokumentiert (AssetList, AssetCreated, BucketFile, QueueItemAdded, TriggerEnabled, WebhookPinged usw.). Data ist entweder ein einzelnes Objekt (get, create, update) oder ein Array (list, versions, event-types, history).
Auflistungen sind derzeit entpackt – sie enthalten kein count oder nextPage -Feld der obersten Ebene. Die Bucket-Datei list ist die Ausnahme; Die Nutzlast enthält continuationToken die für das Paginieren verwendet werden.
Funktionierte Beispiele
Listen Sie Warteschlangen in einem Ordner auf
uip resource queues list --folder-path Shared
uip resource queues list --folder-path Shared
Erstellen Sie ein Asset und geben Sie es dann für mehrere Ordner frei
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
Fügen Sie Warteschlangenelemente aus einer JSON-Datei massenweise hinzu
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
Zugehörige Befehle
uip solution deploy config link– Binden Sie die deklarierte Ressource einer Lösung an eines der Assets/Warteschlangen/Buckets, die überuip resourceerstellt wurden.uip solution resource list– Überprüfen Sie die Ressourcendeklarationen innerhalb einer lokalen Lösung.uip or– Für Ordner, Prozesse, Releases, Aufträge, Maschinen, Benutzer und Anmeldeinformationsspeicher, aus denen Sie bei der Verwendung vonuip resourcehäufig Schlüssel suchen müssen.
Siehe auch
- Authentifizierung – Jeder Unterbefehl erfordert eine aktive Sitzung.
- Konfiguration – heften Sie die Standardwerte für Mandant/Ordner pro Projekt an.
- Globale Optionen und Exit-Codes – Verträge, die von jedem Verb geteilt werden.