MonitoringServiceExtensions.TestAlarm Method

Namespace: net.openstack.Core.Synchronous
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

[ObsoleteAttribute("These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")]
public static ReadOnlyCollection<AlarmData> TestAlarm(
	this IMonitoringService service,
	EntityId entityId,
	TestAlarmConfiguration configuration
)

<ExtensionAttribute>
<ObsoleteAttribute("These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")>
Public Shared Function TestAlarm ( 
	service As IMonitoringService,
	entityId As EntityId,
	configuration As TestAlarmConfiguration
) As ReadOnlyCollection(Of AlarmData)

public:
[ExtensionAttribute]
[ObsoleteAttribute(L"These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")]
static ReadOnlyCollection<AlarmData^>^ TestAlarm(
	IMonitoringService^ service, 
	EntityId^ entityId, 
	TestAlarmConfiguration^ configuration
)

[<ExtensionAttribute>]
[<ObsoleteAttribute("These synchronous wrappers should not be used. For more information, see http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx.")>]
static member TestAlarm : 
        service : IMonitoringService * 
        entityId : EntityId * 
        configuration : TestAlarmConfiguration -> ReadOnlyCollection<AlarmData>

Parameters

service: Type: net.openstack.Providers.RackspaceIMonitoringService
The monitoring service instance.
entityId: Type: net.openstack.Providers.Rackspace.Objects.MonitoringEntityId
The entity ID. This is obtained from Entity.Id.
configuration: Type: net.openstack.Providers.Rackspace.Objects.MonitoringTestAlarmConfiguration
A TestAlarmConfiguration object describing the alarm test configuration.

Return Value

Type: ReadOnlyCollectionAlarmData
A collection AlarmData objects describing the test results.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMonitoringService. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	If service is .
ArgumentNullException	If entityId is . -or- If configuration is .
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If service is .

ArgumentNullException

If entityId is .

-or-

If configuration is .

WebException

If the REST request does not return successfully.

Version Information