ConnectorFrameworkProxy.GetMonitoringAlertsWithBookmarkWithBatchSize Method

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Gets alerts for the specified monitoring connector. You also specify a timestamp bookmark, and all alerts with a timestamp after the bookmark will be returned.

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

Usage

'Usage
Dim instance As ConnectorFrameworkProxy
Dim connectorId As Guid
Dim utcBookmarkTime As DateTime
Dim batchSize As Integer
Dim returnValue As ConnectorMonitoringAlert()

returnValue = instance.GetMonitoringAlertsWithBookmarkWithBatchSize(connectorId, utcBookmarkTime, batchSize)

Syntax

'Declaration
Public Function GetMonitoringAlertsWithBookmarkWithBatchSize ( _
    connectorId As Guid, _
    utcBookmarkTime As DateTime, _
    batchSize As Integer _
) As ConnectorMonitoringAlert()

public ConnectorMonitoringAlert[] GetMonitoringAlertsWithBookmarkWithBatchSize (
    Guid connectorId,
    DateTime utcBookmarkTime,
    int batchSize
)

public:
array<ConnectorMonitoringAlert^>^ GetMonitoringAlertsWithBookmarkWithBatchSize (
    Guid connectorId, 
    DateTime utcBookmarkTime, 
    int batchSize
)

public ConnectorMonitoringAlert[] GetMonitoringAlertsWithBookmarkWithBatchSize (
    Guid connectorId, 
    DateTime utcBookmarkTime, 
    int batchSize
)

public function GetMonitoringAlertsWithBookmarkWithBatchSize (
    connectorId : Guid, 
    utcBookmarkTime : DateTime, 
    batchSize : int
) : ConnectorMonitoringAlert[]

Parameters

• connectorId
  The globally unique identifier (GUID) for the monitoring connector to get alerts for.

• utcBookmarkTime
  A timestamp bookmark. All alerts with a timestamp prior to this will be returned.

• batchSize
  The approximate maximum batch size to return.

Return Value

Returns an Array of ConnectorMonitoringAlert objects, limited by the batchSize parameter, that contain the alerts for the specified monitoring connector.

Remarks

This method gets all alerts assigned to a specific monitoring connector after the specified bookmark date and time.

The batchSize limitation allows you to perform the get monitoring alerts operation in small batches, thereby avoiding a timeout failure.

It is good practice to limit the number of alerts obtained by a single call. When you perform this GetMonitoringAlertsWithBookmarkWithBatchSize 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.

This method gets alerts only from the bookmark date to the current time less 30 seconds.

After you get the monitoring alert, you need to acknowledge that alert with an AcknowledgeMonitoringAlerts. Failure to acknowledge an alert will result in subsequent calls to get new alerts returning the already received alerts.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows Server 2003, and

Target Platforms

See Also

Reference

ConnectorFrameworkProxy Class
ConnectorFrameworkProxy Members
Microsoft.EnterpriseManagement.ConnectorFramework Namespace