IConnectorFramework.GetMonitoringAlertsWithBatchSize(Guid, String, Int32) Method

Definition

Gets alerts for the given connector.

public:
 cli::array <Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorMonitoringAlert ^> ^ GetMonitoringAlertsWithBatchSize(Guid connectorId, System::String ^ languageCodes, int batchSize);
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.ObjectNotFoundException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.ServiceNotRunningException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownChannelException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnauthorizedAccessEnterpriseManagementException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownDatabaseException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.InvalidDatabaseDataException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.ConnectorInvalidException))]
[System.ServiceModel.FaultContract(typeof(System.ArgumentNullException))]
[System.ServiceModel.FaultContract(typeof(System.InvalidOperationException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownServiceException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.UnknownAuthorizationStoreException))]
[System.ServiceModel.FaultContract(typeof(System.TimeoutException))]
[System.ServiceModel.FaultContract(typeof(Microsoft.EnterpriseManagement.Common.ServerDisconnectedException))]
[System.ServiceModel.OperationContract]
public Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert[] GetMonitoringAlertsWithBatchSize (Guid connectorId, string languageCodes, int batchSize);
abstract member GetMonitoringAlertsWithBatchSize : Guid * string * int -> Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert[]
Public Function GetMonitoringAlertsWithBatchSize (connectorId As Guid, languageCodes As String, batchSize As Integer) As ConnectorMonitoringAlert()

Parameters

connectorId
Guid

The connector id.

languageCodes
String

A comma delimited list of three letter iso language standard language codes.

batchSize
Int32

The batch size.

Returns

ConnectorMonitoringAlert[]

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

Attributes

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.

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