Get-SqlAgentJob
Ruft ein SQL-Agent-Auftragsobjekt für jeden Auftrag ab, der in der Zielinstanz des SQL-Agents vorhanden ist.
Syntax
Get-SqlAgentJob
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-SqlAgentJob
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[[-Name] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-SqlAgentJob
[[-Name] <String>]
[-InputObject] <JobServer>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Beschreibung
Das Cmdlet Get-SqlAgentJob ruft ein SQL Agent Job -Objekt für jeden Auftrag ab, der in der Zielinstanz 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 Vorgangsmodi zum Abrufen einer Sammlung von Job-Objekten:
- Geben Sie den Pfad der SQL-Agent-Instanz an.
- Übergeben Sie die Instanz des SQL-Agents in der Eingabe.
- Rufen Sie das Cmdlet in einem gültigen Kontext auf.
Beispiele
Beispiel 1: Abrufen aller Auftragsinstanzen aus der angegebenen Serverinstanz
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 in der Serverinstanz namens "MyServerInstance" abgerufen.
Beispiel 2: Abrufen einer Auftragsinstanz anhand des Namens aus der angegebenen Serverinstanz
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...Dieser Befehl ruft die Auftragsinstanz namens 'MyJob1' in der Serverinstanz mit dem Namen 'MyServerInstance' ab.
Parameter
-AccessToken
Das Zugriffstoken, das zur Authentifizierung bei SQL Server verwendet wird, als Alternative zur Benutzer-/Kennwort- oder Windows-Authentifizierung.
Dies kann z. B. zum Herstellen einer Verbindung mit SQL Azure DB und SQL Azure Managed Instance mithilfe eines Service Principal oder einer Managed Identityverwendet werden.
Der zu verwendende Parameter kann entweder eine Zeichenfolge sein, die das Token darstellt, oder ein PSAccessToken-Objekt, wie durch Ausführen von Get-AzAccessToken -ResourceUrl https://database.windows.netzurückgegeben wird.
Dieser Parameter ist neu in v22 des Moduls.
| Typ: | PSObject |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-ConnectionTimeout
Gibt die Anzahl der Sekunden an, die auf eine Serververbindung warten sollen, bevor ein Timeoutfehler auftritt. Der Timeoutwert muss eine ganze Zahl zwischen 0 und 65534 sein. Wenn 0 angegeben ist, werden Verbindungsversuche nicht unterbrochen.
| Typ: | Int32 |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | 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.
| Typ: | PSCredential |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-Encrypt
Der Verschlüsselungstyp, der beim Herstellen einer Verbindung mit SQL Server verwendet werden soll.
Dieser Wert ist der Encrypt Eigenschaft SqlConnectionEncryptOption für das SqlConnection-Objekt des Microsoft.Data.SqlClient-Treibers zugeordnet.
In v22 des Moduls ist die Standardeinstellung Optional (aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "Verpflichtend", wodurch für vorhandene Skripts eine bahnbrechende Änderung erstellt werden kann.
Dieser Parameter ist neu in v22 des Moduls.
| Typ: | String |
| Zulässige Werte: | Mandatory, Optional, Strict |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-HostNameInCertificate
Der Hostname, der beim Überprüfen des SQL Server TLS/SSL-Zertifikats verwendet werden soll. Sie müssen diesen Parameter übergeben, wenn Ihre SQL Server-Instanz für die Erzwingungsverschlüsselung aktiviert ist und Sie eine Verbindung mit einer Instanz mit 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 einer SQL Server-Instanz herzustellen, die für die Erzwingungsverschlüsselung aktiviert ist.
Dieser Parameter ist neu in v22 des Moduls.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-InputObject
Gibt ein SQL Management Objects (SMO)-Objekt an, das den ZIEL-SQL Server-Agent darstellt.
| Typ: | JobServer |
| Position: | 2 |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Name
Gibt den Namen des Job-Objekts an, das dieses Cmdlet abruft. Je nach Sortierung des SQL Server, in dem der SQL-Agent ausgeführt wird, kann die Groß-/Kleinschreibung beachtet werden.
| Typ: | String |
| Position: | 1 |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | 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 Arbeitsspeicherort.
| Typ: | String |
| Position: | 2 |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-ProgressAction
Bestimmt, wie PowerShell auf Statusaktualisierungen reagiert, die von einem Skript, Cmdlet oder Anbieter generiert werden, z. B. auf die Statusanzeigen, die vom Cmdlet Write-Progress generiert werden. Das Cmdlet Write-Progress erstellt Statusanzeigen, die den Status eines Befehls anzeigen.
| Typ: | ActionPreference |
| Aliase: | proga |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-ServerInstance
Gibt als Zeichenfolgenarray den Namen einer Instanz von SQL Server an, an der 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\InstanceName".
| Typ: | String[] |
| Position: | 2 |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-TrustServerCertificate
Gibt an, ob der Kanal verschlüsselt wird, während die Zertifikatkette umgangen wird, um die Vertrauensstellung zu überprüfen.
In v22 des Moduls ist die Standardeinstellung $true (aus Kompatibilität mit v21). In v23+ des Moduls lautet der Standardwert "$false", wodurch möglicherweise eine änderung für vorhandene Skripts geändert wird.
Dieser Parameter ist neu in v22 des Moduls.
| Typ: | SwitchParameter |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
Ausgaben
System.Object