UIP ou déclencheurs

Syntaxe et options pour `uip or triggers`, qui gère le temps, la file d'attente et les déclencheurs d'API dans Orchestrator.

Gérer les déclencheurs Orchestrator: heure (planification), file d'attente et API. Les déclencheurs de temps et de file d'attente sont à l'échelle du dossier; Les déclencheurs d'API sont à l'échelle du locataire. Chaque verbe accepte --type <time|queue|api> (par défaut time).

Pour les conventions inter-ressources (authentification, étendue des dossiers, types de clés, enveloppe de sortie), consultez la vue d’ensembleuip or .

Synthèse

uip or triggers list     [--type <type>] [--folder-path <path> | --folder-key <key>] [-n <name>] [--enabled | --disabled] [--sort-by <field>] [--all-fields]
uip or triggers get      <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] [--all-fields]
uip or triggers create   --type <type> --name <n> --release-key <k> --runtime-type <r> --job-priority <p> [type-specific flags]
uip or triggers update   <trigger-key> --type <type> [type-specific flags] [--enabled | --disabled]
uip or triggers delete   <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] --yes
uip or triggers history  <trigger-key> --type <type> [--folder-path <path> | --folder-key <key>] [-l <n>] [--offset <n>] [--all-fields]

Remarque :

Il n’y a pas de commande enable ou disable dédiée. Activez ou désactivez un déclencheur avec update <trigger-key> --enabled ou update <trigger-key> --disabled à la place (les deux indicateurs sont mutuellement exclusifs).

List

Lister les déclencheurs Filtres: -n, --name, --enabled, --disabled (sont mutuellement exclusifs). --sort-by <field> trie les résultats. --all-fields renvoie la réponse complète de l'API au lieu du sous-ensemble sélectionné.

uip or triggers list --type time --folder-path Shared --enabled

get

Obtenir un déclencheur par clé. --all-fields renvoie la réponse complète de l'API au lieu du sous-ensemble sélectionné.

Créer

Créez un déclencheur. Indicateurs requis: --name, --release-key, --runtime-type <Serverless|Unattended|Headless|NonProduction|AgentService>, --job-priority <Low|Normal|High> (par défaut Normal).

Spécifique au type:

• l'heure a besoin de --cron (au format Quartz 6 champs) et éventuellement --time-zone.
• la file d’attente a besoin de --queue-key (et accepte --items-threshold, --max-jobs, --items-per-job, --activate-on-complete).
• l'API a besoin --slug et --method <Get|Post|Put|Delete> (avec --calling-mode facultatif).

Commun: -d, --description, --input-arguments <json>, --calendar-key, --stop-strategy <SoftStop|Kill>, --kill-process-expression, --resume-on-same-context, --run-as-me, répétable --target "machine=<guid>,user=<guid>,session=<int>", --mapping-mode <dynamic|strict> (par défaut dynamic; utiliser strict lorsque le a activé « Activer les mappages compte-machine»).

uip or triggers create --type time \
  --name NightlyInvoices --release-key <release-guid> \
  --runtime-type Unattended --job-priority Normal \
  --folder-path Shared --cron "0 0 2 * * ?" --time-zone UTC

Mettre à jour

Mettre à jour par clé. Mêmes indicateurs spécifiques au type que create, tous facultatifs. Utilisez des homologues --no-* pour ne pas définir les booléens (par exemple --no-activate-on-complete, --no-resume-on-same-context, --no-run-as-me). Transmettez --enabled ou --disabled pour activer/désactiver l'état du déclencheur ( mutuellement exclusif).

uip or triggers update <trigger-key> --type time --disabled

Supprimer (Delete)

Supprimer un déclencheur par clé. Requiert -y, --yes — la CLI ne demande jamais d'opérations destructrices.

uip or triggers delete <trigger-key> --type time --yes

Historique

Affichez l'historique d'exécution du déclencheur (journaux des exécutions). Paginé via -l, --limit / --offset. --all-fields renvoie la réponse complète de l'API au lieu du sous-ensemble sélectionné. Utile pour diagnostiquer la raison pour laquelle un déclencheur ne s'est pas activé (licence manquante, aucune machine, désactivé, etc.).

Codes de sortie

Voir Codes de sortie pour le contrat partagé. delete quitte 1 si -y, --yes est omis.

Commandes associées

• uip or processes — obtenez un --release-key pour triggers create.
• uip or queues — clés de file d'attente pour --queue-key sur les déclencheurs de file d'attente.

Voir également

• Vue d’ensemble deuip or — conventions partagées pour chaque uip or verbe.
• Comment procéder: Gérer les ressources et les files d'attente d'Orchestrator — déclencher des modèles de création.