com.microsoft.windowsazure.management.compute

Interface LoadBalancerOperations

All Known Implementing Classes:

LoadBalancerOperationsImpl

public interface LoadBalancerOperations

The Compute Management API includes operations for managing the load balancers for your subscription.

Method Summary

Methods

Modifier and Type	Method and Description
OperationStatusResponse	beginCreating(String serviceName, String deploymentName, LoadBalancerCreateParameters parameters) Add an internal load balancer to a an existing deployment.
Future<OperationStatusResponse>	beginCreatingAsync(String serviceName, String deploymentName, LoadBalancerCreateParameters parameters) Add an internal load balancer to a an existing deployment.
OperationStatusResponse	beginDeleting(String serviceName, String deploymentName, String loadBalancerName) Delete an internal load balancer from the deployment.
Future<OperationStatusResponse>	beginDeletingAsync(String serviceName, String deploymentName, String loadBalancerName) Delete an internal load balancer from the deployment.
OperationStatusResponse	beginUpdating(String serviceName, String deploymentName, String loadBalancerName, LoadBalancerUpdateParameters parameters) Updates an internal load balancer associated with an existing deployment.
Future<OperationStatusResponse>	beginUpdatingAsync(String serviceName, String deploymentName, String loadBalancerName, LoadBalancerUpdateParameters parameters) Updates an internal load balancer associated with an existing deployment.
OperationStatusResponse	create(String serviceName, String deploymentName, LoadBalancerCreateParameters parameters) Add an internal load balancer to a an existing deployment.
Future<OperationStatusResponse>	createAsync(String serviceName, String deploymentName, LoadBalancerCreateParameters parameters) Add an internal load balancer to a an existing deployment.
OperationResponse	delete(String serviceName, String deploymentName, String loadBalancerName) Delete an internal load balancer from the deployment.
Future<OperationResponse>	deleteAsync(String serviceName, String deploymentName, String loadBalancerName) Delete an internal load balancer from the deployment.
OperationStatusResponse	update(String serviceName, String deploymentName, String loadBalancerName, LoadBalancerUpdateParameters parameters) Updates an internal load balancer associated with an existing deployment.
Future<OperationStatusResponse>	updateAsync(String serviceName, String deploymentName, String loadBalancerName, LoadBalancerUpdateParameters parameters) Updates an internal load balancer associated with an existing deployment.

Method Detail

beginCreating

OperationStatusResponse beginCreating(String serviceName,
                                    String deploymentName,
                                    LoadBalancerCreateParameters parameters)
                                      throws ParserConfigurationException,
                                             SAXException,
                                             TransformerException,
                                             IOException,
                                             ServiceException

Add an internal load balancer to a an existing deployment. When used by an input endpoint, the internal load balancer will provide an additional private VIP that can be used for load balancing to the roles in this deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

parameters - Required. Parameters supplied to the Create Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

ParserConfigurationException - Thrown if there was an error configuring the parser for the response body.

SAXException - Thrown if there was an error parsing the response body.

TransformerException - Thrown if there was an error creating the DOM transformer.

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginCreatingAsync

Future<OperationStatusResponse> beginCreatingAsync(String serviceName,
                                                 String deploymentName,
                                                 LoadBalancerCreateParameters parameters)

Add an internal load balancer to a an existing deployment. When used by an input endpoint, the internal load balancer will provide an additional private VIP that can be used for load balancing to the roles in this deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

parameters - Required. Parameters supplied to the Create Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

beginDeleting

OperationStatusResponse beginDeleting(String serviceName,
                                    String deploymentName,
                                    String loadBalancerName)
                                      throws IOException,
                                             ServiceException

Delete an internal load balancer from the deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the load balancer.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginDeletingAsync

Future<OperationStatusResponse> beginDeletingAsync(String serviceName,
                                                 String deploymentName,
                                                 String loadBalancerName)

Delete an internal load balancer from the deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the load balancer.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

beginUpdating

OperationStatusResponse beginUpdating(String serviceName,
                                    String deploymentName,
                                    String loadBalancerName,
                                    LoadBalancerUpdateParameters parameters)
                                      throws ParserConfigurationException,
                                             SAXException,
                                             TransformerException,
                                             IOException,
                                             ServiceException

