Get-SqlAgentJobHistory
Obtient l’historique des travaux présent dans l’instance cible de SQL Agent.
Syntaxe
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>]
[-ProgressAction <ActionPreference>]
[<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>]
[-ProgressAction <ActionPreference>]
[<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>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Description
L’applet de commande Get-SqlAgentJobHistory obtient l’objet JobHistory présent dans l’instance cible de SQL Agent.
Cette applet de commande prend en charge les modes d’opération suivants pour obtenir l’objet JobHistory :
- Spécifiez le chemin d’accès de l’instance SQL Agent.
- Transmettez l’instance de SQL Agent dans l’entrée.
- Appelez l’applet de commande dans un contexte valide.
Exemples
Exemple 1 : Obtenir l’intégralité de l’historique des travaux à partir de l’instance de serveur spécifiée
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 ExitCette commande obtient l’historique complet des travaux dans l’instance de serveur nommée MyServerInstance, puis met en forme la sortie.
Exemple 2 : Obtenir l’historique des travaux à partir de l’instance de serveur spécifiée
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 : 3Cette commande obtient l’historique des travaux de l’objet de travail avec l’ID « 187112d7-84e1-4b66-b093-e97201c441ed » dans l’instance de serveur nommée « MyServerInstance ».
Exemple 3 : Obtenir l’historique des travaux à partir d’une durée à partir de l’instance de serveur spécifiée
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 le jour précédent dans l’instance de serveur nommée « 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 à SQL Azure DB et SQL Azure Managed Instance à l’aide d’un Service Principal ou d’un Managed Identity.
Le paramètre à utiliser peut être une chaîne représentant le jeton ou un objet PSAccessToken tel qu’il est retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net.
Ce paramètre est nouveau dans v22 du module.
| Type: | PSObject |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-ConnectionTimeout
Spécifie le nombre de secondes à attendre pour une connexion serveur avant une défaillance de délai d’attente. La valeur de délai d’attente doit être une valeur entière comprise entre 0 et 65534. Si 0 est spécifié, les tentatives de connexion n’expirent pas.
| Type: | Int32 |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Credential
Spécifie un objet PSCredential utilisé pour spécifier les informations d’identification d’une connexion SQL Server autorisée à effectuer cette opération.
| Type: | PSCredential |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Encrypt
Type de chiffrement à utiliser lors de la connexion à SQL Server.
Cette valeur est mappée à la propriété EncryptSqlConnectionEncryptOption 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 v22 du module.
| Type: | String |
| Valeurs acceptées: | Mandatory, Optional, Strict |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-EndRunDate
Spécifie une contrainte de filtre de travail qui limite les valeurs retournées à la date de fin du travail.
| Type: | DateTime |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-HostNameInCertificate
Nom d’hôte à utiliser pour valider le certificat TLS/SSL SQL Server. Vous devez passer ce paramètre si votre instance SQL Server est activée pour Forcer le chiffrement et que vous souhaitez vous connecter à une instance à l’aide du nom d’hôte/shortname. Si ce paramètre est omis, le passage du nom de domaine complet (FQDN) à -ServerInstance est nécessaire pour se connecter à une instance SQL Server activée pour Forcer le chiffrement.
Ce paramètre est nouveau dans v22 du module.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-InputObject
Spécifie un tableau d’objets SMO (SQL Server Management Object) qui représentent l’agent SQL Server ciblé.
| Type: | JobServer[] |
| Position: | 1 |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | 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 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | 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 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-MinimumRetries
Spécifie la contrainte de filtre de travail qui limite les valeurs retournées aux travaux ayant échoué et qui ont été retentées pendant un nombre minimal de fois.
| Type: | Int32 |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-MinimumRunDurationInSeconds
Spécifie une contrainte de filtre de travail qui limite les valeurs retournées aux travaux qui se sont terminés pendant la durée minimale spécifiée, en secondes.
| Type: | Int32 |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | 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 la première commande la plus récente.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-OutcomesType
Spécifie une contrainte de filtre de travail qui limite les valeurs retournées aux travaux qui ont le résultat spécifié à l’achèvement.
Les valeurs acceptables pour ce paramètre sont les suivantes :
-- Échec -- Réussite -- Nouvelle tentative -- Annulé -- InProgress -- Inconnu
| Type: | CompletionResult |
| Valeurs acceptées: | Failed, Succeeded, Retry, Cancelled, InProgress, Unknown |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | 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 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-ProgressAction
Détermine comment PowerShell répond aux mises à jour de progression générées par un script, une applet de commande ou un fournisseur, telles que les barres de progression générées par l’applet de commande Write-Progress. L’applet de commande Write-Progress crée des barres de progression qui affichent l’état d’une commande.
| Type: | ActionPreference |
| Alias: | proga |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-ServerInstance
Spécifie le nom d’une instance de SQL Server, en tant que tableau, où SQL Agent 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 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Since
Spécifie une abréviation que vous pouvez au lieu 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 acceptables pour ce paramètre sont les suivantes :
- 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 dans la semaine dernière)
- LastMonth (obtient toutes les informations d’historique des travaux générées au cours du dernier mois)
| Type: | SinceType |
| Valeurs acceptées: | Midnight, Yesterday, LastWeek, LastMonth |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | 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 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | 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 gravité spécifiée pendant l’exécution.
| Type: | Int32 |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-StartRunDate
Spécifie une contrainte de filtre de travail qui limite les valeurs retournées à la date de démarrage du travail.
| Type: | DateTime |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-TrustServerCertificate
Indique si le canal sera chiffré lors du contournement de la marche à pied de 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 v22 du module.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
Entrées
System.String[]
Microsoft.SqlServer.Management.Smo.Agent.JobServer[]
Sorties
System.Object