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>]
   [-ProgressAction <ActionPreference>]
   [<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>]
   [-ProgressAction <ActionPreference>]
   [<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>]
   [-ProgressAction <ActionPreference>]
   [<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 модуля.

Тип:	PSObject
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ConnectionTimeout

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

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Credential

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

Тип:	PSCredential
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Encrypt

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

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

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

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

Тип:	String
Допустимые значения:	Mandatory, Optional, Strict
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-EndRunDate

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

Тип:	DateTime
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-HostNameInCertificate

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

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

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-InputObject

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

Тип:	JobServer[]
Position:	1
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-JobID

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

Тип:	Guid
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-JobName

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

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-MinimumRetries

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

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-MinimumRunDurationInSeconds

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

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-OldestFirst

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-OutcomesType

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

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

-- Сбой - Выполнено успешно - Повторная попытка - Отменено - InProgress - Неизвестно

Тип:	CompletionResult
Допустимые значения:	Failed, Succeeded, Retry, Cancelled, InProgress, Unknown
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Path

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

Тип:	String[]
Position:	1
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ProgressAction

Определяет, как PowerShell реагирует на обновления хода выполнения, созданные скриптом, командлетом или поставщиком, например индикаторами хода выполнения, созданными командлетом Write-Progress. Командлет Write-Progress создает индикаторы хода выполнения, показывающие состояние команды.

Тип:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ServerInstance

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

Тип:	String[]
Position:	1
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Since

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

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

Если этот параметр используется, нельзя использовать параметр StartRunDate.

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

• Полночь (получает все сведения журнала заданий, созданные после полуночи)
• Вчера (получает все сведения журнала заданий, созданные за последние 24 часа)
• LastWeek (получает все сведения журнала заданий, созданные на прошлой неделе)
• LastMonth (получает все сведения журнала заданий, созданные в прошлом месяце)

Тип:	SinceType
Допустимые значения:	Midnight, Yesterday, LastWeek, LastMonth
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SqlMessageID

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

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SqlSeverity

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

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-StartRunDate

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

Тип:	DateTime
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-TrustServerCertificate

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

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

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

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

System.String[]

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

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

System.Object

Связанные ссылки

• Get-SqlAgent
• Get-SqlAgentJob
• Get-SqlAgentJobSchedule
• Get-SqlAgentJobStep