Get-SqlAgentJobStep
Obtém um objeto JobStep do SQL para cada etapa presente na instância de destino do Trabalho do SQL Agent.
Syntax
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>]
Description
O cmdlet Get-SqlAgentJobStep obtém um objeto JobStep do SQL para cada etapa presente na instância de destino do Trabalho do SQL Agent. Se você fornecer o nome da etapa de trabalho, o cmdlet obterá apenas esse objeto JobStep específico.
Esse cmdlet dá suporte aos seguintes modos de operação para retornar uma coleção de objetos JobStep:
- Passe a instância do Trabalho do SQL Agent na entrada.
- Especifique o parâmetro Path da instância de Trabalho.
- Invoque o cmdlet em um contexto válido.
Exemplos
Exemplo 1: Obter todas as instâncias jobStep nas instâncias de trabalho
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
Esse comando usa o cmdlet Get-SqlAgent para obter a instância de servidor chamada 'MyServerInstance' e, em seguida, passa o resultado usando o pipeline para o cmdlet Get-SqlAgentJob . Em seguida, o comando passa o resultado usando o pipeline para o cmdlet Get-SqlAgentJobStep para obter todas as instâncias de JobStep.
Exemplo 2: Obter uma instância JobStep pelo 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
Esse comando usa o cmdlet Get-SqlAgent para obter a instância de servidor chamada 'MyServerInstance' e, em seguida, passa o resultado usando o pipeline para o cmdlet Get-SqlAgentJob . Em seguida, o comando passa o resultado usando o pipeline para o cmdlet Get-SqlAgentJobStep para obter a instância JobStep chamada 'Step1'.
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 |
-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 |
-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 o objeto de trabalho da instância de destino.
Type: | Job |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Especifica o nome do objeto JobStep que este cmdlet obtém.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Especifica o caminho para o objeto de trabalho no 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: | 2 |
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
Microsoft.SqlServer.Management.Smo.Agent.Job
Saídas
System.Object