Condividi tramite


Get-SqlAgentJobStep

Ottiene un oggetto JobStep SQL per ogni passaggio presente nell'istanza di destinazione del processo di SQL Agent.

Sintassi

ByPath (impostazione predefinita).

Get-SqlAgentJobStep
    [[-Name] <String>]
    [[-Path] <String>]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByObject

Get-SqlAgentJobStep
    [[-Name] <String>]
    [-InputObject] <Job>
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

Descrizione

Il cmdlet Get-SqlAgentJobStep ottiene un oggetto JobStep SQL per ogni passaggio presente nell'istanza di destinazione del processo di SQL Agent. Se si specifica il nome del passaggio del processo, il cmdlet ottiene solo questo oggetto JobStep specifico.

Questo cmdlet supporta le modalità di funzionamento seguenti per restituire una raccolta di oggetti JobStep:

  • Passare l'istanza del processo di SQL Agent nell'input.
  • Specificare il parametro Path dell'istanza di Job.
  • Richiamare il cmdlet in un contesto valido.

Esempio

Esempio 1: Ottenere tutte le istanze di JobStep nelle istanze del processo

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

Questo comando usa il cmdlet Get-SqlAgent per ottenere l'istanza del server denominata "MyServerInstance" e quindi passa il risultato usando la pipeline al cmdlet Get-SqlAgentJob . Il comando passa quindi il risultato usando la pipeline al cmdlet Get-SqlAgentJobStep per ottenere tutte le istanze di JobStep.

Esempio 2: Ottenere un'istanza jobStep in base al nome

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

Questo comando usa il cmdlet Get-SqlAgent per ottenere l'istanza del server denominata "MyServerInstance" e quindi passa il risultato usando la pipeline al cmdlet Get-SqlAgentJob . Il comando passa quindi il risultato usando la pipeline al cmdlet Get-SqlAgentJobStep per ottenere l'istanza jobStep denominata 'Step1'.

Parametri

-AccessToken

Token di accesso usato per eseguire l'autenticazione a SQL Server, come alternativa all'autenticazione utente/password o windows.

Può essere usato, ad esempio, per connettersi a SQL Azure DB e SQL Azure Managed Instance usando un Service Principal oggetto o .Managed Identity

Il parametro da usare può essere una stringa che rappresenta il token o un PSAccessToken oggetto restituito eseguendo Get-AzAccessToken -ResourceUrl https://database.windows.net.

Questo parametro è nuovo nella versione 22 del modulo.

Proprietà dei parametri

Tipo:PSObject
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Encrypt

Tipo di crittografia da usare per la connessione a SQL Server.

Questo valore esegue il Encrypt mapping alla proprietà SqlConnectionEncryptOption nell'oggetto SqlConnection del driver Microsoft.Data.SqlClient.

Nella versione 22 del modulo, l'impostazione predefinita è Optional (per compatibilità con v21). Nella versione 23+ del modulo, il valore predefinito sarà "Obbligatorio", che potrebbe creare una modifica di rilievo per gli script esistenti.

Questo parametro è nuovo nella versione 22 del modulo.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Valori accettati:Mandatory, Optional, Strict
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HostNameInCertificate

Nome host da usare per la convalida del certificato TLS/SSL di SQL Server. È necessario passare questo parametro se l'istanza di SQL Server è abilitata per Forza crittografia e si vuole connettersi a un'istanza usando nome host/nome breve. Se questo parametro viene omesso, è necessario passare il nome di dominio completo (FQDN) a -ServerInstance per connettersi a un'istanza di SQL Server abilitata per Forza crittografia.

Questo parametro è nuovo nella versione 22 del modulo.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InputObject

Specifica l'oggetto processo dell'istanza di destinazione.

Proprietà dei parametri

Tipo:Job
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

ByObject
Posizione:2
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Name

Specifica il nome dell'oggetto JobStep che ottiene questo cmdlet.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:1
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Path

Specifica il percorso dell'oggetto processo in cui viene eseguita l'operazione da questo cmdlet. Se non si specifica un valore per questo parametro, il cmdlet usa la posizione di lavoro corrente.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

ByPath
Posizione:2
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-TrustServerCertificate

Indica se il canale verrà crittografato durante il bypass della catena di certificati per convalidare l'attendibilità.

Nella versione 22 del modulo, l'impostazione predefinita è $true (per compatibilità con v21). Nella versione 23+ del modulo, il valore predefinito sarà "$false", che potrebbe creare una modifica di rilievo per gli script esistenti.

Questo parametro è nuovo nella versione 22 del modulo.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

Microsoft.SqlServer.Management.Smo.Agent.Job

Output

System.Object