Get-SqlAgentJobStep
Obtém um objeto JobStep do SQL para cada etapa que está presente na instância de destino do Trabalho do SQL Agent.
Sintaxe
ByPath (Padrão)
Get-SqlAgentJobStep
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
ByObject
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 este 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 do 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 do 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 do 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 do 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 do JobStep chamada 'Step1'.
Parâmetros
-AccessToken
O token de acesso usado para autenticar no SQL Server, como uma alternativa ao usuário/senha ou à Autenticação do Windows.
Isso pode ser usado, por exemplo, para se conectar SQL Azure DB e 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.
Propriedades do parâmetro
| Tipo: | PSObject |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Encrypt
O tipo de criptografia a ser usado ao se conectar ao 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 significativa para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Valores aceitos: | Mandatory, Optional, Strict |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 do SQL Server estiver habilitada para o Force Encryption e quiser se conectar a uma instância usando nome de host/nome curto. Se esse parâmetro for omitido, passar o FQDN (Nome de Domínio Totalmente Qualificado) para -ServerInstance será necessário para se conectar a uma instância do SQL Server habilitada para o Force Encryption.
Esse parâmetro é novo na v22 do módulo.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-InputObject
Especifica o objeto de trabalho da instância de destino.
Propriedades do parâmetro
| Tipo: | Job |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByObject
| Cargo: | 2 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Name
Especifica o nome do objeto JobStep que este cmdlet obtém.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByPath
| Cargo: | 2 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-TrustServerCertificate
Indica se o canal será criptografado ao ignorar a 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 significativa para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.