Update Load Balancer

Article
08/03/2016

The Update Load Balancer operation updates information about a load balancer that is associated with a deployment.

Request

The Update Load Balancer request is specified as follows. Replace <subscription-id> with your subscription ID, <service-name> with the name of the cloud service, <deployment-name> with the name of the deployment, and <load-balancer-name> with the name of the load balancer to update.

Method	Request URI
PUT	https://management.core.windows.net/<subscription-id>/services/hostedservices/<service-name>/deployments/<deployment-name>/loadbalancers/<load-balancer-name>

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header	Description
Content-Type	Required. Set this header to application/xml.
x-ms-version	Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2014-06-01 or higher.

Request Body

The format of the request body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<LoadBalancer xmlns="https://schemas.microsoft.com/windowsazure">
  <Name>name-of-internal-load-balancer</ServiceName>
  <FrontendIpConfiguration>
    <Type>type-of-ip-address</Type>
    <SubnetName>name-of-subnet</SubnetName>
    <StaticVirtualNetworkIPAddress>static-ip-address</StaticVirtualNetworkIPAddress>
  </FrontendIpConfiguration>
</LoadBalancer>

The following table describes the elements of the request body.

Element Name	Description
Name	Required. Specifies the name of the internal load balancer. This value is only provided to identify the load balancer to update and cannot be changed.
FrontendIpConfiguration	Required. Specifies the configuration for the virtual IP address that is provided by the load balancer.
Type	Required. Specifies the type of virtual IP address that is provided by the load balancer. The only allowable value is Private.
SubnetName	Required. Specifies the subnet of the virtual network that the load balancer uses. The virtual IP address that is managed by the load balancer is contained in this subnet.
StaticVirtualNetworkIPAddress	Required. Specifies a specific virtual IP address that the load balancer uses from the subnet in the virtual network.

Response

The response includes an HTTP status code and a set of response headers.

Status Code

A successful operation returns status code 201 (Created).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header	Description
x-ms-request-id	A value that uniquely identifies a request made against the management service. For an asynchronous operation, you can call Get Operation Status with the value of the header to determine whether the operation is complete, has failed, or is still in progress.

Response Body