ConnectorFrameworkProxy.GetMonitoringAlertsWithBookmarkWithBatchSize(Guid, DateTime, Int32) Method

Definition

Gets alerts for the given connector.

public:
 cli::array <Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorMonitoringAlert ^> ^ GetMonitoringAlertsWithBookmarkWithBatchSize(Guid connectorId, DateTime utcBookmarkTime, int batchSize);
public Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert[] GetMonitoringAlertsWithBookmarkWithBatchSize (Guid connectorId, DateTime utcBookmarkTime, int batchSize);
member this.GetMonitoringAlertsWithBookmarkWithBatchSize : Guid * DateTime * int -> Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert[]
Public Function GetMonitoringAlertsWithBookmarkWithBatchSize (connectorId As Guid, utcBookmarkTime As DateTime, batchSize As Integer) As ConnectorMonitoringAlert()

Parameters

connectorId
Guid

The connector id.

utcBookmarkTime
DateTime

The bookmark time to get alerts by.

batchSize
Int32

The batch size.

Returns

ConnectorMonitoringAlert[]

The alerts that have changed since the current bookmark of the 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.

Applies to