Get-SqlAgentJobHistory

  • Ссылка
Модуль:
SQLServer

Возвращает журнал заданий, присутствующий в целевом экземпляре агента SQL.

Синтаксис

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>]

Описание

Командлет Get-SqlAgentJobHistory получает объект JobHistory, присутствующий в целевом экземпляре агента SQL.

Этот командлет поддерживает следующие режимы операций для получения объекта JobHistory:

  • Укажите путь к экземпляру агента SQL.
  • Передайте экземпляр агента SQL во входные данные.
  • Вызовите командлет в допустимом контексте.

Примеры

Пример 1. Получение всего журнала заданий из указанного экземпляра сервера

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

Эта команда получает весь журнал заданий в экземпляре сервера с именем MyServerInstance, а затем форматирует выходные данные.

Пример 2. Получение журнала заданий из указанного экземпляра сервера

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

Эта команда получает журнал заданий объекта задания с идентификатором "187112d7-84e1-4b66-b093-e97201c441ed" в экземпляре сервера с именем "MyServerInstance".

Пример 3. Получение журнала заданий за период времени из указанного экземпляра сервера

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).

Эта команда возвращает журнал заданий с днем ранее в экземпляре сервера с именем MyServerInstance.

Параметры

-AccessToken

Маркер доступа, используемый для проверки подлинности для SQL Server в качестве альтернативы проверке подлинности пользователя или пароля или проверки подлинности Windows.

Это можно использовать, например, для подключения к SQL Azure DB и SQL Azure Managed Instance с помощью Service Principal или Managed Identity.

Используемый параметр может быть строкой, представляющей маркер, или объектом, PSAccessToken возвращенным при выполнении .Get-AzAccessToken -ResourceUrl https://database.windows.net

Этот параметр является новым в версии 22 модуля.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTimeout

Указывает время ожидания подключения к серверу в секундах до сбоя времени ожидания. Значение времени ожидания должно быть целым числом от 0 до 65534. Если указано значение 0, попытки соединения не прекращаются.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Указывает объект PSCredential, используемый для указания учетных данных для имени входа SQL Server, имеющего разрешение на выполнение этой операции.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encrypt

Тип шифрования, используемый при подключении к SQL Server.

Это значение сопоставляется со свойством EncryptSqlConnectionEncryptOption объекта SqlConnection драйвера Microsoft.Data.SqlClient.

В версии 22 модуля по умолчанию используется Optional значение (для совместимости с версией 21). В версии 23+ модуля значением по умолчанию будет "Обязательно", что может привести к критическому изменению для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndRunDate

Задает ограничение фильтра задания, которое ограничивает возвращаемые значения датой завершения задания.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

Имя узла используется для проверки TLS/SSL-сертификата SQL Server. Этот параметр необходимо передать, если экземпляр SQL Server включен для принудительного шифрования и вы хотите подключиться к экземпляру с помощью hostname/shortname. Если этот параметр опущен, для подключения к экземпляру SQL Server, включенного для принудительного шифрования, необходимо передать полное доменное имя (FQDN) в параметр -ServerInstance.

Этот параметр является новым в версии 22 модуля.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Указывает массив объектов SQL Server Management Object (SMO), представляющих целевой агент SQL Server.

Type:JobServer[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-JobID

Задает ограничение фильтра задания, которое ограничивает возвращаемые значения заданием, заданным значением идентификатора задания.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobName

Задает ограничение фильтра задания, которое ограничивает возвращаемые значения заданием, указанным именем задания.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MinimumRetries

Задает ограничение фильтра заданий, которое ограничивает возвращаемые значения заданиями, которые завершились сбоем и повторялись в течение минимального количества раз.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MinimumRunDurationInSeconds

Задает ограничение фильтра заданий, которое ограничивает возвращаемые значения заданиями, выполненными в течение указанного минимального периода времени в секундах.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OldestFirst

Указывает, что этот командлет перечисляет задания в самом старом порядке. Если этот параметр не указан, командлет использует новый порядок.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutcomesType

Задает ограничение фильтра заданий, которое ограничивает возвращаемые значения заданиями, имеющими указанный результат по завершении.

Допустимые значения для этого параметра:

-- Failed -- Succeeded -- Retry -- Отменено -- 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

Указывает путь к агенту SQL Server в виде массива, на котором этот командлет выполняет операцию. Если значение этого параметра не указано, командлет использует текущее рабочее расположение.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Указывает имя экземпляра SQL Server в виде массива, в котором выполняется агент SQL. Для экземпляров по умолчанию укажите только имя компьютера: MyComputer. Для именованных экземпляров используйте формат ComputerName\InstanceName.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Since

Указывает аббревиатура, которую можно использовать вместо параметра StartRunDate.

Его можно указать с помощью параметра EndRunDate.

При использовании этого параметра нельзя использовать параметр StartRunDate.

Допустимые значения для этого параметра:

  • Полночь (получает все сведения журнала заданий, созданные после полуночи)
  • Вчера (получает все сведения журнала заданий, созданные за последние 24 часа)
  • LastWeek (получает все сведения журнала заданий, созданные за последнюю неделю)
  • LastMonth (получает все сведения журнала заданий, созданные за последний месяц)
Type:SinceType
Accepted values:Midnight, Yesterday, LastWeek, LastMonth
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlMessageID

Задает ограничение фильтра заданий, которое ограничивает возвращаемые значения заданиями, создающими указанное сообщение во время выполнения.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlSeverity

Задает ограничение фильтра задания, которое ограничивает возвращаемые значения заданиями, которые вызвали ошибку указанной серьезности во время выполнения.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StartRunDate

Задает ограничение фильтра задания, которое ограничивает возвращаемые значения датой запуска задания.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustServerCertificate

Указывает, будет ли канал зашифрован при обходе цепочки сертификатов для проверки доверия.

В версии 22 модуля по умолчанию используется $true значение (для совместимости с версией 21). В версии 23+ модуля значение по умолчанию будет "$false", что может привести к критическому изменению для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Входные данные

System.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer[]

Выходные данные

System.Object