Get-SqlAgentJobHistory

  • Référence
Module:
SQLServer

Obtient l’historique des travaux présent dans le instance cible de SQL Agent.

Syntax

Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [[-Path] <String[]>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]
Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]
Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [-InputObject] <JobServer[]>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]

Description

L’applet de commande Get-SqlAgentJobHistory obtient l’objet JobHistory présent dans le instance cible de SQL Agent.

Cette applet de commande prend en charge les modes de fonctionnement suivants pour obtenir l’objet JobHistory :

  • Spécifiez le chemin d’accès de l’agent SQL instance.
  • Passez la instance de l’agent SQL dans l’entrée.
  • Appelez l’applet de commande dans un contexte valide.

Exemples

Exemple 1 : Obtenir l’historique complet des travaux à partir du serveur instance spécifié

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" | Format-Table

InstanceID SqlMessageID Message
---------- ------------ -------
        34            0 The job succeeded.  The Job was invoked by Schedule 8 (syspolicy_purge_history_schedule).  T... 
        33            0 Executed as user: DOMAIN\Machine1$. The step did not generate any output.  Process Exit

Cette commande obtient l’historique complet des travaux dans le serveur instance nommé MyServerInstance, puis met en forme la sortie.

Exemple 2 : Obtenir l’historique des travaux à partir du serveur spécifié instance

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -JobID 187112d7-84e1-4b66-b093-e97201c441ed

JobID            : 187112d7-84e1-4b66-b093-e97201c441ed
JobName          : Job_73cc6990-6386-49f9-9826-96c318ad8afa
RunStatus        : 3

Cette commande obtient l’historique des travaux de l’objet de travail avec l’ID « 187112d7-84e1-4b66-b093-e97201c441ed » dans le serveur instance nommé « MyServerInstance ».

Exemple 3 : Obtenir l’historique des travaux à partir d’une durée à partir du serveur spécifié instance

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -Since Yesterday
InstanceID       : 4
SqlMessageID     : 0
Message          : The job was stopped prior to completion by User admin.  The Job was invoked by User
                   admin.  The last step to run was step 1 (JobStep_3e4cd4ba-3433-4311-a6a2-816884101504).

Cette commande retourne l’historique des travaux depuis la veille dans le serveur instance nommé « MyServerInstance ».

Paramètres

-AccessToken

Jeton d’accès utilisé pour s’authentifier auprès de SQL Server, comme alternative à l’authentification utilisateur/mot de passe ou Windows.

Cela peut être utilisé, par exemple, pour se connecter à et à SQL Azure DB l’aide d’un Service Principal ou d’un Managed Identity.SQL Azure Managed Instance

Le paramètre à utiliser peut être une chaîne représentant le jeton ou un PSAccessToken objet tel que retourné par l’exécution Get-AzAccessToken -ResourceUrl https://database.windows.netde .

Ce paramètre est nouveau dans la version 22 du module.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTimeout

Spécifie le nombre de secondes d’attente d’une connexion au serveur avant un échec de délai d’attente. La valeur du délai d’attente doit être une valeur entière comprise entre 0 et 65534. Si la valeur 0 est spécifiée, les tentatives de connexion n'expirent pas.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Spécifie un objet PSCredential qui est utilisé pour spécifier les informations d’identification d’une connexion SQL Server qui a l’autorisation d’effectuer cette opération.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encrypt

Type de chiffrement à utiliser lors de la connexion à SQL Server.

Cette valeur est mappée à la Encrypt propriété SqlConnectionEncryptOption sur l’objet SqlConnection du pilote Microsoft.Data.SqlClient.

Dans la version 22 du module, la valeur par défaut est Optional (pour la compatibilité avec v21). Dans la version 23+ du module, la valeur par défaut est « Obligatoire », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans la version 22 du module.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndRunDate

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées à la date d’achèvement du travail.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat SQL Server TLS/SSL. Vous devez passer ce paramètre si votre SQL Server instance est activé pour Forcer le chiffrement et que vous souhaitez vous connecter à un instance à l’aide de nom d’hôte/nom_court. Si ce paramètre est omis, le passage du nom de domaine complet (FQDN) à -ServerInstance est nécessaire pour se connecter à un SQL Server instance activé pour forcer le chiffrement.

Ce paramètre est nouveau dans la version 22 du module.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Spécifie un tableau d’objets SMO (SQL Server Management Object) qui représentent les SQL Server Agent ciblés.

Type:JobServer[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-JobID

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées au travail spécifié par la valeur d’ID de travail.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobName

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées au travail spécifié par le nom du travail.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MinimumRetries

Spécifie la contrainte de filtre de travail qui limite les valeurs retournées aux travaux qui ont échoué et qui ont été retentés pendant un nombre minimal de fois.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MinimumRunDurationInSeconds

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées aux travaux qui se sont terminés dans la durée minimale spécifiée, en secondes.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OldestFirst

Indique que cette applet de commande répertorie les travaux dans l’ordre le plus ancien. Si vous ne spécifiez pas ce paramètre, l’applet de commande utilise newest-first order.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutcomesType

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées aux travaux dont le résultat est spécifié à l’achèvement.

Les valeurs valides pour ce paramètre sont :

-- Failed -- Succeeded -- Retry -- Cancelled -- InProgress -- Unknown

Type:CompletionResult
Accepted values:Failed, Succeeded, Retry, Cancelled, InProgress, Unknown
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Spécifie le chemin d’accès à l’Agent de SQL Server, sous la forme d’un tableau, sur lequel cette applet de commande exécute l’opération. Si vous ne spécifiez pas de valeur pour ce paramètre, l’applet de commande utilise l’emplacement de travail actuel.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Spécifie le nom d’une instance de SQL Server, sous la forme d’un tableau, où l’Agent SQL s’exécute. Pour les instances par défaut, spécifiez uniquement le nom de l’ordinateur : MyComputer. Pour les instances nommées, utilisez le format ComputerName\InstanceName.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Since

Spécifie une abréviation que vous pouvez utiliser à la place du paramètre StartRunDate.

Il peut être spécifié avec le paramètre EndRunDate.

Vous ne pouvez pas utiliser le paramètre StartRunDate si vous utilisez ce paramètre.

Les valeurs valides pour ce paramètre sont :

  • Minuit (obtient toutes les informations d’historique des travaux générées après minuit)
  • Hier (obtient toutes les informations d’historique des travaux générées au cours des dernières 24 heures)
  • LastWeek (obtient toutes les informations d’historique des travaux générées au cours de la dernière semaine)
  • LastMonth (obtient toutes les informations d’historique des travaux générées au cours du dernier mois)
Type:SinceType
Accepted values:Midnight, Yesterday, LastWeek, LastMonth
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlMessageID

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées aux travaux qui ont généré le message spécifié pendant l’exécution.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlSeverity

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées aux travaux qui ont généré une erreur de la gravité spécifiée pendant l’exécution.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StartRunDate

Spécifie une contrainte de filtre de travail qui limite les valeurs retournées à la date de début du travail.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustServerCertificate

Indique si le canal sera chiffré tout en contournant la chaîne de certificats pour valider l’approbation.

Dans la version 22 du module, la valeur par défaut est $true (pour la compatibilité avec v21). Dans v23+ du module, la valeur par défaut est « $false », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans la version 22 du module.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

System.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer[]

Sorties

System.Object