Share via

IConnectorFramework.GetMonitoringAlertsWithBatchSizeForTiers Method

  • Article

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

Gets alerts marked for the monitoring connector for all configured management tiers. The returned array is limited to the batchSize parameter. The failures that occurred for the configured tiers are returned.

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

Usage

'Usage
Dim instance As IConnectorFramework
Dim connectorId As Guid
Dim languageCodes As String
Dim batchSize As Integer
Dim failures As ConnectorTieredOperationFailure()
Dim returnValue As ConnectorMonitoringAlert()

returnValue = instance.GetMonitoringAlertsWithBatchSizeForTiers(connectorId, languageCodes, batchSize, failures)

Syntax

'Declaration
<FaultContractAttribute(GetType(ArgumentNullException))> _
<FaultContractAttribute(GetType(UnknownChannelException))> _
<FaultContractAttribute(GetType(ObjectNotFoundException))> _
<FaultContractAttribute(GetType(UnknownAuthorizationStoreException))> _
<FaultContractAttribute(GetType(UnknownDatabaseException))> _
<FaultContractAttribute(GetType(InvalidDatabaseDataException))> _
<FaultContractAttribute(GetType(ConnectorInvalidException))> _
<OperationContractAttribute> _
<FaultContractAttribute(GetType(InvalidOperationException))> _
<FaultContractAttribute(GetType(UnauthorizedAccessEnterpriseManagementException))> _
<FaultContractAttribute(GetType(TimeoutException))> _
<FaultContractAttribute(GetType(ServerDisconnectedException))> _
<FaultContractAttribute(GetType(ServiceNotRunningException))> _
<FaultContractAttribute(GetType(UnknownServiceException))> _
Function GetMonitoringAlertsWithBatchSizeForTiers ( _
    connectorId As Guid, _
    languageCodes As String, _
    batchSize As Integer, _
    <OutAttribute> ByRef failures As ConnectorTieredOperationFailure() _
) As ConnectorMonitoringAlert()

[FaultContractAttribute(typeof(ArgumentNullException))] 
[FaultContractAttribute(typeof(UnknownChannelException))] 
[FaultContractAttribute(typeof(ObjectNotFoundException))] 
[FaultContractAttribute(typeof(UnknownAuthorizationStoreException))] 
[FaultContractAttribute(typeof(UnknownDatabaseException))] 
[FaultContractAttribute(typeof(InvalidDatabaseDataException))] 
[FaultContractAttribute(typeof(ConnectorInvalidException))] 
[OperationContractAttribute] 
[FaultContractAttribute(typeof(InvalidOperationException))] 
[FaultContractAttribute(typeof(UnauthorizedAccessEnterpriseManagementException))] 
[FaultContractAttribute(typeof(TimeoutException))] 
[FaultContractAttribute(typeof(ServerDisconnectedException))] 
[FaultContractAttribute(typeof(ServiceNotRunningException))] 
[FaultContractAttribute(typeof(UnknownServiceException))] 
ConnectorMonitoringAlert[] GetMonitoringAlertsWithBatchSizeForTiers (
    Guid connectorId,
    string languageCodes,
    int batchSize,
    out ConnectorTieredOperationFailure[] failures
)

[FaultContractAttribute(typeof(ArgumentNullException))] 
[FaultContractAttribute(typeof(UnknownChannelException))] 
[FaultContractAttribute(typeof(ObjectNotFoundException))] 
[FaultContractAttribute(typeof(UnknownAuthorizationStoreException))] 
[FaultContractAttribute(typeof(UnknownDatabaseException))] 
[FaultContractAttribute(typeof(InvalidDatabaseDataException))] 
[FaultContractAttribute(typeof(ConnectorInvalidException))] 
[OperationContractAttribute] 
[FaultContractAttribute(typeof(InvalidOperationException))] 
[FaultContractAttribute(typeof(UnauthorizedAccessEnterpriseManagementException))] 
[FaultContractAttribute(typeof(TimeoutException))] 
[FaultContractAttribute(typeof(ServerDisconnectedException))] 
[FaultContractAttribute(typeof(ServiceNotRunningException))] 
[FaultContractAttribute(typeof(UnknownServiceException))] 
array<ConnectorMonitoringAlert^>^ GetMonitoringAlertsWithBatchSizeForTiers (
    Guid connectorId, 
    String^ languageCodes, 
    int batchSize, 
    [OutAttribute] array<ConnectorTieredOperationFailure^>^% failures
)

/** @attribute FaultContractAttribute(System.ArgumentNullException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownChannelException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ObjectNotFoundException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownAuthorizationStoreException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownDatabaseException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.InvalidDatabaseDataException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ConnectorInvalidException) */ 
/** @attribute OperationContractAttribute() */ 
/** @attribute FaultContractAttribute(System.InvalidOperationException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnauthorizedAccessEnterpriseManagementException) */ 
/** @attribute FaultContractAttribute(System.TimeoutException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServerDisconnectedException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServiceNotRunningException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownServiceException) */ 
ConnectorMonitoringAlert[] GetMonitoringAlertsWithBatchSizeForTiers (
    Guid connectorId, 
    String languageCodes, 
    int batchSize, 
    /** @attribute OutAttribute() */ /** @ref */ ConnectorTieredOperationFailure[] failures
)

Parameters

  • connectorId
    The globally unique identifier (GUID) for the monitoring connector to get alerts for.
  • languageCodes
    A comma-delimited list of language codes. The language code is an ISO 639-2 three-letter code that corresponds to the values used by the CultureInfo.ThreeLetterISOLanguageName property.
  • batchSize
    The approximate max batch size to return.
  • failures
    The array of failures that may have occurred for various tiers.

Return Value

Returns an array of ConnectorMonitoringAlert objects that contain the alerts for the specified monitoring 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. 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 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 AcknowledgeMonitoringAlertsForTiers. 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

IConnectorFramework Interface
IConnectorFramework Members
Microsoft.EnterpriseManagement.ConnectorFramework Namespace