Get-SqlAgentJob
Ruft ein SQL-Agent-Job-Objekt für jeden Auftrag ab, der im Ziel-instance des SQL-Agents vorhanden ist.
Syntax
Get-SqlAgentJob
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlAgentJob
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[[-Name] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlAgentJob
[[-Name] <String>]
[-InputObject] <JobServer>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Beschreibung
Das cmdlet Get-SqlAgentJob ruft ein SQL-Agent-Auftragsobjekt für jeden Auftrag ab, der im Ziel-instance des SQL-Agents vorhanden ist. Wenn der Name des Auftrags angegeben wird, ruft das Cmdlet nur dieses spezifische Auftragsobjekt ab.
Dieses Cmdlet unterstützt die folgenden Betriebsmodi, um eine Auflistung von Job-Objekten 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 aller Auftragsinstanzen vom angegebenen Server instance
PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob
Name Owner Category Enabled CurrentRunStatus DateCreated LastModified JobID
---- ----- -------- ------- ---------------- ----------- ------------ -----
MyJob1 Owner [Uncategorized (Local)] True Idle 6/2/2016 10:21:44 AM 6/2/2016 10:21:44 AM 841255df-06e8-43ef-b798-3...
MyJob2 Owner [Uncategorized (Local)] True Idle 5/31/2016 2:40:58 PM 6/1/2016 5:09:40 PM 995b296a-cd35-4505-868a-3...
MyJob3 Owner [Uncategorized (Local)] True Idle 5/25/2016 12:13:56 PM 5/25/2016 12:13:56 PM 01d2e61a-9a90-4f77-98f4-e...
Mit diesem Befehl werden alle Auftragsinstanzen auf dem Server instance mit dem Namen "MyServerInstance" abgerufen.
Beispiel 2: Abrufen eines Auftrags instance nach Name vom angegebenen Server instance
PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob -Name MyJob1
Name Owner Category Enabled CurrentRunStatus DateCreated LastModified JobID
---- ----- -------- ------- ---------------- ----------- ------------ -----
MyJob1 Owner [Uncategorized (Local)] True Idle 6/2/2016 10:21:44 AM 6/2/2016 10:21:44 AM 841255df-06e8-43ef-b798-3...
Mit diesem Befehl wird der Auftrag instance mit dem Namen "MyJob1" in der Serverinstanz "MyServerInstance" abgerufen.
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 Service Principal
von 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.net
zurückgegeben wird.
Dieser Parameter ist neu in v22 des Moduls.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionTimeout
Gibt die Anzahl der Sekunden an, die vor einem Timeoutfehler auf eine Serververbindung gewartet werden müssen. 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 v23+ des Moduls lautet der Standardwert "Obligatorisch", wodurch möglicherweise eine Breaking Change für vorhandene Skripts entsteht.
Dieser Parameter ist neu in v22 des Moduls.
Type: | String |
Accepted values: | Mandatory, Optional, Strict |
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 einer instance mithilfe von hostname/shortname herstellen möchten. Wenn dieser Parameter nicht angegeben wird, ist das Übergeben 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 neu in v22 des Moduls.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Gibt ein SMO-Objekt (SQL Management Objects) an, das die SQL Server-Agent darstellt, die als Ziel verwendet wird.
Type: | JobServer |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Gibt den Namen des Job-Objekts an, das dieses Cmdlet abruft. Bei dem Namen kann die Groß-/Kleinschreibung beachtet werden, abhängig von der Sortierung des SQL Server, in dem der SQL-Agent ausgeführt wird.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Gibt den Pfad zum Agent von SQL Server an, auf dem dieses Cmdlet den Vorgang ausführt. Wenn Sie keinen Wert für diesen Parameter angeben, verwendet das Cmdlet den aktuellen Arbeitsstandort.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServerInstance
Gibt als Zeichenfolgenarray den Namen eines instance von SQL Server an, an 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: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TrustServerCertificate
Gibt an, ob der Kanal verschlüsselt wird, während das Durchlaufen der Zertifikatkette zur Überprüfung der Vertrauensstellung umgangen wird.
In v22 des Moduls ist $true
der Standardwert (aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "$false", wodurch möglicherweise eine Breaking Change für vorhandene Skripts entsteht.
Dieser Parameter ist neu in v22 des Moduls.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Ausgaben
System.Object