Get-SqlAgentJobHistory

  • Referenz
Modul:
SQLServer

Ruft den Auftragsverlauf ab, der im Ziel-instance des SQL-Agents vorhanden ist.

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>]

Beschreibung

Das Cmdlet Get-SqlAgentJobHistory ruft das JobHistory-Objekt ab, das im Ziel-instance des SQL-Agents vorhanden ist.

Dieses Cmdlet unterstützt die folgenden Betriebsmodi, um das JobHistory-Objekt abzurufen:

  • Geben Sie den Pfad des SQL-Agent-instance an.
  • Übergeben Sie die instance des SQL-Agents in der Eingabe.
  • Rufen Sie das Cmdlet in einem gültigen Kontext auf.

Beispiele

Beispiel 1: Abrufen des gesamten Auftragsverlaufs vom angegebenen Server instance

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

Dieser Befehl ruft den gesamten Auftragsverlauf auf dem Server instance mit dem Namen MyServerInstance ab und formatiert dann die Ausgabe.

Beispiel 2: Abrufen des Auftragsverlaufs vom angegebenen Server 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

Dieser Befehl ruft den Auftragsverlauf des Auftragsobjekts mit der ID "187112d7-84e1-4b66-b093-e97201c441ed" im Server instance namens "MyServerInstance" ab.

Beispiel 3: Abrufen des Auftragsverlaufs aus einer Zeitdauer vom angegebenen Server 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).

Dieser Befehl gibt den Auftragsverlauf seit dem Vortag im Server instance namens "MyServerInstance" zurück.

Parameter

-AccessToken

Das Zugriffstoken, das zur Authentifizierung bei SQL Server verwendet wird, als Alternative zur Benutzer-/Kennwort- oder Windows-Authentifizierung.

Dies kann z. B. verwendet werden, um eine Verbindung mit SQL Azure DB und SQL Azure Managed Instance mithilfe von oder Service Principal herzustellen Managed Identity.

Der zu verwendende Parameter kann entweder eine Zeichenfolge sein, die das Token darstellt, oder ein PSAccessToken Objekt, das durch Ausführen Get-AzAccessToken -ResourceUrl https://database.windows.netvon zurückgegeben wird.

Dieser Parameter ist in v22 des Moduls neu.

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

-ConnectionTimeout

Gibt die Anzahl von Sekunden an, die vor einem Timeoutfehler auf eine Serververbindung gewartet werden soll. Der Timeoutwert muss ein ganzzahliger Wert zwischen 0 und 65534 sein. Wenn 0 angegeben wird, verursachen Verbindungsversuche kein Timeout.

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

-Credential

Gibt ein PSCredential-Objekt an, das verwendet wird, um die Anmeldeinformationen für eine SQL Server Anmeldung anzugeben, die über die Berechtigung zum Ausführen dieses Vorgangs verfügt.

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

-Encrypt

Der Verschlüsselungstyp, der beim Herstellen einer Verbindung mit SQL Server verwendet werden soll.

Dieser Wert wird der Encrypt -Eigenschaft SqlConnectionEncryptOption des SqlConnection-Objekts des Microsoft.Data.SqlClient-Treibers zugeordnet.

In v22 des Moduls ist Optional der Standardwert (aus Kompatibilität mit v21). In Version 23 und höher des Moduls lautet der Standardwert "Obligatorisch", was zu einer Breaking Change für vorhandene Skripts führen kann.

Dieser Parameter ist in v22 des Moduls neu.

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

-EndRunDate

Gibt eine Auftragsfiltereinschränkung an, die die zurückgegebenen Werte auf das Datum beschränkt, an dem der Auftrag abgeschlossen wurde.

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

-HostNameInCertificate

Der Hostname, der beim Überprüfen des TLS/SSL-Zertifikats von SQL Server verwendet werden soll. Sie müssen diesen Parameter übergeben, wenn Ihr SQL Server instance für "Verschlüsselung erzwingen" aktiviert ist und Sie eine Verbindung mit einem instance mithilfe des Hostnamens/Kurznamens herstellen möchten. Wenn dieser Parameter ausgelassen wird, ist die Übergabe des vollqualifizierten Domänennamens (Fully Qualified Domain Name, FQDN) an -ServerInstance erforderlich, um eine Verbindung mit einem für die Verschlüsselung erzwingen aktivierten SQL Server instance herzustellen.

