Jaa

Get-SqlAgentJobSchedule

  • Reference
Module:
SQLServer

Gets a job schedule object for each schedule that is present in the target instance of SQL Agent Job.

Syntax

Get-SqlAgentJobSchedule
   [[-Name] <String>]
   [[-Path] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-SqlAgentJobSchedule
   [[-Name] <String>]
   [-InputObject] <Job>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

The Get-SqlAgentJobSchedule cmdlet gets a SQL JobStepSchedule object for each step that is present in the target instance of SQL Agent Job. If the name of the job schedule is provided, the cmdlet gets only this specific JobSchedule object.

This cmdlet supports the following modes of operation to get a collection of JobSchedule objects:

  • Pass the instance of the SQL Agent Job in the input.
  • Specify the Path parameter of the Job instance.
  • Invoke the cmdlet in a valid context.

Examples

Example 1: Get all JobSchedule object instances in the specified server instance

PS C:\> Get-SqlAgent -ServerInstance "MyServerInstance" | Get-SqlAgentJob | Get-SqlAgentJobSchedule

Name                           Jobs  Enabled    DateCreated               ActiveStartDate           ActiveEndDate             ID
----                           ----  -------    -----------               ---------------           -------------             --
Schedule1                      1     False      6/2/2016 10:21:44 AM      6/14/2016 12:00:00 AM     12/31/9999 12:00:00 AM    10
Schedule2                      1     True       6/9/2016 4:35:25 PM       6/9/2016 12:00:00 AM      12/31/9999 12:00:00 AM    58
Schedule3                      1     True       6/9/2016 4:35:25 PM       6/9/2016 12:00:00 AM      12/31/9999 12:00:00 AM    59

This command gets all JobSchedule object instances in the Job Instances passed by pipeline.

Example 2: Get a JobSchedule object instance in the specified server instance

PS C:\> Get-SqlAgentJob -ServerInstance "MyServer" | Get-SqlAgentJobSchedule -Name "Schedule1"

This command gets the JobSchedule object instance named 'Schedule1' from the Job instances passed by pipeline.

Parameters

-AccessToken

The access token used to authenticate to SQL Server, as an alternative to user/password or Windows Authentication.

This can be used, for example, to connect to SQL Azure DB and SQL Azure Managed Instance using a Service Principal or a Managed Identity.

The parameter to use can be either a string representing the token or a PSAccessToken object as returned by running Get-AzAccessToken -ResourceUrl https://database.windows.net.

This parameter is new in v22 of the module.

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

-Encrypt

The encryption type to use when connecting to SQL Server.

This value maps to the Encrypt property SqlConnectionEncryptOption on the SqlConnection object of the Microsoft.Data.SqlClient driver.

In v22 of the module, the default is Optional (for compatibility with v21). In v23+ of the module, the default value will be 'Mandatory', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

The host name to be used in validating the SQL Server TLS/SSL certificate. You must pass this parameter if your SQL Server instance is enabled for Force Encryption and you want to connect to an instance using hostname/shortname. If this parameter is omitted then passing the Fully Qualified Domain Name (FQDN) to -ServerInstance is necessary to connect to a SQL Server instance enabled for Force Encryption.

This parameter is new in v22 of the module.

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

-InputObject

Specifies the Job object of the target instance.

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

-Name

Specifies the name of the JobSchedule object that this cmdlet gets.

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

-Path

Specifies the path to the Job object on which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet uses the current working location.

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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustServerCertificate

Indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.

In v22 of the module, the default is $true (for compatibility with v21). In v23+ of the module, the default value will be '$false', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

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

Inputs

Microsoft.SqlServer.Management.Smo.Agent.Job

Outputs

System.Object