Get-SqlAgentJobStep
Ruft ein SQL JobStep-Objekt für jeden Schritt ab, der im Ziel-instance des SQL-Agent-Auftrags vorhanden ist.
Syntax
Get-SqlAgentJobStep
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlAgentJobStep
[[-Name] <String>]
[-InputObject] <Job>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Beschreibung
Das Cmdlet Get-SqlAgentJobStep ruft ein SQL JobStep-Objekt für jeden Schritt ab, der im Ziel-instance des SQL-Agent-Auftrags vorhanden ist. Wenn Sie den Namen des Auftragsschritts angeben, ruft das Cmdlet nur dieses spezifische JobStep-Objekt ab.
Dieses Cmdlet unterstützt die folgenden Betriebsmodi, um eine Auflistung von JobStep-Objekten zurückzugeben:
- Übergeben Sie die instance des SQL-Agentauftrags in der Eingabe.
- Geben Sie den Path-Parameter des Job-instance an.
- Rufen Sie das Cmdlet in einem gültigen Kontext auf.
Beispiele
Beispiel 1: Abrufen aller JobStep-Instanzen in den Auftragsinstanzen
PS C:\> Get-SqlAgent -ServerInstance "MyServerInstance" | Get-SqlAgentJob | Get-SqlAgentJobStep
Name ID OnSuccessAction OnFailAction LastRunDate LastRunDuration
---- -- --------------- ------------ ----------- ---------------
step1 1 QuitWithSuccess QuitWithFailure 1/1/0001 12:00:00 AM 4.03:23:45
step2 2 QuitWithSuccess QuitWithFailure 1/1/0001 12:00:00 AM 00:33:59
step3 3 GoToNextStep QuitWithSuccess 1/1/0001 12:00:00 AM 00:00:11
Dieser Befehl verwendet das Cmdlet Get-SqlAgent, um den Server instance namens "MyServerInstance" abzurufen, und übergibt dann das Ergebnis mithilfe der Pipeline an das Cmdlet Get-SqlAgentJob. Der Befehl übergibt dann das Ergebnis mithilfe der Pipeline an das Cmdlet Get-SqlAgentJobStep , um alle JobStep-Instanzen abzurufen.
Beispiel 2: Abrufen eines Auftragsschritts instance nach Name
PS C:\> Get-SqlAgent -ServerInstance "MyServerInstance" | Get-SqlAgentJob | Get-SqlAgentJobStep -Name "Step1"
Name ID OnSuccessAction OnFailAction LastRunDate LastRunDuration
---- -- --------------- ------------ ----------- ---------------
step1 1 QuitWithSuccess QuitWithFailure 1/1/0001 12:00:00 AM 4.03:23:45
Dieser Befehl verwendet das Cmdlet Get-SqlAgent, um den Server instance namens "MyServerInstance" abzurufen, und übergibt dann das Ergebnis mithilfe der Pipeline an das Cmdlet Get-SqlAgentJob. Der Befehl übergibt dann das Ergebnis mithilfe der Pipeline an das Cmdlet Get-SqlAgentJobStep, um die JobStep-instance mit dem Namen "Step1" abzurufen.
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.net
von 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 |
-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 |
-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 das Auftragsobjekt des ziel-instance an.
Type: | Job |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Gibt den Namen des JobStep-Objekts an, das dieses Cmdlet abruft.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Gibt den Pfad zum Auftragsobjekt an, für das dieses Cmdlet den Vorgang ausführt. Wenn Sie keinen Wert für diesen Parameter angeben, verwendet das Cmdlet den aktuellen Arbeitsspeicherort.
Type: | String |
Position: | 2 |
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
Microsoft.SqlServer.Management.Smo.Agent.Job
Ausgaben
System.Object