Get-SqlMonitorAnnotation
Published 14 February 2023
Gets the current annotation on a target at a specified time.
Syntax
Get-SqlMonitorAnnotation [[-Target] <MonitoredObject>] [[-UtcDate] <datetime>] [<CommonParameters>]
Description
The Get-SqlMonitorAnnotation cmdlet gets the current annotation on a target at a specified time.
Parameters
-Target
<MonitoredObject>
The SQL Server instance to retrieve an annotation for.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-UtcDate
<DateTime>
The time to look for the annotation.
| 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.
-
None.
You cannot pipe input to this cmdlet.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[Annotation] For more information, see https://documentation.red-gate.com/sm/api/annotations.
Examples
-------------------------- Example 1 --------------------------
PS C:\> {{ Add example code here }}
{{ Add example description here }}
