CloudLoadBalancerProvider.AddVirtualAddressAsync Method

CloudLoadBalancerProviderAddVirtualAddressAsync Method

This API is preliminary and subject to change.

Add a virtual address to a 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<LoadBalancerVirtualAddress> AddVirtualAddressAsync(
	LoadBalancerId loadBalancerId,
	LoadBalancerVirtualAddressType type,
	AddressFamily addressFamily,
	AsyncCompletionOption completionOption,
	CancellationToken cancellationToken,
	IProgress<LoadBalancer> progress
)

Public Function AddVirtualAddressAsync ( 
	loadBalancerId As LoadBalancerId,
	type As LoadBalancerVirtualAddressType,
	addressFamily As AddressFamily,
	completionOption As AsyncCompletionOption,
	cancellationToken As CancellationToken,
	progress As IProgress(Of LoadBalancer)
) As Task(Of LoadBalancerVirtualAddress)

public:
virtual Task<LoadBalancerVirtualAddress^>^ AddVirtualAddressAsync(
	LoadBalancerId^ loadBalancerId, 
	LoadBalancerVirtualAddressType^ type, 
	AddressFamily addressFamily, 
	AsyncCompletionOption completionOption, 
	CancellationToken cancellationToken, 
	IProgress<LoadBalancer^>^ progress
) sealed

abstract AddVirtualAddressAsync : 
        loadBalancerId : LoadBalancerId * 
        type : LoadBalancerVirtualAddressType * 
        addressFamily : AddressFamily * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<LoadBalancer> -> Task<LoadBalancerVirtualAddress> 
override AddVirtualAddressAsync : 
        loadBalancerId : LoadBalancerId * 
        type : LoadBalancerVirtualAddressType * 
        addressFamily : AddressFamily * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<LoadBalancer> -> Task<LoadBalancerVirtualAddress>

Parameters

loadBalancerId: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersLoadBalancerId
The load balancer ID. This is obtained from LoadBalancer.Id.
type: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersLoadBalancerVirtualAddressType
The virtual address type.
addressFamily: Type: System.Net.SocketsAddressFamily
The family of address to add. This should be InterNetwork or InterNetworkV6.
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: TaskLoadBalancerVirtualAddress
A Task object representing the asynchronous operation. When the operation completes, the Result property will contain a LoadBalancerVirtualAddress object describing the added virtual address. If completionOption is RequestCompleted, the task will not be considered complete until the load balancer transitions out of the PendingUpdate state.

Implements

ILoadBalancerServiceAddVirtualAddressAsync(LoadBalancerId, LoadBalancerVirtualAddressType, AddressFamily, AsyncCompletionOption, CancellationToken, IProgressLoadBalancer)

Exceptions

Exception	Condition
ArgumentNullException	If loadBalancerId is . -or- If type is .
NotSupportedException	If the specified addressFamily is not supported by this provider.
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If loadBalancerId is .

-or-

If type is .

NotSupportedException

If the specified addressFamily is not supported by this provider.

WebException

If the REST request does not return successfully.

Version Information