Trigger

I trigger richiedono una licenza.

I trigger consentono di avviare job di automazione quando si verificano determinati eventi all'interno di PowerShell Universal. Ad esempio, ciò le permette di intervenire quando i job vengono completati, il server viene avviato o le dashboard si arrestano. I trigger sono utili per assegnare una gestione globale degli errori o per inviare notifiche quando accadono determinati eventi.

I job attivati da trigger non causeranno l'avvio di ulteriori trigger. I trigger sono memorizzati in triggers.ps1.

Eventi trigger

Ai seguenti tipi di eventi può essere assegnato un trigger.

• Job avviato
• Job annullato
• Job completato
• Job completato con errore
• Job che richiede feedback
• Job non riuscito
• Job scaduto
• App (Dashboard) avviata
• App (Dashboard) arrestata
• Sessione dell'app (Dashboard) scaduta
• Event Hub connesso
• Event Hub disconnesso
• Controllo di integrità non riuscito
• Server avviato
• Arresto del server
• Nuovo accesso utente
• Accesso utente
• Utilizzo di un token app revocato
• Autenticazione API non riuscita
• Errore API
• Sincronizzazione git
• Licenza scaduta
• Licenza in scadenza
• Computer offline

Nuovo accesso utente

L'evento di accesso utente si verifica quando un utente accede a PowerShell Universal. Lo script riceverà un parametro $User con le informazioni sull'utente.

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

Accesso utente

L'evento di accesso utente si verifica quando un utente accede a PowerShell Universal. Lo script riceverà un parametro $data con le informazioni sull'utente. La struttura dei dati è mostrata di seguito.

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

Utilizzo di un token app revocato

L'evento del token app si verifica quando viene utilizzato un token app revocato. Lo script riceverà un parametro $data che contiene il contenuto del token app come stringa.

Sincronizzazione git

Questo trigger si verifica quando viene eseguita una sincronizzazione git. Questo trigger si attiverà sia per le sincronizzazioni git riuscite sia per quelle non riuscite.

Riceverà il seguente oggetto nel parametro $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; }
}

Computer offline

Il trigger computer offline fornirà l'oggetto computer al parametro $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
}

Trigger globali

I trigger globali avviano lo script assegnato ogni volta che viene richiamato il tipo di evento.

Ad esempio, Script.ps1 verrà eseguito ogni volta che viene eseguito un job qualsiasi.

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

Trigger di risorsa

I trigger di risorsa avviano lo script assegnato quando l'evento si verifica sulla risorsa selezionata.

Ad esempio, Script.ps1 verrà eseguito ogni volta che la Dashboard viene arrestata.

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

Metadati dell'evento

Ogni volta che un job viene avviato da un trigger, gli vengono forniti i metadati relativi all'oggetto che ha causato l'attivazione dell'evento.

Ai trigger relativi ai job verrà fornito un parametro $Job.

param($Job)

$Job

Ai trigger relativi alle dashboard verrà fornito un parametro $Dashboard.

param($Dashboard)

$Dashboard

I trigger relativi allo stato del server non riceveranno alcun parametro.

Condizioni

Utilizzando il parametro -Condition di New-PSUTrigger, può determinare se un trigger debba essere eseguito o meno in base alle condizioni locali del server. Restituisca $true o $false dalla condizione.

Ad esempio, può disabilitare un trigger se la variabile di ambiente Environment non è impostata su production.

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

API

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