Get-SqlAgentJobHistory
Obtém o histórico de trabalhos presente na instância de destino do SQL Agent.
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>]
Description
O cmdlet Get-SqlAgentJobHistory obtém o objeto JobHistory presente na instância de destino do SQL Agent.
Esse cmdlet dá suporte aos seguintes modos de operação para obter o objeto JobHistory:
- Especifique o caminho da instância do SQL Agent.
- Passe a instância do SQL Agent na entrada.
- Invoque o cmdlet em um contexto válido.
Exemplos
Exemplo 1: Obter todo o histórico de trabalhos da instância de servidor especificada
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
Esse comando obtém todo o histórico de trabalhos na instância de servidor chamada MyServerInstance e formata a saída.
Exemplo 2: Obter o histórico de trabalhos da instância de servidor especificada
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
Esse comando obtém o histórico de trabalhos do objeto de trabalho com a ID '187112d7-84e1-4b66-b093-e97201c441ed' na instância de servidor chamada 'MyServerInstance'.
Exemplo 3: Obter o histórico de trabalho de uma duração de tempo da instância de servidor especificada
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).
Esse comando retorna o histórico de trabalhos desde o dia anterior na instância de servidor chamada 'MyServerInstance'.
Parâmetros
-AccessToken
O token de acesso usado para autenticar em SQL Server, como uma alternativa ao usuário/senha ou à Autenticação do Windows.
Isso pode ser usado, por exemplo, para se conectar e SQL Azure DB
SQL Azure Managed Instance
usar um Service Principal
ou um Managed Identity
.
O parâmetro a ser usado pode ser uma cadeia de caracteres que representa o token ou um PSAccessToken
objeto conforme retornado executando Get-AzAccessToken -ResourceUrl https://database.windows.net
.
Esse parâmetro é novo na v22 do módulo.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionTimeout
Especifica o número de segundos a aguardar uma conexão de servidor antes de uma falha de tempo limite. O valor de tempo limite deve ser um valor inteiro entre 0 e 65534. Se 0 for especificado, as tentativas de conexão não atingirão o tempo limite.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
Especifica um objeto PSCredential que é usado para especificar as credenciais de um logon SQL Server que tenha permissão para executar essa operação.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Encrypt
O tipo de criptografia a ser usado ao se conectar a SQL Server.
Esse valor é mapeado para a Encrypt
propriedade SqlConnectionEncryptOption
no objeto SqlConnection do driver Microsoft.Data.SqlClient.
Na v22 do módulo, o padrão é Optional
(para compatibilidade com v21). Na v23+ do módulo, o valor padrão será 'Obrigatório', o que pode criar uma alteração interruptiva para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Type: | String |
Accepted values: | Mandatory, Optional, Strict |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EndRunDate
Especifica uma restrição de filtro de trabalho que restringe os valores retornados à data em que o trabalho foi concluído.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostNameInCertificate
O nome do host a ser usado na validação do certificado TLS/SSL do SQL Server. Você deve passar esse parâmetro se a instância de SQL Server estiver habilitada para Forçar Criptografia e quiser se conectar a uma instância usando nome do host/nome curto. Se esse parâmetro for omitido, será necessário passar o FQDN (Nome de Domínio Totalmente Qualificado) para -ServerInstance para se conectar a uma instância de SQL Server habilitada para Forçar Criptografia.
Esse parâmetro é novo na v22 do módulo.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Especifica uma matriz de objetos SMO (SQL Server Management Object) que representam o SQL Server Agent sendo direcionado.
Type: | JobServer[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-JobID
Especifica uma restrição de filtro de trabalho que restringe os valores retornados ao trabalho especificado pelo valor da ID do trabalho.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JobName
Especifica uma restrição de filtro de trabalho que restringe os valores retornados ao trabalho especificado pelo nome do trabalho.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MinimumRetries
Especifica a restrição de filtro de trabalho que restringe os valores retornados a trabalhos que falharam e foram repetidos pelo número mínimo de vezes.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MinimumRunDurationInSeconds
Especifica uma restrição de filtro de trabalho que restringe os valores retornados aos trabalhos que foram concluídos no período mínimo de tempo especificado, em segundos.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OldestFirst
Indica que esse cmdlet lista trabalhos na ordem mais antiga. Se você não especificar esse parâmetro, o cmdlet usará a ordem mais recente.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OutcomesType
Especifica uma restrição de filtro de trabalho que restringe os valores retornados aos trabalhos que têm o resultado especificado na conclusão.
Os valores aceitáveis para esse parâmetro são:
-- 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
Especifica o caminho para o Agente de SQL Server, como uma matriz, na qual esse cmdlet executa a operação. Se você não especificar um valor para esse parâmetro, o cmdlet usará o local de trabalho atual.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServerInstance
Especifica o nome de uma instância de SQL Server, como uma matriz, em que o SQL Agent é executado. Para instâncias padrão, especifique apenas o nome do computador: MyComputer. Para instâncias nomeadas, use o formato ComputerName\InstanceName.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Since
Especifica uma abreviação que você pode em vez do parâmetro StartRunDate.
Ele pode ser especificado com o parâmetro EndRunDate.
Você não poderá usar o parâmetro StartRunDate se usar esse parâmetro.
Os valores aceitáveis para esse parâmetro são:
- Meia-noite (obtém todas as informações do histórico de trabalhos geradas após a meia-noite)
- Ontem (obtém todas as informações do histórico de trabalhos geradas nas últimas 24 horas)
- LastWeek (obtém todas as informações de histórico de trabalho geradas na última semana)
- LastMonth (obtém todas as informações de histórico de trabalho geradas no último mês)
Type: | SinceType |
Accepted values: | Midnight, Yesterday, LastWeek, LastMonth |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SqlMessageID
Especifica uma restrição de filtro de trabalho que restringe os valores retornados aos trabalhos que geraram a mensagem especificada durante o runtime.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SqlSeverity
Especifica uma restrição de filtro de trabalho que restringe os valores retornados aos trabalhos que geraram um erro da gravidade especificada durante o runtime.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StartRunDate
Especifica uma restrição de filtro de trabalho que restringe os valores retornados à data em que o trabalho foi iniciado.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrustServerCertificate
Indica se o canal será criptografado ao ignorar a movimentação da cadeia de certificados para validar a confiança.
Na v22 do módulo, o padrão é $true
(para compatibilidade com v21). Na v23+ do módulo, o valor padrão será "$false", o que pode criar uma alteração interruptiva para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entradas
System.String[]
Microsoft.SqlServer.Management.Smo.Agent.JobServer[]
Saídas
System.Object