MonitoringConnector.GetMonitoringAlertsForTiers Method (DateTime, Int32, IList<ConnectorTieredOperationFailure>)

Article
12/03/2015

Applies To: Operations Manager for System Center 2012

Gets alerts marked for the monitoring connector, for each tiered Management Group. You also specify a timestamp bookmark, and all alerts with a timestamp after the bookmark will be returned. The retrieved array is limited to the batchSize parameter. The failures that occurred for the configured tiers are returned along with the alerts.

Namespace: Microsoft.EnterpriseManagement.ConnectorFramework
Assembly: Microsoft.EnterpriseManagement.OperationsManager (in Microsoft.EnterpriseManagement.OperationsManager.dll)

Syntax

public ReadOnlyCollection<ConnectorMonitoringAlert> GetMonitoringAlertsForTiers(
    DateTime utcBookmarkTime,
    int batchSize,
    out IList<ConnectorTieredOperationFailure> failures
)

public:
ReadOnlyCollection<ConnectorMonitoringAlert^>^ GetMonitoringAlertsForTiers(
    DateTime utcBookmarkTime,
    int batchSize,
    [OutAttribute] IList<ConnectorTieredOperationFailure^>^% failures
)

member GetMonitoringAlertsForTiers : 
        utcBookmarkTime:DateTime *
        batchSize:int *
        failures:IList<ConnectorTieredOperationFailure> byref -> ReadOnlyCollection<ConnectorMonitoringAlert>

Public Function GetMonitoringAlertsForTiers (
    utcBookmarkTime As Date,
    batchSize As Integer,
    <OutAttribute> ByRef failures As IList(Of ConnectorTieredOperationFailure)
) As ReadOnlyCollection(Of ConnectorMonitoringAlert)

Parameters

utcBookmarkTime
Type: System.DateTime

A timestamp bookmark. All alerts with a timestamp after this will be acknowledged.

batchSize
Type: System.Int32

The approximate max batch size to return.

failures
Type: System.Collections.Generic.IList<ConnectorTieredOperationFailure>

The array of failures that may have occurred for various tiers

Return Value

Type: System.Collections.ObjectModel.ReadOnlyCollection<ConnectorMonitoringAlert>

Returns a ReadOnlyCollection<T> 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 GetMonitoringAlertsForTiers 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.