Get-SqlAgentJob

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

Syntax

Get-SqlAgentJob
   [[-Name] <String>]
   [[-Path] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]
Get-SqlAgentJob
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [[-Name] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]
Get-SqlAgentJob
   [[-Name] <String>]
   [-InputObject] <JobServer>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]

Description

El cmdlet Get-SqlAgentJob obtiene un objeto Job del Agente SQL para cada trabajo presente en la instancia de destino del Agente SQL. Si se proporciona el nombre del trabajo, el cmdlet obtiene solo este objeto de trabajo específico.

Este cmdlet admite los siguientes modos de operación para obtener una colección de objetos Job:

  • Especifique la ruta de acceso de la instancia del Agente SQL.
  • Pase la instancia del Agente SQL en la entrada.
  • Invoque el cmdlet en un contexto válido.

Ejemplos

Ejemplo 1: Obtener todas las instancias de trabajo de la instancia de servidor especificada

PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob
Name                      Owner                Category                  Enabled    CurrentRunStatus     DateCreated               LastModified              JobID
----                      -----                --------                  -------    ----------------     -----------               ------------              -----
MyJob1                    Owner                [Uncategorized (Local)]   True       Idle                 6/2/2016 10:21:44 AM      6/2/2016 10:21:44 AM      841255df-06e8-43ef-b798-3... 
MyJob2                    Owner                [Uncategorized (Local)]   True       Idle                 5/31/2016 2:40:58 PM      6/1/2016 5:09:40 PM       995b296a-cd35-4505-868a-3... 
MyJob3                    Owner                [Uncategorized (Local)]   True       Idle                 5/25/2016 12:13:56 PM     5/25/2016 12:13:56 PM     01d2e61a-9a90-4f77-98f4-e...

Este comando obtiene todas las instancias de trabajo de la instancia del servidor denominada "MyServerInstance".

Ejemplo 2: Obtener una instancia de trabajo por nombre de la instancia de servidor especificada

PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob -Name MyJob1
Name                      Owner                Category                  Enabled    CurrentRunStatus     DateCreated               LastModified              JobID
----                      -----                --------                  -------    ----------------     -----------               ------------              -----
MyJob1                    Owner                [Uncategorized (Local)]   True       Idle                 6/2/2016 10:21:44 AM      6/2/2016 10:21:44 AM      841255df-06e8-43ef-b798-3...

Este comando obtiene la instancia de trabajo denominada "MyJob1" en la instancia del servidor denominada "MyServerInstance".

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

-ConnectionTimeout

Especifica el número de segundos que se deben esperar a una conexión de servidor antes de un error de tiempo de espera. El valor de tiempo de espera debe ser un valor entero entre 0 y 65534. Si se especifica 0, los intentos de conexión no tienen tiempo de espera.

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

-Credential

Especifica un objeto PSCredential que se usa para especificar las credenciales de un inicio de sesión de SQL Server que tiene permiso para realizar esta operación.

Type:PSCredential
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 un objeto de objetos de administración de SQL (SMO) que representa el Agente SQL Server de destino.

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

-Name

Especifica el nombre del objeto Job que obtiene este cmdlet. El nombre puede o no distinguir mayúsculas de minúsculas, en función de la intercalación del SQL Server donde se ejecuta el Agente SQL.

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

-Path

Especifica la ruta de acceso al agente de SQL Server en la 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

-ServerInstance

Especifica, como matriz de cadenas, el nombre de una instancia de SQL Server en la que se ejecuta el Agente SQL. Para las instancias predeterminadas, especifique solo el nombre del equipo: MyComputer. Para las instancias con nombre, use el formato NombreDeEquipo\NombreDeInstancia.

Type:String[]
Position:2
Default value:None
Required:False
Accept pipeline input:True
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

Salidas

System.Object