Поделиться через

Get-SqlAgentJobStep

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

Возвращает объект Sql JobStep для каждого шага, который присутствует в целевом экземпляре задания агента SQL.

Синтаксис

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

Описание

Командлет Get-SqlAgentJobStep получает объект Sql JobStep для каждого шага, присутствующего в целевом экземпляре задания агента SQL. Если указать имя шага задания, командлет получает только этот конкретный объект JobStep.

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

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

Примеры

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

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

Эта команда использует командлет Get-SqlAgent для получения экземпляра сервера с именем MyServerInstance, а затем передает результат с помощью конвейера командлету Get-SqlAgentJob . Затем команда передает результат с помощью конвейера командлету Get-SqlAgentJobStep , чтобы получить все экземпляры JobStep.

Пример 2. Получение экземпляра JobStep по имени

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

Эта команда использует командлет Get-SqlAgent для получения экземпляра сервера с именем MyServerInstance, а затем передает результат с помощью конвейера командлету Get-SqlAgentJob . Затем команда передает результат с помощью конвейера командлету Get-SqlAgentJobStep , чтобы получить экземпляр JobStep с именем Step1.

Параметры

-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

-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

-HostNameInCertificate

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

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

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

-InputObject

Указывает объект задания целевого экземпляра.

Type:Job
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Указывает имя объекта JobStep, который получает этот командлет.

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

-Path

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

Type:String
Position:2
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

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

Microsoft.SqlServer.Management.Smo.Agent.Job

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

System.Object