CloudLoadBalancerProvider.UpdateLoadBalancerAsync Method

CloudLoadBalancerProviderUpdateLoadBalancerAsync Method

This API is preliminary and subject to change.

Updates attributes for an existing load balancer.

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

Syntax

C++

Copy

public Task UpdateLoadBalancerAsync(
	LoadBalancerId loadBalancerId,
	LoadBalancerUpdate configuration,
	AsyncCompletionOption completionOption,
	CancellationToken cancellationToken,
	IProgress<LoadBalancer> progress
)

Public Function UpdateLoadBalancerAsync ( 
	loadBalancerId As LoadBalancerId,
	configuration As LoadBalancerUpdate,
	completionOption As AsyncCompletionOption,
	cancellationToken As CancellationToken,
	progress As IProgress(Of LoadBalancer)
) As Task

public:
virtual Task^ UpdateLoadBalancerAsync(
	LoadBalancerId^ loadBalancerId, 
	LoadBalancerUpdate^ configuration, 
	AsyncCompletionOption completionOption, 
	CancellationToken cancellationToken, 
	IProgress<LoadBalancer^>^ progress
) sealed

abstract UpdateLoadBalancerAsync : 
        loadBalancerId : LoadBalancerId * 
        configuration : LoadBalancerUpdate * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<LoadBalancer> -> Task 
override UpdateLoadBalancerAsync : 
        loadBalancerId : LoadBalancerId * 
        configuration : LoadBalancerUpdate * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<LoadBalancer> -> Task

Parameters

loadBalancerId: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersLoadBalancerId
The load balancer ID. This is obtained from LoadBalancer.Id.
configuration: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersLoadBalancerUpdate
The updated configuration for the load balancer.
completionOption: Type: net.openstack.CoreAsyncCompletionOption
Specifies when the Task representing the asynchronous server operation should be considered complete.
cancellationToken: Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.
progress: Type: SystemIProgressLoadBalancer
An optional callback object to receive progress notifications, if completionOption is RequestCompleted. If this is , no progress notifications are sent.

Return Value

Type: Task
A Task object representing the asynchronous operation. If completionOption is RequestCompleted, the task will not be considered complete until the load balancer transitions out of the PendingUpdate state.

Implements

ILoadBalancerServiceUpdateLoadBalancerAsync(LoadBalancerId, LoadBalancerUpdate, AsyncCompletionOption, CancellationToken, IProgressLoadBalancer)

Exceptions

Exception	Condition
ArgumentNullException	If loadBalancerId is . -or- If configuration is .
ArgumentException	If completionOption is not a valid AsyncCompletionOption.
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If loadBalancerId is .

-or-

If configuration is .

ArgumentException

If completionOption is not a valid AsyncCompletionOption.

WebException

If the REST request does not return successfully.

Version Information