MonitoringConnector.GetMonitoringAlertsForTiers Method

Definition

Gets alerts marked for the monitoring connector from the current Management Group as well as from any additional tiers that are configured for this connector.

Overloads

GetMonitoringAlertsForTiers(DateTime, Int32, IList<ConnectorTieredOperationFailure>)

Gets all the alerts that would be pending for the given connector, given the bookmark, on each tier.

GetMonitoringAlertsForTiers(Int32, IList<ConnectorTieredOperationFailure>)

Gets all the alerts that are currently pending for this connector, on each tier.

GetMonitoringAlertsForTiers(IList<ConnectorTieredOperationFailure>)

Gets all the alerts that are currently pending for this connector, on each tier.

GetMonitoringAlertsForTiers(DateTime, IList<ConnectorTieredOperationFailure>)

Gets all the alerts that would be pending for the given connector, given the bookmark, on each tier.

Remarks

To get a MonitoringAlert collection through a MonitoringConnector:

  • The monitoring connector must be set up.

  • The monitoring connector must be initialized.

  • Alerts must be present.

  • Alerts must be marked for the monitoring connector.

GetMonitoringAlertsForTiers(DateTime, Int32, IList<ConnectorTieredOperationFailure>)

Gets all the alerts that would be pending for the given connector, given the bookmark, on each tier.

public:
 System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorMonitoringAlert ^> ^ GetMonitoringAlertsForTiers(DateTime utcBookmarkTime, int batchSize, [Runtime::InteropServices::Out] System::Collections::Generic::IList<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorTieredOperationFailure ^> ^ % failures);
public System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert> GetMonitoringAlertsForTiers (DateTime utcBookmarkTime, int batchSize, out System.Collections.Generic.IList<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorTieredOperationFailure> failures);
member this.GetMonitoringAlertsForTiers : DateTime * int * IList -> System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert>
Public Function GetMonitoringAlertsForTiers (utcBookmarkTime As DateTime, batchSize As Integer, ByRef failures As IList(Of ConnectorTieredOperationFailure)) As ReadOnlyCollection(Of ConnectorMonitoringAlert)

Parameters

utcBookmarkTime
DateTime

The utc bookmark.

batchSize
Int32

The approximate max batch size to return (total).

failures
IList<ConnectorTieredOperationFailure>

A list of failures that occured.

Returns

ReadOnlyCollection<ConnectorMonitoringAlert>

The alerts with the given bookmark applied.

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.

This method only gets alerts that are marked for the monitoring connector from the bookmark time to the current time less 30 seconds.

Applies to

GetMonitoringAlertsForTiers(Int32, IList<ConnectorTieredOperationFailure>)

Gets all the alerts that are currently pending for this connector, on each tier.

public:
 System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorMonitoringAlert ^> ^ GetMonitoringAlertsForTiers(int batchSize, [Runtime::InteropServices::Out] System::Collections::Generic::IList<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorTieredOperationFailure ^> ^ % failures);
public System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert> GetMonitoringAlertsForTiers (int batchSize, out System.Collections.Generic.IList<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorTieredOperationFailure> failures);
member this.GetMonitoringAlertsForTiers : int * IList -> System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert>
Public Function GetMonitoringAlertsForTiers (batchSize As Integer, ByRef failures As IList(Of ConnectorTieredOperationFailure)) As ReadOnlyCollection(Of ConnectorMonitoringAlert)

Parameters

batchSize
Int32

The approximate max batch size to return (total).

failures
IList<ConnectorTieredOperationFailure>

A list of failures that occured.

Returns

ReadOnlyCollection<ConnectorMonitoringAlert>

The alerts currently pending for this connector.

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.

This method only gets alerts that are marked for the monitoring connector from the bookmark time to the current time less 30 seconds.

Applies to

GetMonitoringAlertsForTiers(IList<ConnectorTieredOperationFailure>)

Gets all the alerts that are currently pending for this connector, on each tier.

public:
 System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorMonitoringAlert ^> ^ GetMonitoringAlertsForTiers([Runtime::InteropServices::Out] System::Collections::Generic::IList<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorTieredOperationFailure ^> ^ % failures);
public System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert> GetMonitoringAlertsForTiers (out System.Collections.Generic.IList<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorTieredOperationFailure> failures);
member this.GetMonitoringAlertsForTiers : IList -> System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert>
Public Function GetMonitoringAlertsForTiers (ByRef failures As IList(Of ConnectorTieredOperationFailure)) As ReadOnlyCollection(Of ConnectorMonitoringAlert)

Parameters

failures
IList<ConnectorTieredOperationFailure>

A list of failures that occured.

Returns

ReadOnlyCollection<ConnectorMonitoringAlert>

The alerts currently pending for this connector.

Remarks

This method only gets alerts that are marked for the monitoring connector from the bookmark time to the current time less 30 seconds.

Applies to

GetMonitoringAlertsForTiers(DateTime, IList<ConnectorTieredOperationFailure>)

Gets all the alerts that would be pending for the given connector, given the bookmark, on each tier.

public:
 System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorMonitoringAlert ^> ^ GetMonitoringAlertsForTiers(DateTime utcBookmarkTime, [Runtime::InteropServices::Out] System::Collections::Generic::IList<Microsoft::EnterpriseManagement::ConnectorFramework::ConnectorTieredOperationFailure ^> ^ % failures);
public System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert> GetMonitoringAlertsForTiers (DateTime utcBookmarkTime, out System.Collections.Generic.IList<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorTieredOperationFailure> failures);
member this.GetMonitoringAlertsForTiers : DateTime * IList -> System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.EnterpriseManagement.ConnectorFramework.ConnectorMonitoringAlert>
Public Function GetMonitoringAlertsForTiers (utcBookmarkTime As DateTime, ByRef failures As IList(Of ConnectorTieredOperationFailure)) As ReadOnlyCollection(Of ConnectorMonitoringAlert)

Parameters

utcBookmarkTime
DateTime

The utc bookmark.

failures
IList<ConnectorTieredOperationFailure>

A list of failures that occured.

Returns

ReadOnlyCollection<ConnectorMonitoringAlert>

The alerts with the given bookmark applied.

Remarks

This method only gets alerts that are marked for the monitoring connector from the utcBookmarkTime bookmark time to the current time less 30 seconds.

Applies to