Assembly: Microsoft.EnterpriseManagement.OperationsManager (in microsoft.enterprisemanagement.operationsmanager.dll)
Usage
| Visual Basic |
|---|
Dim instance As MonitoringConnector Dim utcBookmarkTime As DateTime Dim batchSize As Integer Dim returnValue As ReadOnlyCollection(Of ConnectorMonitoringAlert) returnValue = instance.GetMonitoringAlerts(utcBookmarkTime, batchSize) |
Syntax
| Visual Basic |
|---|
Public Function GetMonitoringAlerts ( _ utcBookmarkTime As DateTime, _ batchSize As Integer _ ) As ReadOnlyCollection(Of ConnectorMonitoringAlert) |
| C# |
|---|
public ReadOnlyCollection<ConnectorMonitoringAlert> GetMonitoringAlerts ( DateTime utcBookmarkTime, int batchSize ) |
| C++ |
|---|
public: ReadOnlyCollection<ConnectorMonitoringAlert^>^ GetMonitoringAlerts ( DateTime utcBookmarkTime, int batchSize ) |
| J# |
|---|
public ReadOnlyCollection<ConnectorMonitoringAlert> GetMonitoringAlerts ( DateTime utcBookmarkTime, int batchSize ) |
| JScript |
|---|
public function GetMonitoringAlerts ( utcBookmarkTime : DateTime, batchSize : int ) : ReadOnlyCollection<ConnectorMonitoringAlert> |
Parameters
- utcBookmarkTime
-
A timestamp bookmark. All alerts with a timestamp after this will be acknowledged.
- batchSize
-
The approximate max batch size to return.
Return Value
An array of ConnectorMonitoringAlert objects that contain the alerts for the specified monitoring connector and have a bookmark time since the utcBookmarkTime value.Remarks
This method will only retrieve up to the number of alerts that are specified by the batchSize parameter. This limitation allows you to perform the get monitoring alerts operation in small batches, thereby avoiding a time-out failure.
This method only gets alerts that are marked for the monitoring connector from the bookmark time to the current time less 30 seconds.
It is good practice to limit the number of alerts obtained by a single call. When you perform this GetMonitoringAlerts method you should check to see if the count property of the returned collection equals or exceeds the batchSize. If the count property of the returned collection equals or exceeds the batchSize then you should acknowledge the alerts received, and call this function again to get the next batch of alerts. Only when the returned collection is smaller than the batchSize can you be sure that you have received all of the alerts.
After you retrieve the monitoring alert, you need to acknowledge that alert with an AcknowledgeMonitoringAlerts, or one of the overloaded methods. Failure to acknowledge an alert will result in subsequent calls to get new alerts returning the already received alerts.
This method only gets alerts that are marked for the monitoring connector from the bookmark time to the current time less 30 seconds.