Dieser Parameter ist in v22 des Moduls neu.

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

-InputObject

Gibt ein Array von SQL Server Management Object (SMO)-Objekten an, die die SQL Server-Agent darstellen, die als Ziel verwendet wird.

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

-JobID

Gibt eine Auftragsfiltereinschränkung an, die die zurückgegebenen Werte auf den durch den Auftrags-ID-Wert angegebenen Auftrag beschränkt.

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

-JobName

Gibt eine Auftragsfiltereinschränkung an, die die zurückgegebenen Werte auf den durch den Namen des Auftrags angegebenen Auftrag beschränkt.

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

-MinimumRetries

Gibt die Auftragsfiltereinschränkung an, die die werte einschränkt, die auf Aufträge zurückgegeben werden, die fehlgeschlagen sind und für die mindestens mal wiederholt wurden.

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

-MinimumRunDurationInSeconds

Gibt eine Auftragsfiltereinschränkung an, die die werte einschränkt, die auf Aufträge zurückgegeben werden, die in der angegebenen Mindestdauer in Sekunden abgeschlossen wurden.

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

-OldestFirst

Gibt an, dass dieses Cmdlet Aufträge in der ältesten und ersten Reihenfolge auflistet. Wenn Sie diesen Parameter nicht angeben, verwendet das Cmdlet newest-first order.

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

-OutcomesType

Gibt eine Auftragsfiltereinschränkung an, die die zurückgegebenen Werte auf Aufträge beschränkt, die bei Abschluss das angegebene Ergebnis aufweisen.

Zulässige Werte für diesen Parameter:

-- 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

Gibt den Pfad zum Agent von SQL Server als Array an, auf dem dieses Cmdlet den Vorgang ausführt. Wenn Sie keinen Wert für diesen Parameter angeben, verwendet das Cmdlet den aktuellen Arbeitsspeicherort.

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

-ServerInstance

Gibt den Namen einer instance von SQL Server als Array an, in dem der SQL-Agent ausgeführt wird. Geben Sie für Standardinstanzen nur den Computernamen MyComputer an. Verwenden Sie für benannte Instanzen das Format ComputerName\Instanzname.

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

-Since

Gibt eine Abkürzung an, die Anstelle des StartRunDate-Parameters möglich ist.

Sie kann mit dem EndRunDate-Parameter angegeben werden.

Sie können den StartRunDate-Parameter nicht verwenden, wenn Sie diesen Parameter verwenden.

Zulässige Werte für diesen Parameter:

  • Mitternacht (ruft alle Auftragsverlaufsinformationen ab, die nach Mitternacht generiert werden)
  • Gestern (ruft alle Auftragsverlaufsinformationen ab, die in den letzten 24 Stunden generiert wurden)
  • LastWeek (ruft alle Auftragsverlaufsinformationen ab, die in der letzten Woche generiert wurden)
  • LastMonth (ruft alle Im letzten Monat generierten Auftragsverlaufsinformationen ab)
Type:SinceType
Accepted values:Midnight, Yesterday, LastWeek, LastMonth
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlMessageID

Gibt eine Auftragsfiltereinschränkung an, die die zurückgegebenen Werte auf Aufträge beschränkt, die die angegebene Nachricht während der Laufzeit generiert haben.

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

-SqlSeverity

Gibt eine Auftragsfiltereinschränkung an, die die zurückgegebenen Werte auf Aufträge beschränkt, die während der Laufzeit einen Fehler des angegebenen Schweregrads generiert haben.

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

-StartRunDate

Gibt eine Auftragsfiltereinschränkung an, die die zurückgegebenen Werte auf das Datum beschränkt, an dem der Auftrag gestartet wurde.

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

-TrustServerCertificate

Gibt an, ob der Kanal verschlüsselt wird, während das Durchlaufen der Zertifikatkette zum Überprüfen der Vertrauensstellung umgangen wird.

In v22 des Moduls ist $true der Standardwert (aus Kompatibilität mit v21). In Version 23 und höher des Moduls lautet der Standardwert "$false", was zu einer Breaking Change für vorhandene Skripts führen kann.

Dieser Parameter ist in v22 des Moduls neu.

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

Eingaben

System.String[]

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

Ausgaben

System.Object