Déclencheurs

Les déclencheurs nécessitent une licence.

Les déclencheurs permettent de démarrer des tâches d'automatisation lorsque certains événements se produisent dans PowerShell Universal. Par exemple, cela vous permet d'agir lorsque des tâches se terminent, que le serveur démarre ou que des tableaux de bord s'arrêtent. Les déclencheurs sont utiles pour assigner une gestion globale des erreurs ou envoyer des notifications lorsque certaines choses se produisent.

Les tâches déclenchées ne provoqueront pas le démarrage de déclencheurs additionnels. Les déclencheurs sont stockés dans le triggers.ps1.

Événements déclencheurs

Les types d'événements suivants peuvent être associés à un déclencheur.

• Tâche démarrée
• Tâche annulée
• Tâche terminée
• Tâche terminée avec erreur
• Tâche demandant une rétroaction
• Échec de la tâche
• Délai de la tâche expiré
• Appli (tableau de bord) démarrée
• Appli (tableau de bord) arrêtée
• Session de l'appli (tableau de bord) expirée
• Event Hub connecté
• Event Hub déconnecté
• Échec de la vérification de l'état
• Serveur démarré
• Arrêt du serveur
• Nouvelle connexion d'utilisateur
• Connexion d'utilisateur
• Utilisation d'un jeton d'application révoqué
• Échec de l'authentification API
• Erreur d'API
• Synchronisation Git
• Licence expirée
• Licence en voie d'expiration
• Ordinateur hors ligne

Nouvelle connexion d'utilisateur

L'événement de connexion d'utilisateur se produit lorsqu'un utilisateur accède à PowerShell Universal. Le script recevra un paramètre $Useravec les informations de l'utilisateur.

@{
    Name = "username"
    Roles = @()
}

Connexion d'utilisateur

L'événement de connexion d'utilisateur se produit lorsqu'un utilisateur accède à PowerShell Universal. Le script recevra un paramètre $data avec les informations de l'utilisateur. La structure de données est présentée ci-dessous.

@{
    UserName = 'username'
    RemoteIpAddress = ''
    LocalPort = ''
    RemotePort = ''
}

Utilisation d'un jeton d'application révoqué

L'événement de jeton d'application se produit lorsqu'un jeton d'application révoqué est utilisé. Le script recevra un paramètre $data qui contient le contenu du jeton d'application sous forme de chaîne.

Synchronisation Git

Ce déclencheur se produit lorsqu'une synchronisation git est exécutée. Ce déclencheur se déclenchera pour les synchronisations git réussies comme pour celles qui échouent.

Vous recevrez l'objet suivant dans le paramètre $data.

public class GitStatus 
{
    public long Id { get; set; }
    public string CommitId { get; set; }
    public DateTime Timestamp { get; set; }
    public TimeSpan SyncTime { get; set; }
    public int Changes { get; set; }
    public string Location { get; set; }
    public string Remote { get; set; }
    public GitStatusResult Result { get; set; }
    public string ResultMessage { get; set; }
    public string ComputerName { get; set; }
}

Ordinateur hors ligne

Le déclencheur d'ordinateur hors ligne fournira l'objet ordinateur au paramètre $Data.

class Computer
{
    [long]$Id
    [string]$Name
    [DateTime]$HeartBeat
    [ComputerStatus]$Status
    [bool]$Maintenance
    [bool]$Deleted
    [List<ComputerTag>]$Tags
    [string]$Version
    [DateTime]$FileSyncTimestamp
    [string]$DeploymentVersion
    [string]$DeploymentName
    [string]$GitSettings
    [string]$GitBranch
    [ComputerType]$Type
}

enum ComputerStatus
{
    Offline,
    Online,
    Busy,
    Loading,
    StartupError
}

enum ComputerType
{
    Server,
    Agent
}

Déclencheurs globaux

Les déclencheurs globaux démarreront le script assigné chaque fois que le type d'événement est invoqué.

Par exemple, le Script.ps1 sera exécuté chaque fois qu'une tâche est exécutée.

New-PSUTrigger -Name 'Trigger' -EventType JobStarted -TriggerScript Script.ps1

Déclencheurs de ressource

Les déclencheurs de ressource démarreront le script assigné lorsque l'événement se produit sur la ressource sélectionnée.

Par exemple, le Script.ps1 sera exécuté chaque fois que le Dashboard est arrêté.

New-PSUTrigger -Name 'Trigger' -EventType DashboardStopped -TriggerScript Script.ps1 -Dashboard 'Dashboard'

Métadonnées d'événement

Chaque fois qu'une tâche est démarrée à partir d'un déclencheur, elle recevra des métadonnées sur l'objet qui a causé le déclenchement de l'événement.

Les déclencheurs liés aux tâches recevront un paramètre $Job.

param($Job)

$Job

Les déclencheurs liés aux tableaux de bord recevront un paramètre $Dashboard.

param($Dashboard)

$Dashboard

Les déclencheurs liés à l'état du serveur ne recevront pas de paramètre.

Conditions

En utilisant le paramètre -Condition de New-PSUTrigger, vous pouvez déterminer si un déclencheur doit être exécuté ou non selon les conditions locales sur le serveur. Retournez $true ou $false à partir de la condition.

Par exemple, vous pouvez désactiver un déclencheur si la variable d'environnement Environment n'est pas définie à production.

New-PSUTrigger -Condition {
   $Env:Environment -eq 'production'
}

API

• New-PSUTrigger
• Remove-PSUTrigger
• Set-PSUTrigger
• Get-PSUTrigger