Share via

IConnectorFramework.GetMonitoringAlertsWithBookmarkWithBatchSize 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. The returned array is limited to the batchSize parameter.

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 utcBookmarkTime As DateTime
Dim batchSize As Integer
Dim returnValue As ConnectorMonitoringAlert()

returnValue = instance.GetMonitoringAlertsWithBookmarkWithBatchSize(connectorId, languageCodes, utcBookmarkTime, batchSize)

Syntax

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

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

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

/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownChannelException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnauthorizedAccessEnterpriseManagementException) */ 
/** @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 FaultContractAttribute(System.ArgumentNullException) */ 
/** @attribute FaultContractAttribute(System.InvalidOperationException) */ 
/** @attribute FaultContractAttribute(System.TimeoutException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServerDisconnectedException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServiceNotRunningException) */ 
/** @attribute FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownServiceException) */ 
/** @attribute OperationContractAttribute() */ 
ConnectorMonitoringAlert[] GetMonitoringAlertsWithBookmarkWithBatchSize (
    Guid connectorId, 
    String languageCodes, 
    DateTime utcBookmarkTime, 
    int batchSize
)

FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownChannelException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnauthorizedAccessEnterpriseManagementException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ObjectNotFoundException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownAuthorizationStoreException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownDatabaseException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.InvalidDatabaseDataException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ConnectorInvalidException) 
FaultContractAttribute(System.ArgumentNullException) 
FaultContractAttribute(System.InvalidOperationException) 
FaultContractAttribute(System.TimeoutException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServerDisconnectedException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.ServiceNotRunningException) 
FaultContractAttribute(Microsoft.EnterpriseManagement.Common.UnknownServiceException) 
OperationContractAttribute 
function GetMonitoringAlertsWithBookmarkWithBatchSize (
    connectorId : Guid, 
    languageCodes : String, 
    utcBookmarkTime : DateTime, 
    batchSize : int
) : ConnectorMonitoringAlert[]

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.
  • utcBookmarkTime
    A timestamp bookmark. All alerts with a timestamp prior to this will be returned.
  • batchSize
    The approximate max batch size to return.

Return Value

Returns an array of ConnectorMonitoringAlert objects that contain the alerts for the specified monitoring connector that occurred before the specified utcBookmarkTime.

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 GetMonitoringAlertsWithBookmarkWithBatchSize method you should check to see if the count property of the returned collection equals or exceeds thebatchSize. 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.

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