Get-RedgateMonitorJob
Published 18 April 2024
Gets the details of all of the Jobs for the given SQL Server Instance.
Syntax
Get-RedgateMonitorJob [[-Instance] <Instance>] [[-Name] <string>] [<CommonParameters>]
Description
The Get-RedgateMonitorElasticPool cmdlet gets details of Jobs from a Redgate Monitor Server.
Without parameters, this cmdlet gets details of all Jobs.
Connect-RedgateMonitor must be called before this cmdlet.
Parameters
-Instance
<Instance>
The Instance to limit results to. For more information, see https://documentation.red-gate.com/monitor14/api/powershell-api/powershell-cmdlet-reference/get-redgatemonitorinstance.
Aliases | None |
Required? | false |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
Accept Wildcard Characters | false |
-Name
<String>
The Job name to match.
Aliases | None |
Required? | false |
Position? | 2 |
Default Value | None |
Accept Pipeline Input | False |
Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
Aliases | None |
Required? | false |
Position? | named |
Default Value | None |
Accept Pipeline Input | False |
Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
[Instance] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-Instance.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[Job] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-Job.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-RedgateMonitorJob
-------------------------- EXAMPLE 2 --------------------------
Get-RedgateMonitorJob -Instance $instance
-------------------------- EXAMPLE 3 --------------------------
Get-RedgateMonitorJob -Name "ExampleJobName"
-------------------------- EXAMPLE 4 --------------------------
Get-RedgateMonitorJob -Instance $instance -Name "ExampleJobName"