IAutoScaleService.DeleteGroupAsync Method

This API is preliminary and subject to change.

Remove and delete a scaling group.

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

Syntax

C++

Copy

Task DeleteGroupAsync(
	ScalingGroupId groupId,
	Nullable<bool> force,
	CancellationToken cancellationToken
)

Function DeleteGroupAsync ( 
	groupId As ScalingGroupId,
	force As Nullable(Of Boolean),
	cancellationToken As CancellationToken
) As Task

Task^ DeleteGroupAsync(
	ScalingGroupId^ groupId, 
	Nullable<bool> force, 
	CancellationToken cancellationToken
)

abstract DeleteGroupAsync : 
        groupId : ScalingGroupId * 
        force : Nullable<bool> * 
        cancellationToken : CancellationToken -> Task

Parameters

groupId: Type: net.openstack.Providers.Rackspace.Objects.AutoScale.ScalingGroupId
The ID of the scaling group. This is obtained from ScalingGroup.Id.
force: Type: System.Nullable<Boolean>
true to delete the scaling group even if it has active or pending entities; otherwise, false to only delete the group if it does not contain any entities. If the value is null, a provider-specific default value is used.
cancellationToken: Type: System.Threading.CancellationToken
The CancellationToken that the task will observe.

Return Value

Type: Task
A Task object representing the asynchronous operation.

Exceptions

Exception	Condition
ArgumentNullException	If groupId is null.
WebException	If the REST request does not return successfully.

Remarks

If force is true, active servers in the group will be immediately deleted, and pending servers will be deleted once they finish building and become active.

Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6

Reference

IAutoScaleService Interface

net.openstack.Providers.Rackspace Namespace

Other Resources

Delete scaling group (Rackspace Auto Scale Developer Guide - API v1.0)