Updates an internal load balancer associated with an existing deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the loadBalancer.

parameters - Required. Parameters supplied to the Update Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

ParserConfigurationException - Thrown if there was an error configuring the parser for the response body.

SAXException - Thrown if there was an error parsing the response body.

TransformerException - Thrown if there was an error creating the DOM transformer.

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginUpdatingAsync

Future<OperationStatusResponse> beginUpdatingAsync(String serviceName,
                                                 String deploymentName,
                                                 String loadBalancerName,
                                                 LoadBalancerUpdateParameters parameters)

Updates an internal load balancer associated with an existing deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the loadBalancer.

parameters - Required. Parameters supplied to the Update Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

create

OperationStatusResponse create(String serviceName,
                             String deploymentName,
                             LoadBalancerCreateParameters parameters)
                               throws InterruptedException,
                                      ExecutionException,
                                      ServiceException,
                                      IOException,
                                      ParserConfigurationException,
                                      SAXException,
                                      TransformerException,
                                      URISyntaxException

Add an internal load balancer to a an existing deployment. When used by an input endpoint, the internal load balancer will provide an additional private VIP that can be used for load balancing to the roles in this deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

parameters - Required. Parameters supplied to the Create Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

ServiceException - Thrown if the server returned an error for the request.

IOException - Thrown if there was an error setting up tracing for the request.

ParserConfigurationException - Thrown if there was an error configuring the parser for the response body.

SAXException - Thrown if there was an error parsing the response body.

TransformerException - Thrown if there was an error creating the DOM transformer.

ServiceException - Thrown if an unexpected response is found.

URISyntaxException - Thrown if there was an error parsing a URI in the response.

createAsync

Future<OperationStatusResponse> createAsync(String serviceName,
                                          String deploymentName,
                                          LoadBalancerCreateParameters parameters)

Add an internal load balancer to a an existing deployment. When used by an input endpoint, the internal load balancer will provide an additional private VIP that can be used for load balancing to the roles in this deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

parameters - Required. Parameters supplied to the Create Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

delete

OperationResponse delete(String serviceName,
                       String deploymentName,
                       String loadBalancerName)
                         throws IOException,
                                ServiceException,
                                InterruptedException,
                                ExecutionException

Delete an internal load balancer from the deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the load balancer.

Returns:

A standard service response including an HTTP status code and request ID.

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

ServiceException - Thrown if the server returned an error for the request.

deleteAsync

Future<OperationResponse> deleteAsync(String serviceName,
                                    String deploymentName,
                                    String loadBalancerName)

Delete an internal load balancer from the deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the load balancer.

Returns:

A standard service response including an HTTP status code and request ID.

update

OperationStatusResponse update(String serviceName,
                             String deploymentName,
                             String loadBalancerName,
                             LoadBalancerUpdateParameters parameters)
                               throws InterruptedException,
                                      ExecutionException,
                                      ServiceException,
                                      IOException,
                                      ParserConfigurationException,
                                      SAXException,
                                      TransformerException,
                                      URISyntaxException

Updates an internal load balancer associated with an existing deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the loadBalancer.

parameters - Required. Parameters supplied to the Update Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

ServiceException - Thrown if the server returned an error for the request.

IOException - Thrown if there was an error setting up tracing for the request.

ParserConfigurationException - Thrown if there was an error configuring the parser for the response body.

SAXException - Thrown if there was an error parsing the response body.

TransformerException - Thrown if there was an error creating the DOM transformer.

ServiceException - Thrown if an unexpected response is found.

URISyntaxException - Thrown if there was an error parsing a URI in the response.

updateAsync

Future<OperationStatusResponse> updateAsync(String serviceName,
                                          String deploymentName,
                                          String loadBalancerName,
                                          LoadBalancerUpdateParameters parameters)

Updates an internal load balancer associated with an existing deployment.

Parameters:

serviceName - Required. The name of the service.

deploymentName - Required. The name of the deployment.

loadBalancerName - Required. The name of the loadBalancer.

parameters - Required. Parameters supplied to the Update Load Balancer operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.