Get-SqlAgentJobStep

  • Referencia
Módulo:
SQLServer

Obtiene un objeto JobStep de SQL para cada paso que está presente en la instancia de destino del trabajo del Agente SQL.

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

El cmdlet Get-SqlAgentJobStep obtiene un objeto JobStep de SQL para cada paso que está presente en la instancia de destino del trabajo del Agente SQL. Si proporciona el nombre del paso de trabajo, el cmdlet obtiene solo este objeto JobStep específico.

Este cmdlet admite los siguientes modos de operación para devolver una colección de objetos JobStep:

  • Pase la instancia del trabajo del Agente SQL en la entrada.
  • Especifique el parámetro Path de la instancia de Trabajo.
  • Invoque el cmdlet en un contexto válido.

Ejemplos

Ejemplo 1: Obtención de todas las instancias de JobStep en las instancias de trabajo

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

Este comando usa el cmdlet Get-SqlAgent para obtener la instancia de servidor denominada "MyServerInstance" y, a continuación, pasa el resultado mediante la canalización al cmdlet Get-SqlAgentJob . A continuación, el comando pasa el resultado mediante la canalización al cmdlet Get-SqlAgentJobStep para obtener todas las instancias de JobStep.

Ejemplo 2: Obtener una instancia de JobStep por nombre

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

Este comando usa el cmdlet Get-SqlAgent para obtener la instancia de servidor denominada "MyServerInstance" y, a continuación, pasa el resultado mediante la canalización al cmdlet Get-SqlAgentJob . A continuación, el comando pasa el resultado mediante la canalización al cmdlet Get-SqlAgentJobStep para obtener la instancia de JobStep denominada "Step1".

Parámetros

-AccessToken

Token de acceso que se usa para autenticarse en SQL Server, como alternativa a la autenticación de usuario o contraseña de Windows.

Esto se puede usar, por ejemplo, para conectarse a SQL Azure DB y SQL Azure Managed Instance usar o Service Principal .Managed Identity

El parámetro que se va a usar puede ser una cadena que representa el token o un PSAccessToken objeto tal y como se devuelve mediante la ejecución Get-AzAccessToken -ResourceUrl https://database.windows.netde .

Este parámetro es nuevo en la versión 22 del módulo.

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

-Encrypt

Tipo de cifrado que se va a usar al conectarse a SQL Server.

Este valor se asigna a la Encrypt propiedad SqlConnectionEncryptOption del objeto SqlConnection del controlador Microsoft.Data.SqlClient.

En la versión 22 del módulo, el valor predeterminado es Optional (por compatibilidad con v21). En la versión 23+ del módulo, el valor predeterminado será "Obligatorio", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del 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

Nombre de host que se va a usar al validar el certificado TLS/SSL de SQL Server. Debe pasar este parámetro si la instancia de SQL Server está habilitada para Forzar cifrado y desea conectarse a una instancia mediante el nombre de host o el nombre corto. Si se omite este parámetro, es necesario pasar el nombre de dominio completo (FQDN) a -ServerInstance para conectarse a una instancia de SQL Server habilitada para forzar el cifrado.

Este parámetro es nuevo en la versión 22 del módulo.

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

-InputObject

Especifica el objeto de trabajo de la instancia de destino.

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

-Name

Especifica el nombre del objeto JobStep que obtiene este cmdlet.

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

-Path

Especifica la ruta de acceso al objeto de trabajo en el que este cmdlet ejecuta la operación. Si no especifica un valor para este parámetro, el cmdlet usa la ubicación de trabajo actual.

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

-TrustServerCertificate

Indica si el canal se cifrará al pasar la cadena de certificados para validar la confianza.

En la versión 22 del módulo, el valor predeterminado es $true (por compatibilidad con v21). En la versión 23 y posteriores del módulo, el valor predeterminado será "$false", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del 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

Salidas

System.Object