ConnectorFrameworkProxy.GetMonitoringAlertsWithBatchSizeForTiers(Guid, Int32, ConnectorTieredOperationFailure[]) Method

Definition

Gets alerts for the given connector.

public:
 cli::array <Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorMonitoringAlert ^> ^ GetMonitoringAlertsWithBatchSizeForTiers(Guid connectorId, int batchSize, [Runtime::InteropServices::Out] cli::array <Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorTieredOperationFailure ^> ^ % failures);
public Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert[] GetMonitoringAlertsWithBatchSizeForTiers (Guid connectorId, int batchSize, out Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorTieredOperationFailure[] failures);
member this.GetMonitoringAlertsWithBatchSizeForTiers : Guid * int * ConnectorTieredOperationFailure[] -> Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert[]
Public Function GetMonitoringAlertsWithBatchSizeForTiers (connectorId As Guid, batchSize As Integer, ByRef failures As ConnectorTieredOperationFailure()) As ConnectorMonitoringAlert()

Parameters

connectorId
Guid

The connector id.

batchSize
Int32

The approximate maximum batch size to return.

failures
ConnectorTieredOperationFailure[]

Any failures that occurred for various tiers.

Returns

ConnectorMonitoringAlert[]

The alerts that have changed since the current bookmark of the connector.

Remarks

The batchSize limitation allows you to perform the get monitoring alerts operation in small batches, thereby avoiding a timeout failure. The batchSize is the total across all tiers, not per tier.

It is good practice to limit the number of alerts obtained by a single call. When you perform this GetMonitoringAlertsWithBatchSizeForTiers 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 less 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 AcknowledgeMonitoringAlertsForTiers. Failure to acknowledge an alert will result in subsequent calls to get new alerts returning the already received alerts.

Applies to